Data Models¶
This section describes all the JSON schemas used in the Gestix ERP API.
Document Models¶
| Model | Description |
|---|---|
customerDocument |
Invoices, orders, receipts — documents addressed to customers |
supplierDocument |
Purchases and purchase orders — documents addressed to suppliers |
warehouseDocument |
Generic warehouse document (used by GET /documents) |
transferOrder |
Stock transfer orders between warehouses |
documentLine |
A single line item within a customer document |
Entity Models¶
| Model | Description |
|---|---|
thirdParty |
Customer or supplier record |
postalAddress |
Billing or shipping address (embedded in thirdParty) |
article |
Product / inventory item |
location |
Store or warehouse location |
category |
Product category |
family |
Product family |
user |
Gestix ERP user |
serialNumber |
Serial number record |
transaction |
Stock transaction record |
Response Models¶
| Model | Description |
|---|---|
documentCreated |
Response when a document is successfully created |
entityCreated |
Response when a customer, supplier, or article is created |
statusResponse |
Response from GET /status |
apiError |
Standard error response object |
Field Conventions¶
| Convention | Meaning |
|---|---|
readOnly: true |
Field is returned in responses but ignored in request bodies |
required |
Fields listed under Required must be present in POST/PUT request bodies |
format: date |
ISO 8601 date string: YYYY-MM-DD |
format: date-time |
ISO 8601 datetime string: YYYY-MM-DDTHH:MM:SSZ |
format: double |
64-bit floating point number |
format: float |
32-bit floating point number (commonly used for percentage fields) |