...
- 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 "usuario" => Puede enviar el nombre del usuario que creo la acreditación para asociar esa información a la petición.
"descripcion" => Puede enviar alguna descripción para asociar a la petición. Ej.: 'Acreditación de Salario mes de Junio'.
"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.
"monto" => Debe contener el valor a ser acreditado al colaborador sin separación de puntos ni decimales.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"codReturn": 0, "txtReturn": "SUCCESS", "estadoAcreditacion": "APROBADO" => Todos los colaboradores del Request pueden recibir su acreditación sin problemas.
"codReturn": 1, "txtReturn": "ERROR", "estadoAcreditacion": "Hubo un problema al procesar la peticion" => El endpoint tuvo un problema procesando la petición. Sistemas ya fue notificado.
"codReturn": 2, "txtReturn": "WARNING", "estadoAcreditacion": "APROBADO" => Hay usuarios que no pertenecen a la lista de colabores de la empresa, pero si se procesa la orden para el resto.
"codReturn": 3, "txtReturn": "ERROR", "estadoAcreditacion": "No existe ningun colaborador valido" => Todos los colabores del request, no pertenecen a la empresa.
EjecutarAcreditacion
- Endpoint:
/acreditaciones/ejecutar
- Método:
POST
- Descripción: Ejecutar una acreditación.
- 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" } }
Expand title Respuestas posibles asdasdasd
...