Order

Create document for order.

Create document for order

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

Path parameters

idstring required

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

Request body

idExternalstring nullable required

External unique ID of the document - used for the update

numberstring nullable

External document number

priceWithTaxstring nullable

The gross value

priceWithoutTaxstring nullable

The net value

currencystring nullable

Currency on the document

currencyValuestring nullable

Currency exchange rate

typeinteger nullable required

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

mediastring

Null or media UUID - <a href='#tag/Media/operation/post_rest_media_new'>media attachment endpoint</a>

Example request

{
  "idExternal": "1",
  "number": "FV/1/12/2020",
  "priceWithTax": "123.00",
  "priceWithoutTax": "100.00",
  "currency": "PLN",
  "currencyValue": "1.000",
  "type": 16,
  "media": "2ed996a6-0b91-529c-9728-f2e59532e7bc"
}

Response

Order document with the given idExternal already exists

idinteger nullable

Internal ID of the shipment

idExternalstring nullable required

External unique ID of the document - used for the update

numberstring nullable

External document number

priceWithTaxstring nullable

The gross value

priceWithoutTaxstring nullable

The net value

currencystring nullable

Currency on the document

currencyValuestring nullable

Currency exchange rate

typeinteger nullable required

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

mediastring

Null or media UUID - <a href='#tag/Media/operation/post_rest_media_new'>media attachment endpoint</a>

createdAtstring date-time nullable

Date the document was added to Apilo

Example response

{
  "id": 1,
  "idExternal": "1",
  "number": "FV/1/12/2020",
  "priceWithTax": "123.00",
  "priceWithoutTax": "100.00",
  "currency": "PLN",
  "currencyValue": "1.000",
  "type": 16,
  "media": "2ed996a6-0b91-529c-9728-f2e59532e7bc",
  "createdAt": "2023-11-24TT08:33:07+0100"
}

Changes

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