Settings: get creditors
creditors_listList all creditors/suppliers from your accounting records to resolve a supplier name to the creditor ID required by receipt and posting tools.
Instructions
🟢 READ-ONLY: Fetches data. Makes no changes to the accounting records.
get creditors
Get all creditors
Use to list suppliers, for example to resolve a supplier name to the creditor id the receipt and posting tools expect.
For customers you invoice, use debtors_list.
Supports limit and offset. Do not assume rows is the grand total. Continue paging until empty and check progress. v1 offers no delete endpoint for creditors, so they can only be created, listed and updated.
Endpoint: POST /settings/get/creditors
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | limit of the results, default is 25 results | |
| offset | No | offset of the results, default is 0 |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | An array of creditors | |
| rows | No | Number of returned rows | |
| message | No | blank | |
| success | Yes | Success boolean |