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

List agreements for extension

Generic extension agreements placeholder. The current handler accepts any extensionId, performs no handler-level extension validation, and returns hardcoded SoftwareOne-style agreement 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 GenericExtensionAgreementsListResponse

successbooleanRequired
Request succeeded.
Enum: true
dataarray of SoftwareOneAgreementRequired
Agreement records returned by the generic extension MVP handler.
itemsobject
idstringRequired
SoftwareOne agreement identifier, such as agr-001. This is an external SoftwareOne-style ID, not an Alga UUID.
namestringRequired
Human-readable agreement name.
productstringRequired
Product or SKU name associated with the agreement.
vendorstringRequired
Software vendor name, such as Microsoft or Adobe.
consumerstringRequired
End-customer organization name for the agreement.
statusstringRequired
Agreement status.
Enum: activeinactivependingexpired
currencystringRequired
Three-letter billing currency code, such as USD.
spxynumberRequired
Annual SPx value from SoftwareOne dummy data.
marginRpxynumberRequired
Margin RPxY value from SoftwareOne dummy data.
operationsstringRequired
Operational visibility state for the agreement.
Enum: visiblehiddenrestricted
billingConfigIdstringRequired
SoftwareOne billing configuration identifier associated with the agreement.
localConfigobject
Locally editable configuration metadata. Current MVP data includes autoRenewal and notificationDays.
autoRenewalboolean
Whether local auto-renewal is enabled.
notificationDaysinteger
Days before renewal/expiry to notify.
markupnumber
Optional local markup percentage used by richer SoftwareOne schemas.
notesstring
Optional local notes.
tagsarray of string
Optional local tags.
itemsstring
metaobjectRequired
totalintegerRequired
Number of agreements returned.
extensionIdstringRequired
Extension ID echoed from the path.

Response codes

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