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

A purchase order placed with a supplier.

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.

View the enum reference

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

The language of the document.

View the enum reference

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).

View the enum reference

Allowed:

tax_amount_type

string

enum

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

View the enum reference

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

200