Purchase Refund GET API Documentation

Purpose

This API retrieves a list of purchase refunds recorded in the system. It provides detailed information about each refund, including refund ID, status, date, payment method, credit note association, creator details, versioning, and any attached custom attributes. It also supports pagination for handling large datasets efficiently.

Use Case

To display a list of purchase refunds in an accounting or ERP system.
To reconcile supplier refund transactions against purchase records.
To fetch refunds for reporting, auditing, and financial analysis.
To retrieve refund details for integration with payment reconciliation or expense management systems.

Path Parameters

This endpoint does not use path parameters.

Query Parameters

Parameter	Type	Description
limit	int	Number of records to return per request (default: 20).
offset	int	Number of records to skip for pagination.

Request Body

This endpoint does not require a request body.

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 time-zone/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_refunds": [
        {
            "status": "STATUS",
            "id": "PURCHASE_REFUND_ID",
            "date": "DATE",
            "alternate_date": "ALTERNATE_DATE",
            "amount": "AMOUNT",
            "reference": "REFERENCE",
            "note": "NOTE",
            "payment_method": "PAYMENT_METHOD",
            "payment_processor": "PAYMENT_PROCESSOR",
            "credit_note_id": "CREDIT_NOTE_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": []
        }
    ],
    "pagination": {
        "records": "RECORDS",
        "limit": "LIMIT",
        "offset": "OFFSET",
        "previous_page": "PREVIOUS_PAGE",
        "next_page": "NEXT_PAGE"
    }
}
                    

Attribute	Type	Description
status	string	Status of the refund (ACTIVE, INACTIVE).
id	string	Unique refund identifier (human-readable).
date	string (ISO 8601)	Date and time when the refund was issued.
alternate_date	string (ISO 8601)	Alternate localized date for the refund.
amount	string	Amount refunded, represented as a decimal string.
reference	string	Reference number or code related to the refund (if any).
note	string	Additional notes regarding the refund.
payment_method	string	Method of payment used for refund (example: Cash, Bank Transfer).
payment_processor	string	Processor through which refund was handled (example: Cash, PayPal).
credit_note_id	string	Associated credit note ID for the refund.
created_by	string	User who created the refund entry.
created_on	string (ISO 8601)	Timestamp when refund was created.
last_updated_by	string	User who last updated the refund record.
last_updated_on	string (ISO 8601)	Timestamp of the last update.
uuid	string (UUID)	System-generated unique identifier for the refund.
version	string	Version number of the refund record.
custom_attributes	array	List of custom attributes associated with the refund (empty if none).

Purpose

This API retrieves detailed information about a specific purchase refund using its unique identifier. It provides all metadata related to the refund including amount, payment details, associated credit note, timestamps, creator information, and custom attributes.

Use Case

To fetch detailed information about a particular purchase refund for display in dashboards or reports.
To verify refund details during reconciliation.
To retrieve refund records for auditing, dispute resolution, or payment tracking.
To integrate refund details into third-party financial systems.

Path Parameters

Parameter	Type	Required	Description
purchase_refund_id	string	Yes	Unique identifier of the purchase refund.

Query Parameters

This endpoint does not accept query parameters.

Request Body

This endpoint does not require a request body.

Response

The response contains a single object called purchase_refund, which provides detailed information about the refund. It includes identifiers, refund amount, reference information, payment method and processor, association with a credit note, creator and updater metadata, system-generated UUID, versioning information, and any associated custom attributes.

Response Body

                JSON
              

                      {
    "purchase_refund": {
        "status": "STATUS",
        "id": "PURCHASE_REFUND_ID",
        "date": "DATE",
        "alternate_date": "ALTERNATE_DATE",
        "amount": "AMOUNT",
        "reference": "REFERENCE",
        "note": "NOTE",
        "payment_method": "PAYMENT_METHOD",
        "payment_processor": "PAYMENT_PROCESSOR",
        "credit_note_id": "CREDIT_NOTE_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 refund (ACTIVE, INACTIVE).
id	string	Human-readable refund identifier.
date	string (ISO 8601)	Date and time when the refund was issued.
alternate_date	string (ISO 8601)	Alternate localized date for the refund.
amount	string	Amount refunded, represented as a decimal string.
reference	string	Reference number or code associated with the refund.
note	string	Additional notes about the refund.
payment_method	string	Method of payment used (example: Cash, Bank Transfer).
payment_processor	string	Payment processor used (example: Cash, PayPal).
credit_note_id	string	Identifier of the associated credit note.
created_by	string	User who created the refund record.
created_on	string (ISO 8601)	Timestamp when refund was created.
last_updated_by	string	User who last updated the refund record.
last_updated_on	string (ISO 8601)	Timestamp of the last update.
uuid	string (UUID)	System-generated unique identifier for the refund.
version	string	Version number of the refund record.
custom_attributes	array	List of custom attributes related to the refund (empty if none).

Purpose

This API retrieves a paginated list of purchase refunds associated with a specific account. It provides refund details such as refund ID, amount, dates, payment details, linked credit note, and metadata like creator, timestamps, and custom attributes.

Use Case

To fetch all purchase refunds belonging to a specific account.
To display refunds in customer/account dashboards.
To reconcile refunds during accounting or auditing processes.
To integrate account-specific refund records into ERP or financial systems.

Path Parameters

Parameter	Type	Required	Description
account_id	string	Yes	Unique identifier of the account for which purchase refunds need to be retrieved.

Query Parameters

Parameter	Type	Required	Description
limit	int	No	Number of records to return per page (default: 20).
offset	int	No	Number of records to skip before starting to return results (default: 0).

Request Body

This endpoint does not require a request body.

Response

The response returns an account object, which contains a purchase refunds array and pagination details. Each refund record includes its identifier, refund amount, timestamps, references, payment details, linked credit note ID, creator and updater metadata, version, and any associated custom attributes. Pagination ensures that large sets of refund records can be retrieved in multiple requests.

Response Body

                JSON
              

                      {
    "account": {
        "purchase_refunds": [
            {
                "status": "STATUS",
                "id": "PURCHASE_REFUND_ID",
                "date": "DATE",
                "alternate_date": "ALTERNATE_DATE",
                "amount": "AMOUNT",
                "reference": "REFERENCE",
                "note": "NOTE",
                "payment_method": "PAYMENT_METHOD",
                "payment_processor": "PAYMENT_PROCESSOR",
                "credit_note_id": "CREDIT_NOTE_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": []
            }
        ],
        "pagination": {
            "records": "RECORDS",
            "limit": "LIMIT",
            "offset": "OFFSET",
            "previous_page": "PREVIOUS_PAGE",
            "next_page": "NEXT_PAGE"
        }
    }
}
                    

Attribute	Type	Description
status	string	Status of the refund (ACTIVE, INACTIVE).
id	string	Human-readable refund identifier.
date	string (ISO 8601)	Date and time when the refund was issued.
alternate_date	string (ISO 8601)	Alternate localized date for the refund.
amount	string	Refund amount, represented as a decimal string.
reference	string	Reference number or code associated with the refund.
note	string	Additional notes about the refund.
payment_method	string	Method of payment used (example: Cash, Bank Transfer).
payment_processor	string	Payment processor used (example: Cash, PayPal).
credit_note_id	string	Identifier of the associated credit note.
created_by	string	User who created the refund record.
created_on	string (ISO 8601)	Timestamp when refund was created.
last_updated_by	string	User who last updated the refund record.
last_updated_on	string (ISO 8601)	Timestamp of the last update.
uuid	string (UUID)	System-generated unique identifier for the refund.
version	string	Version number of the refund record.
custom_attributes	array	List of custom attributes related to the refund (empty if none).

Retrieve Purchase Refund List: /purchase-refunds

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Specific Purchase Refund Details: /purchase-refunds/{purchase_refund_id}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Purchase Refund List for an Account: /accounts/{account_id}/purchase-refunds

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body