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

List SoftwareOne agreements

Returns SoftwareOne agreement 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 SoftwareOneAgreementsListResponse

successbooleanRequired
Request succeeded.
Enum: true
dataarray of SoftwareOneAgreementRequired
SoftwareOne agreement records.
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
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
Agreement list returned successfully.
401
API key missing at middleware before the handler executes.
500
Unexpected failure while fetching agreements.