Skip to main content
GET
/
payments
/
credit-notes
Get All Credit Notes
curl --request GET \
  --url https://api.rootfi.dev/v3/payments/credit-notes \
  --header 'api_key: <api-key>'
{
  "data": [
    {
      "rootfi_id": 157,
      "rootfi_deleted_at": null,
      "rootfi_created_at": "2024-01-22T05:07:31.465Z",
      "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
      "rootfi_company_id": 1089,
      "platform_id": "cn_123456",
      "contact_id": "cus_123456",
      "document_number": "CN-001",
      "total_amount": 110,
      "total_discount": 10,
      "remaining_credit": 110,
      "tax_amount": 10,
      "shipping_amount": 5,
      "posted_date": "2024-01-22T05:07:31.000Z",
      "currency_id": "USD",
      "memo": "Credit note for returned items",
      "status": "SUBMITTED",
      "invoice_ids": [
        "inv_123456"
      ],
      "created_at": "2024-01-22T05:07:31.000Z",
      "updated_at": "2024-01-22T05:07:31.000Z"
    }
  ],
  "prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
  "total_count": 123
}
The Credit Notes Data Model is designed to streamline the management and retrieval of credit note information across various payments platforms.

Authorizations

​
api_key
string
header
required

Query Parameters

​
limit
integer | null

The number of credit notes you want to retrieve

​
next
string | null

The next page of objects to retrieve

​
prev
string | null

The previous page of objects to retrieve

​
select
string | null

Comma separated fields to select. Supported values are raw_data, data_hash

​
rootfi_updated_at[gte]
string | null

Filter by rootfi_updated_at Greater than or Equal To.

​
rootfi_company_id[eq]
integer | null

Filter by rootfi_company_id. You can filter by any field using this syntax field_name[operator]

​
include_deleted_records
string | null

Include deleted records. By default, deleted records are not included. Supported values are true and false

​
return_count
string | null

Return the count of the objects. Supported values are true and false

​
sort[rootfi_created_at]
enum<string> | null

Sort by rootfi_created_at

Available options:
ASC,
DESC
​
sort[rootfi_updated_at]
enum<string> | null

Sort by rootfi_updated_at

Available options:
ASC,
DESC

Response

The data of the credit notes endpoint.

​
data
paymentsCreditNotesObject · object[]
required
​
prev
string | null

The previous page of objects to retrieve

​
next
string | null

The next page of objects to retrieve

​
total_count
integer | null

The total count of the objects