API Reference Overview
Access & Connections
Accounting
Invoicing
POS
eCommerce
PMS
Payment
Banking
Other
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"currency": "<string>",
"invoice_type": "customer_invoice",
"status": "cancelled",
"invoice_date": "2023-12-25",
"tax_amount": 123,
"untaxed_amount": 123,
"total": 123,
"lines": [],
"partner_id": "<string>",
"invoice_number": "<string>",
"due_date": "2023-12-25",
"reference": "<string>",
"payment_communication": "<string>",
"customer_memo": "<string>",
"journal_ref": {
"id": "<string>",
"model": "<string>",
"name": "<string>"
},
"italian_specificities": {
"stamp_duty_amount": 123,
"withholding_tax": {
"rate": 123,
"amount": 123,
"reason": "RT01",
"payment_reason": "A"
},
"welfare_fund": {
"rate": 123,
"amount": 123,
"type": "TC01"
},
"payment_reporting": {
"method": "MP01",
"conditions": "TP01"
}
},
"last_updated_on": "2023-11-07T05:31:56Z",
"outstanding_amount": 123,
"last_payment_date": "2023-12-25",
"accounting_date": "2023-12-25",
"payment_method_id": "<string>",
"currency_exchange_rate": 1
}
],
"total": 1,
"page": 2,
"size": 2
}Retrieve all invoices
Returns a list of invoices. Optionally invoice type and dates can be defined to retrieve invoices of a certain type from a certain date to another date
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/invoicing/invoices \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"currency": "<string>",
"invoice_type": "customer_invoice",
"status": "cancelled",
"invoice_date": "2023-12-25",
"tax_amount": 123,
"untaxed_amount": 123,
"total": 123,
"lines": [],
"partner_id": "<string>",
"invoice_number": "<string>",
"due_date": "2023-12-25",
"reference": "<string>",
"payment_communication": "<string>",
"customer_memo": "<string>",
"journal_ref": {
"id": "<string>",
"model": "<string>",
"name": "<string>"
},
"italian_specificities": {
"stamp_duty_amount": 123,
"withholding_tax": {
"rate": 123,
"amount": 123,
"reason": "RT01",
"payment_reason": "A"
},
"welfare_fund": {
"rate": 123,
"amount": 123,
"type": "TC01"
},
"payment_reporting": {
"method": "MP01",
"conditions": "TP01"
}
},
"last_updated_on": "2023-11-07T05:31:56Z",
"outstanding_amount": 123,
"last_payment_date": "2023-12-25",
"accounting_date": "2023-12-25",
"payment_method_id": "<string>",
"currency_exchange_rate": 1
}
],
"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
Page number
x >= 1Page size
1 <= x <= 100customer_invoice, customer_refund, supplier_invoice, supplier_refund, all all, unpaid, paid Include the invoice lines in the response. By default, invoice lines are included when no extra request is needed to fetch them. If you want to include them explicitly, set this parameter to true.
true, false Include analytic accounts in the response
true, false Response
Successful Response
Show child attributes
Show child attributes
Technical id in Chift
Currency matching target sofware name
Invoice type
customer_invoice, customer_refund, supplier_invoice, supplier_refund, all Status
cancelled, draft, posted, paid Invoicing date
Taxes amount
Untaxed amount
Total amount incl. taxes
Invoice lines
Show child attributes
Show child attributes
Unit price excl. taxes
Quantity
Line total taxes amount
Line total untaxed amount
Line total amount incl. taxes, total = tax_amount + untaxed_amount
Line description
Line discount amount excl. taxes, (unit_price * quantity) - discount_amount = untaxed_amount
Tax rate (e.g. 21.0)
Number of the accounting account used (e.g. 701000)
Technical id of the tax in Chift
Tax exemption reason
Unit of measure matching target sofware name
Technical id of the product in Chift
Product reference
Product name
List of analytic distributions for the line item. Each distribution specifies an analytic plan and the associated analytic accounts with their percentages.
Show child attributes
Show child attributes
Code of the analytic plan to which the distribution applies.
List of analytic accounts and their respective percentages for the distribution.
Show child attributes
Show child attributes
Code of the analytic account.
Name of the analytic account.
Percentage of the untaxed amount attributed to this analytic account. Only whole numbers (no decimals) are allowed. The total across the analytic distribution (all accounts in a given analytic plan) must equal 100%.
Technical id of the vendor/customer in Chift
Number/sequence
Due date
Reference
Payment communication
Customer note/memo
Specificities for Italy
Show child attributes
Show child attributes
Documentary stamp tax (specific to Italy)
Withholding tax (specific to Italy)
Show child attributes
Show child attributes
Rate
Amount
Reason
RT01, RT02, RT03, RT04, RT05, RT06 Payment reason
A, U, R, Q, H, V, V2, I, J, K, P, S, T, W, X, Y, B, C, D, E, F, G, L, L1, M, M1, M2, IN, O, O1, V1 Welfare fund (specific to Italy)
Show child attributes
Show child attributes
Rate
Amount
Type
TC01, TC02, TC03, TC04, TC05, TC06, TC07, TC08, TC09, TC10, TC11, TC12, TC13, TC14, TC15, TC16, TC17, TC18, TC19, TC20, TC21, TC22 Payment reporting (specific to Italy)
Show child attributes
Show child attributes
Payment method
MP01, MP02, MP03, MP04, MP05, MP06, MP07, MP08, MP09, MP10, MP11, MP12, MP13, MP14, MP15, MP16, MP17, MP18, MP19, MP20, MP21, MP22, MP23 Payment conditions
TP01, TP02, TP03 Amount left to be paid
Date of the last payment linked to the invoice
Accounting date
Technical id of the payment method in Chift
Indicates the exchange rate at the date of the invoice.
x >= 0x >= 1x >= 1