API reference · SoftwareOne Extensions
GET/api/extensions/softwareone/statements

List SoftwareOne statements

Returns SoftwareOne billing statement records available to the SoftwareOne extension. The current handler is an MVP placeholder backed by hardcoded dummy data; comments in the route indicate that a full implementation will validate permissions, derive tenant context, fetch from the SoftwareOne API, and apply filtering, sorting, and pagination. This route is not in the middleware API-key skip list, so callers must provide x-api-key at the API layer.

Response body

Success response 200 · schema SoftwareOneStatementsListResponse

successbooleanRequired
Request succeeded.
Enum: true
dataarray of SoftwareOneStatementRequired
SoftwareOne statement records.
itemsobject
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.
metaobjectRequired
totalintegerRequired
Total records returned by the current dummy implementation.
pageintegerRequired
Current page number. Currently hardcoded to 1.
pageSizeintegerRequired
Page size. Currently hardcoded to 50.

Response codes

200
Statement list returned successfully.
401
API key missing at middleware before the handler executes.
500
Unexpected failure while fetching statements.