Custom Ledger

The Custom Ledger object is required to submit billing information for clients with manual billing activated. Only SoftwareOne Operations can access this object.

Field
Type
Description

id

string

The unique identifier. Note that no nesting exists for this identifier.

Example: OUP-1234-1239

seller

A reference to the Seller object.

Example:

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

vendor

A reference to the vendor account object.

Example:

{
    "id": "ACC-1234-1234",
    "name": "Microsoft",
    "icon": "/static/ACC-1234-1234/account.png"
}

billingStartDate

dateTime

The billing start date.

Example: 2025-01-10T09:09:30.087Z

billingEndDate

dateTime

The billing end date.

Example: 2025-02-10T09:09:30.087Z30.087Z

currency

string

Custom ledger's currency.

Example: EUR

externalId

string

The external ID or reference number. An optional value to match the Custom Ledger with external ERP systems.

Example: bill-12345609.

notes

string

Notes related to the custom ledger.

Example: Billing data for the import file.

status

enum

The status of the ledger.

Possible values: Draft , Deleted , Validating , Validated , Error , Generating , Queued , or Completed.

assignee

A reference to the User object.

Example:

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

audit

The audit object with possible entries, including Created or Updated.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } }
}

price

The custom ledger price summary including the aggregated price values for all charges.

Example:

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

processing

The custom ledger processing summary 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?