API reference · SoftwareOne Extensions
GET/api/extensions/softwareone/statements/{id}/charges

List SoftwareOne statement charges

Returns line-item charges for a SoftwareOne billing statement. The current handler is an MVP placeholder backed by hardcoded dummy data keyed by SoftwareOne statement IDs such as stmt-001. Unknown statement IDs return 200 with an empty data array rather than 404. The id path parameter is not an Alga UUID.

Path parameters

idstringRequired
SoftwareOne external identifier, such as agr-001 or stmt-001. This is not an Alga UUID.

Response body

Success response 200 · schema SoftwareOneChargesListResponse

successbooleanRequired
Request succeeded.
Enum: true
dataarray of SoftwareOneChargeRequired
Charge line items for the requested statement. Unknown statement IDs return an empty array.
itemsobject
idstringRequired
SoftwareOne charge identifier, unique within the statement, such as 1-1.
statementIdstringRequired
Parent SoftwareOne statement identifier, such as stmt-001.
descriptionstringRequired
Human-readable line item description.
productstringRequired
Product or SKU for the charge.
quantitynumberRequired
Quantity billed for this line item.
unitPricenumberRequired
Unit price in the statement currency.
totalAmountnumberRequired
Total line amount.
agreementIdstringRequired
Related SoftwareOne agreement identifier, such as agr-001.
periodstringRequired
Billing period in YYYY-MM format.
categorystringRequired
Charge category, such as Software License, Compute, Storage, or Support.
metaobjectRequired
totalintegerRequired
Number of charge records returned.
statementIdstringRequired
Statement ID from the path parameter.

Response codes

200
Charge list returned successfully. Data may be empty when the statement ID is unknown.
401
API key missing at middleware before the handler executes.
500
Unexpected failure while fetching statement charges.