Skip to main content
GET
/
payable_purchase_orders
/
{purchase_order_id}
Get a purchase order by ID
curl --request GET \
  --url https://api.sandbox.monite.com/v1/payable_purchase_orders/{purchase_order_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "counterpart": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "individual": {
      "first_name": "Adnan",
      "is_customer": true,
      "is_vendor": true,
      "last_name": "Singh",
      "email": "asingh@example.net",
      "phone": "5553211234",
      "title": "Mr."
    },
    "type": "individual",
    "created_automatically": false,
    "created_by_entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_billing_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_shipping_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "language": "ab",
    "reminders_enabled": true,
    "tax_id": "<string>"
  },
  "counterpart_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "AED",
  "document_id": "<string>",
  "entity": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "address": {
      "city": "<string>",
      "line1": "<string>",
      "postal_code": "<string>",
      "country": "DE",
      "line2": "<string>",
      "state": "<string>"
    },
    "individual": {
      "first_name": "<string>",
      "last_name": "<string>",
      "date_of_birth": "2023-12-25",
      "id_number": "<string>",
      "ssn_last_4": "<string>",
      "title": "<string>"
    },
    "status": "active",
    "email": "<string>",
    "logo": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "file_type": "payables",
      "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
      "mimetype": "application/pdf",
      "name": "invoice.pdf",
      "region": "eu-central-1",
      "size": 24381,
      "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
      "pages": [],
      "previews": []
    },
    "phone": "<string>",
    "tax_id": "<string>",
    "website": "<string>"
  },
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "items": [
    {
      "currency": "AED",
      "name": "<string>",
      "price": 123,
      "quantity": 123,
      "unit": "<string>",
      "vat_rate": 5000
    }
  ],
  "message": "<string>",
  "status": "<string>",
  "valid_for_days": 2,
  "counterpart_address": {
    "city": "Berlin",
    "country": "DE",
    "line1": "Flughafenstrasse 52",
    "postal_code": "10115",
    "line2": "<string>",
    "state": "<string>"
  },
  "counterpart_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entity_vat_id": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "country": "<string>",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "value": "<string>"
  },
  "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "file_url": "<string>",
  "issued_at": "2023-12-25",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
purchase_order_id
string<uuid>
required

Response

Successful Response

Represents response for an Accounts Purchase Order document created by entity.

​
id
string<uuid>
required

A unique ID assigned to this purchase order.

​
created_at
string<date-time>
required

Time at which the receivable was created. Timestamps follow the ISO 8601 standard.

​
updated_at
string<date-time>
required

Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard.

​
counterpart
object
required

Counterpart information about an organization (juridical person) or individual (natural person) that provides goods and services to or buys them from an

​
counterpart_id
string<uuid>
required

Counterpart unique ID.

​
currency
enum<string>
required

The currency in which the price of the product is set. (all items need to have the same currency)

Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
SVC,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
​
document_id
string
required
​
entity
object
required

Data of the entity (address, name, contact)

​
entity_id
string<uuid>
required

The ID of the entity which issued the purchase order.

​
items
object[]
required

List of item to purchase

​
message
string
required

Msg which will be send to counterpart for who the purchase order is issued.

​
status
string
required

Purchase order can be in 'draft' state before sending it to counterpart. After that state is 'issued'

​
valid_for_days
integer
required

Number of days for which purchase order is valid

Required range: x >= 1
​
counterpart_address
object

Counterpart address data saved on creation or update of the purchase order.

​
counterpart_address_id
string<uuid>

The ID of counterpart address object stored in counterparts service. If not provided, counterpart's default address is used.

​
created_by_user_id
string<uuid>

ID of the creator of the purchase order

​
entity_vat_id
object
​
file_id
string<uuid>
​
file_url
string
​
issued_at
string<date>

When status changed from 'draft' to 'send', so after sending purchase order

​
project_id
string<uuid>

Project ID of a purchase order