Skip to main content
GET
List credit notes

Authorizations

Authorization
string
header
required

Query Parameters

s
string

Filter credit notes with a JSON-encoded condition passed as a string in the URL — ?s={"field":{"$operator":value}} — and combine conditions with $and / $or.

Operators$eq equals · $ne not equals · $gt $gte $lt $lte range · $between [min, max] · $cont $starts $ends text match · $in $notin value list · $isnull $notnull null check. Append L for case-insensitive text match ($contL, $startsL, …). Shorthand: {"field": value} is the same as {"field": {"$eq": value}}. Dates accept YYYY-MM-DD or full ISO 8601 (2026-06-01T00:00:00.000Z); filtering an unlisted field returns 400.

Filterable fields

status values: available, deducted, disputed, recovery. Any other value returns 400, as do the text-matching and L-suffixed operators; null is read as $isnull. A list of values is only accepted under $in, $notin, $between and $or.

Examples

Example:

"{\"updatedAt\":{\"$gte\":\"2026-06-01T00:00:00.000Z\"}}"

page
integer

The page number to retrieve starting at 1

sort
string

Sort the results as field,DIRECTION, where DIRECTION is ASC or DESC?sort=updatedAt,DESC. Repeat the parameter to sort by several fields, applied in order. When omitted, results are sorted by updatedAt,DESC. Sorting on an unlisted field returns 400.

Sortable fields

id · createdAt · updatedAt

Example:

"updatedAt,DESC"

Response

List of credit notes

data
object[]
count
integer
total
integer
page
integer
pageCount
integer