warehouseDocument¶
Generic warehouse document returned by GET /documents. This schema covers all document types in a unified structure.
Schema¶
| 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 |
due_date |
string (date) | — | — | Payment due date |
reference |
string (max 15) | — | — | Internal reference |
your_ref |
string (max 15) | — | — | Third-party reference |
related_doc |
string | — | — | Related document identifier |
salesperson |
string | — | — | Salesperson code |
source_warehouse |
string | — | — | Source warehouse |
destination_warehouse |
string | — | — | Destination warehouse |
currency |
string | Yes | — | Currency code |
total_amount |
number (double) | Yes | — | Total document amount |
net_amount |
number (double) | — | — | Net amount |
discount |
number (float, 0–100) | — | — | Discount percentage |
discount_money_amount |
number (double) | — | — | Discount amount |
vat |
number (double) | — | — | VAT amount |
eco_tax |
number (float, 0–100) | — | — | Eco-tax rate |
eco_tax_amount |
number (double) | — | — | Eco-tax amount |
stamp_duty |
number (float, 0–100) | — | — | Stamp duty rate |
stamp_duty_amount |
number (double) | — | — | Stamp duty amount |
irs_tax |
number (float, 0–100) | — | — | IRS withholding tax rate |
withholding_tax_amount |
number (double) | — | — | Withholding tax amount |
rounding |
number (double) | — | — | Rounding adjustment |
amount_tendered |
number (double) | — | — | Amount tendered |
amount_paid |
number (double) | — | — | Amount paid |
payment_type |
string | — | — | Payment method |
payment_ref |
string (max 24) | — | — | Payment reference |
status |
string (max 6) | — | ✓ | Document status |
delivery_date |
string (date-time) | — | — | Delivery date/time |
plate_number |
string (max 20) | — | — | Transport vehicle plate |
arrival_date |
string (max 20) | — | — | Arrival date |
number_of_packages |
string (max 20) | — | — | Number of packages |
gross_weight |
integer | — | — | Gross weight |
created |
string (date) | — | ✓ | Record creation date |
updated |
string (date) | — | ✓ | Record last updated date |
notes_comments |
string | — | — | Free-text notes |
items |
array | — | — | Document line items |