Purchase orders

Update a purchase order

patch/payable_purchase_orders/{purchase_order_id}

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/payable_purchase_orders/{purchase_order_id}
  • Auth: HTTP bearer

Path parameters

purchase_order_idstring required

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Request body

counterpart_address_idstring uuid

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

counterpart_idstring uuid

Counterpart unique ID.

entity_vat_id_idstring uuid

Entity VAT ID identifier that applied to purchase order

messagestring

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

project_idstring uuid

Project ID of a purchase order

valid_for_daysinteger

Number of days for which purchase order is valid

Response

Successful Response

idstring uuid required

A unique ID assigned to this purchase order.

created_atstring date-time required

Time at which the receivable was created. Timestamps follow the ISO 8601 standard.

updated_atstring date-time required

Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard.

counterpart_address_idstring uuid

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

counterpart_idstring uuid required

Counterpart unique ID.

created_by_user_idstring uuid

ID of the creator of the purchase order

currency'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' required
document_idstring required
entity_idstring uuid required

The ID of the entity which issued the purchase order.

file_idstring uuid
file_urlstring
issued_atstring date

When status changed from 'draft' to 'send', so after sending purchase order

messagestring required

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

project_idstring uuid

Project ID of a purchase order

statusstring required

Purchase order can be in 'draft' state before sending it to counterpart. After that state is 'issued'

valid_for_daysinteger required

Number of days for which purchase order is valid

Changes

No recorded changes to this operation across all 1 revision of this API.