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
Get all orders
Returns a list of all the orders
Authorizations
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Query Parameters
Filter orders created at or after this date (e.g. 2023-01-31)
Filter orders created at or before this date (e.g. 2023-01-31)
Filter orders last updated at or after this date (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors.
Include detailed information concerning refunds
true
, false
Include detailed information about categories
true
, false
Include detailed information about customer
true
, false
x > 1
1 < x < 100
Response
Indicates the currency of the order (e.g. EUR).
Total taxes applied to the order. After returns, removes and returns.
Current total of the order with discount. After returns, removes and returns.
Untaxed amount with discout and any kind of fee (e.g. shipping). After returns, removes and returns.
Technical id in Chift
Quantity without refunds and returns.
Technical id in Chift
Total taxes applied to the order line.
Indicates the tax rate used for the line (e.g. 21.0).
Total of the order line with discount.
Unit price of the product without taxes.
Untaxed amount of the order line with discount.
Technical id of the tax rate in Chift
Product variant
Technical id of the product variant in Chift
An enumeration.
cancelled_unpaid
, cancelled
, draft
, confirmed
, shipped
, refunded
Total taxes applied to the order. Refunds and returns are not included.
Total taxes applied to the order without taxes linked to fees (e.g. shipping).
Total of the order with discount. Refunds and returns are not included.
Total of the order without fees (e.g. shipping) but with discount. Refunds and returns are not included.
Untaxed amount with discout and any kind of fee (e.g. shipping). Refunds and returns are not included.
Untaxed amount without fees (e.g. shipping) but with discout. Refunds and returns are not included.
An enumeration.
main
, delivery
, invoice
Format: ISO 3166-1 codes.
Technical id in Chift
Technical id of the order line in Chift
Total taxes refunded (after discount).
Total refunded (after discount).
Untaxed amount refunded (after discount).
Technical id of the fee in Chift
An enumeration.
shipping
, other
Technical id in Chift
Total taxes refunded (after discount).
Total refunded (after discount).
Untaxed amount refunded (after discount).
Technical id of the transaction in the eCommerce
An enumeration.
failed
, pending
, success
Technical id of the payment method in the eCommerce
Name of the payment method
Technical id in Chift
An enumeration.
shipping
, other
Indicates if the fee has been removed from the order
Technical id of the tax rate in Chift
Technical id of the payment method in the eCommerce
Technical id of the return in Chift
Technical id of the fee in Chift
An enumeration.
shipping
, other
Technical id of the order line in Chift
Total taxes refunded (after discount).
Total refunded (after discount).
Untaxed amount refunded (after discount).
Technical id of the order line in Chift
Total taxes refunded (after discount).
Total refunded (after discount).
Untaxed amount refunded (after discount).
An enumeration.
main
, delivery
, invoice
Format: ISO 3166-1 codes.
Technical id of the transaction in the eCommerce
An enumeration.
failed
, pending
, success
Technical id of the payment method in the eCommerce
Name of the payment method
x > 1
x > 1
x > 0