Get a purchase order by ID

GET
/payable_purchase_orders/:purchase_order_id

Path parameters

purchase_order_idstringRequired

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Response

This endpoint returns an object.
idstring
A unique ID assigned to this purchase order.
created_atdatetime
Time at which the receivable was created. Timestamps follow the ISO 8601 standard.
updated_atdatetime
Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard.
counterpartobject
Counterpart information about an organization (juridical person) or individual (natural person) that provides goods and services to or buys them from an
counterpart_idstring
Counterpart unique ID.
currencyenum
The currency in which the price of the product is set. (all items need to have the same currency)
document_idstring
entityobject
Data of the entity (address, name, contact)
entity_idstring
The ID of the entity which issued the purchase order.
itemslist of objects
List of item to purchase
messagestring
Msg which will be send to counterpart for who the purchase order is issued.
statusstring
Purchase order can be in 'draft' state before sending it to counterpart. After that state is 'issued'
valid_for_daysinteger
Number of days for which purchase order is valid
counterpart_addressobjectOptional
Counterpart address data saved on creation or update of the purchase order.
counterpart_address_idstringOptional
The ID of counterpart address object stored in counterparts service. If not provided, counterpart's default address is used.
created_by_user_idstringOptional
ID of the creator of the purchase order
entity_vat_idobjectOptional
file_idstringOptional
file_urlstringOptional
issued_atstringOptional
When status changed from 'draft' to 'send', so after sending purchase order

Errors