...
- Endpoint:
/colaboradores/listar - Método:
POST - Descripción: Lista uno o todos los colaboradores de la empresa, con información adicional de cada uno.
- Headers:
API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled
Request Body:
Code Block language py title json linenumbers true { "nroDocumento": 4040440 }Expand title Consideraciones del Request "nroDocumento" => Debe ser numérico, contener el número de documento de la persona a quien se le va a asociar como colaborador de la empresa
"nroTelefononroDocumento" => Debe tener ese formato, no debe contener caracteres especiales ni espacios"correo" => Debe ser un correo valido
el valor 0 para que el endpoint devuelva todos los colabores de la empresa.
Response Body:
Code Block language py title json linenumbers true { "header": { "codReturn": 0, "txtReturn": "SUCCESS" }, "data": [ { "apellidos": "Sosa", "correo": "asosa@cabal.com.py", "documento": "4040440", "estado": "Usuario registrado", "nombres": "Arturo", "nroTarjeta": "6043512000595678", "nroTelefono": "0986215487", "tarjetaMask": "6043-XXXX-XXXX-5678" } ] }Expand title Respuestas posibles asdasdasd"codReturn": 0, "txtReturn": "SUCCESS" => Cuando encuentra los datos. (El data puede ser de un colaborador o de todos los colabores de la empresa).
"codReturn": 1, "txtReturn": "ERROR" => Cuando el endpoint tuvo un problema al procesar la petición.
"codReturn": 2, "txtReturn": "No existe el colaborador" => Cuando no hay un colaborador registrado con el documento enviando en el request.
CrearAcreditacion
- Endpoint:
/acreditaciones/crear - Método:
POST - Descripción: Crea una nueva orden de acreditación.
- Headers:
API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled
Request Body:
Code Block language py title json linenumbers true { "acreditacion": { "usuario": "test1", "descripcion":"prueba 1", "lista": [ { "nroDocumento": 4040440, "monto": 1500000 }, { "nroDocumento": 4040440, "monto": 1200000 }, { "nroDocumento": 404011111, "monto": 1600000 } ] } }Expand title Consideraciones del Request "nroDocumento" => Debe ser numérico, contener el número de documento de la persona a quien se le va a asociar como colaborador de la empresa
"nroTelefono" => Debe tener ese formato, no debe contener caracteres especiales ni espacios
"correo" => Debe ser un correo valido
Response Body:
Code Block language py title json linenumbers true { "header": { "codReturn": 1, "txtReturn": "WARNING" }, "data": { "estadoAcreditacion": "APROBADO", "idAcreditacion": "274", "acreditacionesValidas": [ { "estado": "Usuario registrado", "monto": "1500000", "nroDocumento": "4040440" }, { "estado": "Usuario registrado", "monto": "1200000", "nroDocumento": "4040440" } ], "acreditacionesNoValidas": [ { "estado": "No esta registrado como colaborador", "monto": "1600000", "nroDocumento": "404011111" } ] } }Expand title Respuestas posibles asdasdasd
...