Try For Free Login

Invoice

Create Invoice

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

  • If you don't specify an invoice , it will increment from the last one.
  • You may optionally specify a different address on the invoice.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="createInvoice">
	<!-- Client being invoiced -->
	<client>
			<client_id>252405</client_id>            		<!-- Mandatory -->
			<address>123 Fake St.</address>     		<!-- Primary address (All optional) -->
	</client>
	<!-- Title, as it appears on the invoice (Optional) -->
	<invoice_title>DummyInvoice</invoice_title>
	<!-- Number, as it appears on the invoice (Optional)  -->
	<number></number>
	<!-- If not supplied, defaults to today's date (Optional) -->
	<date>2010-03-15</date>
	<!-- Optional -->
	<due_date>2010-03-15</due_date>
	<!-- Optional -->
	<late_fee></late_fee>
	 <!-- Optional -->
	<schedule_date>2010-03-15</schedule_date>
	<!-- Purchase order number (Optional) -->
	<po_number>1234567</po_number>
	<!-- INVOICE STATUS  One of sent, viewed, paid, or draft [default] -->
	<status>draft</status>
	<!-- Notes (Optional) -->
	<notes>Due upon receipt.</notes>
	<!-- Terms (Optional) -->
	<terms>Payment due in 30 days.</terms>
	
	<items>	<!-- Specify one or more items (Optional) -->
	  <item>
			<name>Service-00100</name>									<!-- (Optional) -->
			<type>Service</type>										<!-- Default is "Product" -->
			<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></discount_type>						<!-- Default is "Percent" -->
			<tax1_name></tax1_name>										<!-- (Optional) -->
			<tax2_name>PST</tax2_name>									<!-- (Optional) -->
            <tax1_type></tax1_type>                                     <!-- (Optional) -->
			<tax1_percent></tax1_percent>								<!-- (Optional) -->
			<tax2_percent>10</tax2_percent>								<!-- (Optional) -->
            <tax2_type></tax2_type>                                     <!-- (Optional) -->
	  </item>

	  <item>
			<name>P-00200</name>										<!-- (Optional) -->
			<type>Product</type>										<!-- Default is "Product" -->
			<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) -->
            <tax1_type></tax1_type>                                     <!-- (Optional) -->
			<tax2_name></tax2_name>										<!-- (Optional) -->
			<tax1_percent>10</tax1_percent>								<!-- (Optional) -->
			<tax2_percent></tax2_percent>								<!-- (Optional) -->
            <tax2_type></tax2_type>                                     <!-- (Optional) -->
	  </item>
	  <item>
			<name>P-00200</name>										<!-- (Optional) -->
			<type>Product</type>										<!-- Default is "Product" -->
			<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) -->
            <tax1_type></tax1_type>                                     <!-- (Optional) -->
			<tax2_name></tax2_name>										<!-- (Optional) -->
			<tax1_percent>10</tax1_percent>								<!-- (Optional) -->
			<tax2_percent></tax2_percent>								<!-- (Optional) -->
            <tax2_type></tax2_type>                                     <!-- (Optional) -->
	  </item>
	</items>
	<additional_charges>													<!-- Specify one or more items (Optional) -->
	  <additional_charge>
			<name>Shipping</name>										<!-- (Optional) -->
			<type>Percent</type>										<!-- Default is "Percent" -->
			<amount>10</amount>											<!-- Default is 10 -->
	  </additional_charge>
	</additional_charges>
        <custom_fields>                   			<!-- (All optional) -->
        <custom_field>
            <label>Custom Field Label-1</label>
            <value>Custom Field Value-1</value>
        </custom_field>
        <custom_field>
            <label>Custom Field Label-2</label>
            <value>Custom Field Value-2</value>
        </custom_field>
        <custom_field>
            <label>Custom Field Label-3</label>
            <value>Custom Field Value-3</value>
        </custom_field>
        <custom_field>
            <label>Custom Field Label-4</label>
            <value>Custom Field Value-4</value>
        </custom_field>
        </custom_fields>
</request>

Response

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

Update Invoice

Update an existing invoice with the given invoice_id. Any invoice fields left out of the request will delete the previous value. So, you have to send the same value if you don't want to update any field record.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="updateInvoice">
        <invoice_id>28027</invoice_id>						<!-- Mandatory -->
        <!-- Client being invoiced -->
        <client>
                <client_id>14542</client_id>            		<!-- Mandatory -->
                <address>123 Fake St. New Address</address>     		<!-- Primary address (All optional) -->
        </client>

        <!-- Title, as it appears on the invoice (Optional) -->
        <invoice_title>DummyInvoice</invoice_title>
        <!-- Number, as it appears on the invoice (Optional)  -->
        <number></number>
        <!-- If not supplied, defaults to today's date (Optional) -->
        <date>2010-03-15</date>
        <!-- Optional -->
        <due_date>2010-03-15</due_date>
		<!-- Optional -->
		<late_fee></late_fee>
        <!-- Optional -->
        <schedule_date>2010-03-15</schedule_date>
        <!-- Purchase order number (Optional) -->
        <po_number>12345</po_number>
        <!-- INVOICE STATUS, default will be draft -->
        <status>partial-paid</status>
        <!-- Notes (Optional) -->
        <notes>Due upon receipt.</notes>
        <!-- Terms (Optional) -->
        <terms>Payment due in 30 days.</terms>

        <items>	<!-- Specify one or more items (Optional) -->
			<item>
                <name>san-00100</name>										<!-- (Optional) -->
				<type>Service</type>										<!-- Default is "Product" -->
				<description>updating data of P-00100 from xml</description>	<!-- (Optional) -->
				<unit_cost>500</unit_cost>									<!-- Default is 0 -->
				<quantity>1</quantity>										<!-- Default is 0 -->
				<discount></discount>										<!-- (Optional) -->
				<discount_type></discount_type>								<!-- Default is "Percent" -->
				<tax1_name>PST</tax1_name>									<!-- (Optional) -->
				<tax1_percent>10</tax1_percent>								<!-- (Optional) -->
				<tax1_type>Normal</tax1_type>								<!-- (Optional) -->
				<tax2_name>CST</tax2_name>										<!-- (Optional) -->
				<tax2_percent>10</tax2_percent>								<!-- (Optional) -->
				<tax2_type>Compound</tax2_type>								<!-- (Optional) -->
			</item>
        </items>
	<additional_charges>												<!-- Specify one or more items (Optional) -->
	  <additional_charge>
			<name>Shipping</name>										<!-- (Optional) -->
			<type>Fixed</type>										<!-- Default is "Percent" -->
			<amount>100</amount>											<!-- Default is 10 -->
	  </additional_charge>
	</additional_charges>
</request>

Response

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

Delete Invoice

Delete an existing invoice.

Request

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

Response

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

List Invoice

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

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="listInvoice">
	<filter> <!-- Pass search parameters here -->
		<client_id></client_id> <!-- This is client unique id at Invoicera database -->
		<date_from></date_from> <!-- This is invoice from date. Date format is YYYY-MM-DD-->
		<date_to></date_to> <!-- This is invoice to date. Date format is YYYY-MM-DD -->
		<invoice_number></invoice_number> <!-- This is invoice number at Invoicera database -->
		<invoice_record_status></invoice_record_status> <!-- Status are 'Active','Archived','Cancel'. Only Active records will be displayed if no value defined -->
		<invoice_status></invoice_status> <!-- Status are 'Draft','Sent','Viewed','Outstanding','Paid','Unpaid','Disputed','Auto-Paid','Retry','Failed','Resolved','Auto-Failed','Partial-Paid'. Only Active records will be displayed if no value defined -->
	    <page>1</page> <!-- This is page number -->
	    <per_page_record></per_page_record>  <!-- This is number of records per page -->
	    <sort_column>number</sort_column>  <!-- number, date, invoice_id, organization. Default is number -->
	    <sort_order>desc</sort_order>  <!-- sorting oder asc, desc. Default is desc -->
	</filter> <!-- search parameters ends here -->
</request>

Response

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

                           
                           17389
                           Draft
                           
                           INV137
                           2010-11-01 00:00:00
			   Active
                           
                           0
                           
                           
                           

                           
                           
                           34045
                           P-00100
                           Products
                           getting data of P-00100 from xml
                           10.00
                           10.00
                           
                           Percent
                           
                
                
                
                
                
                
                .
                .
                .

Get Invoice

Return the complete invoice details associated with the given invoice_id.

Request

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

Response

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

                           
                           17389
                           Draft
                           
                           INV137
			   Active
                           2010-11-01 00:00:00
                           
                           0
                           
                           
                           

                           
                           
                           34045
                           P-00100
                           Products
                           Dummy Test description
                           10.00
                           10.00
                           
                           Percent
                           
            
            
            
            
            
            
                .
                .
                .

Send Invoice Mail

Send an existing invoice to your client via e-mail. The invoice status will be changed to sent.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="sendInvoiceMail">
        <invoice_id>39464</invoice_id>
</request>

Response

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

Add Invoice Item

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

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="addInvoiceItem">
	<invoice_id>27811</invoice_id>
	<items>	<!-- Specify one or more items (Optional) -->
		<item>
			<name>San-57</name>	
            <type>Service</type>								<!-- Default is "Product" -->			
			<description>fsaf sa fsa fas</description>			<!-- (Optional) -->
			<unit_cost>100</unit_cost>							<!-- Default is 0 -->
			<quantity>1</quantity>								<!-- Default is 0 -->
			<discount></discount>								<!-- (Optional) -->
			<discount_type></discount_type>						<!-- Default is "Percent" -->
			<tax1_name>PST</tax1_name>							<!-- (Optional) -->
			<tax2_name></tax2_name>								<!-- (Optional) -->
			<tax1_percent>2</tax1_percent>						<!-- (Optional) -->
			<tax2_percent></tax2_percent>	
		</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 invoice.

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

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="updateInvoiceItem">
	<invoice_id>27811</invoice_id>
	<items>	<!-- Specify one or more items (Optional) -->
		<item>
			<invoice_item_id>57963</invoice_item_id>
			<type>Service</type>								<!-- Default is "Product" -->	
			<name>PR-005</name>											
			<description>Updated through API </description>			<!-- (Optional) -->
			<unit_cost>1000</unit_cost>									<!-- Default is 0 -->
			<quantity>1</quantity>										<!-- Default is 0 -->
			<discount></discount>										<!-- (Optional) -->
			<discount_type></discount_type>						<!-- Default is "Percent" -->
			<tax1_name></tax1_name>										<!-- (Optional) -->
			<tax2_name></tax2_name>									<!-- (Optional) -->
			<tax1_percent></tax1_percent>								<!-- (Optional) -->
			<tax2_percent></tax2_percent>	
		</item>
	</items>
</request>

Response

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

Delete Invoice Item

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

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

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteInvoiceItem">
	<invoice_id>27771</invoice_id>
	<invoice_item_id>57888</invoice_item_id>
</request>

Response

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

Offline Invoice Payment

  • Offline payment for an existing invoice.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="invoiceOfflinePayment">
		<invoice>
			<id>27438</id> <!-- This is invoice unique id at Invoicera database. You can use more than one id to add offline payments -->
			<amount>100</amount>
			<method>Cash</method>
			<date>2011-08-18</date>
			<notes>Partial Payment</notes>
			<client_notification>1</client_notification>
		</invoice>
</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