The Fees API managesDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/GuillermoNavarro/Proyecto_comunidades/llms.txt
Use this file to discover all available pages before exploring further.
Cuota resources — the scheduled charges raised against residents of a community. When a fee is created, the system automatically generates a Recibo (receipt) for every active user in the community (or for a single user when the type is INDIVIDUAL). This ensures that payment tracking is always in sync with the fee schedule.
The community for every new fee is derived automatically from the caller’s JWT — it is not supplied in the request body.
All endpoints require a valid JWT Bearer token in the Authorization header.
GET /api/cuotas
Returns every fee across all communities on the platform.Required role:
SUPER_ADMIN200 OK — array of Cuota objects.
Unique identifier of the fee.
Descriptive name for the fee (e.g.
"Cuota Ordinaria Enero 2025").Issue date in
YYYY-MM-DD format.Due date in
YYYY-MM-DD format.Total fee amount (e.g.
85.00). Each resident’s individual receipt amount may differ based on their coeficiente.Fee type. One of
ORDINARIA, EXTRAORDINARIA, or INDIVIDUAL.The community this fee belongs to.
Example response
| Status | Meaning |
|---|---|
200 | OK — list returned (may be empty). |
403 | Forbidden — caller does not have SUPER_ADMIN role. |
GET /api/cuotas/comunidad
Returns all fees that belong to the community encoded in the caller’s JWT.Required role:
ADMIN200 OK — array of Cuota objects scoped to the caller’s community (same schema as above).
| Status | Meaning |
|---|---|
200 | OK — list returned (may be empty). |
403 | Forbidden — caller does not have ADMIN role. |
GET /api/cuotas/{id}
Retrieves a single fee by its numericid. Returns 403 if the fee belongs to a different community than the caller’s JWT community.
Required role:
ADMINPath parameters
The unique identifier of the fee to retrieve.
200 OK — a single Cuota object.
Example response
| Status | Meaning |
|---|---|
200 | OK — fee found and returned. |
403 | Forbidden — fee belongs to a different community, or caller lacks ADMIN role. Returns "No tienes permiso para ver cuotas de otra comunidad". |
404 | Not Found — no fee with the given id exists. |
POST /api/cuotas
Creates a new fee and automatically generates receipts for all active users in the community. If the fee type isINDIVIDUAL, pass the target user’s id as the idUsuario query parameter — only that user receives a receipt.
Required role:
ADMIN or SUPER_ADMINQuery parameters
Optional. The
id of a specific user to issue an INDIVIDUAL fee against. Required when tipo is INDIVIDUAL; ignored for ORDINARIA and EXTRAORDINARIA types.Request body
Descriptive name for the fee.
Issue date in
YYYY-MM-DD format.Due date in
YYYY-MM-DD format.Total fee amount (e.g.
85.00).Fee type. One of
ORDINARIA, EXTRAORDINARIA, or INDIVIDUAL.200 OK — the newly created Cuota object including its generated id and the auto-assigned comunidad.
Example response
| Status | Meaning |
|---|---|
200 | OK — fee created; receipts generated automatically. |
403 | Forbidden — caller does not have the required role. |
PUT /api/cuotas/{id}
Replaces the editable fields of an existing fee. The fee must belong to the caller’s JWT community.Required role:
ADMIN or SUPER_ADMINPath parameters
The unique identifier of the fee to update.
Request body
Updated fee name.
Updated issue date (
YYYY-MM-DD).Updated due date (
YYYY-MM-DD).Updated fee amount.
Updated fee type (
ORDINARIA, EXTRAORDINARIA, or INDIVIDUAL).200 OK — the updated Cuota object.
| Status | Meaning |
|---|---|
200 | OK — fee updated and returned. |
404 | Not Found — no fee with that id exists. |
409 | Conflict — update violates a business rule (e.g. associated paid receipts exist). |
403 | Forbidden — caller does not have the required role. |
DELETE /api/cuotas/{id}
Deletes a fee. The fee must belong to the caller’s JWT community. Deletion may be rejected if the fee has associated paid receipts.Required role:
ADMIN or SUPER_ADMINPath parameters
The unique identifier of the fee to delete.
| Status | Meaning |
|---|---|
200 | OK — fee deleted. Returns "Cuota eliminada correctamente". |
404 | Not Found — no fee with that id exists. |
409 | Conflict — fee cannot be deleted because it has associated receipts in a final state. |
403 | Forbidden — caller does not have the required role. |