Get purchase orders — Monite Documentation

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

orderenumOptional

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

Allowed values: ascdesc

limitintegerOptional>=1<=100Defaults to 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.

pagination_tokenstringOptional

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.

sortenumOptional

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

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

statusenumOptional

Allowed values: draftissued

document_idstringOptional

document_id__instringOptional

created_bystringOptional

counterpart_idstringOptional

counterpart_id__instringOptionalformat: "uuid"

counterpart.namestringOptional

currencyenumOptional

currency__inenumOptional

Response

Successful Response

datalist of objects

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

1 curl https://api.sandbox.monite.com/v1/payable_purchase_orders \ 2 -H "x-monite-version: 2024-05-25" \ 3 -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \ 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 "created_automatically": true, 12 "default_billing_address_id": "default_billing_address_id", 13 "default_shipping_address_id": "default_shipping_address_id", 14 "created_by_entity_user_id": "created_by_entity_user_id", 15 "individual": { 16 "email": "asingh@example.net", 17 "first_name": "Adnan", 18 "is_customer": true, 19 "is_vendor": true, 20 "last_name": "Singh", 21 "phone": "5553211234", 22 "title": "Mr." 23 }, 24 "language": "ab", 25 "reminders_enabled": true, 26 "tax_id": "tax_id", 27 "type": "individual" 28 }, 29 "counterpart_id": "counterpart_id", 30 "currency": "AED", 31 "document_id": "document_id", 32 "entity": { 33 "id": "id", 34 "created_at": "2024-01-15T09:30:00Z", 35 "updated_at": "2024-01-15T09:30:00Z", 36 "address": { 37 "city": "city", 38 "country": "AF", 39 "line1": "line1", 40 "line2": "line2", 41 "postal_code": "postal_code", 42 "state": "state" 43 }, 44 "email": "email", 45 "individual": { 46 "date_of_birth": "date_of_birth", 47 "first_name": "first_name", 48 "id_number": "id_number", 49 "last_name": "last_name", 50 "ssn_last_4": "ssn_last_4", 51 "title": "title" 52 }, 53 "logo": { 54 "id": "id", 55 "created_at": "2024-01-15T09:30:00Z", 56 "file_type": "payables", 57 "md5": "31d1a2dd1ad3dfc39be849d70a68dac0", 58 "mimetype": "application/pdf", 59 "name": "invoice.pdf", 60 "pages": [ 61 { 62 "id": "id", 63 "mimetype": "image/png", 64 "number": 0, 65 "size": 21972, 66 "url": "https://bucket.s3.amazonaws.com/123/456.png" 67 } 68 ], 69 "previews": [ 70 { 71 "height": 400, 72 "url": "https://bucketname.s3.amazonaws.com/1/2/3.png", 73 "width": 200 74 } 75 ], 76 "region": "eu-central-1", 77 "size": 24381, 78 "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf" 79 }, 80 "phone": "phone", 81 "status": "active", 82 "tax_id": "tax_id", 83 "website": "website" 84 }, 85 "entity_id": "entity_id", 86 "items": [ 87 { 88 "currency": "AED", 89 "name": "name", 90 "price": 1, 91 "quantity": 1, 92 "unit": "unit", 93 "vat_rate": 1 94 } 95 ], 96 "message": "message", 97 "status": "status", 98 "valid_for_days": 1, 99 "counterpart_address": { 100 "city": "Berlin", 101 "country": "AF", 102 "line1": "Flughafenstrasse 52", 103 "postal_code": "10115", 104 "line2": "line2", 105 "state": "state" 106 }, 107 "counterpart_address_id": "counterpart_address_id", 108 "created_by_user_id": "created_by_user_id", 109 "entity_vat_id": { 110 "id": "id", 111 "country": "country", 112 "entity_id": "entity_id", 113 "type": "type", 114 "value": "value" 115 }, 116 "file_id": "file_id", 117 "file_url": "file_url", 118 "issued_at": "issued_at" 119 } 120 ], 121 "next_pagination_token": "next_pagination_token", 122 "prev_pagination_token": "prev_pagination_token" 123 }

1	curl https://api.sandbox.monite.com/v1/payable_purchase_orders \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
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	"created_automatically": true,
12	"default_billing_address_id": "default_billing_address_id",
13	"default_shipping_address_id": "default_shipping_address_id",
14	"created_by_entity_user_id": "created_by_entity_user_id",
15	"individual": {
16	"email": "asingh@example.net",
17	"first_name": "Adnan",
18	"is_customer": true,
19	"is_vendor": true,
20	"last_name": "Singh",
21	"phone": "5553211234",
22	"title": "Mr."
23	},
24	"language": "ab",
25	"reminders_enabled": true,
26	"tax_id": "tax_id",
27	"type": "individual"
28	},
29	"counterpart_id": "counterpart_id",
30	"currency": "AED",
31	"document_id": "document_id",
32	"entity": {
33	"id": "id",
34	"created_at": "2024-01-15T09:30:00Z",
35	"updated_at": "2024-01-15T09:30:00Z",
36	"address": {
37	"city": "city",
38	"country": "AF",
39	"line1": "line1",
40	"line2": "line2",
41	"postal_code": "postal_code",
42	"state": "state"
43	},
44	"email": "email",
45	"individual": {
46	"date_of_birth": "date_of_birth",
47	"first_name": "first_name",
48	"id_number": "id_number",
49	"last_name": "last_name",
50	"ssn_last_4": "ssn_last_4",
51	"title": "title"
52	},
53	"logo": {
54	"id": "id",
55	"created_at": "2024-01-15T09:30:00Z",
56	"file_type": "payables",
57	"md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
58	"mimetype": "application/pdf",
59	"name": "invoice.pdf",
60	"pages": [
61	{
62	"id": "id",
63	"mimetype": "image/png",
64	"number": 0,
65	"size": 21972,
66	"url": "https://bucket.s3.amazonaws.com/123/456.png"
67	}
68	],
69	"previews": [
70	{
71	"height": 400,
72	"url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
73	"width": 200
74	}
75	],
76	"region": "eu-central-1",
77	"size": 24381,
78	"url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf"
79	},
80	"phone": "phone",
81	"status": "active",
82	"tax_id": "tax_id",
83	"website": "website"
84	},
85	"entity_id": "entity_id",
86	"items": [
87	{
88	"currency": "AED",
89	"name": "name",
90	"price": 1,
91	"quantity": 1,
92	"unit": "unit",
93	"vat_rate": 1
94	}
95	],
96	"message": "message",
97	"status": "status",
98	"valid_for_days": 1,
99	"counterpart_address": {
100	"city": "Berlin",
101	"country": "AF",
102	"line1": "Flughafenstrasse 52",
103	"postal_code": "10115",
104	"line2": "line2",
105	"state": "state"
106	},
107	"counterpart_address_id": "counterpart_address_id",
108	"created_by_user_id": "created_by_user_id",
109	"entity_vat_id": {
110	"id": "id",
111	"country": "country",
112	"entity_id": "entity_id",
113	"type": "type",
114	"value": "value"
115	},
116	"file_id": "file_id",
117	"file_url": "file_url",
118	"issued_at": "issued_at"
119	}
120	],
121	"next_pagination_token": "next_pagination_token",
122	"prev_pagination_token": "prev_pagination_token"
123	}