Purchase Payment PATCH API Documentation

Purpose

This endpoint allows updating specific information for an existing Purchase Payment record. It supports updating fields such as the origin, note, custom attributes, and other non-financial metadata. This ensures that users can maintain accurate recordkeeping, attach additional contextual information, or integrate workflow-related notes without altering financial postings already applied.

Use Case

Updating the note on a purchase payment to reflect internal comments, audit requirements, or post-processing steps.
Setting or modifying the origin field for tracking how/where a purchase payment was created.
Adding or updating custom attributes linked with workflows or business-specific metadata.
Maintaining data consistency when purchase payment details evolve over time.
Enhancing reporting accuracy by enriching payment records with contextual metadata.

Path Parameters

Parameter	Type	Description
purchase_payment_id	string	Identifier of the Purchase Payment record to update. Required.

Query Parameters

This endpoint does not accept query parameters.

Request Body

                JSON
              

                      {
    "purchase_payment": {
        "origin": "ORIGIN_PLACEHOLDER",
        "note": "NOTE_PLACEHOLDER",
        "custom_attributes": []
    }
}

                    

Attribute	Type	Description
purchase_payment	object	Object containing fields to update for the purchase payment.
origin	string	Source or reference describing where the payment originated from (optional).
note	string	Additional user-defined note or comment for documentation purposes.
custom_attributes	array	List of custom attribute values to update (empty array means no updates).

Response

The response returns the fully updated Purchase Payment object, including system fields, timestamps, applied payment details, linked purchase orders and invoices, and metadata such as created and last-updated user information. Even if only minimal fields are modified, the response contains the entire refreshed payment object, ensuring complete visibility into the current state of the Purchase Payment after the update.

Response Body

                JSON
              

                      {
    "purchase_payment": {
        "status": "STATUS_PLACEHOLDER",
        "id": "PURCHASE_PAYMENT_ID_PLACEHOLDER",
        "origin": "ORIGIN_PLACEHOLDER",
        "purchase_payment_date": "PURCHASE_PAYMENT_DATE_PLACEHOLDER",
        "total_applied": "TOTAL_APPLIED_PLACEHOLDER",
        "purchase_order_id": "PURCHASE_ORDER_ID_PLACEHOLDER",
        "purchase_payment_note": "PURCHASE_PAYMENT_NOTE_PLACEHOLDER",
        "purchase_payment_applied": [
            {
                "id": PAYMENT_APPLIED_ID_PLACEHOLDER,
                "amount": PAYMENT_AMOUNT_PLACEHOLDER,
                "method": "PAYMENT_METHOD_PLACEHOLDER",
                "processor": "PAYMENT_PROCESSOR_PLACEHOLDER",
                "reference": "PAYMENT_REFERENCE_PLACEHOLDER"
            }
        ],
        "purchase_credit_applied": [],
        "purchase_invoices": [
            {
                "applied": APPLIED_AMOUNT_PLACEHOLDER,
                "id": "PURCHASE_INVOICE_ID_PLACEHOLDER",
                "due_date": "DUE_DATE_PLACEHOLDER",
                "issue_date": "ISSUE_DATE_PLACEHOLDER",
                "outstanding": OUTSTANDING_AMOUNT_PLACEHOLDER,
                "total": TOTAL_AMOUNT_PLACEHOLDER
            }
        ],
        "created_by": "CREATED_BY_PLACEHOLDER",
        "created_on": "CREATED_ON_PLACEHOLDER",
        "last_updated_by": "LAST_UPDATED_BY_PLACEHOLDER",
        "last_updated_on": "LAST_UPDATED_ON_PLACEHOLDER",
        "uuid": "PURCHASE_PAYMENT_UUID_PLACEHOLDER",
        "version": "VERSION_PLACEHOLDER",
        "custom_attributes": [],
        "custom_objects": []
    }
}

                    

Attribute	Type	Description
purchase_payment	object	Complete purchase payment record after update.
status	string	Status of the purchase payment (example: ACTIVE).
id	string	System-generated purchase payment identifier.
origin	string	Updated origin value for the purchase payment.
purchase_payment_date	string	Date when the purchase payment was created or applied (ISO format).
total_applied	string	Total payment amount applied to invoices.
purchase_order_id	string	Related purchase order identifier.
purchase_payment_note	string	Updated note associated with the purchase payment.
purchase_payment_applied	array	List of payment application details.
id	integer	Identifier of the applied payment entry.
amount	number	Applied amount.
method	string	Payment method used.
processor	string	Payment processor used.
reference	string	Reference information for the applied payment.
purchase_credit_applied	array	List of applied purchase credits (empty if none).
purchase_invoices	array	List of invoices associated with the payment.
applied	number	Amount applied to the invoice.
id	string	Purchase invoice identifier.
due_date	string	Invoice due date.
issue_date	string	Invoice issue date.
outstanding	number	Remaining outstanding amount on the invoice.
total	number	Total invoice amount.
created_by	string	User who created the purchase payment.
created_on	string	Timestamp of when the payment was created (ISO format).
last_updated_by	string	User who last updated the payment.
last_updated_on	string	Timestamp of last update (ISO format).
uuid	string	UUID of the purchase payment record.
version	string	Version number of the record after update.
custom_attributes	array	Custom attributes attached to the record.
custom_objects	array	Custom objects attached to the record.