Bajas

7 artículos Maxim Por Maxim

Bajas

Bajas: dar de baja materiales y productos del almacén fuera de las ventas y la producción, por ejemplo por defectos, daños o materiales para uso interno. A través de la API puedes crear, editar y eliminar bajas, cambiar su estado, y obtener la lista y los datos de una baja. Las rutas de los métodos se indican respecto a la dirección base de la API; las reglas comunes a todos los métodos (autorización, formato de las solicitudes, edición parcial, paginación) se describen en Descripción general de la API y Reglas generales. Métodos Método Qué hace v1/writeoffs/add Crea una baja v1/writeoffs/edit Modifica una baja v1/writeoffs/delete Elimina una baja v1/writeoffs/update_status Cambia el estado de la baja v1/writeoffs/get_list Devuelve la lista de bajas v1/writeoffs/get_entry Devuelve una baja con sus líneas

Crear una baja

Crea una baja de materiales y productos del almacén. v1/writeoffs/add.php Parámetros Campo Tipo Obligatorio Descripción num string Sí Número materials array materials o products Materiales a dar de baja: id o sku y amount products array materials o products Productos a dar de baja: id o sku y amount date string No Fecha de la baja, YYYY-MM-DD. Por defecto hoy materials_storage_id int No Almacén del que se dan de baja los materiales. Por defecto el almacén de bajas de los ajustes de la empresa products_storage_id int No Almacén del que se dan de baja los productos. Por defecto el almacén de bajas de los ajustes de la empresa notes string No Notas Línea materials y products: Campo Tipo Obligatorio Descripción id int id o sku ID del material o del producto sku string id o sku SKU amount float Sí Cantidad, mayor que 0 notes string No Comentario de la línea Un material o producto se indica por id o sku. Hace falta al menos una línea en uno de los array. Una baja nueva se crea con el estado del ajuste Estado por defecto de las nuevas bajas. Ejemplo de solicitud { "num": "48", "date": "2026-10-06", "materials": [ { "id": 2051, "amount": 0.15, "notes": "Defecto: grieta" } ], "products": [ { "sku": "P-TABLE-01", "amount": 1 } ], "materials_storage_id": 3998, "products_storage_id": 4001, "notes": "Defecto al cortar" } Ejemplo de respuesta { "success": true, "writeoff_id": 19291, "num": "48", "status": 1 } La respuesta devuelve el ID, el número y el código de estado de la nueva baja. Errores Error Motivo No num in input num falta o está vacío No products or materials in input No se envió ninguna línea Materials is not an array materials no es un array (igual para products) Line 0 of materials must be an object La línea no es un objeto (en lugar de 0, el número de línea) SKU or id not set for material 0 La línea no tiene ni id ni sku Material with id 2051 not found Material no encontrado o eliminado (para un producto: Product with SKU "P-TABLE-01" not found) Amount must be greater than 0 for material with id 2051 La cantidad no es un número o no es mayor que 0 tras redondear Invalid notes value for material with id 2051. Must be a string notes de la línea no es una cadena Notes for material with id 2051 are too long: maximum 10000 characters El comentario de la línea supera los 10 000 caracteres Storage ID not found Almacén no encontrado o eliminado Date is not a valid date in format YYYY-MM-DD Formato de fecha no válido

Editar una baja

Modifica una baja. Solo se cambian los campos que envías, el resto se queda como estaba. Consulta la edición parcial en Reglas generales. v1/writeoffs/edit.php Parámetros Campo Tipo Obligatorio Descripción writeoff_id int Sí ID de la baja materials array No Materiales a dar de baja: id o sku y amount products array No Productos a dar de baja: id o sku y amount num string No Número date string No Fecha de la baja, YYYY-MM-DD materials_storage_id int No Almacén del que se dan de baja los materiales. 0: el almacén de bajas por defecto products_storage_id int No Almacén del que se dan de baja los productos. 0: el almacén de bajas por defecto notes string No Notas Si se envía al menos uno de los array materials y products, las líneas se reemplazan por completo, y el array que no se envía se considera vacío. Si no se envía ninguno, las líneas no cambian. El estado no se cambia con este método; usa v1/writeoffs/update_status. Ejemplo de solicitud { "writeoff_id": 19291, "materials": [ { "id": 2051, "amount": 0.2 } ] } En este ejemplo solo se envía materials, así que el producto se quita de la baja. Ejemplo de respuesta { "success": true } Errores Error Motivo No writeoff_id in input Falta writeoff_id Write-off not found or access denied Baja no encontrada o eliminada No products or materials in input Los array de líneas se enviaron pero vacíos Material with id 2051 not found Material no encontrado o eliminado Amount must be greater than 0 for material with id 2051 La cantidad no es un número o no es mayor que 0 tras redondear Storage ID not found Almacén no encontrado o eliminado Date is not a valid date in format YYYY-MM-DD Formato de fecha no válido Los demás errores de líneas son los mismos que en v1/writeoffs/add.

Eliminar una baja

Elimina una baja. v1/writeoffs/delete.php Parámetros Campo Tipo Obligatorio Descripción writeoff_id int Sí ID de la baja La eliminación no se puede deshacer. Los materiales y productos dados de baja vuelven al almacén. Ejemplo de solicitud { "writeoff_id": 19291 } Ejemplo de respuesta { "success": true } Errores Error Motivo No writeoff_id in input Falta writeoff_id Write-off not found or access denied Baja no encontrada o ya eliminada

Cambiar el estado de la baja

Cambia el estado de la baja. El estado determina si los materiales y productos se descuentan de las existencias. v1/writeoffs/update_status.php Parámetros Campo Tipo Obligatorio Descripción writeoff_id int Sí ID de la baja status int Sí Nuevo estado: 0 — Plan, 1 — Dada de baja Ejemplo de solicitud { "writeoff_id": 19291, "status": 1 } Ejemplo de respuesta { "success": true } Errores Error Motivo No writeoff_id in input Falta un campo obligatorio (en lugar de writeoff_id, el nombre del campo) Invalid status value. Must be one of: 0, 1 Código de estado no válido Write-off not found or access denied Baja no encontrada o eliminada

Obtener la lista de bajas

Devuelve las bajas de la empresa, de las nuevas a las antiguas: por fecha y, dentro de una misma fecha, por ID. Las líneas no se incluyen en la lista; las devuelve v1/writeoffs/get_entry. v1/writeoffs/get_list.php Parámetros Campo Tipo Obligatorio Descripción date_from string No Bajas desde esta fecha inclusive, YYYY-MM-DD date_to string No Bajas hasta esta fecha inclusive, YYYY-MM-DD status int No Estado: 0 Plan, 1 Dada de baja limit int No Tamaño de página, de 1 a 1000 offset int No Cuántos registros omitir Sin limit se devuelve toda la lista. Consulta la paginación en Reglas generales. Respuesta Un array writeoffs con los campos de la baja: Campo Tipo Descripción id int ID de la baja num string Número date string Fecha de la baja, YYYY-MM-DD status int Estado: 0 Plan, 1 Dada de baja materials_storage_id int Almacén del que se dan de baja los materiales materials_storage_name string Nombre del almacén de materiales products_storage_id int Almacén del que se dan de baja los productos products_storage_name string Nombre del almacén de productos cost float Coste de lo dado de baja amount float Cantidad total. null si los elementos tienen unidades distintas lines int Número de líneas notes string Notas El campo total contiene el número total de bajas que cumplen los filtros. Ejemplo de solicitud { "date_from": "2026-10-01", "date_to": "2026-10-31", "limit": 100, "offset": 0 } Ejemplo de respuesta { "success": true, "writeoffs": [ { "id": 19291, "num": "48", "date": "2026-10-06", "status": 1, "materials_storage_id": 3998, "materials_storage_name": "Principal", "products_storage_id": 4001, "products_storage_name": "Productos terminados", "cost": 26350, "amount": null, "lines": 2, "notes": "Defecto al cortar" } ], "total": 1 } Errores Error Motivo Date is not a valid date in format YYYY-MM-DD date_from o date_to no válida Invalid status value. Must be a number status no es un número Invalid limit value. Must be between 1 and 1000 limit no válido Offset requires limit se envió offset sin limit

Obtener los datos de una baja

Devuelve una baja con sus líneas. v1/writeoffs/get_entry.php Parámetros Campo Tipo Obligatorio Descripción writeoff_id int Sí ID de la baja Respuesta Un objeto writeoff con los campos de la baja: Campo Tipo Descripción id int ID de la baja num string Número date string Fecha de la baja, YYYY-MM-DD status int Estado: 0 Plan, 1 Dada de baja materials_storage_id int Almacén del que se dan de baja los materiales materials_storage_name string Nombre del almacén de materiales products_storage_id int Almacén del que se dan de baja los productos products_storage_name string Nombre del almacén de productos cost float Coste de lo dado de baja amount float Cantidad total. null si los elementos tienen unidades distintas lines int Número de líneas notes string Notas Y líneas en dos array: materials y products. Si no hay elementos de un tipo, el array está vacío. Campo Tipo Descripción id int ID del material o del producto sku string SKU name string Nombre amount float Cantidad unit string Unidad de medida cost float Coste de la línea position int Número de línea en la baja, desde 0. La numeración es común para materiales y productos notes string Comentario de la línea. Cadena vacía si no hay Las líneas de la respuesta se pueden enviar a v1/writeoffs/edit sin cambios. Ejemplo de solicitud { "writeoff_id": 19291 } Ejemplo de respuesta { "success": true, "writeoff": { "id": 19291, "num": "48", "date": "2026-10-06", "status": 1, "materials_storage_id": 3998, "materials_storage_name": "Principal", "products_storage_id": 4001, "products_storage_name": "Productos terminados", "cost": 26350, "amount": null, "lines": 2, "notes": "Defecto al cortar", "materials": [ { "id": 2051, "sku": "M010", "name": "Tablón de roble", "amount": 0.15, "unit": "m3", "cost": 20250, "position": 0, "notes": "Defecto: grieta" } ], "products": [ { "id": 512, "sku": "P-TABLE-01", "name": "Mesa de comedor", "amount": 1, "unit": "ud", "cost": 6100, "position": 1, "notes": "" } ] } } Errores Error Motivo No writeoff_id in input Falta writeoff_id Write-off not found or access denied Baja no encontrada o eliminada