WAwafeq
Purchase Order Line Items

Partial update purchase order line item

Changed on

Endpoint for partially updating an existing purchase order line item.

patch/purchase-orders/{purchase_order_id}/line-items/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/purchase-orders/{purchase_order_id}/line-items/{id}/
  • Auth
    API key in header Authorization

Path parameters

purchase_order_idstring required
idstring required

Query parameters

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: account, account.parent, cost_center, item, tax_rate. Nested relations are joined with a dot.

Headers

X-Wafeq-Idempotency-Keystring

Client-provided UUID to uniquely identify a request

Request body

accountstring

The account associated with this line item.

cost_centerstring

The cost center associated with this line item, if any.

created_tsstring date-time

The timestamp in UTC when the line item was created.

custom_fieldsobject

A mapping of custom field IDs to their values.

descriptionstring

The detailed description of the line item.

discountnumber double nullable

The discount as the percentage.

idstring

The unique identifier of the line item.

itemstring

The item associated with this line item.

item_unit_of_measurestring nullable

The item unit of measure for this line item.

legacy_idstring

[Deprecated] The legacy identifier of the line item.

line_amountnumber double

The total amount for this line item, calculated as quantity * unit_amount - discount.

modified_tsstring date-time

The timestamp in UTC when the line item was last modified.

orderinteger

The position of the line item within the document.

quantitynumber double

The quantity of the item or service.

tax_amountnumber double

The total tax amount for this line item.

tax_ratestring

The tax rate applied to this line item, if any.

unit_amountnumber double

The price per unit of the item or service.

Response

accountstring

The account associated with this line item.

cost_centerstring

The cost center associated with this line item, if any.

created_tsstring date-time required

The timestamp in UTC when the line item was created.

custom_fieldsobject

A mapping of custom field IDs to their values.

descriptionstring required

The detailed description of the line item.

discountnumber double nullable

The discount as the percentage.

idstring required

The unique identifier of the line item.

itemstring

The item associated with this line item.

item_unit_of_measurestring nullable

The item unit of measure for this line item.

legacy_idstring required

[Deprecated] The legacy identifier of the line item.

line_amountnumber double required

The total amount for this line item, calculated as quantity * unit_amount - discount.

modified_tsstring date-time required

The timestamp in UTC when the line item was last modified.

orderinteger

The position of the line item within the document.

quantitynumber double required

The quantity of the item or service.

tax_amountnumber double required

The total tax amount for this line item.

tax_ratestring

The tax rate applied to this line item, if any.

unit_amountnumber double required

The price per unit of the item or service.

Changes