API ReferenceScheduled Transactions

List Scheduled Transactions

List all scheduled transactions

Query parameters

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

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of transactions
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