Invoices
The Invoice object represents an invoice generated in the ERP system.
This object contains the following attributes:
id
string
The unique identifier of the invoice. No nesting exists for this identifier.
Example: INV-123-567-321
billingType
enum
The type of billing. Possible values are Automated or
 Manual. The values are based on the source of the linked statement, such as a manual upload or journal (automated).
status
enum
The status of the invoice. Possible values are: Issued,
 Paid,
 or Overdue.
currency
string
The invoice currency.
Example: EUR
client
A reference to the Client Account object.
Example:
{
  "id": "ACC-1234-4444",
  "name": "Best LLC",
  "icon": "/static/ACC-1234-4444/account.png"
}   buyer
A reference to the Buyer object.
Example:
{
  "id": "BUY-3731-7971",
  "name": "Adam Ruszczak",
  "icon": "/static/BUY-3731-7971/icon.png"
}vendor
A reference to the Vendor Account object.
Example:
{
    "id": "ACC-1234-1234",
    "name": "Microsoft",
    "icon": "/static/ACC-1234-1234/account.png"
}seller
A reference to the Seller object.
Example:
{
    "id": "SEL-9121-8944",
    "name": "Software LN",
    "icon": "/static/SEL-9121-8944/icon.png"
}product
A reference to the Product object.
Example:
{
    "id": "PRD-1111-1111-1111",
    "name": "Microsoft Office 365 NCE",
    "icon": "/static/PRD-1111-1111-1111/logo.png"
}agreement
A reference to the Agreement object.
Example:
{
    "id": "AGR-2119-4550-8674-5962",
    "name": "Microsoft Office 365 for My Company"
}licensee
A reference to the Licensee object.
Example:
{
    "id": "LCE-9625-9634",
    "name": "John Smith",
    "icon": "/static/LCE-9625-9634/icon.png"
}erpData
The invoice fields from the ERP system.
Example:
{
  "erpId": "DE-SCO-1234567",
  "documentNo": "4564564",
  "documentDate": "2025-01-15T12:05:34.087Z",
  "postingDate": "2025-01-15T16:45:24.123Z",
  "dueDate": "2025-02-10T12:05:34.087Z",
  "balanceDue": 123.23,
  "invoiceTotal": 123.23
}price
statementPriceSummary
The invoice price summary with aggregated price values for all invoice charges.
The StatementPriceSummary object inherits from PriceSummary and adds tax-related properties: TotalST and TotalGT
Note that not all fields are visible to all actors.
Example:
{
  "totalPP": 229.8,
  "markup": 0.5013,
  "margin": 0.3339,  
  "totalSP": 356.57,
  "totalST": 55,
  "totalGT": 411.57
}ERP Invoice Data
This object contains the following attributes:
erpId
string
Identifier in the ERP system.
Example: DE-SCO-1234567
documentNo
string
The document number.
Example: 4564564
documentDate
dateTime
The document date.
Example: 2025-01-15T12:05:34.087Z
postingDate
dateTime
The posting date.
Example: 2025-01-15T16:45:24.123Z
dueDate
dateTime
The due date.
Example: 2025-02-10T12:45:34.087Z
balanceDue
decimal
The balance due.
Example: 123.23
invoiceTotal
decimal
The invoice total.
Example: 123.23
Last updated
Was this helpful?
