Skip to content

GET /documents

List all warehouse documents (generic document listing across all document sets).


Request

GET /api/{account}/v4.0.0/documents
Authorization: Bearer <xa-token>

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. Example: searchColumn=document_set&searchString=ORD
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 warehouseDocument objects (empty array if none found).

400 — Invalid input parameters


Notes

This endpoint provides a unified view of all document types. For filtered views by document type, use the dedicated endpoints: Invoices, Orders, Receipts, Purchases, Purchase Orders.


See Also