Partial update purchase order

patch

https://api.wafeq.com/v1/purchase-orders/{id}/

Endpoint for partially updating an existing purchase order.

Path Params

string

required

Body Params

Adds nested create feature

attachments

array of strings

List of attachments linked to this purchase order.

attachments

branch

string | null

The branch associated with this purchase order, if applicable.

contact

string

The contact (vendor) associated with this purchase order.

currency

string

enum

The currency in which the purchase order is issued.

AED - AED ⃱
SAR - SAR ⃁
USD - USD $
EUR - EUR €
CAD - CAD $
AFN - AFN ؋
ALL - ALL Lek
AMD - AMD դր.
ARS - ARS $
AUD - AUD $
AZN - AZN ман.
BAM - BAM KM
BDT - BDT ৳
BGN - BGN лв.
BHD - BHD د.ب.‏
BIF - BIF FBu
BND - BND $
BOB - BOB Bs
BRL - BRL R$
BWP - BWP P
BYN - BYN BYN
BZD - BZD $
CDF - CDF FrCD
CHF - CHF CHF
CLP - CLP $
CNY - CNY CN¥
COP - COP $
CRC - CRC ₡
CVE - CVE CV$
CZK - CZK Kč
DJF - DJF Fdj
DKK - DKK kr
DOP - DOP RD$
DZD - DZD د.ج.‏
EGP - EGP ج.م.‏
ERN - ERN Nfk
ETB - ETB Br
GBP - GBP £
GEL - GEL GEL
GHS - GHS GH₵
GNF - GNF FG
GTQ - GTQ Q
HKD - HKD $
HNL - HNL L
HRK - HRK kn
HUF - HUF Ft
IDR - IDR Rp
ILS - ILS ₪
INR - INR ₹
IQD - IQD د.ع.‏
IRR - IRR ﷼
ISK - ISK kr
JMD - JMD $
JOD - JOD د.أ.‏
JPY - JPY ￥
KES - KES Ksh
KHR - KHR ៛
KMF - KMF FC
KRW - KRW ₩
KWD - KWD د.ك.‏
KZT - KZT тңг.
LBP - LBP ل.ل.‏
LKR - LKR SL Re
LYD - LYD د.ل.‏
MAD - MAD د.م.‏
MDL - MDL MDL
MGA - MGA MGA
MKD - MKD MKD
MMK - MMK K
MOP - MOP MOP$
MUR - MUR MURs
MXN - MXN $
MYR - MYR RM
MZN - MZN MTn
NAD - NAD N$
NGN - NGN ₦
NIO - NIO C$
NOK - NOK kr
NPR - NPR नेरू
NZD - NZD $
OMR - OMR ر.ع.‏
PAB - PAB B/.
PEN - PEN S/.
PHP - PHP ₱
PKR - PKR ₨
PLN - PLN zł
PYG - PYG ₲
QAR - QAR ر.ق.‏
RON - RON RON
RSD - RSD дин.
RUB - RUB руб.
RWF - RWF FR
SDG - SDG SDG
SEK - SEK kr
SGD - SGD $
SOS - SOS Ssh
SYP - SYP ل.س.‏
THB - THB ฿
TND - TND د.ت.‏
TOP - TOP T$
TRY - TRY TL
TTD - TTD $
TWD - TWD NT$
TZS - TZS TSh
UAH - UAH ₴
UGX - UGX USh
UYU - UYU $
UZS - UZS UZS
VES - VES Bs.S.
VND - VND ₫
XAF - XAF FCFA
XOF - XOF CFA
YER - YER ر.ي.‏
ZAR - ZAR R
ZMW - ZMW ZK

custom_fields

object

A mapping of custom field IDs to their values.

exchange_rate

double | null

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

external_id

string

length ≤ 255

External identifier for the purchase order.

language

string

enum

ar - Arabic
en - English

Full information for LanguageEnum

Allowed:

line_items

array of objects

The individual line items that make up the purchase order.

line_items

notes

string

Any additional notes or comments related to the purchase order.

project

string | null

The project associated with this purchase order, if any.

purchase_order_date

date | null

The date when the purchase order was issued.

purchase_order_number

string

The unique identifier or number assigned to this purchase order.

reference

string

Any additional reference information for this purchase order.

status

string

enum

Defaults to DRAFT

The current status of the purchase order (Draft, Sent, Billed, or Voided).

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

Allowed:

tax_amount_type

string

enum

Specifies whether the tax amount is inclusive or exclusive of the line item amounts.

TAX_INCLUSIVE - inc. tax
TAX_EXCLUSIVE - exc. tax

Allowed:

terms

string

The terms and conditions of the purchase order.

Headers

X-Wafeq-Idempotency-Key

string

Client-provided UUID to uniquely identify a request

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200