OK
Represents a billing statement in the system, containing details about transactions, pricing, and associated entities.
The unique identifier of the statement.
SOM-1234-1234-1234-1234-1234Represents the identifier used for operations in the billing system.
OPS-12345Represents the identifier used for vendors in the billing system.
VND-67890Represents the identifier used in the ERP system for the statement, if applicable.
ERP-12345Represents the identifier used for clients in the billing system.
CLI-12345The unique identifier of the ledger.
BLE-1234-1234-1234-1234The unique identifier of the custom ledger.
Name of the custom ledger.
Quarterly Revenue LedgerRepresents the type of a statement in the billing system.
Represents the type of billing process.
Represents the various statuses a statement 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.
2Gets the message associated with the current object.
Gets the parameters associated with the current request or operation.
Represents 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.The unique identifier of the credit memo.
The unique identifier of the invoice.
INV-123-456-789Represents the status of a backup operation.
Date and time of the backup action, if available.
The unique identifier of the statement.
SOM-1234-1234-1234-1234-1234Gets or sets the count of child statements.
3Gets or sets the count of distinct products across child statements.
3Gets or sets the count of distinct agreements across child statements.
3Gets or sets the count of distinct licensees across child statements.
2Not Found
GET /public/v1/billing/statements/{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
}
},
"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
}
},
"error": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"cancelled": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"pending": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"issued": {
"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
}
},
"consolidating": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"consolidated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"id": "SOM-1234-1234-1234-1234-1234",
"externalIds": {
"operations": "OPS-12345",
"vendor": "VND-67890",
"erpId": "ERP-12345",
"client": "CLI-12345"
},
"ledger": {
"revision": 1,
"id": "BLE-1234-1234-1234-1234"
},
"customLedger": {
"revision": 1,
"id": "text",
"name": "Quarterly Revenue Ledger"
},
"type": "Debit",
"billingType": "Automated",
"status": "Generated",
"client": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"buyer": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"seller": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
},
"agreement": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"status": "New"
},
"licensee": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"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
},
"statusNotes": {
"message": "text",
"parameters": null
},
"error": {
"errorCode": "ERR-001",
"errorMessage": "Invalid billing data provided.",
"id": "12345",
"message": "Failed to process the billing entity due to missing data."
},
"creditMemo": {
"revision": 1,
"id": "text"
},
"invoice": {
"revision": 1,
"id": "INV-123-456-789"
},
"backup": {
"status": "Pending",
"date": "2026-01-01T00:00:00.000Z"
},
"parent": {
"revision": 1,
"id": "SOM-1234-1234-1234-1234-1234"
},
"statistics": {
"statements": 3,
"products": 3,
"agreements": 3,
"licensees": 2
}
}