Purchase Payment GET API Documentation

Purpose

This API retrieves a list of purchase payment records within the system. Each record contains details about payments made to suppliers or vendors, including payment amount, method, processor, and the associated purchase orders and invoices. It helps users monitor supplier payments, applied credits, and payment histories in a single, paginated response for financial reconciliation and auditing.

Use Case

Retrieve all existing purchase payment records for review or reconciliation.
Display supplier payment history in dashboards or financial reports.
Track payments linked to purchase orders and invoices.
Verify payment methods, processors, and total applied amounts.
Audit who created or last updated payments.

Path Parameters

This endpoint does not have any path parameters.

Query Parameters

Parameter	Type	Description
limit	Integer	Number of records to return per page (pagination control).
offset	Integer	Starting index for paginated records.

Request Body

No data is required for the request body.

Response

On success, the API returns a paginated list of purchase payment records. Each record contains core payment metadata such as payment status, total amount applied, associated purchase orders, applied invoices and credits, and audit details. Each payment may include one or more entries under purchase_payment_applied and purchase_credit_applied, showing how the payment amount was distributed. The response also includes pagination details for large datasets.

Response Body

                JSON
              

                      {
    "purchase_payments": [
        {
            "status": "{{status}}",
            "id": "{{purchase_payment_id}}",
            "origin": "{{origin_source}}",
            "purchase_payment_date": "{{payment_date}}",
            "total_applied": "{{total_applied_amount}}",
            "purchase_order_id": "{{purchase_order_id}}",
            "purchase_payment_note": "{{payment_note}}",
            "purchase_payment_applied": [
                {
                    "id": "{{applied_id}}",
                    "amount": "{{applied_amount}}",
                    "method": "{{payment_method}}",
                    "processor": "{{payment_processor}}",
                    "reference": "{{reference_number}}"
                }
            ],
            "purchase_credit_applied": [
                {
                    "id": "{{credit_id}}",
                    "amount": "{{credit_amount}}"
                }
            ],
            "purchase_invoices": [
                {
                    "applied": "{{invoice_applied_amount}}",
                    "id": "{{invoice_id}}",
                    "due_date": "{{invoice_due_date}}",
                    "issue_date": "{{invoice_issue_date}}",
                    "outstanding": "{{invoice_outstanding_amount}}",
                    "total": "{{invoice_total_amount}}"
                }
            ],
            "created_by": "{{created_by_user}}",
            "created_on": "{{created_timestamp}}",
            "last_updated_by": "{{last_updated_user}}",
            "last_updated_on": "{{last_updated_timestamp}}",
            "uuid": "{{uuid}}",
            "version": "{{version_number}}",
            "custom_attributes": [],
            "custom_objects": []
        }
    ],
    "pagination": {
        "records": "{{total_records}}",
        "limit": "{{page_limit}}",
        "offset": "{{page_offset}}",
        "previous_page": "{{previous_page_url}}",
        "next_page": "{{next_page_url}}"
    }
}

                    

Attribute	Type	Description
status	String	Current status of the purchase payment record.
id	String	Unique system-generated identifier for the purchase payment.
origin	String	Source or origin of the payment entry.
purchase_payment_date	String (DateTime)	The date when the purchase payment was recorded.
total_applied	String (Decimal)	Total amount applied across all invoices or credits.
purchase_order_id	String	Identifier of the associated purchase order.
purchase_payment_note	String	Additional notes related to the payment (if provided).
purchase_payment_applied	Array	List of payment application details showing how the payment amount was applied.
purchase_credit_applied	Array	List of applied credits associated with the purchase payment.
purchase_invoices	Array	List of invoices linked to this purchase payment, including amounts, dates, and balances.
created_by	String	Name of the user who created the payment record.
created_on	String (DateTime)	Timestamp of when the payment record was created.
last_updated_by	String	Name of the user who last modified the record.
last_updated_on	String (DateTime)	Timestamp of the last update to the record.
uuid	String	Unique universal identifier of the purchase payment record.
version	String	Version number of the record, incremented upon updates.
custom_attributes	Array	Custom attributes defined for the payment record.
custom_objects	Array	Custom objects linked to the payment record.

Purpose

This API retrieves the detailed information of a specific purchase payment using its unique identifier. It returns payment details such as status, payment date, total applied amount, associated invoices, applied credits, and transaction methods. This endpoint is useful for reviewing or verifying payment records linked to a purchase process within an account.

Use Case

Retrieve full details of a specific purchase payment for auditing or review.
View associated invoices and credits linked to a payment.
Validate payment processing details such as method, processor, and reference numbers.
Support reporting and reconciliation processes between invoices and payments.

Path Parameters

Parameter	Type	Description
purchase_payment_id	String	Unique identifier of the purchase payment to be retrieved.

Query Parameters

This endpoint does not accept any query parameters.

Request Body

No data is required for the request body.

Response

On success, the API returns the full details of the specified purchase payment. The response includes high-level payment attributes such as status, ID, payment date, total applied amount, and order linkage, along with nested data structures for applied payments, applied credits, and related invoices. Each nested object provides granular details about amounts, payment methods, references, and invoice-level details (due dates, totals, outstanding balances). This detailed structure enables comprehensive visibility into how each payment was processed and applied across related transactions.

Response Body

                JSON
              

                      {
  "purchase_payment": {
    "status": "{{status}}",
    "id": "{{purchase_payment_id}}",
    "origin": "{{origin_source}}",
    "purchase_payment_date": "{{purchase_payment_date}}",
    "total_applied": "{{total_applied_amount}}",
    "purchase_order_id": "{{purchase_order_id}}",
    "purchase_payment_note": "{{note}}",
    "purchase_payment_applied": [
      {
        "id": "{{applied_id}}",
        "amount": {{applied_amount}},
        "method": "{{payment_method}}",
        "processor": "{{payment_processor}}",
        "reference": "{{reference_number}}"
      }
    ],
    "purchase_credit_applied": [
      {
        "id": "{{credit_id}}",
        "amount": {{credit_amount}}
      }
    ],
    "purchase_invoices": [
      {
        "applied": {{applied_amount}},
        "id": "{{invoice_id}}",
        "due_date": "{{invoice_due_date}}",
        "issue_date": "{{invoice_issue_date}}",
        "outstanding": {{outstanding_amount}},
        "total": {{invoice_total}}
      }
    ],
    "created_by": "{{created_by_user}}",
    "created_on": "{{created_timestamp}}",
    "last_updated_by": "{{last_updated_user}}",
    "last_updated_on": "{{last_updated_timestamp}}",
    "uuid": "{{purchase_payment_uuid}}",
    "version": "{{version_number}}",
    "custom_attributes": [],
    "custom_objects": []
  }
}

                    

Attribute	Type	Description
purchase_payment	Object	Root object containing all purchase payment details.
status	String	Current status of the purchase payment (example: ACTIVE).
id	String	Unique identifier of the purchase payment.
origin	String	Source or origin of the payment record.
purchase_payment_date	String (ISO 8601)	Date when the payment was made.
total_applied	String	Total amount applied across all related invoices.
purchase_order_id	String	Identifier of the related purchase order, if applicable.
purchase_payment_note	String	Additional notes or comments related to the payment.
purchase_payment_applied	Array	List of payment application details, including method and reference.
purchase_payment_applied.id	Integer	Unique identifier for each applied payment entry.
purchase_payment_applied.amount	Number	Amount applied in the specific transaction.
purchase_payment_applied.method	String	Payment method used (example: Cash, Bank Transfer).
purchase_payment_applied.processor	String	Processor or handler of the payment.
purchase_payment_applied.reference	String	Reference number or identifier associated with the payment.
purchase_credit_applied	Array	List of credit notes applied to this payment.
purchase_credit_applied.id	String	Identifier of the applied credit note.
purchase_credit_applied.amount	Number	Amount of credit applied.
purchase_invoices	Array	List of invoices associated with the payment.
purchase_invoices.applied	Number	Amount applied to the invoice from this payment.
purchase_invoices.id	String	Unique identifier of the invoice.
purchase_invoices.due_date	String	Due date of the invoice.
purchase_invoices.issue_date	String	Date the invoice was issued.
purchase_invoices.outstanding	Number	Remaining outstanding amount after the payment.
purchase_invoices.total	Number	Total invoice amount.
created_by	String	Name of the user who created the record.
created_on	String (ISO 8601)	Timestamp when the payment record was created.
last_updated_by	String	Name of the user who last updated the record.
last_updated_on	String (ISO 8601)	Timestamp when the record was last updated.
uuid	String	Unique system-generated identifier for the payment record.
version	String	Current version of the payment record.
custom_attributes	Array	List of custom fields defined for the purchase payment (if any).
custom_objects	Array	List of custom objects linked to the purchase payment (if any).

Purpose

This API retrieves a list of all purchase payments associated with a specific account. It returns detailed information for each purchase payment, including payment date, applied amounts, related invoices, and credits. This endpoint is primarily used for monitoring account-level payment activity, reconciling purchase transactions, and generating financial reports.

Use Case

Retrieve all purchase payments made under a specific account.
Review payment details, including applied credits and associated invoices.
Support financial reconciliation and validation processes.
Enable audit tracking of payments created or updated within an account.
Display payment lists in account dashboards or reporting interfaces.

Path Parameters

Parameter	Type	Description
account_id	String	Unique identifier of the account for which purchase payments are to be retrieved.

Query Parameters

Parameter	Type	Description
limit	Integer	Number of records to return per page (pagination limit).
offset	Integer	Number of records to skip before starting to return results.

Request Body

No data is required for the request body.

Response

On success, the API returns a list of all purchase payments associated with the specified account. Each payment object provides key details including payment ID, date, total applied amount, status, associated invoices, applied credits, and creation metadata. The response also includes pagination information to handle large datasets efficiently. This structure allows client applications to list payments with detailed insights into each transaction and maintain traceability between invoices and payments.

Response Body

                JSON
              

                      {
  "account": {
    "purchase_payments": [
      {
        "status": "{{status}}",
        "id": "{{purchase_payment_id}}",
        "origin": "{{origin_source}}",
        "purchase_payment_date": "{{purchase_payment_date}}",
        "total_applied": "{{total_applied_amount}}",
        "purchase_order_id": "{{purchase_order_id}}",
        "purchase_payment_note": "{{note}}",
        "purchase_payment_applied": [
          {
            "id": "{{applied_id}}",
            "amount": {{applied_amount}},
            "method": "{{payment_method}}",
            "processor": "{{payment_processor}}",
            "reference": "{{reference_number}}"
          }
        ],
        "purchase_credit_applied": [
          {
            "id": "{{credit_id}}",
            "amount": {{credit_amount}}
          }
        ],
        "purchase_invoices": [
          {
            "applied": {{applied_amount}},
            "id": "{{invoice_id}}",
            "due_date": "{{invoice_due_date}}",
            "issue_date": "{{invoice_issue_date}}",
            "outstanding": {{outstanding_amount}},
            "total": {{invoice_total}}
          }
        ],
        "created_by": "{{created_by_user}}",
        "created_on": "{{created_timestamp}}",
        "last_updated_by": "{{last_updated_user}}",
        "last_updated_on": "{{last_updated_timestamp}}",
        "uuid": "{{purchase_payment_uuid}}",
        "version": "{{version_number}}",
        "custom_attributes": [],
        "custom_objects": []
      }
    ],
    "pagination": {
      "records": {{total_records}},
      "limit": {{limit_value}},
      "offset": {{offset_value}},
      "previous_page": "{{previous_page_url}}",
      "next_page": "{{next_page_url}}"
    }
  }
}

                    

Attribute	Type	Description
account	Object	Root object containing account-level purchase payment data.
purchase_payments	Array	List of all purchase payments associated with the account.
status	String	Current status of the purchase payment (example: ACTIVE).
id	String	Unique identifier of the purchase payment.
origin	String	Source or origin of the payment record.
purchase_payment_date	String (ISO 8601)	Date when the payment was made.
total_applied	String	Total amount applied across all related invoices.
purchase_order_id	String	Identifier of the related purchase order, if applicable.
purchase_payment_note	String	Additional notes or comments related to the payment.
purchase_payment_applied	Array	List of payment application details, including method and reference.
purchase_payment_applied.id	Integer	Unique identifier for each applied payment entry.
purchase_payment_applied.amount	Number	Amount applied in the specific transaction.
purchase_payment_applied.method	String	Payment method used (example: Cash, Bank Transfer).
purchase_payment_applied.processor	String	Processor or handler of the payment.
purchase_payment_applied.reference	String	Reference number or identifier associated with the payment.
purchase_credit_applied	Array	List of credit notes applied to this payment.
purchase_credit_applied.id	String	Identifier of the applied credit note.
purchase_credit_applied.amount	Number	Amount of credit applied.
purchase_invoices	Array	List of invoices associated with the payment.
purchase_invoices.applied	Number	Amount applied to the invoice from this payment.
purchase_invoices.id	String	Unique identifier of the invoice.
purchase_invoices.due_date	String	Due date of the invoice.
purchase_invoices.issue_date	String	Date the invoice was issued.
purchase_invoices.outstanding	Number	Remaining outstanding amount after the payment.
purchase_invoices.total	Number	Total invoice amount.
created_by	String	Name of the user who created the record.
created_on	String (ISO 8601)	Timestamp when the payment record was created.
last_updated_by	String	Name of the user who last updated the record.
last_updated_on	String (ISO 8601)	Timestamp when the record was last updated.
uuid	String	Unique system-generated identifier for the payment record.
version	String	Current version of the payment record.
custom_attributes	Array	List of custom fields defined for the purchase payment (if any).
custom_objects	Array	List of custom objects linked to the purchase payment (if any).
pagination	Object	Contains pagination details for managing record sets.
pagination.records	Integer	Total number of records available.
pagination.limit	Integer	Number of records returned per page.
pagination.offset	Integer	Starting point for the returned records.
pagination.previous_page	String	URL for the previous page of results.
pagination.next_page	String	URL for the next page of results.

Purpose

This API retrieves all purchase payments associated with a specific purchase order. It provides detailed information about each payment, including payment amount, method, linked invoices, applied credits, and metadata.
It is mainly used for tracking payments made against a particular purchase order, enabling better financial visibility, reconciliation, and auditing of procurement transactions.

Use Case

Retrieve all payments made toward a particular purchase order.
View detailed payment information (example: payment methods, applied invoices, and total amount).
Reconcile purchase order balances against applied payments.
Support reporting and auditing functions for supplier transactions.
Integrate payment details into procurement and accounting dashboards.

Path Parameters

Parameter	Type	Description
purchase_order_id	String	Unique identifier of the purchase order whose related payments are to be retrieved.

Query Parameters

Parameter	Type	Description
limit	Integer	Number of records to return per page (pagination limit).
offset	Integer	Number of records to skip before starting to return results.

Request Body

No data is required for the request body.

Response

On success, the API returns all purchase payments linked to the specified purchase order. Each payment record contains comprehensive information such as payment ID, date, total applied amount, applied credits, linked invoices, and creation details. Pagination details are also included to support efficient data navigation and large record sets. This response structure helps developers and financial teams view all transactions related to a purchase order in a structured and traceable format.

Response Body

                JSON
              

                      {
  "purchase_order": {
    "purchase_payments": [
      {
        "status": "{{status}}",
        "id": "{{purchase_payment_id}}",
        "origin": "{{origin_source}}",
        "purchase_payment_date": "{{purchase_payment_date}}",
        "total_applied": "{{total_applied_amount}}",
        "purchase_order_id": "{{purchase_order_id}}",
        "purchase_payment_note": "{{payment_note}}",
        "purchase_payment_applied": [
          {
            "id": "{{applied_id}}",
            "amount": {{applied_amount}},
            "method": "{{payment_method}}",
            "processor": "{{payment_processor}}",
            "reference": "{{reference_number}}"
          }
        ],
        "purchase_credit_applied": [
          {
            "id": "{{credit_id}}",
            "amount": {{credit_amount}}
          }
        ],
        "purchase_invoices": [
          {
            "applied": {{applied_amount}},
            "id": "{{invoice_id}}",
            "due_date": "{{invoice_due_date}}",
            "issue_date": "{{invoice_issue_date}}",
            "outstanding": {{outstanding_amount}},
            "total": {{invoice_total}}
          }
        ],
        "created_by": "{{created_by_user}}",
        "created_on": "{{created_timestamp}}",
        "last_updated_by": "{{last_updated_user}}",
        "last_updated_on": "{{last_updated_timestamp}}",
        "uuid": "{{purchase_payment_uuid}}",
        "version": "{{version_number}}",
        "custom_attributes": [],
        "custom_objects": []
      }
    ],
    "pagination": {
      "records": {{total_records}},
      "limit": {{limit_value}},
      "offset": {{offset_value}},
      "previous_page": "{{previous_page_url}}",
      "next_page": "{{next_page_url}}"
    }
  }
}

                    

Attribute	Type	Description
purchase_order	Object	Root object containing the purchase order and its associated payments.
purchase_payments	Array	List of all purchase payments linked to the purchase order.
status	String	Current status of the purchase payment (example: ACTIVE).
id	String	Unique identifier of the purchase payment.
origin	String	Indicates the source or origin of the payment entry.
purchase_payment_date	String (ISO 8601)	Date when the payment was made.
total_applied	String	Total payment amount applied to invoices related to the order.
purchase_order_id	String	Identifier of the purchase order this payment is associated with.
purchase_payment_note	String	Additional note or comment added to the payment record.
purchase_payment_applied	Array	Details of the payment applications (method, amount, and reference).
purchase_payment_applied.id	Integer	Unique identifier for the payment application record.
purchase_payment_applied.amount	Number	Amount applied in the specific transaction.
purchase_payment_applied.method	String	Method used for the payment (example: Cash, Bank Transfer).
purchase_payment_applied.processor	String	Payment processor handling the transaction.
purchase_payment_applied.reference	String	Reference number related to the payment method.
purchase_credit_applied	Array	Details of any credit notes applied against the payment.
purchase_credit_applied.id	String	Unique identifier for the applied credit note.
purchase_credit_applied.amount	Number	Amount of credit applied to the payment.
purchase_invoices	Array	Details of the invoices associated with the payment.
purchase_invoices.applied	Number	Amount from the payment applied to this invoice.
purchase_invoices.id	String	Unique identifier of the linked invoice.
purchase_invoices.due_date	String	Due date of the linked invoice.
purchase_invoices.issue_date	String	Issue date of the linked invoice.
purchase_invoices.outstanding	Number	Remaining amount due after the payment was applied.
purchase_invoices.total	Number	Total invoice amount.
created_by	String	Name of the user who created the record.
created_on	String (ISO 8601)	Timestamp indicating when the record was created.
last_updated_by	String	Name of the user who last updated the record.
last_updated_on	String (ISO 8601)	Timestamp indicating when the record was last updated.
uuid	String	Unique system-generated identifier for the purchase payment.
version	String	Version number of the purchase payment record.
custom_attributes	Array	Custom fields defined for the purchase payment (if any).
custom_objects	Array	Custom objects linked to the purchase payment (if any).
pagination	Object	Object containing pagination details for the retrieved data.
pagination.records	Integer	Total number of purchase payments found for the order.
pagination.limit	Integer	Number of records displayed per page.
pagination.offset	Integer	Number of records skipped before fetching results.
pagination.previous_page	String	URL for the previous page of data (if available).
pagination.next_page	String	URL for the next page of data (if available).

Retrieve Purchase Payments: /purchase-payments

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Purchase Payment Details: /purchase-payments/{purchase_payment_id}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Purchase Payments by Account: /accounts/{account_id}/purchase-payments

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Purchase Payments by Purchase Order: /purchase-orders/{purchase_order_id}/purchase-payments

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body