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

Unique identifier for the statement. Note that no nesting exists for this identifier.

Example: SOM-1234-5678-9876

ledger

Reference to the Ledger object for automated billing.

Example:

operationsUpload

OperationsUpload

Reference to the Operations Upload object for manual billing.

Example:

type

StatementType enum

Type of statement, such as debit or credit.

Example: Debit

billingType

BillingType enum

Based on the source of the statement, such as manual upload (Manual) or journal (automated).

Example: Manual

status

StatementStatus enum

Status of the statement.

Example: Issued

currency

string

Statement currency.

Example: EUR

client

Reference to the client account object.

Example:

buyer

Reference to the buyer object.

Example:

vendor

Account

Reference to vendor account object.

Example:

seller

Reference to the seller object.

Example:

product

Reference to the product object.

Example:

agreement

Reference to the agreement object.

Example:

licensee

Reference to the licensee object.

Example:

externalId

string

Identifier in the ERP system.

Example: DE-SCO-1234567

audit

AuditObject

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 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?