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 Name
Data Type
Description

id

string

A unique identifier for the ledger. No nesting exists for this identifier.

Example: BLE-1234-1239

journal

object

A reference to the journal object.

Example:

{
 "id": "BJO-1234-5678",
 "name": "29 Nov 2024 #1"
}

status

enum

The status of the ledger. Allowed values: draft , rating , error, ready , generating , generated , queued, or completed.

seller

object

A reference to the seller object.

Example:

{
  "id": "SEL-9121-8944",
  "name": "Software LN",
  "icon": "/static/SEL-9121-8944/icon.png"
}

product

object

A reference to the product object.

Example:

{
 "id": "PRD-1111-1111-1111",
  "name": "Microsoft Office 365 NCE",
  "icon": "/static/PRD-1111-1111-1111/logo.png"
}

currency

string

The currency of the ledger.

Example: EUR

assignee

object

A reference to the user object.

Example:

{
  "id": "USR-1234-1234-1234",
  "name": "John Smith",
  "icon": "/static/users/USR-1234-1234-1234.svg"
}

audit

object

The audit object with allowed values as including created or updated.

price

object

The ledger priceSummary including aggregated price values for all ledger charges.

Note that not all fields are visible to all actors.

Example:

{
  "totalPP": 229.8,
  "markup": 0.5013,
  "margin": 0.3339,  
  "totalSP": 356.7
}

processing

object

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

Example:

{
  "total": 150,
  "ready": 140,
  "error": 6,
  "split": 4,
  "cancelled": 2,
  "completed": 0    
}

Last updated

Was this helpful?