API Reference Overview
Authentication
Consumers
Connections
Accounting
- Folders
- Book years
- Clients
- Suppliers
- Invoices
- Ledger accounts
- Journals
- Journal entries
- Employees
- Analytic plans
- Analytic accounts
- Miscellaneous operations
- Outstandings
Invoicing
- Contacts
- Invoices
- Products
- Taxes
- Opportunities
- Payments
- Payment methods
POS
- Orders
- Payment methods
- Payments
- Closure info
- Locations
- Products
- Categories
- Customers
eCommerce
- Orders
- Products & variants
- Categories
- Customers
- Payment methods
- Locations
- Countries
- Taxes
PMS
- Orders
- Invoices
- Payment methods
- Payments
- Closure info
- Locations
- Categories
- Customers
Payment
- Payments
- Balances
- Transactions
- Refunds
Banking
- Financial institutions
- Banking accounts
- Transactions
Advanced
- Webhooks
- Syncs
- Issues
- Datastores
Get suppliers
Returns a list of accounting suppliers
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/accounting/suppliers \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"external_reference": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"name": "<string>",
"function": "<string>",
"is_company": true,
"company_id": "<string>",
"phone": "<string>",
"mobile": "<string>",
"email": "<string>",
"language": "<string>",
"internal_notes": "<string>",
"website": "<string>",
"vat": "<string>",
"iban": "<string>",
"bank_account": "<string>",
"currency": "<string>",
"active": true,
"addresses": [],
"account_number": "<string>",
"company_number": "<string>",
"id": "<string>"
}
],
"total": 1,
"page": 2,
"size": 2
}
Authorizations
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Query Parameters
x >= 1
1 <= x <= 100
Response
Only used when the supplier is an individual (is_company=false). Indicates the first name of the supplier.
Only used when the supplier is an individual (is_company=false). Indicates the last name of the supplier.
Only used when the supplier is an individual (is_company=false). Indicates the function of the supplier.
Indicates if the supplier is an individual or a company.
Only used when the supplier is an individual (is_company=false). Indicates the id of the company linked to the supplier.
Format: ISO 639-1 codes.
IBAN Account number of the supplier.
Bank account number of the supplier.
Indicates the currency of the supplier (e.g. EUR).
An enumeration.
main
, delivery
, invoice
Format: ISO 3166-1 codes.
x >= 0
x >= 1
x >= 1
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/accounting/suppliers \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"external_reference": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"name": "<string>",
"function": "<string>",
"is_company": true,
"company_id": "<string>",
"phone": "<string>",
"mobile": "<string>",
"email": "<string>",
"language": "<string>",
"internal_notes": "<string>",
"website": "<string>",
"vat": "<string>",
"iban": "<string>",
"bank_account": "<string>",
"currency": "<string>",
"active": true,
"addresses": [],
"account_number": "<string>",
"company_number": "<string>",
"id": "<string>"
}
],
"total": 1,
"page": 2,
"size": 2
}