Impuestos
La API permite configurar y actualizar impuestos que se aplicarán a tus productos o servicios.
Crear un impuesto
Este endpoint permite la creación de un nuevo impuesto en tu aplicación.
Petición HTTP
POST/taxes
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
name | Cadena / Obligatoria | Nombre del impuesto |
percentage | Decimal / Obligatorio / Min:0 Max:100 | Porcentaje que aplicará el impuesto, admite 2 decimales |
positive | Boolean / Obligatorio / true, false | Indica si el impuesto se aplica de forma positiva o negativa |
default | Boolean / Obligatorio / true, false | Indica si el impuesto se aplica por defecto a productos o servicios, pueden existir varios por defecto |
Datos petición
{
"name": "Special",
"percentage": 10.55,
"positive": true,
"default": false
}
201Respuesta
{
"data": {
"id": 21,
"name": "Special",
"version": "b61b5814-07e6-402d-acd7-09791e13de72",
"percentage": 10.55,
"positive": true,
"default": false,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
}
}
Listar impuestos
Este endpoint permite la consulta de todos los impuestos de tu aplicación. Los impuestos son devueltos ordenados por nombre.
Petición HTTP
GET/taxes
200 Respuesta
{
"data": [
{
"id": 20,
"name": "IRPF",
"version": "279232c1-4b06-44af-9c4c-f4a681f00be9",
"percentage": 15,
"positive": false,
"default": true,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
},
{
"id": 19,
"name": "IVA",
"version": "5d9faebb-1b26-415f-a0bf-6fe854f1359f",
"percentage": 21,
"positive": true,
"default": true,
"created_at": "2022-09-29T15:30:15+00:00",
"updated_at": "2022-09-29T15:30:15+00:00"
},
{
"id": 21,
"name": "Special",
"version": "b61b5814-07e6-402d-acd7-09791e13de72",
"percentage": 10.55,
"positive": true,
"default": false,
"created_at": "2022-09-28T15:30:15+00:00",
"updated_at": "2022-09-28T15:30:15+00:00"
}
]
}
Obtener un impuesto
Este endpoint permite la consulta de un impuesto de tu aplicación.
Petición HTTP
GET/taxes/{id}
200 Respuesta
{
"data": {
"id": 21,
"name": "Special",
"version": "b61b5814-07e6-402d-acd7-09791e13de72",
"percentage": 10.55,
"positive": true,
"default": false,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
}
}
Actualizar un impuesto
Este endpoint permite la actualización de un impuesto de tu aplicación.
Petición HTTP
PATCH/taxes/{id}
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
name | Cadena / Opcional | Nombre del impuesto |
percentage | Número decimal / Opcional / Min:0 Max:100 | Porcentaje que aplicará el impuesto, admite 2 decimales |
positive | Boolean / Opcional / true, false | Indica si el impuesto se aplica de forma positiva o negativa |
default | Boolean / Opcional / true, false | Indica si el impuesto se aplica por defecto a productos o servicios, pueden existir varios por defecto |
Todos los parámetros son opcionales pero al menos un parámetro con valor debe ser enviado.
Actualizar el valor del impuesto implica que se generará una nueva versión del mismo.
Al editar un impuesto, se actualizarán los productos en los cuales se aplica. No se aplicarán cambios a facturas o presupuestos.
Datos petición
{
"percentage": 11,
"default": true
}
200Respuesta
{
"data": {
"id": 21,
"name": "Special",
"version": "c7214772-51ee-49b1-8e92-7336c44d331b",
"percentage": 11,
"positive": true,
"default": true,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
}
}
Eliminar un impuesto
Este endpoint permite la eliminación de un impuesto de tu aplicación.
No es posible eliminar si está en uso en la aplicación.
Petición HTTP
DELETE/taxes/{id}
204 Respuesta
Respuesta sin cuerpo.