Create a purchase order (v2023-09-01)

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.

Request

This endpoint expects an object.

counterpart_idstringRequired

Counterpart unique ID.

currencyenumRequired

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

itemslist of objectsRequired

List of item to purchase

messagestringRequired

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

valid_for_daysintegerRequired>=1

Number of days for which purchase order is valid

counterpart_address_idstringOptional

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

entity_vat_id_idstringOptional

Entity VAT ID identifier that applied to purchase order

Response

Successful Response

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>=1

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

1 curl -X POST https://api.sandbox.monite.com/v1/payable_purchase_orders \ 2 -H "x-monite-version: 2023-09-01" \ 3 -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \ 4 -H "Authorization: Bearer <token>" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "counterpart_id": "counterpart_id", 8 "currency": "AED", 9 "items": [ 10 { 11 "currency": "AED", 12 "name": "name", 13 "price": 1, 14 "quantity": 1, 15 "unit": "unit", 16 "vat_rate": 1 17 } 18 ], 19 "message": "message", 20 "valid_for_days": 1 21 }'

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

1	curl -X POST https://api.sandbox.monite.com/v1/payable_purchase_orders \
2	-H "x-monite-version: 2023-09-01" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"counterpart_id": "counterpart_id",
8	"currency": "AED",
9	"items": [
10	{
11	"currency": "AED",
12	"name": "name",
13	"price": 1,
14	"quantity": 1,
15	"unit": "unit",
16	"vat_rate": 1
17	}
18	],
19	"message": "message",
20	"valid_for_days": 1
21	}'

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