Editar una factura recurrente

put

https://api.alegra.com/api/v1/recurring-invoices/{id}

Endpoint que permite editar una factura recurrente. Únicamente se modifican los atributos que se envían en el request, los otros atributos del objeto que no se envían quedan intactos. Se retorna la factura recurrente que se ha modificado.

Por ejemplo para editar el término de pago de una factura recurrente se debe enviar el siguiente JSON: {"term" : 2}. Para eliminar algún dato de la factura de venta enviar el atributo en null, así: {"observations" : null}.

Path Params

string

required

Id de la factura recurrente que se desea editar.

Body Params

client

Objeto que indica el id del cliente asociado a la factura recurrente. Se puede enviar directamente el id del cliente en este atributo.

anotation

string

length ≤ 500

Notas de la factura recurrentes, visibles serán visibles en el PDF o documento impreso cuando se convierta a factura de venta. Longitud máxima permitida: 500.

termsConditions

string

length ≤ 500

Términos y condiciones de la factura recurrente. Longitud máxima permitida: 500.

numberTemplate

Objeto que indica el id de la numeración asociada a la factura recurrente. Se puede enviar directamente el id de la numeración en este atributo.

items

array of objects

Array de objetos item (productos/servicios) asociados a la factura recurrente. Cada objeto debe incluir: id (number, obligatorio): identificador del producto o servicio que se vende; price (double, obligatorio): precio de venta; reference (string) : referencia del producto/servicio; description (string): descripción del producto/servicio; tax (objeto) : array de objetos tax que indican la información del impuesto; quantity (obligatorio): cantidad vendida del producto o servicio. El precio del producto/servicio no debe incluir impuestos ni descuentos.

items

startDate

date

Fecha en la que iniciará la generación de facturas de venta a partir de la factura recurrente. Formato yyyy-MM-dd.

endDate

date

Fecha en la que terminará la generación de facturas de venta a partir de la factura recurrente. Formato yyyy-MM-dd. Si se envía null, la factura recurrente correrá para siempre.

repeatEvery

number

Intervalo que indica cada cuantos meses se generará la factura de venta a partir de esta factura recurrente.

term

number

Id del término de pago a utilizar. Índica cuantos días tiene el cliente para pagar una vez se genere la factura de venta.

observations

string

length ≤ 500

Observaciones de la factura recurrente (no serán visibles en el pdf o documento impreso cuando se convierta a factura de venta). Longitud máxima permitida: 500.

priceList

Objeto que indica el id de la lista de precios asociada a la factura recurrente. Se puede enviar directamente el id de la lista de precios en este atributo.

currency

object

Objecto que incluye el código de la moneda asociada a la factura recurrente. Solo se debe incluir si la compañía tiene activa la funcionalidad de multimoneda y tiene configurada la moneda seleccionada.

warehouse

Objeto que indica el id de la bodega/almacén asociada a la factura recurrente. Se puede enviar directamente el id de la bodega/almacén en este atributo. Si no se envía este parámetro la factura recurrente queda asociada a la bodega/almacén Principal.

costCenter

Objeto que indica el id del centro de costo asociado. Se puede enviar directamente el id del centro de costo en este atributo o enviarlo como objeto.

Responses

200Retorna información de una factura recurrente

400Bad request

404Not Found