API ReferenceScheduled Transactions

Read Scheduled Transaction

Info for a specific scheduled transaction

Path parameters

scheduledTransactionIdstringRequired
The id of the scheduled transaction

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request
amountdouble
codestring
typeenum
Allowed values:
createdAtdatetime or null
customerobject or null
deletedAtdatetime or null
descriptionstring or null
endDatestring or nullformat: "date"
householdobject or null
householdIdstring or nullformat: "uuid"
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
leaseobject or null
leaseIdstring or nullformat: "uuid"
ledgerenum or nullDefaults to OPERATING
Allowed values:
notesstring or null
organizationIdstring or nullformat: "uuid"
propertyobject or null
propertyIdstring or nullformat: "uuid"
startDatestring or nullformat: "date"
subledgerenum or nullDefaults to RESIDENT
Allowed values:
updatedAtdatetime or null