v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB

Purchase Orders

Partial update purchase order

Endpoint for partially updating an existing purchase order.

patch/purchase-orders/{id}/

Path parameters

idstring required

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

amountnumber double

The total amount of the purchase order, including taxes and discounts.

attachmentsstring[]

List of attachments linked to this purchase order.

branchstring nullable

The branch associated with this purchase order, if applicable.

contactstring

The contact (vendor) associated with this purchase order.

created_tsstring date-time

The timestamp in UTC when the purchase order was created.

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW'

AED - AED ⃱
SAR - SAR ⃁
USD - USD $
EUR - EUR €
CAD - CAD $
AFN - AFN ؋
ALL - ALL Lek
AMD - AMD դր.
ARS - ARS $
AUD - AUD $
...

Full information for CurrencyEnum

custom_fieldsobject

A mapping of custom field IDs to their values.

exchange_ratenumber double nullable

The exchange rate to the organization base currency at the time of the document.

external_idstring

External identifier for the purchase order.

idstring

The unique identifier of the purchase order.

language'ar' | 'en'

ar - Arabic
en - English

Full information for LanguageEnum

legacy_idstring

[Deprecated] The legacy identifier of the purchase order.

modified_tsstring date-time

The timestamp in UTC when the purchase order was last modified.

notesstring

Any additional notes or comments related to the purchase order.

projectstring nullable

The project associated with this purchase order, if any.

purchase_order_datestring date nullable

The date when the purchase order was issued.

purchase_order_numberstring

The unique identifier or number assigned to this purchase order.

referencestring

Any additional reference information for this purchase order.

status'DRAFT' | 'SENT' | 'BILLED' | 'VOIDED'

DRAFT - DRAFT
SENT - SENT
BILLED - BILLED
VOIDED - VOIDED

Full information for PurchaseOrderStatusEnum

tax_amountnumber double

The total tax amount applied to the purchase order.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'

TAX_INCLUSIVE - inc. tax
TAX_EXCLUSIVE - exc. tax

Full information for TaxAmountTypeEnum

termsstring

The terms and conditions of the purchase order.

Response

amountnumber double required