I Can Receive Family Allowance Payments - Technical Documentation

Overview

Family Allowance Fund (CAF - Caisse Allocations Familiales) (FamilyAllowanceAgency): Government agency that provides financial aid and social benefits to families.
Accommodation Personal Assistance (APL - Aide Personnalisée au Logement) (RentalAllowance): housing allowance provided by CAF to help individuals and families with low incomes reduce their rent or housing costs.
Accommodation Personal Assistance Slip (RentalAllowanceStatement): Periodic summary document of Accommodation Personal Assistance payments (pdf/CSV)
Accommodation Personal Assistance Payment (TenantRentalAllowance) : Periodic payment line of Accommodation Personal Assistance

The RentalAllowance contract references the RentalContract.
A RentalAllowanceContract is binding the tenant with the HousingAgency (modeled as a company).
The RentalAllowanceContract generates the RentalAllowanceStatement, which contains individual payments (TenantRentalAllowance).

allowance

mapping

transitions

I can POST a RentalAllowanceContract - POST /contracts/allowances
I can POST a collection of RentalAllowanceContract - POST /contracts/allowances/batch
I can GET a RentalAllowanceContract - GET /contracts/allowances/{contractId}
I can progress (SIGN, SUSPEND or TERMINATE) a RentalAllowanceContract (state machine) - PATCH /allowances/{contractId}/transitions/{transition}
I can PATCH RentalAllowanceContract next expected amount - PATCH /contracts/allowances/{contractId}/amount
I can GET a RentalAllowanceContract related to my RC - GET /contracts/search/local
I can GET a RentalAllowanceContract allowance details - GET /contracts/allowances/{contractId}/allowance-details
I can PATCH RentalAllowanceContract allowance details - PATCH /contracts/allowances/{contractId}/allowance-details

I can upload an RentalAllowanceStatement document
I can POST a RentalAllowanceStatement - POST /accounting/allowance-statements
I can GET a RentalAllowanceStatement - GET /accounting/allowance-statements/{statementId}
I can DELETE a RentalAllowanceStatement - DELETE /accounting/allowance-statements/{statementId}
I can GET a list of RentalAllowanceStatements (filter + sort + paginate) - GET /accounting/allowance-statements?q={q}
I can PATCH an RentalAllowanceStatement state - PATCH /accounting/allowance-statements/{statementId}/state/{state}
I can propose an RentalAllowanceStatement - POST /accounting/allowance-statements/{statementId}/propose
I can process an RentalAllowanceStatement - POST /accounting/allowance-statements/{statementId}/process

I can add tenant rental allowance to the statement - POST /accounting/allowance-statements/{statementId}/tenant-payment
I can remove tenant rental allowance from the statement - DELETE /accounting/allowance-statements/{statementId}/tenant-payment