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

Get SoftwareOne statement

Returns one SoftwareOne billing statement by external statement ID, including additional detail fields such as subtotal, tax amount, description, and billing address. The current handler is an MVP placeholder backed by hardcoded dummy data. The id path parameter is a SoftwareOne-style string such as stmt-001, 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 SoftwareOneStatementDetailResponse

successbooleanRequired
Request succeeded.
Enum: true
dataobjectRequired
idstringRequired
SoftwareOne statement identifier, such as stmt-001. This is an external SoftwareOne-style ID, not an Alga UUID.
statementNumberstringRequired
Human-readable statement number, such as STMT-2024-001.
periodstringRequired
Billing period in YYYY-MM format.
consumerstringRequired
End-customer organization name.
consumerIdstringRequired
SoftwareOne consumer identifier.
agreementNamestringRequired
Human-readable name of the associated agreement.
agreementIdstringRequired
SoftwareOne agreement identifier associated with this statement.
totalAmountnumberRequired
Total statement amount in the billing currency.
currencystringRequired
Three-letter billing currency code, such as USD.
lineItemCountintegerRequired
Number of line-item charges on the statement.
statusstringRequired
Statement lifecycle status used by the MVP handler.
Enum: draftfinalizedimported
dueDatestringRequired
Payment due date in YYYY-MM-DD format.
createdAtstringRequired
ISO 8601 timestamp when the statement was created.
importedAtstringRequiredNullable
ISO 8601 timestamp when imported into Alga, or null if not imported.
subtotalnumber
Statement subtotal before tax. Present on detail responses.
taxAmountnumber
Statement tax amount. Present on detail responses.
descriptionstring
Statement description. Present on detail responses.
billingAddressobject
Billing address. Present on detail responses.
clientstringRequired
Billing client organization name.
streetstringRequired
Street address.
citystringRequired
City.
statestringRequired
State or province.
zipCodestringRequired
Postal or ZIP code.
countrystringRequired
Country.

Response codes

200
Statement detail returned successfully.
401
API key missing at middleware before the handler executes.
404
Statement not found.
500
Unexpected failure while fetching statement detail.