Skip to main content
GET
cURL

Field support per integration

Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
string
enum
Available options: ASC, DESC
boolean
Supported response fields:
string
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
enum
Available options: OPEN, PAID
number
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:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
Address[]
string
For date format details visit the Standardized Data section
string
string
enum
The currency field supports ISO 4217 (3-letter codes).For details visit the Standardized Data section.
string
For date format details visit the Standardized Data section
LineItem[]
enum
Available options: PENDING, PAID, CANCELED, NO_OPEN_ITEM, UNKNOWN
string
enum
Available options: DRAFT, SUBMITTED, OPEN, PAID, VOIDED, CORRECTIVE
number
number
number
number
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 parameter companyId is correctly populated. You can obtain this value by using the GET Companies endpoint available under the Authentication section.
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
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
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
string
string
string
string
enum
Available options: OPEN, PAID, OVERDUE
number
number
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
string
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
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
number
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
string
enum
Available options: ASC, DESC
boolean
Supported response fields:
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
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
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
enum
Available options: DRAFT, OPEN, PAID, OVERDUE, VOIDED, SUBMITTED
number
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
string
enum
Available options: ASC, DESC
boolean
Supported response fields:
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
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
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
enum
Available options: DRAFT,SUBMITTED, OPEN, PAID,VOIDED
number
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
enum
The currency field supports ISO 4217 alpha-3 (3-letter codes). For details visits the Standardized Data section.
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
enum
Available options: DRAFT, SUBMITTED, OPEN, PARTIALLY_PAID, PAID
number
number
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
Address[]
string
For date format details visit the Standardized Data section
string
string
string
For date format details visit the Standardized Data section
enum
The currency field supports ISO 4217 alpha-3 (3-letter codes). For details visit the Standardized Data section.
string
For date format details visit the Standardized Data section
string
For date format details visit the Standardized Data section
BillLineItem[]
enum
Available options: PENDING, PAID, NO_OPEN_ITEM, CREDIT_NOTE_CLEARED, CLEARED_WITH_CREDIT_NOTE, UNKNOWN
string
string
For date format details visit the Standardized Data section
enum
Available options: DRAFT, SUBMITTED, DOCUMENT_CREATED, OPEN, VOIDED
number
number
number
string
For date format details visit the Standardized Data section

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
orderDir
enum<string>
Available options:
ASC,
DESC
orderField
enum<string>
Available options:
billlDate,
billNumber,
createdDate,
updatedDate
companyId
string
environmentName
string
lastModifiedAt
number
billDateFrom
number
status
string
rawData
boolean

Response

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