The receipt data model describes a receipt document. A receipt is a document that confirms payment for goods or services. The receipt data model includes attributes such as the receipt number, date, total amount, and parties involved.
The receipt data model includes the following attributes:
| Attribute | Type | Description |
|---|---|---|
filename |
string | The original filename of the receipt document. |
document_number |
string | The receipt number. |
document_date |
date | The receipt date (RFC 3339 format). |
net_amount |
float | The net amount (excluding VAT). |
gross_amount |
float | The gross amount (including VAT). |
vat |
array of VatItem | VAT rates and amounts. |
sending_party |
PartyData | The sending party. |
receiving_party |
PartyData | The receiving party. |
order_number |
string | The order number. |
due_date |
date | The due date for payment (RFC 3339 format). |
currency |
string | The currency (ISO 4217 code, defaults to EUR if not provided). |
cash_discount_until_date |
date | Date until cash discount is valid (RFC 3339 format). |
cash_discount_rate |
number | Cash discount rate in percent. |
payment_date |
date | The payment date (RFC 3339 format). |
payment_reference |
string | Reference for the payment. |
line_items |
array | Array of line items (positions). |
payment_status |
string | Payment status (unknown, unpaid, partially_paid, paid). Defaults to unknown. |
payment_method |
string | Payment method (for example bank_transfer). |
delivery_date |
date | Date of delivery of goods/services (RFC 3339 format). |
direction |
string | Direction of the receipt (incoming or outgoing). Defaults to incoming. |
The receipt data model can include an array of line items. Each line item is an object that includes the following attributes:
| Attribute | Type | Description |
|---|---|---|
| description | string | Description of the line item. |
| quantity | number | Quantity of the line item. |
| unit_price_net | number | Net price of the line item (excluding tax). |
| tax_rate | number | Tax rate in percent. |
| tax_amount | number | Tax amount for the line item. |
| total_price_net | number | Total net price for the line item. |
| total_price_gross | number | Total gross price for the line item. |
| order_number | string | Order number for the line item. |
Below is an example of the output you can expect from the Receipt Data Model in fetchdocs:
If you need help or want to receive additional attributes, please contact the fetchdocs support team. They're happy to assist you.