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

Get SoftwareOne agreement

Returns one SoftwareOne agreement by external agreement ID, including additional detail fields such as dates, payment terms, contact, and license count. The current handler is an MVP placeholder backed by hardcoded dummy data. The id path parameter is a SoftwareOne-style string such as agr-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 SoftwareOneAgreementDetailResponse

successbooleanRequired
Request succeeded.
Enum: true
dataobjectRequired
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
startDatestring
Agreement start date in YYYY-MM-DD format.
endDatestring
Agreement end date in YYYY-MM-DD format.
billingCyclestring
Billing cycle cadence, such as monthly or annual.
paymentTermsstring
Payment terms, such as Net 30.
descriptionstring
Free-text agreement description.
contactPersonstring
Primary contact name for the agreement.
contactEmailstring <email>
Primary contact email address.
licenseCountinteger
Number of licenses covered by the agreement.
pricePerLicensenumber
Price per license in the agreement currency.

Response codes

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