supplierDocument¶
Represents a purchase document addressed to a supplier: purchases and purchase orders.
The supplierDocument schema mirrors customerDocument closely, with the difference that the header references a supplier entity rather than a customer, and uses source_warehouse / destination_warehouse instead of warehouse.
Schema¶
Refer to customerDocument for the full field list. Key differences in supplierDocument:
| Field | Type | Required | Read-only | Description |
|---|---|---|---|---|
id |
integer | — | ✓ | Internal document ID |
document_set |
string (1–15) | Yes | ✓ | Document set / series code |
seq_number |
string (1–15) | Yes | ✓ | Sequential document number |
date |
string (date) | Yes | ✓ | Document date |
currency |
string | Yes | — | Currency code |
total_amount |
number (double) | Yes | — | Total document amount |
source_warehouse |
string | — | — | Source warehouse (replaces warehouse) |
destination_warehouse |
string | — | — | Destination warehouse |
discount_money_amount |
number (double) | — | — | Discount amount (field name differs from customerDocument) |
withholding_tax_amount |
number (double) | — | — | Withholding tax amount (field name differs from irs_retention_amount) |
related_doc |
string | — | — | Related document (field name differs from related_document) |
items |
array of documentLine | — | — | Document line items (no customer field — supplier docs don't embed a thirdParty customer) |
Supplier reference
Supplier documents do not embed a customer object. The supplier is identified by the document context (document set belonging to the supplier module).
Example¶
{
"document_set": "CC",
"seq_number": "CC2024/0042",
"date": "2024-11-10",
"currency": "EUR",
"total_amount": 5000.00,
"net_amount": 4065.04,
"vat": 934.96,
"source_warehouse": "MAIN",
"items": [
{
"item_code": "WIDGET-A",
"description": "Widget Type A — purchase",
"qty": 200,
"unit_price": 20.33,
"vat": 23.0
}
]
}