Page History

...

• Endpoint: /colaboradores/listar
• Method: POST
• Description: Lists a collaborator by document number.
• 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 "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": 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" } ] }

...

• Endpoint: /acreditaciones/crear
• Method: POST
• Description: Creates a new accreditation.
• 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" } ] } }

...

• Endpoint: /acreditaciones/ejecutar
• Method: POST
• Description: Executes an accreditation.
• Headers:
  • API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

• Request Body:

  Code Block
  language py title json linenumbers true
  { "acreditacion": { "usuario": "test1", "idAcreditacion":274 } }

  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": 0, "txtReturn": "SUCCESS" }, "data": { "descripcion": "Se proceso correctamente" } }

...