Series de facturas
Las series de facturas ofrecen la posibilidad diferenciar facturas correspondientes a diferentes actividades de la empresa o diferentes periodos.
Crear una serie de factura
Este endpoint permite la creación de una nueva serie de factura en tu aplicación.
Petición HTTP
POST/invoices-series
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| name | Cadena / Obligatoria | Nombre de la serie de factura |
| prefix | Cadena / Obligatorio | Prefijo de la serie de factura, precederá al número secuencial |
| number | Entero / Obligatorio / Min:1 | Número en el que empieza la primera factura de la serie, `1` es el valor más usado |
| default | Boolean / Obligatorio / true, false | Indica si es la serie por defecto de su tipo |
| rectification | Boolean / Obligatorio / true, false | Indica el tipo, si es una serie para facturas rectificativas o no |
Al enviar una serie por defecto con el valor `default` = `true` se marcarán el resto de series de su tipo (rectificativas o no) con valor `false`, solo existirá una serie por defecto en cada tipo.
Datos petición
{
"name": "Corrective",
"prefix": "R",
"number": 1,
"rectification": true,
"default": true
}201Respuesta
{
"data": {
"id": 24,
"name": "Corrective",
"prefix": "R",
"number": 1,
"rectification": true,
"default": true,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
}
}Listar series de facturas
Este endpoint permite la consulta de las series de facturas de tu aplicación.
Petición HTTP
GET/invoices-series
200 Respuesta
{
"data": [
{
"id": 24,
"name": "Corrective",
"prefix": "R",
"number": 1,
"rectification": true,
"default": true,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
},
{
"id": 23,
"name": "Secondary",
"prefix": "FS",
"number": 1,
"rectification": false,
"default": false,
"created_at": "2022-09-29T15:30:15+00:00",
"updated_at": "2022-09-29T15:30:15+00:00"
},
{
"id": 22,
"name": "Principal",
"prefix": "F",
"number": 1,
"rectification": false,
"default": true,
"created_at": "2022-09-28T15:30:15+00:00",
"updated_at": "2022-09-28T15:30:15+00:00"
}
]
}Obtener una serie de factura
Este endpoint permite la consulta de una serie de factura de tu aplicación.
Petición HTTP
GET/invoices-series/{id}
200 Respuesta
{
"data": {
"id": 24,
"name": "Corrective",
"prefix": "R",
"number": 1,
"rectification": true,
"default": true,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
}
}Actualizar una serie de factura
Este endpoint permite la actualización de una serie de factura de tu aplicación.
Solo se puede actualizar los atributos `name´ y `default´ de una serie en uso, si se envían parámetros adicionales serán obviados.
Petición HTTP
PATCH/invoices-series/{id}
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| name | Cadena / Opcional | Nombre de la serie de factura |
| prefix | Cadena / Opcional | Prefijo de la serie de factura, precederá al número secuencial |
| number | Entero / Opcional / Min:1 | Número en el que empieza la primera factura de la serie, `1` es el valor más usado |
| default | Boolean / Opcional / true, false | Indica si es la serie por defecto de su tipo |
| rectification | Boolean / Opcional / true, false | Indica el tipo, si es una serie para facturas rectificativas o no |
Una serie en uso no puede ser eliminada y solo puede ser actualizada parcialmente.
Todos los parámetros son opcionales pero al menos un parámetro con valor debe ser enviado.
Al enviar una serie por defecto con el valor `default` = `true` se marcarán el resto de series de su tipo (rectificativas o no) con valor `false`, solo existirá una serie por defecto en cada tipo.
Datos petición
{
"name": "Corrective serie"
}204 Respuesta
Respuesta sin cuerpo.
Eliminar una serie de factura
Este endpoint permite la eliminación de una serie de factura de tu aplicación.
No es posible eliminar si está en uso en la aplicación.
Petición HTTP
DELETE/invoices-series/{id}
204 Respuesta
Respuesta sin cuerpo.
Una serie en uso no puede ser eliminada y solo puede ser actualizada parcialmente.