Endpoints Overview¶
The Gestix ERP API exposes 20 endpoints grouped by functional area.
System & Authentication¶
| Method | Path | Summary |
|---|---|---|
GET |
/helo |
Authenticate with API Token → get session token |
GET |
/status |
Get session health, version info, and recent errors |
POST |
/sms |
Send an SMS to a specified phone number |
POST |
/auth |
Authenticate with username + password → get session token |
Sales Documents¶
| Method | Path | Summary |
|---|---|---|
GET |
/invoices |
List invoices |
POST |
/invoices |
Create an invoice |
GET |
/orders |
List sales orders |
POST |
/orders |
Create a sales order |
GET |
/receipts |
List receipts |
POST |
/receipts |
Create a receipt |
Purchase Documents¶
| Method | Path | Summary |
|---|---|---|
GET |
/purchases |
List purchases |
POST |
/purchases |
Create a purchase |
GET |
/purchase_orders |
List purchase orders |
POST |
/purchase_orders |
Create a purchase order |
Warehouse¶
| Method | Path | Summary |
|---|---|---|
GET |
/documents |
List all warehouse documents |
GET |
/transfer_orders |
List stock transfer orders |
POST |
/transfer_orders |
Create a transfer order |
GET |
/serial_numbers |
List serial numbers |
GET |
/transactions |
List stock transactions |
Master Data¶
| Method | Path | Summary |
|---|---|---|
GET |
/customers |
List customers |
POST |
/customers |
Create a customer |
PUT |
/customers |
Update a customer |
GET |
/suppliers |
List suppliers |
POST |
/suppliers |
Create a supplier |
PUT |
/suppliers |
Update a supplier |
GET |
/articles |
List products/articles |
POST |
/articles |
Create an article |
PUT |
/articles |
Update an article |
GET |
/locations |
List locations (stores/warehouses) |
GET |
/categories |
List product categories |
GET |
/families |
List product families |
GET |
/users |
List Gestix ERP users |
Common Patterns¶
Authentication¶
All endpoints except /helo require a session token (xa-token) as a Bearer token. See the Authentication guide.
Nonce¶
All POST and PUT endpoints require a nonce query parameter. See Session Management.
Pagination¶
List endpoints support skip and limit parameters. See Pagination & Filtering.
Errors¶
All error responses follow the apiError schema. See Error Handling.