API Reference Overview
Authentication
Consumers
Connections
Accounting
- Folders
- Book years
- Clients
- Suppliers
- Invoices
- 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)
- POST
- 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 invoices by type (sale/purchase entries)
Returns a list of invoices by a specific type (=sale/purchase entries). Each line of the invoice will include the analytic account linked to default analytic plan. Optionally dates can be defined to retrieve invoice from a certain date to another date
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/accounting/invoices/type/{invoice_type} \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"invoice_type": "customer_invoice",
"invoice_number": "<string>",
"currency": "<string>",
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123,
"reference": "<string>",
"payment_communication": "<string>",
"customer_memo": "<string>",
"id": "<string>",
"invoice_date": "2023-12-25",
"due_date": "2023-12-25",
"partner_id": "<string>",
"journal_id": "<string>",
"payments": [
{
"id": "<string>",
"name": "<string>",
"currency": "<string>",
"amount": 123,
"dedicated_amount": 0,
"payment_date": "2023-12-25",
"journal_type": "customer_invoice",
"journal_id": "<string>",
"journal_name": "<string>",
"reconciled": false,
"communication": "<string>",
"matching_number": "<string>"
}
],
"status": "cancelled",
"lines": [
{
"line_number": 1,
"description": "<string>",
"unit_price": 123,
"unit_of_measure": "<string>",
"quantity": 123,
"untaxed_amount": 123,
"tax_rate": 123,
"tax_amount": 123,
"total": 123,
"account_number": "<string>",
"tax_code": "<string>",
"analytic_account": "<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
An enumeration.
customer_invoice
, customer_refund
, supplier_invoice
, supplier_refund
Query Parameters
x >= 1
1 <= x <= 100
An enumeration.
true
, false
An enumeration.
all
, unpaid
, paid
Response
An enumeration.
customer_invoice
, customer_refund
, supplier_invoice
, supplier_refund
Indicates the currency of the invoice (e.g. EUR).
Accounting invoice date. It is automatically set to '1970-01-01' if the value is empty in the accounting system.
Due date of the invoice. We use the value of the invoice date if the value is not available/empty in the accounting system.
Indicates the journal used in for the invoice. If the journal is not given, the journal will be automatically set if only one journal exists otherwise an error will be thrown.
Indicates the tax rate used for the line (e.g. 21.0).
Indicates the number of the account used for the line (e.g. 701000).
A list of default units can be used for which an advanced mapping has been done (units: 'hour', 'day', 'cm', 'm2', 'm3', 'm', 'km', 'mile', 'g', 'kg', 'ton', 'box', 'pallet', 'roll', 'liter', 'unit'). Custom units of measure must have an identical name in the target software.
Indicates the tax code used for the line. This is the ID of the Tax Code in the accounting software.
Number of the invoice. If left empty, will be automatically generated by the accounting system at creation.
Total amount of the payment. A part of this amount could be reconciled with another invoice.
An enumeration.
customer_invoice
, customer_refund
, supplier_invoice
, supplier_refund
, financial_operation
, miscellaneous_operation
, unknown
Amount of the payment dedicated to the invoice. Zero the accounting software doesn't provide the information.
An enumeration.
cancelled
, draft
, posted
, paid
x >= 0
x >= 1
x >= 1
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/accounting/invoices/type/{invoice_type} \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"invoice_type": "customer_invoice",
"invoice_number": "<string>",
"currency": "<string>",
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123,
"reference": "<string>",
"payment_communication": "<string>",
"customer_memo": "<string>",
"id": "<string>",
"invoice_date": "2023-12-25",
"due_date": "2023-12-25",
"partner_id": "<string>",
"journal_id": "<string>",
"payments": [
{
"id": "<string>",
"name": "<string>",
"currency": "<string>",
"amount": 123,
"dedicated_amount": 0,
"payment_date": "2023-12-25",
"journal_type": "customer_invoice",
"journal_id": "<string>",
"journal_name": "<string>",
"reconciled": false,
"communication": "<string>",
"matching_number": "<string>"
}
],
"status": "cancelled",
"lines": [
{
"line_number": 1,
"description": "<string>",
"unit_price": 123,
"unit_of_measure": "<string>",
"quantity": 123,
"untaxed_amount": 123,
"tax_rate": 123,
"tax_amount": 123,
"total": 123,
"account_number": "<string>",
"tax_code": "<string>",
"analytic_account": "<string>"
}
]
}
],
"total": 1,
"page": 2,
"size": 2
}