Skip to main content
GET
/
payable_purchase_orders
Get purchase orders
curl --request GET \
  --url https://api.sandbox.monite.com/v1/payable_purchase_orders \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "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"
    }
  ],
  "next_pagination_token": "<string>",
  "prev_pagination_token": "<string>"
}

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"

Query Parameters

​
order
enum<string>
default:asc

Sort order (ascending by default). Typically used together with the sort parameter.

Available options:
asc,
desc
​
limit
integer
default:100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

Required range: 1 <= x <= 100
​
pagination_token
string

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

​
sort
enum<string>

The field to sort the results by. Typically used together with the order parameter.

Available options:
created_at,
updated_at
​
created_at__gt
string<date-time>
​
created_at__lt
string<date-time>
​
created_at__gte
string<date-time>
​
created_at__lte
string<date-time>
​
updated_at__gt
string<date-time>
​
updated_at__lt
string<date-time>
​
updated_at__gte
string<date-time>
​
updated_at__lte
string<date-time>
​
issued_at__gt
string<date-time>
​
issued_at__lt
string<date-time>
​
issued_at__gte
string<date-time>
​
issued_at__lte
string<date-time>
​
status
enum<string>
Available options:
draft,
issued
​
document_id
string
​
document_id__in
string[]
​
created_by
string<uuid>
​
counterpart_id
string<uuid>
​
counterpart_id__in
string<uuid>[]
​
counterpart.name
string
​
currency
enum<string>
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
​
currency__in
enum<string>[]
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
​
project_id
string<uuid>

Response

Successful Response

A paginated list of purchase orders.

​
data
object[]
required
​
next_pagination_token
string

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you've reached the last page).

​
prev_pagination_token
string

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you've reached the first page).