Items from the "receipts" domain represent a receipt.
Structure URL's:
/api/v1/receipts: Receipt data
/api/v1/receipts/5005: Invoice with ID 5005
/api/v1/receipts/5005/items: Items of receipt with ID 5005
/api/v1/receipts/5005/items/4005: Item with ID 4005 of receipt with ID 5005
/api/v1/receipts/5005/remarks: Notes of receipt ID 5005
/api/v1/receipts/5005/remarks/5010: Note with ID 5010 of receipt with ID 5005
/api/v1/receipts/5005/payments: Payments of receipt with ID 5005
/api/v1/receipts/5005/payments/5020: Payment with ID 5020 of receipt with ID 5005
/api/v1/receipts/5005/events: Events of recipt with ID 5005
/api/v1/receipts/5005/events/5030: Event with ID 5030 of receipt with ID 5005
Domain : receipts
| Field name | Type | Description | Example |
|---|---|---|---|
| receipt_id | int | Unique ID of the receipt. Generated by the system. Required to be specified in URL (except for creation). | 5005 |
| uri | text | URL to the receipt. Generated by the system. To be used when addressing receipt via the API. | – |
| external_receipt_id | text | (Unique) ID of the receipt that can be set by a third party. Maximum 50 characters long. Uniqueness of the value is not enforced. | Receipt-0983984 |
| client_id | int | Unique ID of the customer. Optional to be specified. | 1001 |
| client_uri | text | URL to the customer. Generated by the system. To be used when addressing the customer via the API. | – |
| client_name | text | Naam van de klant. Wordt automatisch overgenomen uit de klantgegevens indien niet opgegeven. | IT Services BVBA |
| client_attention | text | Name of the customer. Is automatically taken from the customer data if not specified. | Administration Department |
| type | text | Type of receipt. Always contains the value: 'recipe'. It is determined by the system and cannot be passed on by itself. | invoice |
| number | text | Unique number of the receipt as shown on the receipt. Generated if not provided. Maximum 255 characters long. | 00000001 |
| layout_id | int | Unique ID of the layout. If not specified, the default layout is determined automatically. Can be empty if no layout has been set for the account. | 8001 |
| reference | text | Self-specified reference of the receipt. Not required. Maximum 250 characters long. | ID123456789 |
| date | date | Date of creation of the receipt. Generated if not provided. Format YYYY-MM-DD. | 2012-02-15 |
| status | text | Status of the receipt. Possible values: 'open', 'closed'. Defined by the system and cannot be specified by yourself. | open |
| billing_address | Address | Customer billing address. Is automatically taken from the customer data if not specified. | – |
| delivery_address | Address | Customer's shipping address. Is automatically taken from the customer data if not specified. | – |
| site_address | Address | Customer site address. Is automatically taken from the customer data if not specified. | – |
| discount_percentage | float | Discount percentage that applies to the entire receipt. Amount must be between 0 and 100. Numbers up to 2 digits after the decimal point are allowed. If not specified, this value is 0. | 5 |
| language | text | The language in which the receipt is formatted. This value can contain 'dutch', 'french', 'english' or 'german' but can also be empty. If empty (= default value), the default language (dutch) is used. | dutch |
| tax_calculation | text | The VAT calculation method of the receipt. Possible values: 'total', 'item'. By default, 'total' is used. With the calculation method 'total' the VAT is calculated on the total amount of the receipt, with the calculation method 'item' the VAT is calculated per receipt line. Switching between the calculation method can cause rounding differences. If 'tax_included'='yes', only 'item' is a valid value. | total |
| tax_included | text | Indicates whether or not the amounts of the receipt have been entered including VAT and are therefore printed including VAT. Can have value 'yes' or 'no'. If empty, the default value is determined as set for the account (default 'no'). | no |
| items | list | List of receipt items. | – |
| discount_total_without_tax | float | Total amount of the discount on the total receipt without taking into account VAT. Calculated automatically and cannot be specified by yourself. | 10.00 |
| total_refundable_deposit | float | Total amount of invoice lines with refundable packaging (tax_rate_special_status = DR). Calculated automatically and cannot be specified by yourself. | 5.00 |
| total_without_tax | float | Total amount across all invoice items without taking into account VAT. Any discounts (discount_total_without_tax) and refundable packaging (total_refundable_deposit) are already included in this total. Calculated automatically and cannot be specified by yourself. | 200.00 |
| tax_rate_1 | float | 1st VAT percentage that can be used on the receipt. Taken from the settings during creation and cannot be specified by yourself. | 21 |
| total_tax_1 | float | Total amount of VAT according to 1st VAT percentage across all items. Calculated automatically and cannot be specified by yourself. | 42.00 |
| tax_rate_2 | float | 2nd VAT percentage that can be used on the receipt. Taken from the settings during creation and cannot be specified by yourself. | 12 |
| total_tax_2 | float | Total amount of VAT according to 2nd VAT percentage over all items. Calculated automatically and cannot be specified by yourself. | 0.00 |
| tax_rate_3 | float | 3rd VAT percentage that can be used on the receipt. Taken from the settings during creation and cannot be specified by yourself. | 6 |
| total_tax_3 | float | Total amount of VAT according to 3rd VAT percentage over all items. Calculated automatically and cannot be specified by yourself. | 0.00 |
| discount_total_with_tax | float | Total amount of the discount granted on the total of the receipt including VAT. Calculated automatically and cannot be specified by yourself. | 12.10 |
| total_with_tax | float | Total amount across all items including VAT. Calculated automatically and cannot be specified by yourself. | 242.00 |
| total_paid | float | Total amount already paid by customer. Is the summation of all amounts in payments. Calculated automatically and cannot be specified by yourself. | 25.00 |
| note | text | Note shown at the bottom of the receipt. Optional to give. Maximum 2000 characters long. | Warranty conditions apply |
| note_html | html | Note shown at the bottom of the receipt. Optional to give. Maximum 2000 characters long. | <p>Warranty conditions apply</p> |
| last_activity | datetime | Time with the last activity of the receipt. Cannot be specified, automatically determined by the system. | 2018-05-03 11:33:45 |
| custom_values | list | Lijst met standaard velden die kunnen worden toegevoegd aan het kasticket. De beschikbare standaard velden kunnen worden ingesteld via “Instellingen” > “Geavanceerd”. | – |
| tags | list | List of tags indicating which actions have already been performed for the receipt. | – |
| payments | list | List of payments received from the receipt. | – |
| remarks | list | List of personal notes on the receipt. | – |
| events | list | List of receipt events. | – |
Subdomain : items ( < receipts )
| Field name | Type | Description | Example |
|---|---|---|---|
| item_id | int | Unique ID of the receipt item. Generated by the system. Required to be specified in URL (except for creation). | 4004 |
| receipt_id | int | Unique ID of the receipt. Generated by the system. Required to be specified in URL. | 3003 |
| uri | text | URL to receipt item. Generated by the system. To be used when addressing a receipt item via the API. | – |
| amount | float | Amount per unit (1 quantity) of the receipt item excluding VAT. Mandatory to be used if field tax_included='no'. Can be specified to 4 decimal places. The maximum amount is 9,999,999,9999. Will be calculated automatically if amount is specified via 'amount_with_tax'. | 100.00 |
| amount_with_tax | float | Amount per unit (1 quantity) of the receipt item including VAT. Mandatory to be used if field tax_included='yes'. Can be specified to 4 decimal places. The maximum amount is 9,999,999,9999. Will be calculated automatically if amount was entered via 'amount'. | 121.00 |
| quantity | float | Number of units of the receipt item. Can be specified to 2 decimal places. If not specified, '1' is used by default. The maximum amount is 999,999.99. | 2 |
| unit | text | Unit of the item. Not required. Maximum 10 characters long and must start with a letter. Must not contain spaces. | piece |
| stockitem_code | text | Artikelcode gekoppeld aan het item. Niet verplicht. Maximum 20 karakters lang. Toevoegen van een artikelcode heeft geen invloed op het aantal items in voorraad op de artikelenlijst. | A0000001 |
| stockitem_id | int | Article code linked to the item. Not required. Maximum 20 characters long. Adding an item code does not affect the number of items in stock on the item list. | 2002 |
| quantity_with_unit | text | Quantity and unit of the item separated by a space. Can only be used during creation or editing. Cannot be used in combination with field 'quantity' or 'unit'. The same restrictions as 'quantity' and 'unit' fields apply. | 2 piece |
| description | text | Description of the receipt item. Mandatory at creation (alternatively, field description_html can be specified). | product description |
| description_html | html | Description of the receipt item. Mandatory to be specified at creation (alternatively, field description can be specified). | <p>product description</p> |
| total_without_tax | float | Total amount of the receipt item excluding VAT. Is calculated by means of fields 'amount' and 'quantity'. | 200.00 |
| tax_rate | float | Tax percentage of the receipt item. Must match one of the sales tax percentages of the receipt or must be '0'. If not specified, '0' is assumed. | 21 |
| tax_rate_special_status | text | Code deviating VAT rate from the used VAT percentage (tax_rate) of the receipt item. Can only be used if the VAT percentage is 0. The field is optional and can be up to 20 characters long. | MC |
| total_with_tax | float | Total amount of the receipt item including VAT. Is calculated using the fields 'amount', 'quantity' and 'tax_rate'. | 242.00 |
| general_ledger_account | text | Code of the ledger account associated with the receipt item. Not required. Between 6 and 8 characters long, only numbers are allowed. | 700000 |
| custom_values | list | List of standard fields. The available fields are added via “Settings” > “Advanced”. | – |
Subdomein : custom_values ( < receipts + items < receipts )
| Field name | Type | Description | Example |
|---|---|---|---|
| name | text | Internal name of the default field. Determined when the default field is created and can be used as a unique identifier for the default field. Mandatory when adding or changing the value of this field. | myreference |
| description | text | Name or description of the default field as it appears when used. Returned for informational purposes only and cannot be modified via the API. | Our reference |
| value | text | Value of the defautlt field. Maximum 75 characters long. | 123456 |
Subdomein : tags ( < receipts )
| Field name | Type | Description | Example |
|---|---|---|---|
| tag_id | number | Unique ID of the tag | 3 |
| name | text | Tag name or code. Possible values: 'printed' (tag_id=3), 'sent' (tag_id=6), 'accountant' (tag_id=9). printed | printed |
Note: The 'tags' subdomain is not a full-fledged subdomain and cannot be accessed separtely from domain 'receipts'. It is not possible to adjust values in tags via the API. This data is automatically addes based on actions performed.
Subdomain : payments ( < receipts )
| Field name | Type | Description | Example |
|---|---|---|---|
| payment_id | int | Unique ID of the payment. Generated by the system. Required to be specified in URL (except for creation). | 5010 |
| receipt_id | int | Unique ID of the receipt. Generated by the system. Required to be specified in URL. | 3003 |
| uri | text | URL to payment. Generated by the system. To be used when requesting payment via the API. | – |
| date | date | Date the payment was recorded. Has the format YYYY-MM-DD. If not specified at creation, current date is used. | 2012-02-15 |
| amount | float | Payment amount. Mandatory when creating an alternative field 'remaining_amount' can be specified. | 25.00 |
| method | text | Payment method of payment. Optional to give. Valid values: transfer, cash, debit card, credit card, direct collection, online, bancontact, ideal. | cash |
| description | text | Description of the payment. Optional to give. Maximum 255 characters long. | Deposit |
| remaining_amount | text | Only applicable when adding a payment (POST/PUT). This designation ensures that the 'amount' field contains the full remaining unpaid amount of the receipt. Not required field, if specified it always has value 'yes'. | yes |
Subdomain : remarks ( < receipts )
| Veldnaam | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
| remark_id | int | Unique ID of the comment. Generated by the system. Required to be specified in URL (except for creation). | 5020 |
| receipt_id | int | Unique ID of the receipt. Generated by the system. Required to be specified in URL. | 3003 |
| uri | text | URL to comment. Generated by the system. To be used when addressing comment via the API. | – |
| date | date | Date the comment was added. If not specified, the current date is used. Format is YYYY-MM-DD. | 2012-02-15 |
| description | text | Description of the comment. Mandatory to be specified when creating or modifying. | Customer has already received goods |
| description_html | html | Description of the comment. Mandatory to be specified when creating or modifying (alternatively, field description can be used). | <p>Customer has already received goods</p> |
Subdomain : events ( < receipts )
| Field name | Type | Description | Example |
|---|---|---|---|
| event_id | int | Unique ID of the event. Generated by the system. Required to be specified in URL. | 5030 |
| receipt_id | int | Unique ID of the receipt. Generated by the system. Required to be specified in URL. | 3003 |
| uri | text | URL to event. Generated by the system. To be used when calling event via the API. | – |
| date | date | Date when the event occurred. Format YYYY-MM-DD. | 2012-02-15 |
| type | text | Event type. Currently only 'email sent' is possible. | email sent |
| content | text | Content or description of the event. With type 'email sent' the content of the email will be sent here. | In bijlage uw kasticket |
| recipients | list | List of event recipients. | – |
Note: An element of the 'events' subdomain cannot be modified or created by yourself. Only the system can create an 'event'.
Subdomain : recipients ( < events < receipts )
| Field name | Type | Description | Example |
|---|---|---|---|
| name | text | Name (first name + last name) of the recipient. | Bart Decouster |
| email_address | text | Email address of the recipient. | [email protected] |
| external_event_recipient_id | text | External unique reference to this record. | 17ad5dfc-b03e-4fd3-b66b-05b264cfa0c6 |
| status | text | Status that returns whether the event has already arrived at the recipient. Possible statuses are: sending, sent, open, failed. | sending |
| information | text | Additional information about the status. An error message will appear here if status is set to 'failed'. | – |
Note: The 'recipients' subdomain is not a full-fledged subdomain and cannot be accessed separately from the 'events' subdomain.
Type : Address
| Field name | Type | Description | Example |
|---|---|---|---|
| street | text | Street + house number of the address. Not required, maximum 150 characters long. | Langestraat 189 |
| street2 | text | Second address line of the address. Not required, maximum 150 characters long. | |
| city | text | City of the address. Not required, maximum 50 characters long. | Antwerp |
| postal_code | text | The postal code of the city of the address. Not required, maximum 10 characters long. | 2000 |
| country | text | Country of the customer. Cannot be specified. Is automatically determined by country_code. | Belgium |
| country_code | text | Customer country code. Mandatory, 2 characters long, in capital letters. | BE |
Example in XML of a receipt:
<receipt>
<receipt_id>5005</receipt_id>
<uri>https://eenvoudigfactureren.be/api/v1/receipts/5005</uri>
<external_receipt_id>Receipt-0983984</external_receipt_id>
<client_id>1001</client_id>
<client_uri>https://eenvoudigfactureren/api/v1/clients/1001</client_uri>
<client_name>IT Services BVBA</client_name>
<client_attention>Dienst administratie</client_attention>
<type>receipt</type>
<number>00000001</number>
<layout_id>8001</layout_id>
<reference>ID123456789</reference>
<date>2012-02-15</date>
<status>open</status>
<billing_address>
<street>Olifantstraat 200</street>
<street2></street2>
<postal_code>9000</postal_code>
<city>Gent</city>
<country_code>BE</country_code>
<country>België</country>
</billing_address>
<delivery_address>
<street>Olifantstraat 200</street>
<street2></street2>
<postal_code>9000</postal_code>
<city>Gent</city>
<country_code>BE</country_code>
<country>België</country>
</delivery_address>
<site_address>
<street>Olifantstraat 200</street>
<street2></street2>
<postal_code>9000</postal_code>
<city>Gent</city>
<country_code>BE</country_code>
<country>België</country>
</site_address>
<discount_percentage>5</discount_percentage>
<language>dutch</language>
<tax_calculation>total</tax_calculation>
<tax_included>no</tax_included>
<items>
<item>
<item_id>4004</item_id>
<uri>https://eenvoudigfactureren.be/api/v1/receipts/5005/items/4004</uri>
<description>product omschrijving</description>
<description_html><![CDATA[<p>product omschrijving</p>]]></description_html>
<amount>100.00</amount>
<amount_with_tax>121.00</amount_with_tax>
<quantity>2</quantity>
<unit>stuk</unit>
<stockitem_code>A000001</stockitem_code>
<total_without_tax>200.00</total_without_tax>
<tax_rate>21</tax_rate>
<total_with_tax>242.00</total_with_tax>
<general_ledger_account>700000</general_ledger_account>
<custom_values>
<custom_value>
<name>ean</name>
<description>EAN</description>
<value>100000000000001</value>
</custom_value>
</custom_values>
</item>
</items>
<discount_total_without_tax>10.00</discount_total_without_tax>
<total_without_tax>190.00</total_without_tax>
<tax_rate_1>21</tax_rate_1>
<total_tax_1>42.00</total_tax_1>
<tax_rate_2>12</tax_rate_2>
<total_tax_2>0.00</total_tax_2>
<tax_rate_3>6</tax_rate_3>
<total_tax_3>0.00</total_tax_3>
<discount_total_with_tax>12.10</discount_total_with_tax>
<total_with_tax>229.90</total_with_tax>
<total_paid>25.0</total_paid>
<note>Garantievoorwaarden zijn van toepassing.</note>
<note_html><![CDATA[<p>Garantievoorwaarden zijn van toepassing.</p>]]></note_html>
<last_activity>2018-05-03 11:33:45</last_activity>
<custom_values>
<custom_value>
<name>myreference</name>
<description>Onze referentie</description>
<value>123456</value>
</custom_value>
</custom_values>
<tags>
<tag>
<tag_id>3</tag_id>
<name>printed</name>
</tag>
</tags>
<payments>
<payment>
<payment_id>5010</payment_id>
<uri>https://eenvoudigfactureren.be/api/v1/receipts/5005/payments/5010</uri>
<date>2012-02-15</date>
<amount>25.00</amount>
<method>cash</method>
<description>Voorschot</description>
</payment>
</payments>
<remarks>
<remark>
<remark_id>5020</remark_id>
<uri>https://eenvoudigfactureren.be/api/v1/receipts/5005/remarks/5020</uri>
<date>2012-02-15</date>
<description>Klant heeft goederen reeds ontvangen</description>
<description_html><![CDATA[<p>Klant heeft goederen reeds ontvangen</p>]]></description_html>
</remark>
</remarks>
<events>
<event>
<event_id>5030</event_id>
<uri>https://eenvoudigfactureren.be/api/v1/receipts/5005/events/5030</uri>
<date>2012-02-16</date>
<type>email sent</type>
<content>In bijlage uw kasticket</content>
<recipients>
<recipient>
<name>Bart Decouster</name>
<email_address>[email protected]</email_address>
<external_event_recipient_id>17ad5dfc-b03e-4fd3-b66b-05b264cfa0c6</external_event_recipient_id>
<status>sending</status>
<information>-</information>
</recipient>
</recipients>
</event>
</events>
</receipt>