Try For Free Login

Invoice Recurring

Create Recurring Invoice

Create a new recurring complete with line items. If successful, returns the recurring_id of the newly created recurring.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="createRecurring">
	<!-- Client being invoiced -->
	<client>
			<client_id>2820</client_id>            		<!-- Mandatory -->
			<address>123 Fake St.</address>     		<!-- Primary address (All optional) -->
	</client>
	<!-- Title, as it appears on the invoice (Optional) -->
	<recurring_title>DummyInvoice</recurring_title>
	<!-- If not supplied, defaults to today's date (Optional) -->
	<date></date>
	<!-- Purchase order number (Optional) -->
	<po_number>1234567</po_number>
	<!-- Notes (Optional) -->
	<notes>Due upon receipt.</notes>
	<!-- Terms (Optional) -->
	<terms>Payment due in 30 days.</terms>
	<frequency>2 Week</frequency> 	<!-- "1 Week"->Weekly, "2 Week"->2 Weeks, "3 Week"->3 Weeks, "4 Week"->4 Weeks, "1 Month"->Monthly, "3 Month"->Quarterly -->
									<!-- "6 Month"->Half Yearly,"1 Year"->Yearly, "2 Year"->2 Years,"3 Year"->3 Years -->
	<occurence>2</occurence>
	<send>1</send>
	
	<autobill>
		<payment_gateway>Authorize.Net</payment_gateway>
		<credit_card>
			<number>4111111111111111</number>
			<type>Visa</type>
			<cvv>111</cvv>
			<first_name>Sandeep</first_name>
			<last_name>Kumar</last_name>
			<name_on_card>Sandeep Kumar</name_on_card>
			<country>USA</country>
			<state>OH</state>
			<city>Scottown</city>
			<zip>45678</zip>
			<address>Test address</address>
			<expiry>
				<month>11</month>
				<year>2012</year>
			</expiry>			
		</credit_card>
	</autobill>
	
	<items>	<!-- Specify one or more items (Optional) -->
	  <item>
			<name>P-00100</name>										<!-- (Optional) -->
			<description>getting data of P-00100 from xml</description>	<!-- (Optional) -->
			<unit_cost>10</unit_cost>									<!-- Default is 0 -->
			<quantity>10</quantity>										<!-- Default is 0 -->
			<discount>20</discount>										<!-- (Optional) -->
			<discount_type>Fixed</discount_type>						<!-- Default is "Percent" -->
			<tax1_name></tax1_name>										<!-- (Optional) -->
			<tax2_name>PST</tax2_name>									<!-- (Optional) -->
			<tax1_percent></tax1_percent>								<!-- (Optional) -->
			<tax2_percent>10</tax2_percent>								<!-- (Optional) -->
	  </item>

	  <item>
			<name>P-00200</name>										<!-- (Optional) -->
			<description>getting data of P-00200 from xml</description>	<!-- (Optional) -->
			<unit_cost>500</unit_cost>									<!-- Default is 0 -->
			<quantity>3</quantity>										<!-- Default is 0 -->
			<discount>5</discount>										<!-- (Optional) -->
			<discount_type></discount_type>								<!-- Default is "Percent" -->
			<tax1_name>GST</tax1_name>									<!-- (Optional) -->
			<tax2_name></tax2_name>										<!-- (Optional) -->
			<tax1_percent>10</tax1_percent>								<!-- (Optional) -->
			<tax2_percent></tax2_percent>								<!-- (Optional) -->
	  </item>
	  <item>
			<name>P-00200</name>										<!-- (Optional) -->
			<description>getting data of P-00200 from xml</description>	<!-- (Optional) -->
			<unit_cost>500</unit_cost>									<!-- Default is 0 -->
			<quantity>3</quantity>										<!-- Default is 0 -->
			<discount>5</discount>										<!-- (Optional) -->
			<discount_type></discount_type>								<!-- Default is "Percent" -->
			<tax1_name>GST</tax1_name>									<!-- (Optional) -->
			<tax2_name></tax2_name>										<!-- (Optional) -->
			<tax1_percent>10</tax1_percent>								<!-- (Optional) -->
			<tax2_percent></tax2_percent>								<!-- (Optional) -->
	  </item>
	</items>
</request>

Response

<?xml version="1.0" encoding="utf-8"?>
 
 201

Update Recurring Invoice

Update an existing recurring with the given recurring_id. Any recurring fields left out of the request will remain unchanged.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="updateRecurring">
	 <recurring_id>695</recurring_id>						<!-- Mandatory -->
	<!-- Client being invoiced -->
	<client>
			<client_id>2820</client_id>            		<!-- Mandatory -->
			<address>123 Fake St.</address>     		<!-- Primary address (All optional) -->
	</client>
	<!-- Title, as it appears on the invoice (Optional) -->
	<recurring_title>DummyInvoice</recurring_title>
	<!-- If not supplied, defaults to today's date (Optional) -->
	<date>2010-03-15</date>
	<!-- Purchase order number (Optional) -->
	<po_number>1234567</po_number>
	 <!-- Currency Code, defaults to your base currency (Optional) -->
	<currency_code>USD</currency_code>
	<!-- Notes (Optional) -->
	<notes>Due upon receipt.</notes>
	<!-- Terms (Optional) -->
	<terms>Payment due in 30 days.</terms>
	<frequency>2 Week</frequency> 	<!-- "1 Week"->Weekly, "2 Week"->2 Weeks, "3 Week"->3 Weeks, "4 Week"->4 Weeks, "1 Month"->Monthly, "3 Month"->Quarterly -->
									<!-- "6 Month"->Half Yearly,"1 Year"->Yearly, "2 Year"->2 Years,"3 Year"->3 Years -->
	<occurence>2</occurence>
	<send>1</send>
	
	<autobill>
		<payment_gateway>Authorize.Net</payment_gateway>
		<credit_card>
			<number>4111111111111111</number>
			<type>Visa</type>
			<cvv>111</cvv>
			<first_name>Sandeep</first_name>
			<last_name>Kumar</last_name>
			<name_on_card>Sandeep Kumar</name_on_card>
			<country>USA</country>
			<state>OH</state>
			<city>Scottown</city>
			<zip>45678</zip>
			<address>Test address</address>
			<expiry>
				<month>11</month>
				<year>2012</year>
			</expiry>			
		</credit_card>
	</autobill>
	
	<items>	<!-- Specify one or more items (Optional) -->
	  <item>
			<name>P-A</name>										<!-- (Optional) -->
			<description>getting data of P-00100 from xml</description>	<!-- (Optional) -->
			<unit_cost>10</unit_cost>									<!-- Default is 0 -->
			<quantity>10</quantity>										<!-- Default is 0 -->
			<discount>20</discount>										<!-- (Optional) -->
			<discount_type>Fixed</discount_type>						<!-- Default is "Percent" -->
	  </item>
	  <item>
			<name>P-C</name>										<!-- (Optional) -->
			<description>getting data of P-00200 from xml</description>	<!-- (Optional) -->
			<unit_cost>500</unit_cost>									<!-- Default is 0 -->
			<quantity>3</quantity>										<!-- Default is 0 -->
			<discount>5</discount>										<!-- (Optional) -->
			<discount_type></discount_type>								<!-- Default is "Percent" -->
			<tax1_name>GST</tax1_name>									<!-- (Optional) -->
			<tax2_name></tax2_name>										<!-- (Optional) -->
			<tax1_percent>10</tax1_percent>								<!-- (Optional) -->
			<tax2_percent></tax2_percent>								<!-- (Optional) -->
	  </item>
	</items>
</request>

Response

<?xml version="1.0" encoding="utf-8"?>
 
 201

Delete Recurring Invoice

Delete an existing Recurring Invoice.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteRecurring">
	<recurring_id></recurring_id> <!-- This is recurring unique id at Invoicera database. You can use more than one row for delete -->
</request>

Response

<?xml version="1.0" encoding="utf-8"?>

List Recurring Invoice

Returns a list of recurring summaries. Results are ordered by descending recurring number.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="listRecurring">
	<filter> <!-- Pass search parameters here -->
		<client_id></client_id> <!-- This is client unique id at Invoicera database -->
		<date_from></date_from>  <!-- This is recurring from date. Date format is YYYY-MM-DD -->
		<date_to></date_to> <!-- This is recurring to date. Date format is YYYY-MM-DD -->
		<recurring_number></recurring_number> <!-- This is recurring number at Invoicera database -->
		<recurring_record_status></recurring_record_status> <!-- Status are 'Active','Archived','Delete','Stop'. Only Active records will be displayed if no value defined -->
	    <page></page> <!-- This is page number -->
	    <per_page_record></per_page_record>  <!-- This is number of records per page -->
	</filter> <!-- search parameters ends here -->
</request>

Response

<?xml version="1.0" encoding="utf-8"?>
    
        
            
            
                5741
                Sand Soft
                
dummy address

            
            630
            Active
            Recurring
            Pro-2569
            2010-11-22 00:00:00
            
            97.28
            
            
            

            
                
                    890
                    P-00200
                    Products
                    Dummy Description
                    500.00
                    1.00
                    
                    Percent
                    
                    
                    
                    
                    
                    
                
                .
                .
                .

Get Recurring Invoice

Return the complete recurring details associated with the given recurring_id.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="getRecurring">
        <recurring_id></recurring_id> <!-- This is recurring unique id at Invoicera database. Only one ID can be pass at a time. -->
</request>

Response

<?xml version="1.0" encoding="utf-8"?>

        
            
                5741
                Sand Soft
                
dummy address

            

            630
            Active
            Recurring
            Pro-2569
            2010-11-22 00:00:00
            
            97.28
            
            

            
                
                    890
                    P-00200
                    Products
                    Dummy Description
                    500.00
                    1.00
                    
                    Percent

Add Recurring Invoice Item

One or more lines may be added to an existing recurring.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="addRecurringItem">
	<recurring_id>630</recurring_id>
	<items>	<!-- Specify one or more items (Optional) -->
	  <item>
			<name>San-73</name>										<!-- (Optional) -->
			<description>Added item through API</description>	<!-- (Optional) -->
			<unit_cost>200</unit_cost>									<!-- Default is 0 -->
			<quantity>1</quantity>										<!-- Default is 0 -->
	  </item>

	</items>
</request>

Response

<?xml version="1.0" encoding="utf-8"?>

    10459
        
34052
34053

Update Invoice Item

Updates (an) existing line(s) on an existing recurring.

  • One or more lines may be updated.
  • Only the provided fields will be updated. All others will be left unchanged.
  • recurring_item_id is mandatory for each line to be updated. Use addRecurringItem to create new lines..

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="updateRecurringItem">
	<recurring_id>630</recurring_id>
	<items>	<!-- Specify one or more items (Optional) -->
	<item>
			<recurring_item_id>902</recurring_item_id>
			<name>San-6</name>										<!-- (Optional) -->
			<description>updated item through API</description>		<!-- (Optional) -->
			<unit_cost>17</unit_cost>								<!-- Default is 0 -->
			<quantity>4</quantity>									<!-- Default is 0 -->
			<discount>20</discount>										<!-- (Optional) -->
			<discount_type>Percent</discount_type>						<!-- Default is "Percent" -->
			<tax1_name></tax1_name>										<!-- (Optional) -->
			<tax2_name>PST</tax2_name>									<!-- (Optional) -->
			<tax1_percent></tax1_percent>								<!-- (Optional) -->
			<tax2_percent>10</tax2_percent>	
	</item>
	</items>
</request>

Response

<?xml version="1.0" encoding="utf-8"?>

Delete Recurring Invoice Item

Delete recurring items from an existing recurring.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteRecurringItem">
	<recurring_id>630</recurring_id>
	<recurring_item_id>901</recurring_item_id>
</request>

Response

<?xml version="1.0" encoding="utf-8"?>
Invoice/Estimate
People
Items
Expense
Time Tracking

Get Started for FREE

Over 3 Million Users Have Chosen Invoicera

No credit card required. Cancel anytime REQUEST A FREE DEMO