For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
API StatusPartner Portal
HomeGuidesAPI ExplorerSDKsGitHubSupport
HomeGuidesAPI ExplorerSDKsGitHubSupport
  • API Concepts
    • Overview
    • Environments and URLs
    • Authentication
    • API versioning
    • Rate limiting
    • HTTP headers
    • Pagination, sorting, and filtering
  • General
  • Common
  • Accounts payable
      • GETGet purchase orders
      • POSTCreate a purchase order
      • GETGet the available variables for purchase orders
      • GETGet a purchase order by ID
      • DELDelete a purchase order
      • PATCHUpdate a purchase order
      • POSTPreview a purchase order's email message
      • POSTSend a purchase order via email
  • Accounts receivable
  • E-invoicing
  • Payments
  • Accounting integration
  • Expense management
  • Utilities
LogoLogo
API StatusPartner Portal
Accounts payablePurchase orders

Update a purchase order

PATCH
/payable_purchase_orders/:purchase_order_id
PATCH
/v1/payable_purchase_orders/:purchase_order_id
$curl -X PATCH https://api.sandbox.monite.com/v1/payable_purchase_orders/purchase_order_id \
>     -H "x-monite-version: 2024-01-31" \
>     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
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    "created_by_entity_user_id": "created_by_entity_user_id",
11    "default_billing_address_id": "default_billing_address_id",
12    "default_shipping_address_id": "default_shipping_address_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  "project_id": "project_id"
118}
Was this page helpful?
Previous

Preview a purchase order's email message

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

purchase_order_idstringRequired

Headers

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
counterpart_address_idstringOptionalformat: "uuid"
The ID of counterpart address object stored in counterparts service. If not provided, counterpart's default address is used.
counterpart_idstringOptionalformat: "uuid"
Counterpart unique ID.
entity_vat_id_idstringOptionalformat: "uuid"
Entity VAT ID identifier that applied to purchase order
itemslist of objectsOptional
List of item to purchase
messagestringOptional
Msg which will be send to counterpart for who the purchase order is issued.
project_idstringOptionalformat: "uuid"
Project ID of a purchase order
valid_for_daysintegerOptional>=1
Number of days for which purchase order is valid

Response

Successful Response
idstringformat: "uuid"
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_idstringformat: "uuid"
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_idstringformat: "uuid"
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_addressobject
Counterpart address data saved on creation or update of the purchase order.
counterpart_address_idstringformat: "uuid"
The ID of counterpart address object stored in counterparts service. If not provided, counterpart's default address is used.
created_by_user_idstringformat: "uuid"
ID of the creator of the purchase order
entity_vat_idobject
file_idstringformat: "uuid"
file_urlstring
issued_atstringformat: "date"
When status changed from 'draft' to 'send', so after sending purchase order
project_idstringformat: "uuid"
Project ID of a purchase order

Errors

400
Patch Payable Purchase Orders ID Request Bad Request Error
404
Patch Payable Purchase Orders ID Request Not Found Error
422
Patch Payable Purchase Orders ID Request Unprocessable Entity Error
500
Patch Payable Purchase Orders ID Request Internal Server Error