Recursos
Por Maxim
Por Maxim
Recursos
Recursos: todo lo que se usa en la producción y no es un material. Por ejemplo, la mano de obra, la electricidad, los equipos o los gastos generales. Los recursos entran en los componentes de un producto y cuentan para su coste; no tienen existencias en los almacenes. A través de la API puedes crearlos, editarlos y eliminarlos, y obtener la lista y los datos de un recurso. 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/resources/add Crea un recurso v1/resources/edit Modifica un recurso v1/resources/delete Elimina un recurso v1/resources/get_list Devuelve los recursos de la empresa v1/resources/get_entry Devuelve los datos de un recurso
Crear un recurso
Crea un recurso. El conjunto de campos obligatorios depende del tipo de cálculo. v1/resources/add.php Parámetros Campo Tipo Obligatorio Descripción name string Sí Nombre type string Sí Tipo de cálculo: «rate», «percent» o «amortized» dynamic int No 1: el precio de una tarifa fija o el porcentaje de un recurso porcentual se indica en los componentes del producto. Por defecto 0. No se usa en la amortización unit string Para rate y amortized Unidad de medida, un código de Unidades de medida . No hace falta en una tarifa con dynamic 1 price float Para rate Precio por unidad. No hace falta en una tarifa con dynamic 1 base string Para percent Base de cálculo: «cost» o «price» percent float Para percent Porcentaje. No hace falta con dynamic 1 initial_cost float Para amortized Coste inicial useful_life float Para amortized Vida útil, en unidades de unit notes string No Notas categories array No Categorías: objetos con id o name Una categoría se puede pasar por nombre: si no existe, se crea. Los ID de las categorías existentes los devuelve v1/categories/get_list. Tipos de recurso El tipo de cálculo determina qué campos hacen falta al crear un recurso. Tipo Descripción Campos obligatorios «rate», Tarifa fija Mano de obra, electricidad, fabricación por contrato unit, price «rate» con dynamic 1, El precio se indica en los componentes del producto El importe se fija en los componentes de cada producto Ninguno «percent», Porcentaje Gastos generales, comisiones base, percent «percent» con dynamic 1, El porcentaje se indica en los componentes del producto El porcentaje se fija en los componentes de cada producto base «amortized», Amortización Equipos, vehículos, herramientas unit, initial_cost, useful_life La base de cálculo (base) de un recurso porcentual: - «cost»: el coste del producto sin los recursos porcentuales; - «price»: el precio de venta de la ficha del producto. Unidades de medida A un recurso se le puede asignar cualquier unidad, incluidas las de tiempo y energía disponibles solo para los recursos: «h», «min», «kWh». Consulta la lista en Unidades de medida. Ejemplos de solicitud Una tarifa fija: la tarifa por hora de un carpintero. { "name": "Trabajo del carpintero", "type": "rate", "unit": "h", "price": 600, "categories": [{ "id": 31 }] } Un porcentaje del coste, igual para todos los productos: { "name": "Gastos generales", "type": "percent", "base": "cost", "percent": 10 } Una comisión del marketplace cuyo porcentaje se fija en los componentes de cada producto: { "name": "Comisión del marketplace", "type": "percent", "dynamic": 1, "base": "price" } Amortización de un equipo: { "name": "Fresadora", "type": "amortized", "unit": "h", "initial_cost": 600000, "useful_life": 2000 } Ejemplo de respuesta { "success": true, "resource_id": 57 } Errores Error Motivo No name in input Falta un campo obligatorio (en lugar de name, el nombre del campo: type o un campo obligatorio del tipo) Name must not be empty Nombre vacío Name must be a string El nombre no se envió como cadena, p. ej. como array Invalid type value. Must be one of: rate, percent, amortized type no válido Unit not set Se envió una unidad de medida vacía Unit not found Unidad de medida desconocida Invalid price value. Must be a number, 0 or greater El precio no es un número o es menor que 0 (igual para initial_cost) Invalid base value. Must be one of: cost, price Base de cálculo no válida Percent must be greater than 0 and not exceed 100 El porcentaje es 0, menor que 0 o mayor que 100 Useful life must be greater than 0 La vida útil es 0 o menor Category 12 not found Categoría no encontrada
Editar un recurso
Modifica un recurso. Solo se cambian los campos que envías, el resto se queda como estaba. v1/resources/edit.php Parámetros Campo Tipo Obligatorio Descripción resource_id int Sí ID del recurso name string No Nombre type string No Tipo de cálculo: «rate», «percent» o «amortized» dynamic int No 1: el precio o el porcentaje se indica en los componentes del producto unit string No Unidad de medida. Se tiene en cuenta solo en la tarifa fija y la amortización price float No Precio por unidad base string No Base de cálculo: «cost» o «price» percent float No Porcentaje initial_cost float No Coste inicial useful_life float No Vida útil, en las unidades del recurso notes string No Notas categories array No Categorías: objetos con id o name. Reemplazan las actuales por completo Qué campos necesita cada tipo se describe en Crear un recurso. Al cambiar type, envía los campos que el recurso aún no tiene: unit para la tarifa fija y la amortización, base y percent para el porcentaje, initial_cost y useful_life para la amortización. La cantidad del recurso en los componentes de los productos no se recalcula, así que compruébala tras el cambio. En un recurso que ya se ha consumido en producción no se puede cambiar el tipo de cálculo, y en un recurso amortizado tampoco el coste inicial, la vida útil ni la unidad. Los demás campos sí se pueden cambiar. Ejemplo de solicitud { "resource_id": 57, "price": 650 } Ejemplo de respuesta { "success": true } Errores Error Motivo No resource_id in input Falta resource_id Resource not found or access denied Recurso no encontrado o eliminado Name must not be empty Se envió un nombre vacío Name must be a string El nombre no se envió como cadena, p. ej. como array Invalid type value. Must be one of: rate, percent, amortized type no válido No unit in input El tipo cambió a tarifa fija o amortización, pero el recurso no tiene unidad Unit not set Se envió una unidad de medida vacía Unit not found Unidad de medida desconocida Unit cannot be changed to another unit group: the resource is used in components of products Cambio del grupo de unidad de un recurso usado en los componentes de un producto Invalid price value. Must be a number, 0 or greater El precio no es un número o es menor que 0 (igual para initial_cost) Invalid base value. Must be one of: cost, price Base de cálculo no válida, o no se envió al cambiar el tipo a porcentaje Percent must be greater than 0 and not exceed 100 El porcentaje está fuera de rango, o no se envió al cambiar el tipo a porcentaje Useful life must be greater than 0 La vida útil es 0 o menor, o no se envió al cambiar el tipo a amortización The resource is already used in production, so these fields cannot be changed: type, useful_life El recurso ya se ha consumido en producción. Al final se enumeran los campos que no se pueden cambiar: type, initial_cost, useful_life, unit Category 12 not found Categoría no encontrada
Eliminar un recurso
Elimina un recurso. v1/resources/delete.php Parámetros Campo Tipo Obligatorio Descripción resource_id int Sí ID del recurso Ejemplo de solicitud { "resource_id": 57 } Ejemplo de respuesta { "success": true } Errores Error Motivo No resource_id in input Falta resource_id Resource not found or access denied Recurso no encontrado o ya eliminado
Obtener la lista de recursos
Devuelve los recursos de la empresa, ordenados por nombre. Los recursos archivados también se incluyen. v1/resources/get_list.php Parámetros Campo Tipo Obligatorio Descripción 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 resources con los campos del recurso y sus categorías. El campo total contiene el número total de recursos. Campo Tipo Descripción id int ID del recurso name string Nombre type string Tipo de cálculo: «rate», «percent» o «amortized» dynamic int 1 si el precio o el porcentaje se indica en los componentes del producto base string Base de cálculo de un recurso porcentual: «cost» o «price». null en los demás tipos unit string Unidad de medida, un código de Unidades de medida . Presente solo en la tarifa fija y la amortización, null en el resto price float Precio por unidad percent float Porcentaje de un recurso porcentual initial_cost float Coste inicial del equipo useful_life float Vida útil, en las unidades del recurso left_life float Vida útil restante. Disminuye cuando el recurso se consume en producción notes string Notas archived int 1 si el recurso está archivado categories array Categorías del recurso: objetos con id y name Ejemplo de solicitud { "limit": 100, "offset": 0 } Ejemplo de respuesta { "success": true, "resources": [ { "id": 57, "name": "Trabajo del carpintero", "type": "rate", "dynamic": 0, "base": null, "unit": "h", "price": 600, "percent": 0, "initial_cost": 0, "useful_life": 0, "left_life": 0, "notes": "", "archived": 0, "categories": [ { "id": 31, "name": "Personal" } ] }, { "id": 59, "name": "Fresadora", "type": "amortized", "dynamic": 0, "base": null, "unit": "h", "price": 300, "percent": 0, "initial_cost": 600000, "useful_life": 2000, "left_life": 1874.5, "notes": "", "archived": 0, "categories": [] } ], "total": 2 } Errores Error Motivo Invalid limit value. Must be between 1 and 1000 limit no válido Invalid offset value. Must be 0 or greater offset no válido Offset requires limit se envió offset sin limit
Obtener los datos de un recurso
Devuelve los datos de un recurso. v1/resources/get_entry.php Parámetros Campo Tipo Obligatorio Descripción resource_id int Sí ID del recurso Respuesta Un objeto resource con los campos del recurso y sus categorías. Las categorías de la respuesta se pueden enviar a v1/resources/edit sin cambios. Campo Tipo Descripción id int ID del recurso name string Nombre type string Tipo de cálculo: «rate», «percent» o «amortized» dynamic int 1 si el precio o el porcentaje se indica en los componentes del producto base string Base de cálculo de un recurso porcentual: «cost» o «price». null en los demás tipos unit string Unidad de medida, un código de Unidades de medida . Presente solo en la tarifa fija y la amortización, null en el resto price float Precio por unidad percent float Porcentaje de un recurso porcentual initial_cost float Coste inicial del equipo useful_life float Vida útil, en las unidades del recurso left_life float Vida útil restante. Disminuye cuando el recurso se consume en producción notes string Notas archived int 1 si el recurso está archivado categories array Categorías del recurso: objetos con id y name Ejemplo de solicitud { "resource_id": 58 } Ejemplo de respuesta { "success": true, "resource": { "id": 58, "name": "Gastos generales", "type": "percent", "dynamic": 0, "base": "cost", "unit": null, "price": 0, "percent": 10, "initial_cost": 0, "useful_life": 0, "left_life": 0, "notes": "", "archived": 0, "categories": [] } } Errores Error Motivo No resource_id in input Falta resource_id Resource not found or access denied Recurso no encontrado o eliminado