Get purchase orders

GET

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.

Query parameters

order"asc" or "desc"Optional

Order by

Allowed values: ascdesc

limitintegerOptional

Max is 100

pagination_tokenstringOptional

A token, obtained from previous page. Prior over other filters

sort"created_at" or "updated_at"Optional

Allowed sort fields

Allowed values: created_atupdated_at

created_at__gtdatetimeOptional

created_at__ltdatetimeOptional

created_at__gtedatetimeOptional

created_at__ltedatetimeOptional

updated_at__gtdatetimeOptional

updated_at__ltdatetimeOptional

updated_at__gtedatetimeOptional

updated_at__ltedatetimeOptional

issued_at__gtdatetimeOptional

issued_at__ltdatetimeOptional

issued_at__gtedatetimeOptional

issued_at__ltedatetimeOptional

status"draft" or "issued"Optional

Allowed values: draftissued

document_idstringOptional

document_id__instringOptional

created_bystringOptional

counterpart_idstringOptional

counterpart_id__instringOptional

counterpart.namestringOptional

currencyenumOptional

currency__inenumOptional

Response

This endpoint returns an object.

datalist of objects

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

next_pagination_tokenstringOptional

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_tokenstringOptional

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).

Errors

GET

1 curl https://api.sandbox.monite.com/v1/payable_purchase_orders \
2      -H "x-monite-version: 2024-01-31" \
3      -H "x-monite-entity-id: x-monite-entity-id" \
4      -H "Authorization: Bearer <token>"

1 {
2   "data": [
3     {
4       "id": "id",
5       "created_at": "2024-01-15T09:30:00Z",
6       "updated_at": "2024-01-15T09:30:00Z",
7       "counterpart": {
8         "id": "id",
9         "created_at": "2024-01-15T09:30:00Z",
10         "updated_at": "2024-01-15T09:30:00Z",
11         "individual": {
12           "email": "asingh@example.net",
13           "first_name": "Adnan",
14           "is_customer": true,
15           "is_vendor": true,
16           "last_name": "Singh",
17           "phone": "5553211234",
18           "title": "Mr."
19         },
20         "type": "individual"
21       },
22       "counterpart_id": "counterpart_id",
23       "currency": "AED",
24       "document_id": "document_id",
25       "entity": {
26         "id": "id",
27         "created_at": "2024-01-15T09:30:00Z",
28         "updated_at": "2024-01-15T09:30:00Z",
29         "address": {
30           "city": "city",
31           "line1": "line1",
32           "postal_code": "postal_code"
33         },
34         "individual": {
35           "first_name": "first_name",
36           "last_name": "last_name"
37         },
38         "logo": {
39           "id": "id",
40           "created_at": "2024-01-15T09:30:00Z",
41           "file_type": "payables",
42           "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
43           "mimetype": "application/pdf",
44           "name": "invoice.pdf",
45           "pages": [
46             {
47               "id": "id",
48               "mimetype": "image/png",
49               "number": 0,
50               "size": 21972,
51               "url": "https://bucket.s3.amazonaws.com/123/456.png"
52             }
53           ],
54           "previews": [
55             {
56               "height": 400,
57               "url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
58               "width": 200
59             }
60           ],
61           "region": "eu-central-1",
62           "size": 24381,
63           "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf"
64         },
65         "status": "active"
66       },
67       "entity_id": "entity_id",
68       "items": [
69         {
70           "currency": "AED",
71           "name": "name",
72           "price": 1,
73           "quantity": 1,
74           "unit": "unit",
75           "vat_rate": 1
76         }
77       ],
78       "message": "message",
79       "status": "status",
80       "valid_for_days": 1,
81       "counterpart_address": {
82         "city": "Berlin",
83         "country": "AF",
84         "line1": "Flughafenstrasse 52",
85         "postal_code": "10115"
86       },
87       "counterpart_address_id": "counterpart_address_id",
88       "created_by_user_id": "created_by_user_id",
89       "entity_vat_id": {
90         "id": "id",
91         "country": "country",
92         "entity_id": "entity_id",
93         "type": "type",
94         "value": "value"
95       },
96       "file_id": "file_id",
97       "file_url": "file_url",
98       "issued_at": "issued_at"
99     }
100   ],
101   "next_pagination_token": "next_pagination_token",
102   "prev_pagination_token": "prev_pagination_token"
103 }

1	curl https://api.sandbox.monite.com/v1/payable_purchase_orders \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
4	-H "Authorization: Bearer <token>"

1	{
2	"data": [
3	{
4	"id": "id",
5	"created_at": "2024-01-15T09:30:00Z",
6	"updated_at": "2024-01-15T09:30:00Z",
7	"counterpart": {
8	"id": "id",
9	"created_at": "2024-01-15T09:30:00Z",
10	"updated_at": "2024-01-15T09:30:00Z",
11	"individual": {
12	"email": "asingh@example.net",
13	"first_name": "Adnan",
14	"is_customer": true,
15	"is_vendor": true,
16	"last_name": "Singh",
17	"phone": "5553211234",
18	"title": "Mr."
19	},
20	"type": "individual"
21	},
22	"counterpart_id": "counterpart_id",
23	"currency": "AED",
24	"document_id": "document_id",
25	"entity": {
26	"id": "id",
27	"created_at": "2024-01-15T09:30:00Z",
28	"updated_at": "2024-01-15T09:30:00Z",
29	"address": {
30	"city": "city",
31	"line1": "line1",
32	"postal_code": "postal_code"
33	},
34	"individual": {
35	"first_name": "first_name",
36	"last_name": "last_name"
37	},
38	"logo": {
39	"id": "id",
40	"created_at": "2024-01-15T09:30:00Z",
41	"file_type": "payables",
42	"md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
43	"mimetype": "application/pdf",
44	"name": "invoice.pdf",
45	"pages": [
46	{
47	"id": "id",
48	"mimetype": "image/png",
49	"number": 0,
50	"size": 21972,
51	"url": "https://bucket.s3.amazonaws.com/123/456.png"
52	}
53	],
54	"previews": [
55	{
56	"height": 400,
57	"url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
58	"width": 200
59	}
60	],
61	"region": "eu-central-1",
62	"size": 24381,
63	"url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf"
64	},
65	"status": "active"
66	},
67	"entity_id": "entity_id",
68	"items": [
69	{
70	"currency": "AED",
71	"name": "name",
72	"price": 1,
73	"quantity": 1,
74	"unit": "unit",
75	"vat_rate": 1
76	}
77	],
78	"message": "message",
79	"status": "status",
80	"valid_for_days": 1,
81	"counterpart_address": {
82	"city": "Berlin",
83	"country": "AF",
84	"line1": "Flughafenstrasse 52",
85	"postal_code": "10115"
86	},
87	"counterpart_address_id": "counterpart_address_id",
88	"created_by_user_id": "created_by_user_id",
89	"entity_vat_id": {
90	"id": "id",
91	"country": "country",
92	"entity_id": "entity_id",
93	"type": "type",
94	"value": "value"
95	},
96	"file_id": "file_id",
97	"file_url": "file_url",
98	"issued_at": "issued_at"
99	}
100	],
101	"next_pagination_token": "next_pagination_token",
102	"prev_pagination_token": "prev_pagination_token"
103	}