Offer
📄 About the offer data model
The offer data model describes an offer document. An offer is a document that proposes goods or services at specified prices and terms. The offer data model includes attributes such as the offer number, offer date, total amount, and parties involved.
📦 Attributes
The offer data model includes the following attributes:
| Attribute | Type | Description |
|---|---|---|
filename |
string | The original filename of the offer document. |
document_number |
string | The offer number. |
document_date |
date | The offer 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 acceptance (RFC 3339 format). |
currency |
string | The currency (ISO 4217 code, defaults to EUR if not provided). |
line_items |
array | Array of line items (positions). |
direction |
string | Direction of the offer (incoming or outgoing). Defaults to incoming. |
📦 Line items
The offer 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. |
📝 Example output
Below is an example of the output you can expect from the Offer Data Model in fetchdocs:
JSON
{
"filename": "offer-2024-0001.pdf",
"document_number": "OF20240724001",
"document_date": "2025-07-24",
"net_amount": 200.00,
"gross_amount": 238.00,
"vat": [
{
"vat_rate": 19.00,
"vat_amount": 38.00,
"net_amount": 200.00,
"gross_amount": 238.00
}
],
"sending_party": {
"company_name": "Supplier Inc.",
"address": {
"street": "Main Street 123",
"zip": "12345",
"city": "Springfield",
"country": "US"
},
"address_string": "Main Street 123, Springfield, 12345, US",
"external_id": "123456"
},
"receiving_party": {
"company_name": "Customer Inc.",
"address": {
"street": "Main Street 456",
"zip": "54321",
"city": "Springfield",
"country": "US"
},
"address_string": "Main Street 456, Springfield, 54321, US",
"external_id": "654321"
},
"order_number": "123456",
"due_date": "2025-08-01",
"currency": "EUR",
"line_items": [
{
"description": "Product A",
"quantity": 1,
"unit_price_net": 100.00,
"tax_rate": 19.00,
"tax_amount": 19.00,
"total_price_net": 100.00,
"total_price_gross": 119.00
},
{
"description": "Product B",
"quantity": 1,
"unit_price_net": 100.00,
"tax_rate": 19.00,
"tax_amount": 19.00,
"total_price_net": 100.00,
"total_price_gross": 119.00
}
],
"direction": "incoming"
}
🛟 Need help?
If you need help or want to receive additional attributes, please contact the fetchdocs support team. They're happy to assist you.