Retrieve Purchase Credit Note Application List: /purchase-credit-note-applications

Purpose

This API retrieves a paginated list of purchase credit note applications. A purchase credit note application represents the allocation of a supplier’s credit note against a purchase payment. It provides visibility into how credit balances are applied, including details such as the application date, applied amount, related credit note, and payment reference. This ensures accurate tracking of credit utilization within the procurement-to-payment lifecycle.

Use Case

This endpoint is used to monitor how supplier credit notes are applied against outstanding invoices. It supports reconciliation of supplier credits, validation of whether a credit note has been fully or partially applied, and the generation of audit and financial reports that track credit utilization. By exposing application-level details, the API helps organizations maintain transparency in credit management and ensures that overpayments and credit balances are properly accounted for.

Path Parameters

This endpoint does not require path parameters.

Query Parameters

Request Body

This is a GET request, so no request body is required.

Response

The response returns a list of purchase credit note application objects, each containing metadata such as the application date, applied amount, credit note ID, payment ID, creator details, system timestamps, UUID, and version. These records show how credit notes are linked to specific payments and provide a clear audit trail of credit usage. In addition, pagination metadata is included, detailing the total number of records, the applied limit, current offset, and navigation links for previous and next pages. This structure ensures efficient browsing and reporting across large datasets of credit note applications.

Response Body

Retrieve Specific Purchase Credit Note Application Details: /purchase-credit-note-applications/{purchase_credit_note_applications_uuid}

Purpose

This API retrieves the details of a single purchase credit note application using its unique UUID. A purchase credit note application represents the allocation of a supplier’s credit note against a purchase payment, ensuring transparency in how credit balances are utilized within the procurement-to-payment process.

Use Case

This endpoint is used to review the details of a specific credit note application for auditing, reconciliation, or reporting purposes. It supports workflows such as confirming the applied amount, validating the linkage between a credit note and its corresponding payment, and resolving discrepancies between payments and credits. By exposing transaction-level details, the API ensures accurate tracking of supplier credits and their application to outstanding invoices.

Path Parameters

Query Parametrs

This endpoint does not support query parameters.

Request Body

This is a GET request, so no request body is required.

Response

The response returns a single object containing complete details of the credit note allocation. This includes the application date, the amount applied, the associated credit note ID, and the linked purchase payment ID. Metadata such as the creator, system timestamps, UUID, and version are also provided, offering a clear audit trail of the credit note application. This structure ensures that organizations can accurately monitor and reconcile supplier credits at the transaction level.

Response Body

Retrieve Purchase Credit Note Applications by Purchase Invoice: /purchase-invoices/{purchase_invoice_id}/purchase-credit-note-applications

Purpose

This API retrieves all purchase credit note applications linked to a specific purchase invoice. A purchase credit note application represents the allocation of supplier credits that have been applied to payments against the invoice. By exposing these records, the endpoint ensures transparency in how credit balances are utilized to settle invoice outstanding amounts.

Use Case

This endpoint is used to review how supplier credits have been applied to a particular purchase invoice. It supports workflows such as validating invoice settlement through credit notes, reconciling credits with payments, and generating reports that highlight outstanding versus settled invoice amounts. By providing application-level details, the API helps organizations maintain accurate financial records and streamline reconciliation processes.

Path Parameters

Query Parameters

Request Body

This is a GET request, so no request body is required.

Response

The response returns a  object containing an array of purchase credit note applications. Each application includes details such as the application date, the applied amount, the associated credit note ID, the linked payment ID, and system metadata including creator, creation timestamp, UUID, and version. In addition, a pagination object is provided, which includes metadata about the result set such as the total number of records, the applied limit, the current offset, and navigation links for previous and next pages. This structure ensures efficient browsing and reporting across multiple credit note applications tied to a single invoice.

Response Body

Retrieve Specific Purchase Credit Note Details: /purchase-credit-notes/{purchase_credit_note_id}

Purpose

This API retrieves the details of a single purchase credit note using its unique identifier. A purchase credit note represents a supplier credit generated from an overpayment of a purchase invoice. It provides visibility into the credit note’s status, total amount, remaining balance, refund eligibility, and linkage to the original payment transaction.

Use Case

This endpoint is used to review and manage supplier credits. It supports workflows such as validating the creation of a credit note after an overpayment, reconciling outstanding balances, confirming whether a credit note is refundable, and tracking its application against future invoices. By exposing transaction-level details, the API ensures accurate monitoring of credit balances and supports compliance in financial reporting.

Path Parameters

Query Parameters

This endpoint does not support query parameters.

Request Body

This is a GET request, so no request body is required.

Response

The response returns a object containing complete details of the credit note. This includes the credit note ID, status, date of creation, total credited amount, and the remaining balance available for application. It also provides metadata such as refund eligibility, the linked payment ID, creator information, timestamps, UUID, version, and any custom attributes. This structure ensures that organizations can track the lifecycle of a credit note, from its creation through its application or refund, and integrate it into reconciliation and reporting processes.

Response Body

Retrieve All Purchase Credit Notes: /purchase-credit-notes

Purpose

This API retrieves a paginated list of all purchase credit notes available in the system. A purchase credit note represents a supplier credit generated from an overpayment or adjustment against a purchase invoice or payment transaction. These credits can be refunded, applied to future invoices, or used to reconcile supplier accounts. The endpoint provides essential details such as the credit note amount, remaining balance, refund eligibility, and audit metadata, ensuring transparency in credit management.

Use Case

This endpoint is used to review all existing purchase credit notes in the system. It supports workflows such as tracking refundable credits available for future purchases or refunds, validating balances for reconciliation, and integrating credit note data into supplier account summaries. The API also assists in financial reporting and auditing by providing visibility into supplier credits, ensuring that overpayments and adjustments are properly accounted for and applied.

Path Parameters

This endpoint does not have any path parameters.

Query Parameters

Request Body

No data is required for the request body.

Response

The response returns an  array containing multiple credit note objects. Each object includes metadata such as the credit note ID, status, creation date, total credited amount, remaining balance, refund eligibility, associated payment ID, creator details, timestamps, UUID, version, and any custom attributes. Pagination metadata is also included, providing information about the total number of records, applied limit, current offset, and navigation links for previous and next pages. This structure ensures efficient browsing and reporting across large sets of credit notes, enabling accurate reconciliation and streamlined financial management.

Response Body