Purchase Order PATCH API Documentation

Purpose

This API allows to update the information of an existing purchase order, including supplier invoice details, issue and due dates, expected completion date, purchase order notes, and other metadata. It enables partial updates without recreating the purchase order, providing flexibility in managing procurement records as new information becomes available.

Use Case

This endpoint is used to modify or correct purchase order details after creation. Typical scenarios include updating the supplier’s invoice ID once it is received, adjusting due or expected completion dates to reflect delivery changes, or adding notes and metadata for compliance or reporting purposes. It ensures that procurement teams can keep purchase orders accurate and up to date throughout their lifecycle.

Path Parameters

Parameter	Type	Description
purchase_order_id	String	Unique identifier of the purchase order to be updated.

Query Parameters

This endpoint does not accept query parameters.

Request Body

                JSON
              

                      {
    "purchase-order": {
        "supplier_invoice_id": "SUPPLIER_INVOICE_ID",
        "issue_date": "ISSUE_DATE",
        "due_date": "DUE_DATE",
        "expected_completion_date": "EXPECTED_COMPLETION_DATE",
        "purchase_order_note": "NOTE",
        "custom_attributes": [
            {
                "name": "ATTRIBUTE_NAME",
                "value": "ATTRIBUTE_VALUE"
            }
        ]
    }
}

                    

Attribute	Type	Description
purchase-order	Object	Parent object containing updated purchase order details.
supplier_invoice_id	String	Supplier’s reference invoice ID linked to this purchase order.
issue_date	String (Date)	Date the purchase order was issued. Format: YYYY-MM-DD.
due_date	String (Date)	Payment or fulfillment due date of the purchase order.
expected_completion_date	String (Date)	Estimated date when the order is expected to be completed.
purchase_order_note	String	Additional notes or remarks associated with the purchase order.
custom_attributes	Array	List of custom attribute objects containing name-value pairs for additional metadata.
name	String	Name of the custom attribute.
value	String	Value assigned to the custom attribute.

Response

The response returns the updated purchase order object with all relevant details. It includes identifiers such as the purchase order ID and UUID, supplier account linkage, currency information, issue and due dates, and updated metadata like last_updated_by and versioning. Financial values such as subtotal, tax, and total are provided, along with line item details including item IDs, names, quantities, pricing snapshots, and tax configurations. KPIs summarize operational and financial metrics such as expenses, outstanding balances, and invoice history. The response confirms that the purchase order has been successfully modified and reflects the latest version of the record.

Response Body

                JSON
              

                      {
    "purchase_order": {
        "status": "STATUS",
        "id": "PURCHASE_ORDER_ID",
        "currency": {
            "uuid": "CURRENCY_UUID",
            "name": "CURRENCY_NAME",
            "link": "CURRENCY_LINK"
        },
        "supplier_invoice_id": "SUPPLIER_INVOICE_ID",
        "issue_date": "ISSUE_DATE",
        "due_date": "DUE_DATE",
        "expected_completion_date": "EXPECTED_COMPLETION_DATE",
        "subtotal": "SUBTOTAL",
        "tax": "TAX_AMOUNT",
        "total": "TOTAL_AMOUNT",
        "price_tax_inclusive": "IS_TAX_INCLUSIVE",
        "purchase_order_note": "NOTE",
        "account_id": "ACCOUNT_ID",
        "created_by": "CREATED_BY",
        "created_on": "CREATION_TIMESTAMP",
        "last_updated_by": "LAST_UPDATED_BY",
        "last_updated_on": "LAST_UPDATED_TIMESTAMP",
        "uuid": "PURCHASE_ORDER_UUID",
        "version": "VERSION",
        "custom_attributes": [
            {
                "name": "ATTRIBUTE_NAME",
                "value": "ATTRIBUTE_VALUE"
            }
        ],
        "lines": [
            {
                "subtotal": "LINE_SUBTOTAL",
                "total": "LINE_TOTAL",
                "tax": "LINE_TAX",
                "item_uuid": "ITEM_UUID",
                "item_id": "ITEM_ID",
                "item_name": "ITEM_NAME",
                "item_quantity": "ITEM_QUANTITY",
                "item_price_snapshot": {
                    "pricing_rule": {
                        "uuid": "PRICING_RULE_UUID",
                        "version": "PRICING_VERSION",
                        "price_type": "PRICE_TYPE",
                        "price": "ITEM_PRICE",
                        "uom": "UNIT_OF_MEASURE",
                        "warehouse": "WAREHOUSE_NAME"
                    }
                },
                "item_purchase_tax_configuration": {
                    "purchase_price_is_tax_inclusive": "IS_TAX_INCLUSIVE",
                    "tax_code": {
                        "uuid": "TAX_CODE_UUID",
                        "code": "TAX_CODE",
                        "rate": "TAX_RATE",
                        "link": "TAX_LINK"
                    }
                },
                "item_price_tax_exempt": "IS_TAX_EXEMPT",
                "item_price_tax": {
                    "uuid": "ITEM_TAX_UUID",
                    "code": "TAX_CODE",
                    "rate": "TAX_RATE",
                    "link": "TAX_LINK"
                },
                "uuid": "LINE_UUID",
                "version": "LINE_VERSION"
            }
        ]
    }
}

                    

Attribute	Type	Description
purchase_order	Object	Root object containing the updated purchase order details.
status	String	Current status of the purchase order (example: ACTIVE, CLOSED).
id	String	Unique purchase order ID.
currency	Object	Details about the currency used for this purchase order.
uuid	String	Unique identifier of the currency.
name	String	Name of the currency (example: AUD, USD).
link	String	Reference link for currency details.
supplier_invoice_id	String	Supplier’s invoice ID associated with the order.
issue_date	String (Date)	Purchase order issue date.
due_date	String (Date)	Due date for the order payment or completion.
expected_completion_date	String (Date)	Anticipated completion date of the order.
subtotal	String (Decimal)	Total cost before tax.
tax	String (Decimal)	Total tax amount applied to the order.
total	String (Decimal)	Total payable amount after taxes.
price_tax_inclusive	Boolean	Indicates if prices include tax (true or false).
purchase_order_note	String	Note or remark attached to the order.
account_id	String	ID of the account linked to this purchase order.
created_by	String	Name or ID of the user who created the record.
created_on	String (DateTime)	Timestamp of purchase order creation.
last_updated_by	String	Name or ID of the user who last updated the record.
last_updated_on	String (DateTime)	Timestamp of the last modification.
uuid	String	Unique UUID of the purchase order.
version	String	Version number of the purchase order record.
custom_attributes	Array	List of custom attributes linked to this purchase order.
name	String	Name of the custom attribute.
value	String	Value assigned to the custom attribute.
lines	Array	Collection of line items included in the purchase order.
subtotal	String (Decimal)	Subtotal cost for the line item.
total	String (Decimal)	Total cost for the line item after taxes.
tax	String (Decimal)	Tax applied to the line item.
item_uuid	String	Unique identifier for the item.
item_id	String	Item ID used in the catalog or system.
item_name	String	Name of the purchased item.
item_quantity	String	Quantity of the item ordered.
item_price_snapshot	Object	Snapshot of the item’s pricing details at order time.
pricing_rule	Object	Pricing rule details used for the item.
uuid	String	Pricing rule UUID.
version	String	Pricing rule version.
price_type	String	Type of price (example: FIXED, DISCOUNT).
price	String (Decimal)	Unit price of the item.
uom	String	Unit of measure (example: EA, BOX).
warehouse	String	Name of the warehouse associated with pricing.
item_purchase_tax_configuration	Object	Tax configuration details for the item purchase.
purchase_price_is_tax_inclusive	Boolean	Indicates if item price includes tax.
tax_code	Object	Tax code details applied to the item.
uuid	String	Unique identifier for the tax code.
code	String	Tax code (example: GST, VAT).
rate	String (Decimal)	Tax rate percentage.
link	String	Reference link for tax code details.
item_price_tax_exempt	Boolean	Indicates if the item is exempt from tax.
item_price_tax	Object	Applied tax information for the item.
uuid	String	Unique identifier for the item tax configuration.
code	String	Tax code applied to the item.
rate	String (Decimal)	Tax rate applied.
link	String	Link to tax configuration resource.
uuid	String	Unique identifier for the line item.
version	String	Version number of the line item.