Skip to main content
GET
cURL

Field support per integration

Query parameters:
limit
enum
Available options: 5, 10, 20, 50, 100
page
number
rawData
boolean
Supported response fields:
id
string
createdDate
string
For date format details visit the Standardized Data section
creditNoteDate
string
For date format details visit the Standardized Data section
creditNoteNumber
string
paymentStatus
enum
Available options: PENDING, PARTLY_PAID, PAID
status
enum
Available options: OPEN, PAID
totalGrossAmount
number
Query parameters:
limit
enum
Available options: 5, 10, 20, 50, 100
page
number
filter
string
rawData
boolean
Supported response fields:
id
string
contactId
string
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
creditNoteDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
creditNoteNumber
string
currency
enum
status
enum
Available options: DRAFT, OPEN, PAID, VOIDED
totalGrossAmount
number
updatedDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
If you’re not using the Interactive Authentication Flow, make sure the query parameters environmentName and companyId are correctly populated. You can obtain these values by using the GET Environments and GET Companies endpoints available under the Authentication section.
Query parameters:
limit
enum
Available options: 5, 10, 20, 50, 100
page
number
filter
string
rawData
boolean
Supported response fields:
id
string
addresses
Address[]
contactId
string
creditNoteDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
creditNoteNumber
string
currency
enum
Available options (3-letter ISO 4217):
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GQE, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZM, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SYP, SZL, THB, TJS, TMT, TND, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEB, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMK, ZWR
paymentTermId
string
status
enum
Available options: DRAFT, OPEN, SUBMITTED, VOIDED, CORRECTIVE, PAID
totalDiscountAmount
number
totalGrossAmount
string
totalNetAmount
string
totalTaxAmount
string
updatedDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Query parameters:
limit
enum
Available options: 5, 10, 20, 50, 100
page
number
filter
string
rawData
boolean
Supported response fields:
id
string
addresses
Address[]
contactId
string
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
creditNoteDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
creditNoteLines
LineItem[]
creditNoteNumber
string
currency
enum
Available options (3-letter ISO 4217): AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GQE, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZM, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SYP, SZL, THB, TJS, TMT, TND, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEB, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMK, ZWR
paymentStatus
enum
Available options: NO_OPEN_ITEM, PENDING, PAID, CREDIT_NOTE_CLEARED, UNKNOWN,
status
enum
Available options: DRAFT, DOCUMENT_CREATED,OPEN, VOIDED
totalGrossAmount
number
totalNetAmount
number
updatedDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Query parameters:
limit
enum
Available options: 5, 10, 20, 50, 100
page
number
filter
string
rawData
boolean
Supported response fields:
id
string
addresses
Address[]
contactId
string
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
creditNoteDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
creditNoteLines
LineItem[]
Note: This array is always empty for the list endpoint. Line items are only available when retrieving a single credit note by ID.
creditNoteNumber
string
currency
enum
The currency field supports ISO 4217 (3-letter codes). For details visits the Standardized Data section.
reference
string
status
enum
Available options: DRAFT, OPEN, PARTIALLY_PAID, PAID
taxRule
enum
Available options: NET, TAXFREE, INTRACOMMUNITY_SERVICE, EXPORT_SERVICE, REVERSE_CHARGE, SMALL_BUSINESS_EXEMPTION, NON_DOMESTIC_SERVICE, OSS_GOODS, OSS_ELECTRONIC_SERVICES, OSS_SERVICES
totalDiscountAmount
number
totalGrossAmount
number
totalNetAmount
number
totalTaxAmount
number
updatedDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

Headers

X-API-KEY
string
required

API key

X-ACCOUNT-KEY
string
required

Account key

Query Parameters

page
number
limit
enum<number>
Available options:
5,
10,
20,
50,
100
companyId
string
environmentName
string
lastModifiedAt
string
rawData
boolean

Response

200 - application/json
meta
object
data
object[]
Last modified on July 14, 2026