Sign in
Order

Get simple list of documents for given order.

List of documents belongs to the indicated order

get/rest/api/orders/{id}/documents/

Path parameters

idstring required

order number in Apilo system, e.g. <code>AL0012345</code>

Query parameters

{"stackTrail":"paths:/rest/api/orders/{id}/documents/:get:parameters:1:schema","oasType":"schema","type":"unknown"}

ID of the document

{"stackTrail":"paths:/rest/api/orders/{id}/documents/:get:parameters:2:schema","oasType":"schema","type":"unknown"}

External unique ID of the document

numberinteger

External document number

typeinteger

Document type - <a href='#tag/Order/operation/get_rest_documents_map'>order document types endpoint</a>

{"stackTrail":"paths:/rest/api/orders/{id}/documents/:get:parameters:5:schema","oasType":"schema","type":"unknown"}

start date of document creation in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200</code>

{"stackTrail":"paths:/rest/api/orders/{id}/documents/:get:parameters:6:schema","oasType":"schema","type":"unknown"}

end date of document creation in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200</code>

{"stackTrail":"paths:/rest/api/orders/{id}/documents/:get:parameters:7:schema","oasType":"schema","type":"unknown"}

Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)

{"stackTrail":"paths:/rest/api/orders/{id}/documents/:get:parameters:8:schema","oasType":"schema","type":"unknown"}

Limit of returned results, max 512 records

Response

Order document array

totalCountinteger

Number of matching results

currentOffsetinteger

Current list offset

pageResultCountinteger

Number of results per page

Example response

{
  "documents": [
    {
      "id": 1,
      "idExternal": "1",
      "number": "FV/1/12/2020",
      "priceWithTax": "123.00",
      "priceWithoutTax": "100.00",
      "currency": "PLN",
      "currencyValue": "1.000",
      "type": 16,
      "createdAt": "2023-11-24TT08:33:07+0100"
    }
  ],
  "totalCount": 7398,
  "pageResultCount": 64
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.