Statement

The Statement object represents entries generated in the scope of an agreement from the corresponding ledger.

Statements are visible to clients, enabling them to reconcile their consumption as necessary. The Statement object contains the following properties:

Field
Type
Description

id

string

The unique identifier for the statement. Note that no nesting exists for this identifier.

Example: SOM-1234-5678-9876

ledger

A reference to the Ledger object for automated billing.

Example:

{
    "id": "BLE-1234-1239"
}

operationsUpload

operationsUpload

A reference to the Operations Upload object for manual billing.

Example:

{
    "id": "OUP-5678-9876"
}

type

enum

The type of statement. Possible values: Debit or Credit.

billingType

enum

The type of billing. Possible values: Automated or Manual .

The values are based on the source of the statement, such as manual upload (Manual) or journal (automated).

status

enum

The status of the statement.

Possible enum values: Generated , Queued , Error , Cancelled , Pending , or Issued.

currency

string

The statement's 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"
}

externalId

string

The identifier in the ERP system.

Example: DE-SCO-1234567

audit

The audit object with possible entries: Created or Updated.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } }
}

price

statementPriceSummary

The statement price summary with aggregated price values for all statement charges.

The StatementPriceSummary object inherits from PriceSummary and adds these tax-related properties: TotalST and TotalGT .

Note that not all fields are visible to all actors.

processing

The statement processing summary including the total charges and counts of ready, error, split, cancelled, and completed charges.

Example:

{
  "total": 150,
  "ready": 140,
  "error": 6,
  "split": 4,
  "cancelled": 2,
  "completed": 0    
}

Last updated

Was this helpful?