Skip to main content
GET
cURL

Field support per integration

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:
boolean
Supported response fields:
string
string
string
string
number
string
number
enum
Available options (3-letter ISO 4217): ITEM, COMMENT, ACCOUNT, CHARGE, VALUE, RESOURCE, FIXED_ASSET
number
number
number
number
number
number
string
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. Please use the id field as the companyId.
Query parameters:
boolean
Supported response fields:
string
string
ISO-8601 date format, e.g., 2024-01-01T00:00:00Z
string
string
number
Note that quantity can be a decimal numeral.
number
number
number
number
number
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

Path Parameters

offerId
string
required
lineItemId
string
required

Query Parameters

companyId
string
environmentName
string
rawData
boolean

Response

200 - application/json
meta
object
data
object
Last modified on July 9, 2026