Vencimientos
Los vencimientos establecen el plazo límite de días desde la fecha de emisión de una factura hasta su pago.
Crear un vencimiento
Este endpoint permite la creación de un nuevo vencimiento en tu aplicación.
Petición HTTP
POST/due-dates
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| name | Cadena / Obligatoria | Nombre de el vencimiento |
| days | Entero / Obligatorio / Min:0 Max:999 | Días desde la fecha de emisión de una factura hasta el plazo máximo de pago. |
| default | Boolean / Obligatorio / true, false | Vencimiento por defecto para aplicar en los documentos como facturas. |
Al enviar un vencimiento con el valor `default` = `true` se marcarán el resto de vencimientos con valor `false`, solo existirá un vencimiento por defecto.
Datos petición
{
"name": "Two months",
"days": 60,
"default": false
}201Respuesta
{
"data": {
"id": 23,
"name": "Two months",
"days": 60,
"default": false,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
}
}Listar vencimientos
Este endpoint permite la consulta de todos los vencimiento de tu aplicación. Los vencimientos son devueltos ordenados por días, de menor a mayor.
Petición HTTP
GET/due-dates
200 Respuesta
{
"data": [
{
"id": 17,
"name": "Payment on demand",
"days": 0,
"default": false,
"created_at": "2022-09-21T15:30:15+00:00",
"updated_at": "2022-09-21T15:30:15+00:00"
},
{
"id": 22,
"name": "One week",
"days": 7,
"default": true,
"created_at": "2022-09-29T16:30:15+00:00",
"updated_at": "2022-09-29T16:30:15+00:00"
},
{
"id": 18,
"name": "15 Days",
"days": 15,
"default": false,
"created_at": "2022-09-28T15:30:15+00:00",
"updated_at": "2022-09-28T15:30:15+00:00"
},
{
"id": 21,
"name": "One month",
"days": 30,
"default": false,
"created_at": "2022-09-29T15:30:15+00:00",
"updated_at": "2022-09-29T15:30:15+00:00"
},
{
"id": 23,
"name": "Two months",
"days": 60,
"default": false,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
}
]
}Obtener un vencimiento
Este endpoint permite la consulta de un vencimiento de tu aplicación.
Petición HTTP
GET/due-dates/{id}
200 Respuesta
{
"data": {
"id": 23,
"name": "Two months",
"days": 60,
"default": false,
"created_at": "2022-09-30T15:30:15+00:00",
"updated_at": "2022-09-30T15:30:15+00:00"
}
}Actualizar un vencimiento
Este endpoint permite la actualización de un vencimiento de tu aplicación.
El atributo `days´ de un vencimiento en uso no puede ser actualizado, si se envía será obviado.
Petición HTTP
PATCH/due-dates/{id}
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| name | Cadena / Opcional | Nombre de el vencimiento |
| days | Entero / Opcional / Min:0 Max:999 | Días desde la fecha de emisión de una factura hasta el plazo máximo de pago. |
| default | Boolean / Opcional / true, false | Vencimiento por defecto para aplicar en los documentos como facturas. |
Todos los parámetros son opcionales pero al menos un parámetro con valor debe ser enviado.
Al enviar un vencimiento con el valor `default` = `true` se marcarán el resto de vencimientos con valor `false`, solo existirá un vencimiento por defecto.
Datos petición
{
"name": "Two months",
"days": 60,
"default": true
}204 Respuesta
Respuesta sin cuerpo.
Eliminar un vencimiento
Este endpoint permite la eliminación de un vencimiento de tu aplicación.
No es posible eliminar si está en uso en la aplicación.
Petición HTTP
DELETE/due-dates/{id}
204 Respuesta
Respuesta sin cuerpo.