Subsidies + Direct Debit Documentation

Overview

The Subsidies + Direct Debit feature enables automated tenant payment processing in rental contracts by integrating balance calculations, subsidies, tenant-specific payment instructions, and SEPA Direct Debit execution.

Key Concepts

Direct Debit: Automated debiting of tenant accounts after a Call for Rent (CFR) operation.
Direct Debit Header: Summarizes direct debit details, including balances, subsidies, contract info, and total amounts.
Direct Debit Item: Tenant-specific record detailing payment amounts, tenant info, and SEPA mandate details.
Payment Instruction: Defines the percentage each tenant must pay and their SEPA mandate details.

Core Models

Calculation Logic

Direct Debit Basis and Formulas

Direct Debit Basis	Formula
`ACCOUNTING_BALANCE_AND_CFR`	`balance + cfr`
`ACCOUNTING_BALANCE_AND_CFR_LESS_SUBSIDIES`	`(balance + cfr) - socialAllowance`
`CFR`	`cfr`
`CFR_LESS_SUBSIDIES`	`cfr - socialAllowance`

SEPA Direct Debit Calculation

Formula to calculate tenant-specific SEPA debit amounts:

sepaDirectDebitAmount = (AmountBasedOnBasis - if allowance_statement(exists)? current_expected : next_subsidies ) * paymentInstruction%

Logic Flow Diagram

API Endpoints

1. Allowance Statement API

Method: GET
URL: adb-accounting/accounting/allowance-statements

Query Parameters:

{
    "states": ["PAID"],
    "periods": ["{Direct Debit period}"],
    "rentalContracts": ["{rcId}"]
}

2. Propose Direct Debit API

Method: POST
URL: adb-contracts/contracts/direct-debit/{period}/propose

3. Process Direct Debit API

Method: POST
URL: adb-contracts/contracts/direct-debit/{period}/process