Top

Recurring Invoices

List recurring invoices
GET /recurringinvoices
List all recurring invoices with pagination.
Get a recurring invoice
GET /recurringinvoices/:recurring_invoice_id
Get the details of a recurring invoice.
Create a recurring invoice
POST /recurringinvoices
Create a recurring invoice for your customer.
Update a recurring invoice
PUT /recurringinvoices/:recurring_invoice_id
Update an existing recurring invoice. To delete a line item just remove it from the line_items list.
Delete a recurring invoice
DELETE /recurringinvoices/:recurring_invoice_id
Delete an existing recurring invoice.
Stop a recurring invoice
POST /recurringinvoices/:recurring_invoice_id/status/stop
Stop an active recurring invoice.
Resume a recurring invoice
POST /recurringinvoices/:recurring_invoice_id/status/resume
Resume a stopped recurring invoice.
Update recurring invoice template
PUT /recurringinvoices/:recurring_invoice_id/templates/:template_id
Update the pdf template associated with the recurring invoice.
List recurring invoice history
GET /recurringinvoices/:recurring_invoice_id/comments
Get the complete history and comments of a recurring invoice.

List recurring invoices

GET  /recurringinvoices

List all recurring invoices with pagination.

Parameters

recurrence_name string
[100]
Search recurring invoices by name.
Variants: recurrence_name_startswith and recurrence_name_contains
item_name string
[100]
Search recurring invoices by item name.
Variants: item_name_startswith and profileitemname_contains
item_description string
[100]
Search recurring invoices by item description.
Variants: item_description_startswith and item_description_contains
customer_name string
[100]
Search recurring invoices by customer name.
Variants: customer_name_startswith and customer_name_contains
line_item_id string Search recurring invoices by line item id.
item_id string Search recurring invoices by item id.
tax_id string Search recurring invoices by tax id.
notes string Search recurring invoices by notes.
Variants: notes_startswith and notes_contains
start_date string
[yyyy-MM-dd]
Search recurring invoices by start date.
Variants: start_date_start, start_date_end, start_date_before and start_date_after
end_date string
[yyyy-MM-dd]
Search recurring invoices by end date.
Variants: end_date_start, end_date_end, end_date_before and end_date_after
customer_id string Search recurring invoices by customer id.
status string Search recurring invoices by status.
Allowed Values: active, stopped and expired
filter_by string Filter recurring invoices by any status.
Allowed Values: Status.All, Status.Active, Status.Stopped and Status.Expired
search_text string
[100]
Search recurring invoices by recurring invoice name or customer name.
sort_column string Sort recurring invoices.
Allowed Values: customer_name, recurrence_name, total, start_date, end_date, last_sent_date, next_invoice_date and created_time

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "recurring_invoices": [
    {
      "recurring_invoice_id": "460000000052117",
      "recurrence_name": "Premium Plan",
      "status": "stopped",
      "total": 44.60,
      "customer_id": "460000000026049",
      "customer_name": "Bowman and Co",
      "start_date": "2013-10-03",
      "end_date": "2013-11-04",
      "last_sent_date": "2013-10-03",
      "next_invoice_date": "2013-11-03",
      "recurrence_frequency": "months",
      "repeat_every": 1,
      "created_time": "2013-10-03T19:11:16+0530"
    },
    {
      "recurring_invoice_id": "460000000030017",
      "recurrence_name": "Premium Plan Upgrade",
      "status": "stopped",
      "total": 58.24,
      "customer_id": "460000000026049",
      "customer_name": "Bowman and Co",
      "start_date": "2013-08-06",
      "end_date": "2014-08-16",
      "last_sent_date": "2013-08-06",
      "next_invoice_date": "2013-09-06",
      "recurrence_frequency": "months",
      "repeat_every": 1,
      "created_time": "2013-08-06T18:08:04+0530"
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 200,
    "has_more_page": false,
    "report_name": "Recurring Invoices",
    "applied_filter": "Status.All",
    "sort_column": "created_time",
    "sort_order": "D"
  }
}

Get a recurring invoice

GET  /recurringinvoices/:recurring_invoice_id

Get the details of a recurring invoice.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "recurring_invoice": {
    "recurring_invoice_id": "460000000052117",
    "recurrence_name": "Premium Plan",
    "status": "stopped",
    "recurrence_frequency": "months",
    "repeat_every": 1,
    "start_date": "2013-10-03",
    "end_date": "2013-11-04",
    "last_sent_date": "2013-10-03",
    "next_invoice_date": "2013-11-03",
    "payment_terms": 15,
    "payment_terms_label": "Net 15",
    "customer_id": "460000000026049",
    "customer_name": "Bowman and Co",
    "contact_persons": [
      "460000000026051"
    ],
    "currency_id": "460000000000097",
    "currency_code": "USD",
    "exchange_rate": 1.00,
    "discount": 0.00,
    "is_discount_before_tax": true,
    "discount_type": "item_level",
    "is_inclusive_tax": "false",
    "line_items": [
      {
        "item_id": "460000000027017",
        "line_item_id": "460000000052125",
        "name": "Premium Plan - Web hosting",
        "description": "10 GB Space, 300 GB Transfer 100 Email Accounts 10 MySQL Databases",
        "item_order": 1,
        "rate": 33.00,
        "quantity": 1.00,
        "unit": "Nos",
        "discount": "10.60%",
        "tax_id": "460000000027007",
        "tax_name": "Sales Tax",
        "tax_type": "tax",
        "tax_percentage": 10.5,
        "item_total": 29.50
      }
    ],
    "shipping_charge": 10.00,
    "adjustment": 2.00,
    "adjustment_description": "Adjustment",
    "sub_total": 29.50,
    "total": 44.60,
    "tax_total": 3.10,
    "allow_partial_payments": true,
    "taxes": [
      {
        "tax_name": "Sales Tax (10.5%)",
        "tax_amount": 3.10
      }
    ],
    "payment_options": {
      "payment_gateways": [
        {
          "configured": true,
          "additional_field1": "standard",
          "gateway_name": "paypal"
        },
        {
          "configured": true,
          "gateway_name": "stripe"
        }
      ]
    },
    "billing_address": {
      "address": "4900 Hopyard Rd, Suite 310",
      "city": "Pleasanton",
      "state": "CA",
      "zip": "94588",
      "country": "USA",
      "fax": "+1-925-924-9600"
    },
    "shipping_address": {
      "address": "Suite 125, McMillan Avenue",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94134",
      "country": "USA",
      "fax": "+1-925-924-9600"
    },
    "template_id": "460000000052069",
    "template_name": "Custom Classic",
    "notes": "Thanks for your business.",
    "terms": "",
    "salesperson_id": "460000000027021",
    "salesperson_name": "John Michael",
    "created_time": "2013-10-03T19:11:16+0530",
    "last_modified_time": "2013-10-07T19:18:40+0530"
  }
}

Create a recurring invoice

POST  /recurringinvoices

Create a recurring invoice for your customer.

Request attributes

recurrence_name* string
[50]
Name of the recurring invoice.
customer_id* string ID of the customer the recurring invoice has to be created.
contact_persons array Contact person(s) associated with the recurring invoice.
template_id string ID of the pdf template associated with the recurring profile. The child invoice generated from the recurring profile will have the template.
start_date string
[yyyy-MM-dd]
Start date of the recurring invoice. Invoices will not be generated for dates prior to the current date.
end_date string
[yyyy-MM-dd]
Date on which recurring invoice has to expire. Can be left as empty to run forever.
recurrence_frequency* string Frequency of the recurring invoice. E.g. weekly, monthly, yearly.
Allowed Values: days, weeks, months and years
repeat_every int Frequency to repeat. E.g. 1, 6, 12.
payment_terms int Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this.
tax_id
(US Edition only)
string (Optional) ID of the tax or tax group applied to the invoice.
tax_authority_id
(US Edition only)
string (Optional) ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_exemption_id
(US Edition only)
string (Optional) ID of the tax exemption.
avatax_use_code
(Avalara integration only)
string
[25]
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara standard codes or enter a custom code.
avatax_exempt_no
(Avalara integration only)
string
[25]
Exemption certificate number of the customer.
vat_treatment
(UK Edition only)
string (Optional) VAT treatment for the invoice. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in a EU country & if he is VAT registered then his VAT treatment is eu_vat_registered, if he resides in EU & if he is not VAT registered then his VAT treatment is eu_vat_not_registered and if he resides outside the EU then his VAT treatment is non_eu.
payment_terms_label string
[100]
Used to override the default payment terms label. Default value for 15 days is "Net 15 Days".
exchange_rate double Exchange rate of the currency.
payment_options hash Payment options associated with the recurring invoice, online payment gateways.
payment_gateways array Online payment gateways through which payment can be made.
gateway_name* string Name of the payment gateway associated with the recurring profile. E.g. paypal, stripe.
Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree
additional_field1 string Paypal payment method.
Allowed Values: standard and adaptive
discount string
[100]
Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190.
is_discount_before_tax boolean Used to specify how the discount has to applied. Either before or after the calculation of tax.
discount_type string How the discount is specified.
Allowed Values: entity_level and item_level
is_inclusive_tax
(Not applicable for US and Canada editions)
boolean Used to specify whether the line item rates are inclusive or exclusive of tax.
line_items array Line items of an invoice.
item_id string ID of the item.
name string
[100]
Name of the line item.
description string
[2000]
Description of the line item.
rate double Rate of the line item.
quantity double Quantity of the line item.
unit string
[100]
Unit of the line item e.g. kgs, Nos.
discount string
[100]
Discount applied to the line item. It can be either in % or in amount. e.g. 12.5% or 190.
tax_id string ID of the tax or tax group applied to the line item.
tax_exemption_id
(US Edition only)
string (Optional) ID of the tax exemption.
avatax_tax_code
(Avalara integration only)
string
[25]
A tax code is a unique label used to group Items (products, services, or charges) together. Refer the link for more deails.
avatax_use_code
(Avalara integration only)
string
[25]
Used to group like customers for exemption purposes at line item level. It is a custom value that links customers to a tax rule. Select from Avalara standard codes or enter a custom code.
salesperson_name string
[200]
Name of the sales person.
shipping_charge double Shipping charges applied to the invoice.
adjustment double Adjustments made to the invoice.
adjustment_description string
[200]
Customize the adjustment description. E.g. Rounding off.

Sample Request

{
      "recurrence_name": "Premium Plan",
      "customer_id": "460000000026049",
      "contact_persons": [
        "460000000026051"
      ],
      "template_id": "460000000052069",
      "start_date": "2013-10-03",
      "end_date": "2013-11-04",
      "recurrence_frequency": "months",
      "repeat_every": 1,
      "payment_terms": 15,
      "payment_terms_label": "Net 15",
      "exchange_rate": 1.00,
      "payment_options": {
        "payment_gateways": [
          {
            "gateway_name": "paypal",
            "additional_field1": "standard"
          },
          {
            "gateway_name": "stripe",
            "additional_field1": ""
          }
        ]
      },
      "discount": 0.00,
      "is_discount_before_tax": true,
      "discount_type": "item_level",
      "is_inclusive_tax": "false",
      "allow_partial_payments": true,
      "line_items": [
        {
          "item_id": "460000000027017",
          "name": "Premium Plan - Web hosting",
          "description": "10 GB Space, 300 GB Transfer 100 Email Accounts 10 MySQL Databases",
          "item_order": 1,
          "rate": 33.00,
          "quantity": 1.00,
          "unit": "Nos",
          "discount": "10.60%",
          "tax_id": "460000000027007"
        }
      ],
      "notes": "Thanks for your business.",
      "terms": "",
      "salesperson_name": "John Michael",
      "shipping_charge": 10.00,
      "adjustment": 2.00,
      "adjustment_description": "Adjustment"
    }

Sample Response


Status: 201 Created
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The recurring invoice has been created.",
      "recurring_invoice": {
        "recurring_invoice_id": "460000000052117",
        "recurrence_name": "Premium Plan",
        "status": "stopped",
        "recurrence_frequency": "months",
        "repeat_every": 1,
        "start_date": "2013-10-03",
        "end_date": "2013-11-04",
        "last_sent_date": "2013-10-03",
        "next_invoice_date": "2013-11-03",
        "payment_terms": 15,
        "payment_terms_label": "Net 15",
        "customer_id": "460000000026049",
        "customer_name": "Bowman and Co",
        "contact_persons": [
          "460000000026051"
        ],
        "currency_id": "460000000000097",
        "currency_code": "USD",
        "exchange_rate": 1.00,
        "discount": 0.00,
        "is_discount_before_tax": true,
        "discount_type": "item_level",
        "is_inclusive_tax": "false",
        "line_items": [
          {
            "item_id": "460000000027017",
            "line_item_id": "460000000052125",
            "name": "Premium Plan - Web hosting",
            "description": "10 GB Space, 300 GB Transfer 100 Email Accounts 10 MySQL Databases",
            "item_order": 1,
            "rate": 33.00,
            "quantity": 1.00,
            "unit": "Nos",
            "discount": "10.60%",
            "tax_id": "460000000027007",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 10.5,
            "item_total": 29.50
          }
        ],
        "shipping_charge": 10.00,
        "adjustment": 2.00,
        "adjustment_description": "Adjustment",
        "sub_total": 29.50,
        "total": 44.60,
        "tax_total": 3.10,
        "allow_partial_payments": true,
        "taxes": [
          {
            "tax_name": "Sales Tax (10.5%)",
            "tax_amount": 3.10
          }
        ],
        "payment_options": {
          "payment_gateways": [
            {
              "configured": true,
              "additional_field1": "standard",
              "gateway_name": "paypal"
            },
            {
              "configured": true,
              "gateway_name": "stripe"
            }
          ]
        },
        "billing_address": {
          "address": "4900 Hopyard Rd, Suite 310",
          "city": "Pleasanton",
          "state": "CA",
          "zip": "94588",
          "country": "USA",
          "fax": "+1-925-924-9600"
        },
        "shipping_address": {
          "address": "Suite 125, McMillan Avenue",
          "city": "San Francisco",
          "state": "CA",
          "zip": "94134",
          "country": "USA",
          "fax": "+1-925-924-9600"
        },
        "template_id": "460000000052069",
        "template_name": "Custom Classic",
        "notes": "Thanks for your business.",
        "terms": "",
        "salesperson_id": "460000000027021",
        "salesperson_name": "John Michael",
        "created_time": "2013-10-03T19:11:16+0530",
        "last_modified_time": "2013-10-07T19:18:40+0530"
      }
    }

Update a recurring invoice

PUT  /recurringinvoices/:recurring_invoice_id

Update an existing recurring invoice. To delete a line item just remove it from the line_items list.

Request attributes

recurrence_name* string
[50]
Name of the recurring invoice.
customer_id* string ID of the customer the recurring invoice has to be created.
contact_persons array Contact person(s) associated with the recurring invoice.
template_id string ID of the pdf template associated with the recurring profile. The child invoice generated from the recurring profile will have the template.
start_date string
[yyyy-MM-dd]
Start date of the recurring invoice. Invoices will not be generated for dates prior to the current date.
end_date string
[yyyy-MM-dd]
Date on which recurring invoice has to expire. Can be left as empty to run forever.
recurrence_frequency* string Frequency of the recurring invoice. E.g. weekly, monthly, yearly.
Allowed Values: days, weeks, months and years
repeat_every int Frequency to repeat. E.g. 1, 6, 12.
payment_terms int Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this.
tax_id
(US Edition only)
string (Optional) ID of the tax or tax group applied to the invoice.
tax_authority_id
(US Edition only)
string (Optional) ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_exemption_id
(US Edition only)
string (Optional) ID of the tax exemption.
avatax_use_code
(Avalara integration only)
string
[25]
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara standard codes or enter a custom code.
avatax_exempt_no
(Avalara integration only)
string
[25]
Exemption certificate number of the customer.
vat_treatment
(UK Edition only)
string (Optional) VAT treatment for the invoice. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in a EU country & if he is VAT registered then his VAT treatment is eu_vat_registered, if he resides in EU & if he is not VAT registered then his VAT treatment is eu_vat_not_registered and if he resides outside the EU then his VAT treatment is non_eu.
payment_terms_label string
[100]
Used to override the default payment terms label. Default value for 15 days is "Net 15 Days".
exchange_rate double Exchange rate of the currency.
payment_options hash Payment options associated with the recurring invoice, online payment gateways.
payment_gateways array Online payment gateways through which payment can be made.
gateway_name* string Name of the payment gateway associated with the recurring profile. E.g. paypal, stripe.
Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree
additional_field1 string Paypal payment method.
Allowed Values: standard and adaptive
discount string
[100]
Discount applied to the invoice. It can be either in % or in amount. e.g. 12.5% or 190.
is_discount_before_tax boolean Used to specify how the discount has to applied. Either before or after the calculation of tax.
discount_type string How the discount is specified.
Allowed Values: entity_level and item_level
is_inclusive_tax
(Not applicable for US and Canada editions)
boolean Used to specify whether the line item rates are inclusive or exclusive of tax.
line_items array Line items of an invoice.
item_id string ID of the item.
line_item_id string ID of the line item. Mandatory if the existing line item has to be updated. If empty, a new line item will be created.
name string
[100]
Name of the line item.
description string
[2000]
Description of the line item.
rate double Rate of the line item.
quantity double Quantity of the line item.
unit string
[100]
Unit of the line item e.g. kgs, Nos.
discount string
[100]
Discount applied to the line item. It can be either in % or in amount. e.g. 12.5% or 190.
tax_id string ID of the tax or tax group applied to the line item.
tax_exemption_id
(US Edition only)
string (Optional) ID of the tax exemption.
avatax_tax_code
(Avalara integration only)
string
[25]
A tax code is a unique label used to group Items (products, services, or charges) together. Refer the link for more deails.
avatax_use_code
(Avalara integration only)
string
[25]
Used to group like customers for exemption purposes at line item level. It is a custom value that links customers to a tax rule. Select from Avalara standard codes or enter a custom code.
salesperson_name string
[200]
Name of the sales person.
shipping_charge double Shipping charges applied to the invoice.
adjustment double Adjustments made to the invoice.
adjustment_description string
[200]
Customize the adjustment description. E.g. Rounding off.

Sample Request

{
      "recurrence_name": "Premium Plan",
      "customer_id": "460000000026049",
      "contact_persons": [
        "460000000026051"
      ],
      "template_id": "460000000052069",
      "start_date": "2013-10-03",
      "end_date": "2013-11-04",
      "recurrence_frequency": "months",
      "repeat_every": 1,
      "payment_terms": 15,
      "payment_terms_label": "Net 15",
      "exchange_rate": 1.00,
      "payment_options": {
        "payment_gateways": [
          {
            "gateway_name": "paypal",
            "additional_field1": "standard"
          },
          {
            "gateway_name": "stripe",
            "additional_field1": ""
          }
        ]
      },
      "discount": 0.00,
      "is_discount_before_tax": true,
      "discount_type": "item_level",
      "is_inclusive_tax": "false",
      "allow_partial_payments": true,
      "line_items": [
        {
          "item_id": "460000000027017",
          "line_item_id": "460000000052125",
          "name": "Premium Plan - Web hosting",
          "description": "10 GB Space, 300 GB Transfer 100 Email Accounts 10 MySQL Databases",
          "item_order": 1,
          "rate": 33.00,
          "quantity": 1.00,
          "unit": "Nos",
          "discount": "10.60%",
          "tax_id": "460000000027007"
        }
      ],
      "notes": "Thanks for your business.",
      "terms": "",
      "salesperson_name": "John Michael",
      "shipping_charge": 10.00,
      "adjustment": 2.00,
      "adjustment_description": "Adjustment"
    }

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "Recurring invoice information has been updated.",
      "recurring_invoice": {
        "recurring_invoice_id": "460000000052117",
        "recurrence_name": "Premium Plan",
        "status": "stopped",
        "recurrence_frequency": "months",
        "repeat_every": 1,
        "start_date": "2013-10-03",
        "end_date": "2013-11-04",
        "last_sent_date": "2013-10-03",
        "next_invoice_date": "2013-11-03",
        "payment_terms": 15,
        "payment_terms_label": "Net 15",
        "customer_id": "460000000026049",
        "customer_name": "Bowman and Co",
        "contact_persons": [
          "460000000026051"
        ],
        "currency_id": "460000000000097",
        "currency_code": "USD",
        "exchange_rate": 1.00,
        "discount": 0.00,
        "is_discount_before_tax": true,
        "discount_type": "item_level",
        "is_inclusive_tax": "false",
        "line_items": [
          {
            "item_id": "460000000027017",
            "line_item_id": "460000000052125",
            "name": "Premium Plan - Web hosting",
            "description": "10 GB Space, 300 GB Transfer 100 Email Accounts 10 MySQL Databases",
            "item_order": 1,
            "rate": 33.00,
            "quantity": 1.00,
            "unit": "Nos",
            "discount": "10.60%",
            "tax_id": "460000000027007",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 10.5,
            "item_total": 29.50
          }
        ],
        "shipping_charge": 10.00,
        "adjustment": 2.00,
        "adjustment_description": "Adjustment",
        "sub_total": 29.50,
        "total": 44.60,
        "tax_total": 3.10,
        "allow_partial_payments": true,
        "taxes": [
          {
            "tax_name": "Sales Tax (10.5%)",
            "tax_amount": 3.10
          }
        ],
        "payment_options": {
          "payment_gateways": [
            {
              "configured": true,
              "additional_field1": "standard",
              "gateway_name": "paypal"
            },
            {
              "configured": true,
              "gateway_name": "stripe"
            }
          ]
        },
        "billing_address": {
          "address": "4900 Hopyard Rd, Suite 310",
          "city": "Pleasanton",
          "state": "CA",
          "zip": "94588",
          "country": "USA",
          "fax": "+1-925-924-9600"
        },
        "shipping_address": {
          "address": "Suite 125, McMillan Avenue",
          "city": "San Francisco",
          "state": "CA",
          "zip": "94134",
          "country": "USA",
          "fax": "+1-925-924-9600"
        },
        "template_id": "460000000052069",
        "template_name": "Custom Classic",
        "notes": "Thanks for your business.",
        "terms": "",
        "salesperson_id": "460000000027021",
        "salesperson_name": "John Michael",
        "created_time": "2013-10-03T19:11:16+0530",
        "last_modified_time": "2013-10-07T19:18:40+0530"
      }
    }

Delete a recurring invoice

DELETE  /recurringinvoices/:recurring_invoice_id

Delete an existing recurring invoice.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The recurring invoice has been deleted."
}

Stop a recurring invoice

POST  /recurringinvoices/:recurring_invoice_id/status/stop

Stop an active recurring invoice.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The recurring invoice has been stopped."
}

Resume a recurring invoice

POST  /recurringinvoices/:recurring_invoice_id/status/resume

Resume a stopped recurring invoice.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The recurring invoice has been activated."
}

Update recurring invoice template

PUT  /recurringinvoices/:recurring_invoice_id/templates/:template_id

Update the pdf template associated with the recurring invoice.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Recurring invoice information has been updated."
}

List recurring invoice history

GET  /recurringinvoices/:recurring_invoice_id/comments

Get the complete history and comments of a recurring invoice.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "comments": [
    {
      "comment_id": "460000000053255",
      "recurring_invoice_id": "460000000052117",
      "description": "Recurring Invoice updated",
      "commented_by_id": "460000000024003",
      "commented_by": "John David",
      "comment_type": "system",
      "date": "2013-10-07",
      "date_description": "9 days ago",
      "time": "7:18 PM",
      "operation_type": "Updated",
      "transaction_id": "",
      "transaction_type": "recurring_invoice"
    },
    {
      "comment_id": "460000000052145",
      "recurring_invoice_id": "460000000052117",
      "description": "Recurring Invoice stopped",
      "commented_by_id": "460000000024003",
      "commented_by": "John David",
      "comment_type": "system",
      "date": "2013-10-03",
      "date_description": "13 days ago",
      "time": "7:11 PM",
      "operation_type": "Updated",
      "transaction_id": "",
      "transaction_type": "recurring_invoice"
    },
    {
      "comment_id": "460000000052133",
      "recurring_invoice_id": "460000000052117",
      "description": "Invoice created - INV-00005",
      "commented_by_id": "460000000024003",
      "commented_by": "John David",
      "comment_type": "system",
      "date": "2013-10-03",
      "date_description": "13 days ago",
      "time": "7:11 PM",
      "operation_type": "Added",
      "transaction_id": "460000000052127",
      "transaction_type": "invoice"
    }
  ]
}