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

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.

This object contains the following attributes:

Field
Type
Description

id

string, core

(Read-only) The unique identifier. No nesting exists for this identifier.

name

string, core

The name of the custom ledger.

externalIds

(Optional) The external IDs for vendors and operations.

seller

object

(Read-only) Represents the seller object.

vendor

object

(Read-only) Represents the vendor account object.

billingStartDate

dateTime, core

The billing start date.

billingEndDate

dateTime, core

The billing end date.

notes

string

(Optional) Notes related to the custom ledger.

status

enum

The status of the ledger. Allowed values are:

  • Draft

  • Deleted

  • Validating

  • Validated

  • Error

  • Generating

  • Queued

  • Completed

assignee

object

(Optional) Represents the user object.

audit

object

(Read-only) Represents the audit object.

price

object

(Read-only) The custom ledger priceSummary including the aggregated price values for all charges.

processing

object

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

error

object

Represents the billingEntityError object containing error details associated with the custom ledger entry, if any.

Example

CUSTOM LEDGER OBJECT
{
    "id": "CLE-6666-0422",
    "name": "Test 3",
    "externalIds": {},
    "seller": {
        "id": "SEL-4970-1115",
        "externalId": "CH",
        "address": {
            "country": "CH"
        },
        "name": "SoftwareONE Switzerland",
        "icon": "/v1/accounts/sellers/SEL-4970-1115/icon"
    },
    "vendor": {
        "id": "ACC-9226-9856",
        "type": "Vendor",
        "status": "Active",
        "name": "Adobe"
    },
    "billingStartDate": "2025-05-15T22:00:00.000Z",
    "billingEndDate": "2025-05-15T22:00:00.000Z",
    "status": "Completed",
    "price": {
        "currency": {
            "purchase": "EUR",
            "sale": "EUR",
            "rate": 1.0000000000
        },
        "markup": 8.7083671812,
        "margin": 8.0107607234,
        "totalPP": 5170.20000,
        "totalSP": 5620.44000
    },
    "processing": {
        "total": 3,
        "ready": 3,
        "error": 0,
        "split": 0,
        "skipped": 0
    },
    "audit": {
        "draft": {
            "at": "2025-05-16T12:59:40.112Z",
            "by": {
                "id": "USR-0000-0043",
                "name": "Marc Serrat",
                "icon": "/v1/accounts/users/USR-0000-0043/icon"
            }
        },
        "deleted": {},
        "validating": {
            "at": "2025-05-16T12:59:49.507Z",
            "by": {
                "id": "USR-0000-0043",
                "name": "Marc Serrat",
                "icon": "/v1/accounts/users/USR-0000-0043/icon"
            }
        },
        "validated": {
            "at": "2025-05-16T12:59:52.560Z",
            "by": {
                "id": "USR-0000-0000",
                "name": "System"
            }
        },
        "error": {},
        "generating": {
            "at": "2025-05-16T12:59:59.976Z",
            "by": {
                "id": "USR-0000-0043",
                "name": "Marc Serrat",
                "icon": "/v1/accounts/users/USR-0000-0043/icon"
            }
        },
        "generated": {
            "at": "2025-05-16T13:00:02.131Z",
            "by": {
                "id": "USR-0000-0000",
                "name": "System"
            }
        },
        "queued": {
            "at": "2025-05-16T13:00:15.103Z",
            "by": {
                "id": "USR-0000-0043",
                "name": "Marc Serrat",
                "icon": "/v1/accounts/users/USR-0000-0043/icon"
            }
        },
        "completed": {
            "at": "2025-05-16T13:04:15.596Z",
            "by": {
                "id": "TKN-0291-1452",
                "name": "Marc Serrat",
                "icon": ""
            }
        },
        "created": {
            "at": "2025-05-16T12:59:40.112Z",
            "by": {
                "id": "USR-0000-0043",
                "name": "Marc Serrat",
                "icon": "/v1/accounts/users/USR-0000-0043/icon"
            }
        },
        "updated": {
            "at": "2025-05-16T13:04:15.596Z",
            "by": {
                "id": "TKN-0291-1452",
                "name": "Marc Serrat",
                "icon": ""
            }
        }
    }
}

Last updated

Was this helpful?