API ReferenceScheduled Transactions

Create Scheduled Transaction

<Badge>Available by Request</Badge> Create one or more scheduled (recurring) transactions for a lease. Scheduled transactions are automatically processed based on the specified frequency (daily, weekly, or monthly) and date range. Common use cases include monthly rent charges, recurring fees, or scheduled credits. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Request

This endpoint expects a list of objects.
amountdoubleRequired>=0
The amount of the scheduled transaction
typeenumRequired
The type of scheduled transaction
Allowed values:
startDatestringRequiredformat: "date"

The start date in YYYY-MM-DD format

codestringRequired
The transaction code
leaseIdstringRequiredformat: "uuid"
The ID of the lease associated with the scheduled transaction
ledgerenumOptionalDefaults to OPERATING

The ledger for the transaction. Note - SECURITY is not supported yet.

Allowed values:
subledgerenumOptionalDefaults to RESIDENT
The subledger for the transaction
Allowed values:
frequencyenumOptional
The frequency of the scheduled transaction
Allowed values:
endDatestringOptionalformat: "date"

The end date in YYYY-MM-DD format. Must be on or after startDate.

documentNumberstringOptional<=255 characters
The document number
notesstringOptional<=255 characters
Notes about the scheduled transaction
idempotencyIdstringOptionalformat: "uuid"

Response

The created scheduled transaction(s)

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