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

List statements for extension

Generic extension statements placeholder. The current handler accepts any extensionId, performs no handler-level extension validation, and returns hardcoded SoftwareOne-style statement data with meta.extensionId echoed from the path. A full implementation will validate the extension ID, check permissions, derive tenant context, and fetch extension-specific data.

Path parameters

extensionIdstringRequired
Extension identifier from the URL. The MVP generic routes accept any value and echo it in response metadata.

Response body

Success response 200 · schema GenericExtensionStatementsListResponse

successbooleanRequired
Request succeeded.
Enum: true
dataarray of SoftwareOneStatementRequired
Statement records returned by the generic extension MVP handler.
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
Number of statements returned.
extensionIdstringRequired
Extension ID echoed from the path.

Response codes

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