Saltearse al contenido

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.


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

GET /obligaciones/{id}
Ventana de terminal
curl -X GET "https://api.guarani.app/obligaciones/{id}" \
-H "x-api-key: Bearer <access_token>" \
-H "Accept: application/json" | jq

Nota: 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 solicitud x-api-key para autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.


ParámetroTipoObligatorioDescripción
iduuidIdentificador único de la obligacion a consultar. (ver obligaciones).
EncabezadoValorDescripción
x-api-keyBearer <access_token>Token de autenticación necesario para acceder al recurso.
Acceptapplication/jsonIndica que la respuesta debe devolverse en formato JSON.
{
"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)"
}
}
CampoTipoDescripción
iduuidIdentificador único de la obligación.
codigonumberCódigo de la obligación según el catálogo oficial.
descripcionstringDescripción de la obligación fiscal.

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