For the complete documentation index, see llms.txt. This page is also available as Markdown.

Ledger

The Ledger object is created by the rating function within a specific Seller's context, based on the relevant entries of a Journal. Only SoftwareOne Operations can access the Ledgers.

This object contains the following attributes:

Field
Type
Description

id

string, core

(Read-only) A unique identifier for the ledger. No nesting exists for this identifier.

journal

object

(Read-only) Represents the journal object.

Example:

status

enum

(Read-only) The status of the ledger. Allowed values:

  • Rating

  • Error

  • Review

  • Generating

  • Generated

  • Queued

  • Completed

authorization

object

Represents the authorization object.

Example:

seller

object

(Read-only) Represents the seller object.

Example:

product

object

(Read-only) Represents the product object.

Example:

assignee

object

(Optional) Represents the user object.

Example:

audit

object

(Read-only) Represents the audit object with allowed values including:

  • Created

  • Updated

  • Rating

  • Error

  • Review

  • Generating

  • Generated

  • Queued

  • Completed

price

object

(Read-only) Represents the ledger priceSummary , including aggregated price values for all ledger charges. Not all fields are visible to all actors.

Example:

processing

object

(Read-only) Represents the ledger processingSummary including the total charges and counts of ready, error, split, cancelled, and completed charges.

Example:

error

object

(Read-only)Represents the error details associated with the ledger entry, if any.

Example:

Example

LEDGER OBJECT
{
    "id": "BLE-3197-5868-4970-1115",
    "journal": {
        "id": "BJO-3197-5868",
        "name": "01 Jun 2025 #3",
        "dueDate": "2025-06-01T11:00:00.000Z"
    },
    "status": "Completed",
    "authorization": {
        "id": "AUT-4697-9467",
        "name": "CH",
        "currency": "CHF"
    },
    "owner": {
        "id": "SEL-4970-1115",
        "externalId": "CH",
        "address": {
            "country": "CH"
        },
        "name": "SoftwareONE Switzerland",
        "icon": "/v1/accounts/sellers/SEL-4970-1115/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"
    },
    "price": {
        "currency": "CHF",
        "markup": 24.0000000000,
        "margin": 19.3535945696,
        "totalPP": 1045.50000,
        "totalSP": 1296.42000
    },
    "processing": {
        "total": 1,
        "ready": 1,
        "error": 0,
        "split": 0,
        "skipped": 0
    },
    "audit": {
        "rating": {},
        "error": {},
        "review": {},
        "generating": {},
        "generated": {},
        "queued": {},
        "completed": {},
        "created": {
            "at": "2025-05-09T16:53:27.301Z",
            "by": {
                "id": "USR-0000-0000",
                "name": "System"
            }
        },
        "updated": {
            "at": "2025-05-09T17:04:37.430Z",
            "by": {
                "id": "TKN-0291-1452",
                "name": "Marc Serrat",
                "icon": ""
            }
        }
    }
}

Last updated

Was this helpful?