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
Retrieve all contacts
Returns a list of all the contacts. Optionally contact type can be defined to retrieve contact from a certain type.
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"is_prospect": true,
"is_customer": true,
"is_supplier": true,
"is_company": true,
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"mobile": "<string>",
"company_id": "<string>",
"vat": "<string>",
"company_number": "<string>",
"currency": "<string>",
"language": "<string>",
"comment": "<string>",
"customer_account_number": "<string>",
"supplier_account_number": "<string>",
"birthdate": "2023-12-25",
"gender": "H",
"addresses": [],
"external_reference": "<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
An enumeration.
prospect
, customer
, supplier
, all
Response
Technical id in Chift
Is a prospect?
Is a customer?
Is a supplier?
Is a company?
Name of the company
Firstname
Lastname
Phone
Mobile
Technical id of the contact' company in Chift
VAT number
Company number (identification number different than the VAT (e.g. siret))
Currency matching target sofware name
Language matching target sofware name
Comment
Number of the accounting account used for sales (e.g. 701000)
Number of the accounting account used for purchases (e.g. 601000)
Birthdate
Gender
H
, F
, N/A
Addresses
An enumeration.
main
, delivery
, invoice
, other
Format: ISO 3166-1 codes.
External reference of the contact in the invoicing system
x >= 0
x >= 1
x >= 1
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"is_prospect": true,
"is_customer": true,
"is_supplier": true,
"is_company": true,
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"mobile": "<string>",
"company_id": "<string>",
"vat": "<string>",
"company_number": "<string>",
"currency": "<string>",
"language": "<string>",
"comment": "<string>",
"customer_account_number": "<string>",
"supplier_account_number": "<string>",
"birthdate": "2023-12-25",
"gender": "H",
"addresses": [],
"external_reference": "<string>"
}
],
"total": 1,
"page": 2,
"size": 2
}