API Reference Overview
General
Consumers
- GETGet consumers
- POSTCreate new consumer
- GETGet one consumer
- DELDelete one consumer
- PATCHUpdate one consumer
- GETGet executions information for one consumer/flow/sync
- POSTRetrieve the url of a sync for a specific consumer
- GETGet sync information for one consumer
- GETGet execution data for a specific consumer and a specific datastore
- POSTAdd data into a datastore for a consumer
- DELDelete execution data for a specific consumer and a specific datastore
- PATCHUpdate execution data for a specific consumer and a specific datastore
Connections
Webhooks
Syncs
Datastores
Accounting
- GETGet Folders
- GETGet Bookyears
- GETGet Analytic Plans
- GETGet clients
- POSTCreate client
- GETGet one client
- PATCHUpdate client
- GETGet suppliers
- POSTCreate supplier
- GETGet one supplier
- PATCHUpdate one supplier
- POSTCreate sale/purchase entry
- POSTCreate sale/purchase entry (Multiple plans)
- GETGet invoices by type (sale/purchase entries)
- GETGet one invoice (sale/purchase entry)
- GETGet one invoice (sale/purchase entry - Multiple Analytic Plans)
- GETGet invoices by type (sale/purchase entries - Multiple Analytic Plans)
- GETGet analytic accounts
- POSTCreate analytic account
- POSTCreate analytic account (Multiple Analytic Plans)
- GETGet analytic account
- PATCHUpdate analytic account
- GETGet analytic account (Multiple Analytic Plans)
- PATCHUpdate analytic account (Multiple Analytic Plans)
- GETGet analytic accounts (Multiple Analytic Plans)
- GETGet journal entries
- POSTCreate Journal Entry [Deprecated]
- GETGet journal entries (Multiple Analytic Plans)
- GETGet one journal entry
- POSTCreate Journal Entry
- GETGet payments by invoice ID
- GETGet journals
- GETGet vat codes
- GETGet miscellaneous operations
- POSTCreate miscellaneous operation
- GETGet one miscellaneous operation
- POSTMatch entries
- POSTMatch multipe entries
- POSTAttach a document (PDF)
- GETGet chart of accounts
- POSTGet the balance of accounts
- GETGet employees
- POSTCreate a financial entry [Deprecated]
- POSTCreate a financial entry
- GETGet clients/suppliers outstanding items
- GETGet attachments
Point of Sale
eCommerce
- GETGet all customers
- GETGet one specific customer
- GETGet all products
- GETGet one specific product
- GETGet one specific product variant
- POSTUpdate available quantity
- GETGet all locations
- GETGet all orders
- POSTCreate an order
- GETGet one specific order
- GETGet all payment methods
- GETGet all product categories
- GETGet all tax rates
- GETGet all countries
Invoicing
- GETRetrieve all invoices
- POSTCreate an invoice
- GETRetrieve one invoice
- GETRetrieve all taxes
- GETRetrieve one tax
- GETRetrieve all products
- POSTCreate a product
- GETRetrieve one product
- GETRetrieve all opportunities
- GETRetrieve one opportunity
- GETRetrieve all contacts
- POSTCreate a contact
- GETRetrieve one contact
- GETRetrieve all payments
- GETRetrieve all payment methods
Banking
Payment
Retrieve all contacts
Returns a list of all the contacts. Optionally contact type can be defined to retrieve contact from a certain type.
Authorizations
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Query Parameters
Filter based on the type of the contact (e.g. supplier/customer/prospect).
prospect
, customer
, supplier
, all
x > 1
1 < x < 100
Response
Technical id in Chift
Addresses
An enumeration.
main
, delivery
, invoice
, other
Format: ISO 3166-1 codes.
Birthdate
Comment
Technical id of the contact' company in Chift
Name of the company
Company number (identification number different than the VAT (e.g. siret))
Currency matching target sofware name
Number of the accounting account used for sales (e.g. 701000)
External reference of the contact in the invoicing system
Firstname
Gender
H
, F
, N/A
Is a company?
Is a customer?
Is a prospect?
Is a supplier?
Language matching target sofware name
Lastname
Mobile
Phone
Number of the accounting account used for purchases (e.g. 601000)
VAT number
x > 1
x > 1
x > 0