OK
Represents a custom ledger in the billing system.
The unique identifier of the custom ledger.
Name of the custom ledger.
Quarterly Revenue LedgerRepresents the identifier used for operations in the billing system.
OPS-12345Represents the identifier used for vendors in the billing system.
VND-67890The start date of the billing period for the custom ledger.
2025-01-01T00:00:00+00:00The end date of the billing period for the custom ledger.
2025-03-31T23:59:59+00:00Additional notes or comments about the custom ledger.
Includes all transactions for Q1 2025.Represents the various statuses a custom ledger can have in the billing system.
Represents the markup value applied to the pricing.
15.5Represents the margin value calculated for the pricing.
20Represents the total purchase price.
1000Represents the total sale price in buyer currency.
1200Indicates the purchase price currency visible to vendors or operations.
USDIndicates the sale price currency visible to clients or operations.
EURExchange rate between the purchase and sale currencies.
1Represents the total sale price.
1200Indicates the total number of items involved in the processing.
100Indicates the number of items that are ready for further processing.
80Indicates the number of items that encountered errors during processing.
5Indicates the number of items that were split into multiple parts during processing.
10Indicates the number of items that were skipped during processing.
5Indicates the number of items that were manually ignored.
2Represents the error code associated with the billing entity.
ERR-001Represents the error message providing details about the issue.
Invalid billing data provided.Represents the unique identifier for the error, if applicable.
12345Represents the detailed message associated with the error, if applicable.
Failed to process the billing entity due to missing data.Represents the status of a backup operation.
Date and time of the backup action, if available.
Not Found
GET /public/v1/billing/custom-ledgers/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"draft": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"validating": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"validated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"error": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"generating": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"generated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"queued": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"completed": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"id": "text",
"name": "Quarterly Revenue Ledger",
"externalIds": {
"operations": "OPS-12345",
"vendor": "VND-67890"
},
"seller": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"billingStartDate": "2025-01-01T00:00:00+00:00",
"billingEndDate": "2025-03-31T23:59:59+00:00",
"notes": "Includes all transactions for Q1 2025.",
"status": "Validated",
"assignee": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
},
"price": {
"markup": 15.5,
"margin": 20,
"totalPP": 1000,
"totalBSP": 1200,
"currency": {
"purchase": "USD",
"sale": "EUR",
"rate": 1
},
"totalSP": 1200
},
"processing": {
"total": 100,
"ready": 80,
"error": 5,
"split": 10,
"skipped": 5,
"ignored": 2
},
"error": {
"errorCode": "ERR-001",
"errorMessage": "Invalid billing data provided.",
"id": "12345",
"message": "Failed to process the billing entity due to missing data."
},
"backup": {
"status": "Pending",
"date": "2026-01-01T00:00:00.000Z"
}
}