Eliminar los movimientos de una bolsa por empleado

Este endpoint permite eliminar los movimientos de una bolsa asociados a un empleado dentro de un periodo de tiempo determinado.

DELETE /api/v1/businesses/{businessId}/bags/{bagId}/employees/{employeeId}/movements?from={yyyy-MM-dd}&to={yyyy-MM-dd}

Si los datos incluidos en la petición son correctos, la respuesta será un 200 OK y se eliminarán todos los movimientos de ese empleado, para la bolsa indicada, dentro del periodo de tiempo especificado en la URL.

A continuación, se muestra un ejemplo:

DELETE /api/v1/businesses/BUSINESSID/bags/DT/employees/1006357/movements?from=2024-09-22&to=2024-09-26

La respuesta de esta petición contendrá todos los movimientos encontrados y el estado de cada uno de ellos:

[
    {
        "status": "DELETE",
        "employeeId": "1006357",
        "destinationBagId": "DT",
        "destinationDate": "2024-09-23",
        "value": 1.0,
        "reason": "Data adjustment 23"
    },
    {
        "status": "DELETE",
        "employeeId": "1006357",
        "destinationBagId": "DT",
        "destinationDate": "2024-09-24",
        "value": 2.0,
        "reason": "Data adjustment 24"
    },
    {
        "status": "DELETE",
        "employeeId": "1006357",
        "destinationBagId": "DT",
        "destinationDate": "2024-09-25",
        "value": 1.0,
        "reason": "Data adjustment 25"
    }
]

En este ejemplo, el campo status indica en cada movimiento que ha sido borrado: DELETE. Si alguno de los movimientos provoca un error al intentar borrarlo, en el campo status del movimiento aparecerá ERROR y también habrá un campo cause que indicará la causa del error.

Consideraciones

La petición elimina todos los movimientos vinculados con la bolsa pasada por parámetro: tanto los movimientos en los que la bolsa es el origen como aquellos en los que es el destino.

Códigos de error

Además de los errores comunes, este endpoint puede devolver los siguientes códigos:

Código Mensaje Descripción

400 Bad Request

Date range from to is not Valid

La fecha indicada en from es posterior a la indicada en to. Se recomienda revisar el orden de las dos fechas de la URL.

404 Not Found

Bag for business not found

El identificador de la bolsa no coincide con ninguna bolsa del negocio, o bien el identificador del empleado no coincide con ningún empleado del negocio: el mismo mensaje cubre las dos causas. Se recomienda verificar la bolsa a través de Obtener bolsas de un negocio y el empleado a través de Obtener información de un empleado.

Bag for person in business not found

La bolsa y el empleado existen, pero esa bolsa no está inicializada para ese empleado, por lo que no tiene ningún movimiento asociado.

Not Movements to Delete in Bag …​ for Employee …​ in Range from …​ to …​

No hay ningún movimiento de esa bolsa para ese empleado dentro del periodo indicado en la URL. Se recomienda comprobar los movimientos existentes a través de Obtener movimientos de bolsas por servicio.

409 Conflict

—

Al menos uno de los movimientos encontrados no se ha podido eliminar. El cuerpo de la respuesta no es un mensaje de error, sino la misma lista de movimientos que devuelve el 200 OK: se recomienda revisar el campo status de cada uno para identificar los que han fallado y el campo cause para conocer el motivo.

Enlaces de interés

¿Qué es una bolsa?