Obtener una lista de las obligaciones

Lista todas las obligaciones registradas en el sistema de forma paginada. Permite consultar las obligaciones disponibles.

---

Entorno

URL Base: https://api.guarani.app

Endpoint

GET /obligaciones?page=1&limit=100

Ejemplo de solicitud

curl -X GET "https://api.guarani.app/obligaciones?page=1&limit=100" \
-H "x-api-key: Bearer <access_token>" \
-H "Accept: application/json" | jq

Nota: Asegúrate de reemplazar <access_token> con un token JWT válido proporcionado por el equipo Guarani. Importante:
Es imprescindible incluir un token de acceso válido en el encabezado de la solicitud x-api-key para autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.

---

Parámetros de consulta

Parámetro	Tipo	Requerido	Descripción
page	integer	No	Número de página. Por defecto: 1.
limit	integer	No	Resultados por página. Por defecto: 10

Encabezados de la solicitud

Encabezado	Valor	Descripción
x-api-key	Bearer <access_token>	Token de autenticación necesario para acceder al recurso.
Accept	application/json	Indica que la respuesta debe devolverse en formato JSON.

Ejemplo de respuesta

{
  "success": true,
  "codigo": "200",
  "message": "Operación realizada correctamente.",
  "data": [
    {
      "id": "a4889c8c-1730-47f3-9650-b0ba06ae4f50",
      "codigo": 41,
      "descripcion": "Aporte obrero al Instituto de Previsión Social (IPS)"
    }
  ],
  "pagination": {
    "total_registros": 1,
    "pagina": 1,
    "total_paginas": 1
  }
}

Descripción de campos de respuesta

Campos principales

Campo	Tipo	Descripción
id	uuid	Identificador único de la obligación.
codigo	number	Código de la obligación según el catálogo oficial.
descripcion	string	Descripción de la obligación fiscal.

Campos de paginación

Campo	Tipo	Descripción
total_registros	number	Cantidad total de obligaciones en el sistema.
pagina	number	Número de página actual.
total_paginas	number	Cantidad total de páginas disponibles.

Recursos adicionales

Para más información sobre posibles errores y cómo manejarlos, consulta errores.