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.

This object contains the following attributes:

Field Name
Data Type
Description

id

string

The unique identifier for the statement. No nesting exists for this identifier.

Example: SOM-1234-5678-9876

ledger

object

A reference to the ledger object for automated billing.

Example:

operationsUpload

object

A reference to the operationsUpload object for manual billing.

Example:

type

enum

The type of statement. Allowed values: debit or credit.

billingType

enum

The type of billing. Allowed 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. Allowed values: generated , queued , error , cancelled , pending or issued.

currency

string

The statement's currency.

Example: EUR

client

object

A reference to the client account object.

Example:

buyer

object

A reference to the buyer object.

Example:

vendor

object

A reference to the vendor account object.

Example:

seller

object

A reference to the seller object.

Example:

product

object

A reference to the product object.

Example:

agreement

object

A reference to the agreement object.

Example:

licensee

object

A reference to the licensee object.

Example:

externalId

string

The identifier in the ERP system.

Example: DE-SCO-1234567

audit

object

A reference to the audit object. Allowed values: created or updated.

price

object

The statementPriceSummary with aggregated price values for all statement charges.

The statementPriceSummary object inherits from PriceSummary and adds totalST and totalGT. Note that not all fields are visible to all actors.

processing

object

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

Example:

Last updated

Was this helpful?