Update a recurring invoice

Update a recurring invoice object.

When a recurring invoice is updated or deleted, all future invoices are automatically changed.

Warning: All invoice line item details are overwritten with an update operation. When you update an invoice detail, enter all existing invoice line item details.

What is a recurring invoice?

A recurring invoice is an identical invoice created to receive periodic payments from a customer. These invoices represent an amount that you are owed by a customer for goods and services that you provide.

You can create a recurring invoice with /v2/Crud/Create/RecurringInvoice.json. In the invoice, add invoice line items to record details about individual goods or services. In addition, you can associate line items to accounts tracking objects, such as item (/Item.json) or chart of accounts (/ChartOfAccounts.json).

Other invoice features:

Line item price, markups, & discounts

In your request, either price or percentage (ratePercent) is required for each recurringInvoiceLineItems object. If you set one, do not set the other.

  • If price is set, amount is (quantity) x (price).
  • If ratePercent is set for a line item, the line item amount is (ratePercent) x (sum of other line item amount values). For example, to apply a discount of 20% in your invoice total of $100, set ratePercent as -20 in the final line item of your request.
  "recurringInvoiceLineItems": [
    {
      "entity": "recurringInvoiceLineItem",
      "description": "item 01",
      "quantity": 1,
      "price": 50,
      "amount": 50
    },
    {
      "entity": "recurringInvoiceLineItem",
      "description": "item 02",
      "quantity": 2,
      "price": 25,
      "amount": 50
    },
    {
      "entity": "recurringInvoiceLineItem",
      "description": "discount",
      "quantity": 1,
      "ratePercent": -20
    }
  ]
Form Data
string
required

Developer key (sent to you when you create a developer account)

string
required

API session ID generated with /v2/Login.json

data
object
required
Response

Response body
object
integer

Response status.

  • 0: Success response
  • 1: Error response. Only error_code and error_message is returned in response_data.
string

Response status.

  • Success: Success response
  • Error: Error response. Only error_code and error_message is returned in response_data.
response_data
object
string

Object type. Set as RecurringInvoice.

string

BILL-generated ID of the recurring invoice. The value begins with rit.

string

Object visibility status. Inactive objects are hidden by default in the BILL web app.

  • 1: Active
  • 2: Inactive
string

BILL-generated ID of the customer. The value begins with 0cu.

string

Purchase order number associated with the invoice

string

Sales representative associated with the invoice

string

BILL-generated ID of the department associated with the invoice. This is an accounts tracking object.

string

BILL-generated ID of the location associated with the invoice. This is an accounts tracking object.

string

BILL-generated ID of the accounting class associated with the invoice. This is an accounts tracking object.

string

BILL-generated ID of the job associated with the invoice. This is an accounts tracking object.

string

BILL-generated ID of the sales tax applied to all taxable line items in the invoice. The value begins with 0ii. The salesTaxTotal in the response is calculated based on the itemSalesTax value.

You can set your sales tax value with the BILL web app. On the Settings page, click Classifications under Accounting, and then create a new item with the TYPE set as Sales Tax.

string

Invoice description

boolean

Set as true if the invoice is to be printed and mailed to the customer

boolean

Set as true if the invoice is to be emailed to the customer

boolean

Set as true if the generated invoice is automatically emailed to the customer. BILL uses the default email template and sends the email to all the customer and customer contacts recipients.

string

BILL-generated ID of the user that set up recurring invoices. The value begins with 006.

string

BILL-generated payment term ID for the customer. The payment term defines when a payment is sent.

string

BILL-generated ID of the invoice template

string

Time period.

  • 0: Day
  • 1: Week
  • 2: Month
  • 3: Year
  • 9: None
integer

Invoice frequency per timePeriod.

For example, if timePeriod is 2 and frequencyPerTimePeriod is 3, an invoice is generated once every 3 months.

string

Due date of the next invoice in the YYYY-MM-DD format

string

Date after which the recurring invoices stop. This value is in the YYYY-MM-DD format.

integer

Number of days before nextDueDate when the next invoice is generated. If the date has occurred in the past for one or more invoices, all those invoices are generated.

number

Total taxable invoice amount

number

Total invoice amount without taxes

string

Created date and time

string

Updated date and time

recurringInvoiceLineItems
array of objects
recurringInvoiceLineItems
object
string

Object type. Set as RecurringInvoiceLineItem.

string

BILL-generated recurring invoice line item ID. The value begins with ril.

string

BILL-generated ID of the chart of accounts associated with the recurring invoice line item. This is an accounts tracking object.

string

BILL-generated ID of the department associated with the recurring invoice line item. This is an accounts tracking object.

string

BILL-generated ID of the location associated with the recurring invoice line item. This is an accounts tracking object.

string

BILL-generated ID of the accounting class associated with the recurring invoice line item. This is an accounts tracking object.

string

BILL-generated ID of the job associated with the recurring invoice line item. This is an accounts tracking object.

string

Recurring invoice line item description

string

BILL-generated ID of the recurring invoice. The value begins with rit.

string

BILL-generated ID of the item associated with the recurring invoice. This is an accounts tracking object.

number

Invoice line item total amount. If ratePercent is set, amount is (ratePercent) x (sum of other line item amount values). If price is set, amount is (quantity) x (price).

number

Quantity of items sold or time spent providing the service

number

Item price or service rate

number

Item rate percentage.

  • A positive value is a markup. For example, set as 20 for a 20% markup.
  • A negative value is a discount. For example, set as -20 for a 20% discount.
boolean

Set as true if the invoice line item is taxable and is included in the salesTaxTotal calculation

string

Created date and time

string

Updated date and time

string

Error code (only when response_status is 1)

string

Error message (only when response_status is 1)

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json