Obtener obligacion por su ID
Obtiene información detallada de una obligación específica usando su ID único. Permite consultar los datos de la obligación.
Entorno
Sección titulada «Entorno»URL Base: https://api.guarani.app
Endpoint
Sección titulada «Endpoint»GET /obligaciones/{id}Ejemplo de solicitud
Sección titulada «Ejemplo de solicitud»curl -X GET "https://api.guarani.app/obligaciones/{id}" \-H "x-api-key: Bearer <access_token>" \-H "Accept: application/json" | jqNota: Asegúrate de reemplazar
{id}con el identificador único de la obligacion que deseas consultar y<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 solicitudx-api-keypara autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.
Parámetros de ruta
Sección titulada «Parámetros de ruta»| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | uuid | Sí | Identificador único de la obligacion a consultar. (ver obligaciones). |
Encabezados de la solicitud
Sección titulada «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
Sección titulada «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)" }}Descripción de campos de respuesta
Sección titulada «Descripción de campos de respuesta»Campos principales
Sección titulada «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. |
Recursos adicionales
Sección titulada «Recursos adicionales»Para más información sobre posibles errores y cómo manejarlos, consulta errores.