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:
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:
operationsUpload
operationsUpload
A reference to the Operations Upload object for manual billing.
Example:
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:
buyer
A reference to the buyer object.
Example:
vendor
A reference to the vendor account object.
Example:
seller
A reference to the seller object.
Example:
product
A reference to the product object.
Example:
agreement
A reference to the agreement object.
Example:
licensee
A reference to the licensee object.
Example:
externalId
string
The identifier in the ERP system.
Example: DE-SCO-1234567
audit
The audit object with possible entries: Created
or Updated
.
Example:
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:
Last updated
Was this helpful?