transferOrder¶
Represents a stock transfer order between warehouses. The schema is identical to warehouseDocument, with the specific semantic that source_warehouse is the origin and destination_warehouse is the target.
Schema¶
See warehouseDocument for the full field reference. Key fields for transfer orders:
| Field | Type | Required | Description |
|---|---|---|---|
document_set |
string (1–15) | Yes | Transfer order document set (e.g., TO) |
seq_number |
string (1–15) | Yes | Sequential number |
date |
string (date) | Yes | Transfer date |
currency |
string | Yes | Currency code |
total_amount |
number (double) | Yes | Total value |
source_warehouse |
string | — | Origin warehouse code |
destination_warehouse |
string | — | Destination warehouse code |
items |
array of movement | — | Items being transferred |
movement¶
Line items in a transfer order use the movement schema (similar to documentLine but tailored for warehouse movements).
| Field | Type | Description |
|---|---|---|
id |
integer | Internal line ID (read-only) |
item_type |
string | Item type |
item_code |
string | Product/article code |
description |
string (max 60) | Line description |
description_2 |
string (max 60) | Additional description |
qty |
number (double) | Quantity to transfer |
unit_of_measurement |
string (max 15) | Unit of measurement |
number_of_packages |
integer | Number of packages |
unit_price |
number (double) | Unit cost/price |
line_discount |
number (float) | Line discount percentage |
vat |
number (float) | VAT rate |
vat_included |
boolean | Whether price includes VAT |