Purchases¶
Endpoints for listing and creating purchases documents.
GET /purchases¶
List purchase documents with optional filtering, searching, and pagination.
Request¶
Parameters¶
| Name | In | Type | Required | Description |
|---|---|---|---|---|
nonce |
query | integer (int64) | No | Client-generated unique sequential number |
filterDate |
query | string | No | Filter by date or interval. Format: YYYY-MM-DD or YYYY-MM-DD:YYYY-MM-DD |
searchString |
query | string | No | Search by document number. Example: searchString=123456 |
searchColumn |
query | string | No | Column to search instead of document number |
searchOperator |
query | string | No | Comparison operator: lt, lte, gt, gte, ne |
skip |
query | integer | No | Number of records to skip (pagination) |
limit |
query | integer | No | Max records to return. Max: 1000, default: 50 |
Responses¶
200 — Success¶
Returns an array of supplierDocument objects (empty array if none found).
400 — Invalid input parameters¶
POST /purchases¶
Create a new purchase document.
Request¶
POST /api/{account}/v4.0.0/purchases?nonce={nonce}
Authorization: Bearer <xa-token>
Content-Type: application/json
Parameters¶
| Name | In | Type | Required | Description |
|---|---|---|---|---|
nonce |
query | integer (int64) | Yes | Client-generated unique sequential number |
print |
query | integer | No | Pass 1 to receive the created document as a PDF. Default: 0 |
Request Body¶
A supplierDocument object. Required fields: document_set, seq_number, date, currency, total_amount.
Responses¶
201 — Document created¶
Returns a documentCreated object by default, or a PDF binary when print=1.
400 — Invalid input¶
Returns an apiError.
409 — Duplicate entry¶
Returned when a document with the same identifier already exists. Returns an apiError.