Credit Note GET API Documentation

Endpoint: GET /api/v3/credit-notes/{credit_note_id}

Purpose

Retrieve the details of a specific credit note by its unique identifier. The response includes information such as the credit note's status, amount, related invoice, remaining balance, and custom attributes for additional metadata.

Use Case

This endpoint is used to fetch detailed information about a specific credit note, including its usage and remaining balance. For example, a business can check if a credit note is refundable or review its associated custom attributes for auditing purposes.

Path Parameters

Parameter	Type	Description
credit_note_id	String	Unique identifier of the credit note to retrieve.

Request

No data is required for the request body.

Response

The response provides comprehensive details about the credit note, including its status, amount, associated invoice and payment IDs, refundability, and a list of custom attributes. This information ensures accurate tracking and validation of credit notes.

                JSON
              

                      {
    "credit_note": {
        "status": "ACTIVE",
        "id": "CREDIT-NOTE-ID",
        "date": "YYYY-MM-DDTHH:MM:SSZ",
        "amount": "AMOUNT",
        "invoice_id": "INVOICE-ID",
        "remaining_balance": "REMAINING-BALANCE",
        "refundable": "true",
        "payment_id": "PAYMENT-ID",
        "custom_attributes": [
            {
                "name": "ATTRIBUTE-NAME",
                "value": "ATTRIBUTE-VALUE"
            }
        ],
        "custom_objects": [],
        "version": "VERSION-NUMBER",
        "created_by": "CREATOR-NAME",
        "created_on": "YYYY-MM-DDTHH:MM:SSZ",
        "updated_by": "UPDATER-NAME",
        "updated_on": "YYYY-MM-DDTHH:MM:SSZ",
        "uuid": "UUID-PLACEHOLDER",
        "account_id": "ACCOUNT-ID"
    }
}

                    

Endpoint: GET /api/v3/credit-note-applications

Purpose

Retrieve a list of credit note applications, including details about the date, amount applied, associated credit note and payment IDs, refund information, and remaining balances. This endpoint is useful for tracking how credit notes are applied to payments or refunds.

Use Case

Use this endpoint to review the history of credit note applications for auditing or reconciliation purposes. For instance, a business can identify which payments or refunds a credit note has been applied to and check the remaining balance.

Path Parameters

No path parameters for this endpoint.

Query Parameters

Parameter	Type	Description
limit	Integer	Specifies the maximum number of credit note application records to return in the response.
order_by	String	Determines the sort order; use asc for ascending or `desc` for descending.
offset	Integer	Defines the starting point for retrieving records, used for pagination.

Request

No data is required for the request body.

Response

The response includes a list of credit note applications, with each record detailing the amount applied, associated IDs (credit note, payment, refund), the date of application, and the remaining balance. Pagination metadata is also provided for navigating through the records.

                JSON
              

                      {
    "credit_note_applications": [
        {
            "date": "YYYY-MM-DDTHH:MM:SSZ",
            "amount": "APPLICATION-AMOUNT",
            "credit_note_id": "CREDIT-NOTE-ID",
            "payment_id": "PAYMENT-ID",
            "refund_id": "REFUND-ID",
            "remaining_balance": "REMAINING-BALANCE",
            "created_by": "CREATOR-NAME",
            "created_on": "YYYY-MM-DDTHH:MM:SSZ",
            "uuid": "UUID-PLACEHOLDER",
            "version": "VERSION-NUMBER"
        }
    ],
    "pagination": {
        "records": "TOTAL-RECORDS",
        "limit": "PAGE-LIMIT",
        "offset": "PAGE-OFFSET",
        "previous_page": "PREVIOUS-PAGE-URL",
        "next_page": "NEXT-PAGE-URL"
    }
}

                    

Endpoint: GET /api/v3/credit-note-applications/{uuid}

Purpose

Retrieve the details of a specific credit note application using its unique identifier. The response provides information about the application date, applied amount, related credit note, payment, refund, and the remaining balance.

Use Case

This endpoint is used to access detailed information about a single credit note application. For instance, a business can verify which payment or refund a specific credit note has been applied to and review the remaining balance.

Path Parameters

Parameter	Type	Description
uuid	String	Unique identifier of the credit note application

Request

No data is required for the request body.

Response

The response includes details of the credit note application, such as the application date, the amount applied, the associated credit note, payment, and refund IDs, as well as the remaining balance. This data allows for precise tracking and validation of credit note usage.

                JSON
              

                      {
    "credit_note_application": {
        "date": "YYYY-MM-DDTHH:MM:SSZ",
        "amount": "APPLICATION-AMOUNT",
        "credit_note_id": "CREDIT-NOTE-ID",
        "payment_id": "PAYMENT-ID",
        "refund_id": "REFUND-ID",
        "remaining_balance": "REMAINING-BALANCE",
        "created_by": "CREATOR-NAME",
        "created_on": "YYYY-MM-DDTHH:MM:SSZ",
        "uuid": "UUID-PLACEHOLDER",
        "version": "VERSION-NUMBER"
    }
}

                    

Endpoint: GET /api/v3/invoices/{invoice_id}/credit-note-applications

Purpose

Retrieve a list of credit note applications linked to a specific invoice. This provides insight into how credit notes have been applied to the invoice, detailing amounts, dates, and associated payment or refund IDs.

Use Case

This endpoint is used to track the application of credit notes against an invoice. For example, a business can review how much of a credit note has been applied, verify the remaining balance, and confirm associated payments or refunds.

Path Parameters

Parameter	Type	Description
invoice_id	String	Unique identifier of the invoice.

Query Parameters

Parameter	Type	Description
limit	Integer	Specifies the maximum number of credit note application records to return in the response.
order_by	String	Determines the sort order; use asc for ascending or `desc` for descending.
offset	Integer	Defines the starting point for retrieving records, used for pagination.

Request

No data is required for the request body.

Response

The response includes a list of credit note applications for the specified invoice. Each entry provides details such as the application date, applied amount, associated credit note, payment, and refund IDs, and the remaining balance. Pagination metadata is included for navigating large datasets.

                JSON
              

                      {
    "invoice": {
        "credit_note_applications": [
            {
                "date": "YYYY-MM-DDTHH:MM:SSZ",
                "amount": "APPLICATION-AMOUNT",
                "credit_note_id": "CREDIT-NOTE-ID",
                "payment_id": "PAYMENT-ID",
                "refund_id": "REFUND-ID",
                "remaining_balance": "REMAINING-BALANCE",
                "created_by": "CREATOR-NAME",
                "created_on": "YYYY-MM-DDTHH:MM:SSZ",
                "uuid": "UUID-PLACEHOLDER",
                "version": "VERSION-NUMBER"
            }
        ],
        "pagination": {
            "records": "TOTAL-RECORDS",
            "limit": "RESULT-LIMIT",
            "offset": "OFFSET-NUMBER",
            "previous_page": "PREVIOUS-PAGE-URL",
            "next_page": "NEXT-PAGE-URL"
        }
    }
}

                    