Scheduled Transactions Overview

The Scheduled Transactions API provides endpoints for managing recurring and future financial transactions within the property management system.

Key Concepts

Transaction Types

Scheduled transactions support different transaction types:

  • PAYMENT: Scheduled incoming payments from residents
  • CHARGE: Recurring charges applied to resident accounts
  • CREDIT: Scheduled credits or refunds to accounts

Ledger Types

Transactions can be allocated to different ledgers:

  • RESIDENT: Standard resident account transactions
  • SECURITY: Security deposit related transactions

Frequency Options

Scheduled transactions support various recurring patterns:

  • DAILY: Transactions processed every day
  • WEEKLY: Transactions processed weekly
  • MONTHLY: Transactions processed monthly

Transaction Management

  • Scheduling: Set up future and recurring transactions
  • Amount Control: Specify exact amounts for each transaction
  • Date Management: Define start dates, end dates, and frequencies
  • Method Tracking: Record payment methods and processing details
  • Code Classification: Categorize transactions with specific codes

Household Integration

All scheduled transactions are linked to specific households:

  • Account Management: Transactions affect household account balances
  • Payment Processing: Automated payment collection and processing
  • Billing Coordination: Integration with regular billing cycles
  • Historical Tracking: Complete record of all scheduled activities

Available Endpoints

EndpointSummaryMethod
/scheduledTransactionsList Scheduled TransactionsGET
/scheduledTransactionsCreate Scheduled TransactionPOST
/scheduledTransactions/{scheduledTransactionId}Read Scheduled TransactionGET
/scheduledTransactions/{scheduledTransactionId}Delete Scheduled TransactionDELETE