Purchase Credit Note Applications GET API Documentation

Purpose

This API retrieves a 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 details such as application date, applied amount, related credit note, and payment reference.

Use Case

To view how supplier credit notes are applied against purchase payments.
To reconcile supplier credits and outstanding payments.
To generate audit and financial reports that track credit utilization.
To validate whether a credit note has been fully or partially applied.

Path Parameters

This endpoint does not require path parameters.

Query Parameters

Category	Parameter / Field	Type	Operators	Description	Example
Sorting	order_by	string	–	Field name to sort results.	order_by=created_on
	direction	string	–	Sorting direction (asc or desc).	direction=desc
Pagination	records	integer	–	Total number of records returned in this result set.	25
	limit	integer	–	Maximum number of records returned per page.	limit=10
	offset	integer	–	Number of records skipped before starting results.	offset=20
	previousPage	string	–	URL or token for the previous page (if available).	previousPage=/purchase-credit-note-applications?limit=10&offset=10
	nextPage	string	–	URL or token for the next page (if available).	nextPage=/purchase-credit-note-applications?limit=10&offset=30
Filtering	uuid	string	eq, ne, contain, not_contain	Filter by unique identifier of the purchase credit note application.	purchase-credit-note-applications/uuid eq 'c7e2a1f9-6d8a-4b0d-9af2-1f2b12345678'

Request Body

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

Response

The response contains two main objects: purchase_refunds, which is an array of refund objects providing detailed information about each purchase refund, including unique identifiers, status, refund date, alternate date (for timezone/local adjustments), refunded amount, reference details, payment method, credit note ID, creator and updater information, system timestamps, version, and custom attributes; and pagination, which provides metadata about the paginated results such as the total number of records, the applied limit, current offset, and links to the previous and next pages to ensure efficient navigation of large datasets.

Response Body

                JSON
              

                      {
    "purchase_credit_note_applications": [
        {
            "date": "DATE",
            "amount": "AMOUNT",
            "credit_note_id": "CREDIT_NOTE_ID",
            "payment_id": "PAYMENT_ID",
            "created_by": "CREATED_BY",
            "created_on": "CREATED_ON",
            "uuid": "UUID",
            "version": "VERSION"
        }
    ],
    "pagination": {
        "records": "RECORDS",
        "limit": "LIMIT",
        "offset": "OFFSET",
        "previous_page": "PREVIOUS_PAGE",
        "next_page": "NEXT_PAGE"
    }
}
                    

Attribute	Type	Description
date	string (date-time)	The date when the credit note was applied to a payment (ISO 8601 format).
amount	string (decimal)	The amount of the credit note applied.
credit_note_id	string	Unique identifier of the purchase credit note.
payment_id	string	Unique identifier of the purchase payment to which the credit note was applied.
created_by	string	Name or identifier of the user who created the application.
created_on	string (date-time)	Timestamp when the application was created.
uuid	string (UUID)	Unique universal identifier for this application record.
version	string	Version number of the record for concurrency control.

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 to a purchase payment.

Use Case

To fetch details of a specific credit note application for auditing or reporting.
To confirm the applied amount and associated credit note/payment reference.
To validate and reconcile supplier credits at the transaction level.
To support error resolution when discrepancies arise between payments and credits.

Path Parameters

Parameter	Type	Description
purchase_credit_note_application_uuid	string (UUID)	Unique identifier of the purchase credit note application record to retrieve.

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 contains a single object, purchase credit note application, which includes complete details of the credit note allocation. This object provides information such as the application date, the amount applied, the associated credit note ID, the linked purchase payment ID, and system metadata (creator, timestamps, UUID, and version).

Response Body

                JSON
              

                      {
    "purchase_credit_note_application": {
        "date": "DATE",
        "amount": "AMOUNT",
        "credit_note_id": "CREDIT_NOTE_ID",
        "payment_id": "PAYMENT_ID",
        "created_by": "CREATED_BY",
        "created_on": "CREATED_ON",
        "uuid": "UUID",
        "version": "VERSION"
    }
}
                    

Attribute	Type	Description
date	string (date-time)	The date when the credit note was applied to a payment (ISO 8601 format).
amount	string (decimal)	The amount of the credit note applied.
credit_note_id	string	Unique identifier of the purchase credit note associated with this application.
payment_id	string	Unique identifier of the purchase payment to which the credit note was applied.
created_by	string	Name or identifier of the user who created the application.
created_on	string (date-time)	Timestamp when the application was created.
uuid	string (UUID)	Unique universal identifier for this application record.
version	string	Version number of the record for concurrency control.

Purpose

This API retrieves all purchase credit note applications linked to a specific purchase invoice. Each application represents a supplier credit that has been applied to payments against the invoice.

Use Case

To review how supplier credits have been applied to a specific purchase invoice.
To validate invoice settlement using credit notes.
To assist in reconciliation between invoices, payments, and credit notes.
To generate reports showing outstanding vs. settled invoice amounts.

Path Parameters

Parameter	Type	Description
purchase_invoice_id	string	Unique identifier of the purchase invoice for which to retrieve credit note applications.

Query Parameters

Parameter	Type	Description
limit	integer	Maximum number of records to return per request (default = 20).
offset	integer	Number of records to skip before starting to return results (for pagination).

Request Body

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

Response

The response contains a purchase invoice object. Inside it, the purchase credit note applications array lists all credit note applications applied to the specified purchase invoice. Each application includes details such as the application date, the applied amount, associated credit note ID, linked payment ID, and system metadata (creator, creation timestamp, UUID, and version). Additionally, the pagination object provides metadata about the result set, including the total number of records, limit, offset, and navigation links for previous and next pages.

Response Body

                JSON
              

                      {
    "purchase_invoice": {
        "purchase_credit_note_applications": [
            {
                "date": "DATE",
                "amount": "AMOUNT",
                "credit_note_id": "CREDIT_NOTE_ID",
                "payment_id": "PAYMENT_ID",
                "created_by": "CREATED_BY",
                "created_on": "CREATED_ON",
                "uuid": "UUID",
                "version": "VERSION"
            }
        ],
        "pagination": {
            "records": "RECORDS",
            "limit": "LIMIT",
            "offset": "OFFSET",
            "previous_page": "PREVIOUS_PAGE",
            "next_page": "NEXT_PAGE"
        }
    }
}
                    

Attribute	Type	Description
date	string (date-time)	The date the credit note was applied (ISO 8601 format).
amount	string (decimal)	Amount of the credit note applied to the invoice.
credit_note_id	string	Unique identifier of the purchase credit note.
payment_id	string	Unique identifier of the purchase payment where the credit note was applied.
created_by	string	User who created the application.
created_on	string (date-time)	Timestamp when the record was created.
uuid	string (UUID)	Unique universal identifier for this record.
version	string	Version number of the record for concurrency control.

Purpose

This API retrieves detailed information about a specific purchase credit note using its unique identifier. A purchase credit note represents a supplier-issued credit, often used to offset payments against purchase invoices or refunded directly.

Use Case

To view the full details of a specific supplier credit note.
To validate the remaining balance available for application or refund.
To audit and track supplier-issued credits and their lifecycle.
To support reconciliation between supplier payments, invoices, and credit notes.

Path Parameters

Parameter	Type	Required	Description
purchase_credit_note_id	string	Yes	Unique identifier of the purchase credit note to retrieve.

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 purchase_credit_note object containing all the relevant details of the credit note. This includes its status (example: ACTIVE), unique ID, issue date, total credit amount, and the remaining balance available. It also specifies whether the credit note is refundable, along with its linked payment ID if applicable. Metadata is provided, including creator, timestamps, last updated information, UUID, version number, and any custom_attributes defined for this credit note.

Response Body

                JSON
              

                      {
    "purchase_credit_note": {
        "status": "STATUS",
        "id": "PURCHASE_CREDIT_NOTE_ID",
        "date": "DATE",
        "amount": "AMOUNT",
        "remaining_balance": "REMAINING_BALANCE",
        "refundable": "REFUNDABLE",
        "payment_id": "PAYMENT_ID",
        "created_by": "CREATED_BY",
        "created_on": "CREATED_ON",
        "last_updated_by": "LAST_UPDATED_BY",
        "last_updated_on": "LAST_UPDATED_ON",
        "uuid": "UUID",
        "version": "VERSION",
        "custom_attributes": []
    }
}
                    

Attribute	Type	Description
status	string	Status of the purchase credit note (example: ACTIVE, INACTIVE).
id	string	Unique identifier of the purchase credit note.
date	string (date-time)	Date when the credit note was issued (ISO 8601 format).
amount	string (decimal)	Total amount of the credit note.
remaining_balance	string (decimal)	Balance left on the credit note that can be applied to invoices or refunded.
refundable	string (boolean as string)	Indicates whether the credit note is refundable (true or false).
payment_id	string	Identifier of the payment associated with this credit note (if any).
created_by	string	User who created the credit note.
created_on	string (date-time)	Timestamp when the credit note was created.
last_updated_by	string	User who last updated the credit note (empty if never updated).
last_updated_on	string (date-time)	Timestamp when the credit note was last updated.
uuid	string (UUID)	Unique universal identifier for the credit note record.
version	string	Version number for concurrency control.
custom_attributes	array	List of custom attributes attached to the credit note (empty if none exist).

Purpose

This API retrieves a list of all purchase credit notes available in the system. Each credit note represents an issued credit against a supplier payment or purchase transaction, typically used for refunding overpayments, returns, or adjustments. The API provides key details for every credit note, such as its amount, remaining balance, refund eligibility, and audit information. It supports pagination for efficient data retrieval.

Use Case

Retrieve all existing purchase credit notes in the system.
View credit note details such as amount, remaining balance, and associated payment.
Track refundable credits available for future purchases or refunds.
Integrate credit note data into supplier account summaries and reconciliation reports.
Support financial reporting and auditing by providing visibility into supplier credits.

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 list of all purchase credit notes that match the specified filters. Each credit note object includes information about its creation, total amount, balance, refund eligibility, associated payment, and audit trail (creator and timestamps). Pagination metadata is included to facilitate navigation through large result sets. This allows financial teams and developers to programmatically manage and analyze supplier credit information for transaction reconciliation and refund operations.

Response Body

                JSON
              

                      {
  "purchase_credit_notes": [
    {
      "status": "{{status}}",
      "id": "{{credit_note_id}}",
      "date": "{{credit_note_date}}",
      "amount": "{{credit_note_amount}}",
      "remaining_balance": "{{remaining_balance_amount}}",
      "refundable": "{{refundable_flag}}",
      "payment_id": "{{linked_payment_id}}",
      "created_by": "{{created_by_user}}",
      "created_on": "{{created_timestamp}}",
      "last_updated_by": "{{last_updated_user}}",
      "last_updated_on": "{{last_updated_timestamp}}",
      "uuid": "{{credit_note_uuid}}",
      "version": "{{version_number}}",
      "custom_attributes": [
        {
          "name": "{{custom_attribute_name}}",
          "value": "{{custom_attribute_value}}"
        }
      ]
    }
  ],
  "pagination": {
    "records": "{{total_records}}",
    "limit": "{{limit_value}}",
    "offset": "{{offset_value}}",
    "previous_page": "{{previous_page_url}}",
    "next_page": "{{next_page_url}}"
  }
}

                    

Attribute	Type	Description
purchase_credit_notes	Array	List of all purchase credit notes retrieved.
status	String	Current status of the credit note (example: ACTIVE, INACTIVE).
id	String	Unique identifier of the credit note.
date	String (ISO 8601)	Date when the credit note was issued.
amount	String	Total credited amount.
remaining_balance	String	Remaining available balance that can be applied or refunded.
refundable	String	Indicates whether the credit note is eligible for refund (true or false).
payment_id	String	Reference to the payment or transaction linked to this credit note.
created_by	String	Name of the user who created the credit note record.
created_on	String (ISO 8601)	Timestamp indicating when the credit note was created.
last_updated_by	String	Name of the user who last updated the record.
last_updated_on	String (ISO 8601)	Timestamp indicating the last modification.
uuid	String	System-generated unique identifier for the credit note.
version	String	Version number of the record, incremented on updates.
custom_attributes	Array	List of any user-defined attributes linked to the credit note.
custom_attributes.name	String	Name of the custom attribute.
custom_attributes.value	String	Value assigned to the custom attribute.
pagination	Object	Object containing pagination details for the result set.
pagination.records	Integer	Total number of credit notes retrieved.
pagination.limit	Integer	Number of records displayed per page.
pagination.offset	Integer	Number of records skipped before retrieving the current set.
pagination.previous_page	String	URL of the previous page (if applicable).
pagination.next_page	String	URL of the next page (if applicable).

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

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

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

Purpose

Use Case

Path Parameters

Query Parametrs

Request Body

Response

Response Body

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

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

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

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

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

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body