Create Scheduled Transaction

curl -X POST https://api.fortresstech.io/v1/scheduledTransactions \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "amount": 1.1,
    "type": "PAYMENT",
    "startDate": "2023-01-15",
    "code": "string",
    "leaseId": "string"
  }
]'

[
  {
    "amount": 1.1,
    "type": "PAYMENT",
    "code": "string",
    "ledger": "OPERATING",
    "subledger": "RESIDENT",
    "startDate": "2023-01-15",
    "endDate": "2023-01-15",
    "description": "string",
    "notes": "string",
    "frequency": "DAILY",
    "note": "string",
    "id": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "organizationId": "string",
    "leaseId": "string",
    "householdId": "string",
    "propertyId": "string",
    "household": {
      "status": "APPLICANT",
      "isUnderEviction": true,
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "currentUnitId": "string",
      "currentLeaseId": "string",
      "applicationId": "string",
      "organizationId": "string",
      "propertyId": "string",
      "currentCertificationId": "string",
      "prospectId": "string",
      "primaryCustomerId": "string",
      "totalActiveRentAmount": 1.1,
      "totalActiveSubsidyAmount": 1.1,
      "totalActiveFeesAmount": 1.1,
      "unitId": "string"
    },
    "customer": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "preferredName": "string",
      "suffix": "string",
      "birthDate": "2023-01-15",
      "status": "APPLICANT",
      "email": "string",
      "phone": "string",
      "gender": "string",
      "headOfHousehold": true,
      "relationship": "PARTNER",
      "passportNumberLastFour": "string",
      "passportCountry": "string",
      "alienRegistrationNumberLastFour": "string",
      "citizenshipStatus": "string",
      "maritalStatus": "string",
      "spouseName": "string",
      "studentType": "string",
      "currentAddressStreet": "string",
      "currentAddressStreet2": "string",
      "currentAddressCity": "string",
      "currentAddressState": "string",
      "currentAddressZipCode": "string",
      "lenderName": "string",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "householdId": "string",
      "propertyId": "string",
      "organizationId": "string"
    },
    "property": {
      "name": "string",
      "shortName": "string",
      "email": "string",
      "phone": "string",
      "physicalStreetAddress1": "string",
      "physicalStreetAddress2": "string",
      "physicalCity": "string",
      "physicalState": "string",
      "physicalZip": "string",
      "physicalCountry": "string",
      "mailingStreetAddress1": "string",
      "mailingStreetAddress2": "string",
      "mailingCity": "string",
      "mailingState": "string",
      "mailingZip": "string",
      "mailingCountry": "string",
      "phoneNumber": "string",
      "faxNumber": "string",
      "timezone": "string",
      "longitude": 1.1,
      "latitude": 1.1,
      "turnMoveOutDays": 1,
      "status": "ACTIVE",
      "propertyClass": "Conventional",
      "organizationId": "string",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "offboardedAt": "2024-01-15T09:30:00Z",
      "countyName": "string",
      "acquisitionDate": "2024-01-15T09:30:00Z"
    },
    "lease": {
      "startDate": "2023-01-15",
      "endDate": "2023-01-15",
      "moveInDate": "2023-01-15",
      "moveOutDate": "2023-01-15",
      "rentAmount": 1.1,
      "leasedRent": 1.1,
      "securityDepositAmount": 1.1,
      "makeReadyDate": "2023-01-15",
      "turnMoveOutDays": 1,
      "documentId": "string",
      "moveOutId": "string",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "propertyId": "string",
      "unitId": "string",
      "householdId": "string",
      "organizationId": "string"
    }
  }
]

Available by Request

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.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Authentication

x-api-keystring

API Key authentication via header

Request

Array of scheduled transactions to create

amountdoubleRequired>=0

The amount of the scheduled transaction

typeenumRequired

The type of scheduled transaction

Allowed values:

startDatedateRequired

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:

endDatedateOptional

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

typeenum

Allowed values:

codestring

ledgerenumOptionalDefaults to OPERATING

Allowed values:

subledgerenumOptionalDefaults to RESIDENT

Allowed values:

startDatedateOptional

endDatedateOptional

descriptionstringOptional

notesstringOptional

frequencyenumOptional

The frequency of the scheduled transaction

Allowed values:

notestringOptional

Note on the scheduled transaction

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

organizationIdstringOptionalformat: "uuid"

leaseIdstringOptionalformat: "uuid"

householdIdstringOptionalformat: "uuid"

propertyIdstringOptionalformat: "uuid"

householdobjectOptional

customerobjectOptional

propertyobjectOptional

leaseobjectOptional