Skip to main content
GET
cURL

Field support per integration

Query parameters:
rawData
boolean
Supported response fields:
id
string
bookingProposalDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
bookingType
enum
Available options: INVOICE, BILL
contactName
string
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
currency
enum
The currency field supports ISO 4217 (3-letter codes). For details visit the Standardized Data section.
deliveryDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
dueDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
number
string
paidDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
status
enum
Available options: OPEN, PAID
totalGrossAmount
number
The endpoint only works with bookingProposalId that is associated with the following types:INVOICE, BILL, INVOICE_CREDIT_NOTE,BILL_CREDIT_NOTE
Query parameters:
rawData
boolean
Supported response fields:
id
string
bookingProposalDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
bookingType
enum
Available options : INVOICE, BILL, INVOICE_CREDIT_NOTE,BILL_CREDIT_NOTE
contactId
string
contactName
string
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
currency
enum
Available options (3-letter ISO 4217): EUR
deliveryDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
dueDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
lineItems
BookingProposalLineItem[]
number
string
status
enum
Available options : DRAFT, SUBMITTED, OPEN, PAID, VOIDED, OVERDUE
totalGrossAmount
number
updatedDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
Query parameters:
rawData
boolean
Supported response fields:
id
string
bookingProposalDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
bookingType
enum
Available options : INVOICE, BILL, CREDIT_NOTE, OTHER
contactId
string
contactName
string
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
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
files
string[]
dueDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
iban
string
number
string
paidDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
status
enum
Available options: DRAFT,SUBMITTED, OPEN, PAID,VOIDED
totalGrossAmount
number
updatedDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
vatId
string
Query parameters:
rawData
boolean
Supported response fields:
id
string
bookingProposalDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
bookingType
enum
Available options: INVOICE, BILL
contactId
string
contactName
string
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
currency
enum
The currency field supports ISO 4217 alpha-3 (3-letter codes). For details visits the Standardized Data section.
deliveryDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
dueDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
iban
string
lineItems
BookingProposalLineItem[]
number
string
paidDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
status
enum
Available options: DRAFT, SUBMITTED, OPEN, PARTIALLY_PAID, PAID
totalGrossAmount
number
updatedDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
vatId
string
Supported response fields:
id
string
required
bookingProposalDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
bookingType
enum
Available options: INVOICE, BILL
contactId
string
required
The contactId field represents the id of the contact associated with the booking proposal.
createdDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
currency
enum
The currency field supports ISO 4217 alpha-3 (3-letter codes). For details visits the Standardized Data section.
dueDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
files
string[]
lineItems
BookingLineItem[]
required
number
string
The number field represents the reference number for the booking proposal transaction.
status
enum
Available options: DRAFT, SUBMITTED, OPEN, PAID, VOIDED, CANCELLED
totalGrossAmount
number
updatedDate
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z

Headers

X-API-KEY
string
required

API key

Example:

"example value"

X-ACCOUNT-KEY
string
required

Account key

Example:

"example value"

Path Parameters

bookingProposalId
string
required

Query Parameters

companyId
string
environmentName
string
rawData
boolean

Response

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