Productos
En los productos puedes almacenar artículos y servicios que uses habitualmente en tus documentos.
Los productos o servicios usan siempre la última versión de los impuestos. Al modificar un impuesto se recalcularán todos los productos en los que se aplica.
Crear un producto
Este endpoint permite la creación de una nuevo producto o servicio en tu aplicación.
Petición HTTP
POST/products
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| name | Cadena / Obligatoria | Nombre del producto o servicio |
| quantity | Entero / Obligatorio | Cantidad |
| price | Número hasta 2 decimales / Obligatorio | Precio / Puede contener un signo negativo como "-100.05" |
| description | Cadena / Opcional / Máximo 500 caracteres | Descripción del producto o servicio |
| sku | Cadena / Opcional | Código interno único de producto |
| discount | Número hasta 2 decimales / Opcional / Min:0 Max:100 | Porcentaje de descuento aplicado al producto o servicio |
| business_line_id | Entero / Opcional | Identificador de línea de negocio asociado al producto o servicio |
| taxes | Array / Opcional | Array de identificadores de impuestos que se aplicarán al producto o servicio |
Datos petición
{
"name": "My product",
"quantity": 2,
"price": 10,
"description": "My product description",
"sku": "my-product-sku",
"discount": 10,
"business_line_id": 1
"taxes": [1,2],
}201Respuesta
{
"data": {
"id": 120,
"name": "My product",
"description": "My product description",
"sku": "my-product-sku",
"business_line": {
"id": 1,
"name": "Hardware"
},
"quantity": 2,
"price": 10,
"discount": 10,
"subtotal": 20,
"total_discount": 2,
"total_before_taxes": 18,
"taxes": [
{
"id": 1,
"name": "IVA",
"percentage": 21,
"total": 3.78
},
{
"id": 2,
"name": "IRPF",
"percentage": -15,
"total": -2.7
}
],
"total_taxes": 1.08,
"total_with_taxes": 19.08,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
}
}Listar productos
Este endpoint permite la consulta de los productos y servicios de tu aplicación.
Petición HTTP
GET/products
Parámetros GET
| Nombre | Tipo | Descripción |
|---|---|---|
| page | Entero / Opcional / Min:1 | Página |
| per_page | Entero / Opcional / Min:1 Max:100 | Elementos por página |
| business_line_id | Entero / Opcional | Filtrar por identificador de línea de negocio |
| search | Cadena / Opcional / Min:3 | Buscar por cadena de al menos 3 caracteres |
| order | Cadena / Opcional | Ordenar por un campo de forma ascendente o descendente, descendente por defecto, en formato "{field},desc" o "{field},asc" donde {field} puede ser: id, name, price, quantity, discount, total |
200 Respuesta
{
"data": [
{
"id": 120,
"name": "My product",
"description": "My product description",
"sku": "my-product-sku",
"business_line": {
"id": 1,
"name": "Hardware"
},
"quantity": 2,
"price": 10,
"discount": 10,
"subtotal": 20,
"total_discount": 2,
"total_before_taxes": 18,
"taxes": [
{
"id": 1,
"name": "IVA",
"percentage": 21,
"total": 3.78
},
{
"id": 2,
"name": "IRPF",
"percentage": -15,
"total": -2.7
}
],
"total_taxes": 1.08,
"total_with_taxes": 19.08,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
}
],
"links": {
"first": "http:\/\/api.orzame.com\/v1\/products?page=1",
"last": "http:\/\/api.orzame.com\/v1\/products?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "http:\/\/api.orzame.com\/v1\/products",
"per_page": 100,
"to": 1,
"total": 1
}
}Obtener un producto
Este endpoint permite la consulta de un producto de tu aplicación.
Petición HTTP
GET/products/{id}
200 Respuesta
{
"data": {
"id": 120,
"name": "My product",
"description": "My product description",
"sku": "my-product-sku",
"business_line": {
"id": 1,
"name": "Hardware"
},
"quantity": 2,
"price": 10,
"discount": 10,
"subtotal": 20,
"total_discount": 2,
"total_before_taxes": 18,
"taxes": [
{
"id": 1,
"name": "IVA",
"percentage": 21,
"total": 3.78
},
{
"id": 2,
"name": "IRPF",
"percentage": -15,
"total": -2.7
}
],
"total_taxes": 1.08,
"total_with_taxes": 19.08,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
}
}Actualizar un producto
Este endpoint permite la actualización de un producto o servicio de tu aplicación.
Petición HTTP
PATCH/products/{id}
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| name | Cadena / Opcional | Nombre del producto o servicio |
| quantity | Entero / Opcional | Cantidad |
| price | Número hasta 2 decimales / Opcional | Precio / Puede contener un signo negativo como "-100.05" |
| description | Cadena / Opcional / Máximo 500 caracteres | Descripción del producto o servicio |
| sku | Cadena / Opcional | Código interno único de producto |
| discount | Número hasta 2 decimales / Opcional / Min:0 Max:100 | Porcentaje de descuento aplicado al producto o servicio |
| business_line_id | Entero / Opcional | Identificador de línea de negocio asociado al producto o servicio. Puedes enviar el valor `null` para desasignar la línea de negocio del producto |
| taxes | Array / Opcional | Array de identificadores de impuestos que se aplicarán al producto o servicio. Puedes enviar un array vacío `[]` para desasignar todos los impuestos del producto |
Todos los parámetros son opcionales pero al menos un parámetro con valor debe ser enviado.
Datos petición
{
"name": "My new product",
"description": "My new product description",
"sku": "my-new-product-sku",
"quantity": 1,
"price": 5,
"discount": 0,
"taxes": [],
"business_line_id": null
}200 Respuesta
{
"data": {
"id": 120,
"name": "My new product",
"description": "My new product description",
"sku": "my-new-product-sku",
"business_line": null,
"quantity": 1,
"price": 5,
"discount": 0,
"subtotal": 5,
"total_discount": 0,
"total_before_taxes": 5,
"taxes": [],
"total_taxes": 0,
"total_with_taxes": 5,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T16:40:25+00:00"
}
}Eliminar un producto
Este endpoint permite la eliminación de un producto o servicio de tu aplicación.
Petición HTTP
DELETE/products/{id}
204 Respuesta
Respuesta sin cuerpo.