ALalegra
Facturas recurrentes

Editar una factura recurrente

Changed on

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}.

put/recurring-invoices/{id}

Request

  • Base URL
    https://api.alegra.com/api/v1
  • URL
    https://api.alegra.com/api/v1/recurring-invoices/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

Id de la factura recurrente que se desea editar.

Request body

termsConditionsstring

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

numberTemplateobject

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.

anotationstring

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.

startDatestring date

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

endDatestring 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.

repeatEverynumber

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

termnumber

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.

observationsstring

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.

clientobject

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

priceListobject

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.

warehouseobject

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.

costCenterobject

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.

Example request

{
  "numberTemplate": {
    "id": "1"
  },
  "items": [
    {
      "name": "Arroz",
      "discount": 20,
      "description": "Arroz para la siembra"
    }
  ],
  "anotation": "Estas son las notas de mi factura recurrente.",
  "startDate": "2019-02-14",
  "endDate": "2019-02-14",
  "repeatEvery": 1,
  "term": 1,
  "observations": "Estas son las observaciones de mi factura recurrente.",
  "client": {
    "id": "1"
  },
  "priceList": {
    "id": "1"
  },
  "currency": {
    "code": "USD"
  },
  "warehouse": {
    "id": "1"
  },
  "costCenter": {
    "id": "1"
  }
}

Response

Retorna información de una factura recurrente

Changes