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	Type	Description
id	string, core	(Read-only) The unique identifier for the statement. No nesting exists for this identifier.
ledger	object	(Read-only) (Optional) Represents the ledger object for automated billing. Example: { "id": "BLE-1234-1239" }
customLedger	object	Represents the customLedger object for manual billing.
externalIds	object	(Optional) Represents the external identifiers used for the client and for vendor/operations systems.
type	enum	(Optional) The type of statement. Allowed values are debit or credit.
billingType	enum	The type of billing. The allowed values automated or manual 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 are: Generated Queued Error Cancelled Pending Issued
currency	string	The currency of the statement.
client	object	(Read-only) Represents the client account object.
buyer	object	(Read-only) Represents the buyer object. Example: { "id": "BUY-3731-7971", "name": "Adam Ruszczak", "icon": "/static/BUY-3731-7971/icon.png" }
vendor	object	(Read-only) Represents the vendor account object. Example: { "id": "ACC-1234-1234", "name": "Microsoft", "icon": "/static/ACC-1234-1234/account.png" }
seller	object	(Read-only) Represents the seller object. Example: { "id": "SEL-9121-8944", "name": "Software LN", "icon": "/static/SEL-9121-8944/icon.png" }
product	object	(Read-only) (Optional) Represents the product object. Example: { "id": "PRD-1111-1111-1111", "name": "Microsoft Office 365 NCE", "icon": "/static/PRD-1111-1111-1111/logo.png" }
agreement	object	(Read-only) (Optional) Represents the agreement object. Example: { "id": "AGR-2119-4550-8674-5962", "name": "Microsoft Office 365 for My Company" }
licensee	object	(Read-only) (Optional) Represents the licensee object. Example: { "id": "LCE-9625-9634", "name": "John Smith", "icon": "/static/LCE-9625-9634/icon.png" }
externalId	string, core	(Optional) The identifier in the ERP system.
audit	object	(Read-only) Represents the audit object. Allowed values: created or updated.
price	object	(Read-only) Represents the statementPriceSummary object 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	(Read-only) Represents the statement processingSummary including the total charges and counts of ready, error, split, cancelled, and completed charges.
statusNotes	object	(Read-only) (Optional) Contains additional notes or messages about the status of the statement, if applicable.
error	object	(Read-only) (Optional) Represents the error object containing error details associated with the statement entry, if any. Example: { "id": "SOM:0001", "message": "The debit statement contains a negative price, which is invalid." }
invoice	object	(Read-only) (Optional) Represents the Invoice object.

Example

STATEMENT OBJECT

{
    "id": "SOM-3197-5868-3617-1129-0665",
    "externalIds": {
        "erpId": "CH-CO-1249923"
    },
    "ledger": {
        "id": "BLE-3197-5868-4970-1115",
        "owner": {
            "id": "SEL-4970-1115",
            "externalId": "CH",
            "address": {
                "addressLine1": "Riedenmatt 4",
                "postCode": "6000",
                "city": "Stans",
                "state": "N/A",
                "country": "CH"
            },
            "name": "SoftwareONE Switzerland",
            "icon": "/v1/accounts/sellers/SEL-4970-1115/icon"
        }
    },
    "type": "Debit",
    "billingType": "Automated",
    "status": "Issued",
    "client": {
        "id": "ACC-3287-0000",
        "type": "Client",
        "status": "Active",
        "name": "FRX company"
    },
    "buyer": {
        "id": "BUY-1369-5376",
        "name": "Schelling AG"
    },
    "vendor": {
        "id": "ACC-6502-7513",
        "type": "Vendor",
        "status": "Enabled",
        "name": "CSP Microsoft",
        "icon": "/v1/accounts/accounts/ACC-6502-7513/icon"
    },
    "seller": {
        "id": "SEL-4970-1115",
        "externalId": "CH",
        "address": {
            "country": "CH"
        },
        "name": "SoftwareONE Switzerland",
        "icon": "/v1/accounts/sellers/SEL-4970-1115/icon"
    },
    "product": {
        "id": "PRD-2507-2933",
        "name": "Microsoft Software Subscriptions",
        "externalIds": {},
        "icon": "/v1/catalog/products/PRD-2507-2933/icon",
        "status": "Published"
    },
    "agreement": {
        "id": "AGR-3617-1129-0665",
        "status": "Active",
        "name": "Microsoft Software Subscriptions"
    },
    "licensee": {
        "id": "LCE-3639-3419-3755",
        "name": "Billing test licensee"
    },
    "price": {
        "currency": {
            "purchase": "CHF",
            "sale": "CHF",
            "rate": 1.0000000000
        },
        "markup": 24.0000000000,
        "margin": 19.3535945696,
        "totalPP": 1045.50000,
        "totalSP": 1296.42000
    },
    "processing": {
        "total": 1,
        "ready": 1,
        "error": 0,
        "split": 0,
        "skipped": 0
    },
    "audit": {
        "generated": {},
        "queued": {},
        "error": {},
        "cancelled": {},
        "pending": {},
        "issued": {},
        "generating": {},
        "created": {
            "at": "2025-05-09T16:53:51.607Z",
            "by": {
                "id": "USR-0000-0000",
                "name": "System"
            }
        },
        "updated": {
            "at": "2025-05-09T17:04:37.310Z",
            "by": {
                "id": "TKN-0291-1452",
                "name": "Jane Doe",
                "icon": ""
            }
        }
    }
}