Skip to navigation

Get a scheduling

Live read, including the settlement (settlement.settlementId) once it exists.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.
schedulingIdstringRequired
Scheduling id returned by the scheduling or retry call.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.

Response

Scheduling
schedulingIdstringOptional
recurrenceIdstringOptionalformat: "uuid"
recurrenceIdentifierstringOptional
endToEndIdstringOptional
dueDatedateOptional
valuedoubleOptional
statusenumOptional
purposeenumOptional
Allowed values:
messagestringOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional
historylist of objectsOptional
settlementobjectOptional

Errors

403
Forbidden Error
404
Not Found Error
502
Bad Gateway Error