Skip to main content
GET
/
external
/
creditNotes
Handles GET requests for the /creditNotes route
curl --request GET \
  --url https://api.valyx.com/external/creditNotes \
  --header 'X-Valyx-Signature: <x-valyx-signature>'
{}

Headers

X-Valyx-Signature
string
required

Auth key for fetching ledger entries

Query Parameters

startDate
string

Fetch credit notes created on or after this date

endDate
string

Fetch credit notes created on or before this date

minAmount
number

Fetch credit notes with total amount >= this amount

maxAmount
number

Fetch credit notes with total amount <= this amount

creditNoteNumber
string[]

Exact credit note numbers to search for

invoiceNumber
string[]

Invoice number reference against which credit note was created

customerId
string[]

Fetch credit notes only for these customers

ownerId
string[]

Fetch credit notes only for these internal stakeholders

type
string[]

Fetch credit notes which are of these types

status
string[]

Fetch credit notes which are of these status

page
integer

Page number for pagination.

pageSize
integer

Page size for pagination.

currencies
string[]

Currencies

Response

200 - application/json

Success

The response is of type object.