Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/scoria02/marbes2021_backend/llms.txt

Use this file to discover all available pages before exploring further.

The reporting endpoints expose read-only views over the Marbes operations database. Reports span four operation types — TCOL (fund collections), TPROD (fund deployments), TCON (contracts), and MOVIMIENTO_FONDO (fund movements) — and are filtered to USD and VES amounts only. Every request must include a valid Authorization: Bearer <token> header. Date-range endpoints accept fechaDesde and fechaHasta as query parameters in YYYY-MM-DD format. For best performance, keep date ranges to three months or fewer.
All report endpoints apply two automatic filters regardless of other parameters: only operations in USD and VES are included, and filtering uses the fecha field (not created_at).

Detailed line-by-line report

Method: GET
Path: /api/report/detallado
Authentication: Bearer JWT required
Returns one row per operation within the date range, covering TCOL, TPROD, TCON, and MOVIMIENTO_FONDO records. Useful for audit trails and transaction-level reconciliation.

Query parameters

fechaDesde
string
required
Start date in YYYY-MM-DD format. Example: 2026-01-01.
fechaHasta
string
required
End date in YYYY-MM-DD format. Example: 2026-01-31.

Response fields

success
boolean
required
true on success.
total
number
required
Total number of records returned.
data
object[]
required
Array of operation objects.

Examples

curl --request GET \
  --url 'https://api.example.com/api/report/detallado?fechaDesde=2026-01-01&fechaHasta=2026-01-31' \
  --header 'Authorization: Bearer <token>'

Success response

200
{
  "success": true,
  "data": [
    {
      "tipo_operacion": "TCOL",
      "operacion_id": "uuid-del-tcol",
      "fecha": "2026-01-15",
      "fecha_registro": "2026-01-15T10:30:00Z",
      "moneda": "USD",
      "monto": 10000,
      "disponible": null,
      "disponible_activo": 10000,
      "prestado": 0,
      "costo_banco": 0.25,
      "tasa_bcv": 350.00,
      "banco": "Banco de Venezuela",
      "referencia": "REF123",
      "estatus": "aceptado",
      "responsable": "uuid-del-empleado",
      "responsable_nombre": "Juan Pérez",
      "id_contrato": "uuid-del-contrato",
      "id_aportante": "uuid-del-aportante",
      "aportante": "María González",
      "id_cliente": null,
      "cliente_nombre": null,
      "id_tprod": null,
      "id_tcon": null,
      "id_movimiento_fondo": null
    }
  ],
  "total": 150
}

Executive summary by responsible

Method: GET
Path: /api/report/resumen-responsable
Authentication: Bearer JWT required
Aggregates all operations by responsible employee and currency, returning totals for each combination. Ideal for performance dashboards and portfolio reviews.

Query parameters

fechaDesde
string
required
Start date in YYYY-MM-DD format.
fechaHasta
string
required
End date in YYYY-MM-DD format.

Response fields

data
object[]
required
Array of aggregated records, one per responsible per currency.

Examples

curl --request GET \
  --url 'https://api.example.com/api/report/resumen-responsable?fechaDesde=2026-01-01&fechaHasta=2026-01-31' \
  --header 'Authorization: Bearer <token>'

Fund origin analysis

Method: GET
Path: /api/report/origen-fondos
Authentication: Bearer JWT required
Groups fund origins by bank and investor (aportante), distinguishing between direct funds (TCOL) and transferred funds (MOVIMIENTO_FONDO). Useful for source-of-funds compliance and investor attribution.

Query parameters

fechaDesde
string
required
Start date in YYYY-MM-DD format.
fechaHasta
string
required
End date in YYYY-MM-DD format.

Response fields

data
object[]
required

Examples

curl --request GET \
  --url 'https://api.example.com/api/report/origen-fondos?fechaDesde=2026-01-01&fechaHasta=2026-01-31' \
  --header 'Authorization: Bearer <token>'

Report by investor and bank (USD)

Method: GET
Path: /api/report/aportante-banco
Authentication: Bearer JWT required
Returns fund totals grouped by investor and bank in USD. No date-range filter — covers all-time data.

Examples

curl --request GET \
  --url https://api.example.com/api/report/aportante-banco \
  --header 'Authorization: Bearer <token>'

Report by investor and bank (VES)

Method: GET
Path: /api/report/aportante-banco-ves
Authentication: Bearer JWT required
Same grouping as /aportante-banco but amounts expressed in VES. No date-range filter.

Examples

curl --request GET \
  --url https://api.example.com/api/report/aportante-banco-ves \
  --header 'Authorization: Bearer <token>'

Report by bank (USD)

Method: GET
Path: /api/report/banco
Authentication: Bearer JWT required
Returns fund totals aggregated per bank in USD. No date-range filter.

Examples

curl --request GET \
  --url https://api.example.com/api/report/banco \
  --header 'Authorization: Bearer <token>'

Report by bank (VES)

Method: GET
Path: /api/report/banco-ves
Authentication: Bearer JWT required
Same grouping as /banco but amounts expressed in VES. No date-range filter.

Examples

curl --request GET \
  --url https://api.example.com/api/report/banco-ves \
  --header 'Authorization: Bearer <token>'

General report per bank (USD + VES equivalent)

Method: GET
Path: /api/report/general-por-banco
Authentication: Bearer JWT required
Returns a combined view per bank showing both the USD amount and its VES equivalent at the recorded BCV rate. No date-range filter.

Examples

curl --request GET \
  --url https://api.example.com/api/report/general-por-banco \
  --header 'Authorization: Bearer <token>'

Total report with Bóveda breakdown

Method: GET
Path: /api/report/total-boveda
Authentication: Bearer JWT required
Returns the grand total across all banks plus a separate line for Bóveda (vault) holdings. Useful for top-level fund position summaries.

Examples

curl --request GET \
  --url https://api.example.com/api/report/total-boveda \
  --header 'Authorization: Bearer <token>'

TCOL/TPROD aggregated report

Method: GET
Path: /api/report/tcol-tprod-agregado
Authentication: Bearer JWT required
For each TCOL, returns the count of associated TPRODs and the sum of payments made. No date-range filter.

Examples

curl --request GET \
  --url https://api.example.com/api/report/tcol-tprod-agregado \
  --header 'Authorization: Bearer <token>'

TCOL/TPROD line-by-line report

Method: GET
Path: /api/report/tcol-tprod-detalle
Authentication: Bearer JWT required
Returns one row per TPROD linked to a TCOL, showing individual payment details. No date-range filter.

Examples

curl --request GET \
  --url https://api.example.com/api/report/tcol-tprod-detalle \
  --header 'Authorization: Bearer <token>'

TPROD by responsible and bank

Method: GET
Path: /api/report/tprod-por-responsable-banco
Authentication: Bearer JWT required
Aggregates accepted TPRODs by responsible employee and bank over a date range. idBanco is optional — omitting it returns results for all banks.

Query parameters

fechaDesde
string
required
Start date in YYYY-MM-DD format.
fechaHasta
string
required
End date in YYYY-MM-DD format.
idBanco
string
Optional UUID of a specific bank to filter results.

Examples

curl --request GET \
  --url 'https://api.example.com/api/report/tprod-por-responsable-banco?fechaDesde=2026-01-01&fechaHasta=2026-01-31' \
  --header 'Authorization: Bearer <token>'

TPROD line-by-line by responsible and bank

Method: GET
Path: /api/report/tprod-detalle-por-responsable-banco
Authentication: Bearer JWT required
Returns one row per TPROD for a specific responsible employee and bank within a date range. All four parameters are required.

Query parameters

id_responsable
string
required
UUID of the responsible employee.
id_banco
string
required
UUID of the bank.
fechaDesde
string
required
Start date in YYYY-MM-DD format.
fechaHasta
string
required
End date in YYYY-MM-DD format.

Examples

curl --request GET \
  --url 'https://api.example.com/api/report/tprod-detalle-por-responsable-banco?id_responsable=uuid-responsable&id_banco=uuid-banco&fechaDesde=2026-01-01&fechaHasta=2026-01-31' \
  --header 'Authorization: Bearer <token>'

Error responses

400
{
  "success": false,
  "message": "Los parámetros id_responsable, id_banco, fechaDesde y fechaHasta son requeridos (UUIDs, fechas: YYYY-MM-DD)"
}
400
{
  "success": false,
  "message": "El formato de fecha debe ser YYYY-MM-DD"
}
500
{
  "success": false,
  "message": "Error interno del servidor"
}

Build docs developers (and LLMs) love