Try For Free Login

Estimate

Create Estimate

Create a new estimate and return the corresponding estimate_id.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="createEstimate">
	<!-- Client being invoiced -->
	<client>
			<client_id>5346</client_id>            		<!-- Mandatory -->
			<address>123 Fake St.</address>     		<!-- Primary address (All optional) -->
	</client>
	<!-- Title, as it appears on the invoice (Optional) -->
	<estimate_title>Dummy Estimate</estimate_title>
	<!-- Number, as it appears on the invoice (Optional)  -->
	<number></number>
	<!-- If not supplied, defaults to today's date (Optional) -->
	<date></date>
	<!-- (Optional) -->
	<schedule_date>2012-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>P-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>Fixed</discount_type>						<!-- Default is "Percent" -->
			<tax1_name></tax1_name>										<!-- (Optional) -->
			<tax1_percent></tax1_percent>								<!-- (Optional) -->
			<tax2_name>PST</tax2_name>									<!-- (Optional) -->								
			<tax2_percent>10</tax2_percent>								<!-- (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_percent>10</tax1_percent>								<!-- (Optional) -->
			<tax2_name></tax2_name>										<!-- (Optional) -->
			<tax2_percent></tax2_percent>								<!-- (Optional) -->
	  </item>
	</items>
</request>

Response

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

Update Estimate

Update an existing estimate.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="updateEstimate">
	<estimate_id>2613</estimate_id>						<!-- Mandatory -->
	<!-- Client being invoiced -->
	<client>
			<client_id>5346</client_id>            		<!-- Mandatory -->
			<address>123 Fake updated St 52525</address>     		<!-- Primary address (All optional) -->
	</client>
	<!-- Title, as it appears on the invoice (Optional) -->
	<estimate_title>Dummy Estimate</estimate_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) -->
	<schedule_date>2012-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>
	 <!-- 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>

	<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) -->
			<tax1_percent></tax1_percent>								<!-- (Optional) -->
			<tax2_name>PST</tax2_name>									<!-- (Optional) -->								
			<tax2_percent>10</tax2_percent>								<!-- (Optional) -->
	  </item>
	</items>
</request>

Response

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

Delete Estimate

Delete an existing estimate.

Request

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

Response

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

List Estimate

Returns a list of estimates. One can optionally filter lists by client_id, estimate_number, status and date.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="listEstimate">
	<filter> <!-- Pass search parameters here -->
		<client_id></client_id> <!-- This is client unique id at Invoicera database -->
		<date_from></date_from> <!-- This is estimate from date -->
		<date_to></date_to> <!-- This is estimate to date -->
		<estimate_number></estimate_number> <!-- This is esimate number at Invoicera database -->
		<status></status> <!-- This is esimate status Draft','Sent','Viewed','Outstanding','Paid','Unpaid','Disputed','Auto-Paid','Retry','Failed','Resolved','Auto-Failed','Expired -->
	    <page>1</page> <!-- This is page number -->
	    <per_page_record>100</per_page_record>  <!-- This is number of records per page -->
        <sort_column>number</sort_column>  <!-- number, date, estimate_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"?>
		
    
        
            
                2820
                Sand Soft
                
 dummy address

            
            1242
            Draft
            
            EST6
            2010-10-12 00:00:00
            
            0
            
            
            
            
                
                    2947
                    San-10
                    Products
                    dummy description 
                    50.00
                    1.00
                    
                    Percent
                    
                    
                    
                    
                    
                    
                
                .
                .
                .

Get Estimate

Return the complete estimate details associated with the given estimate_id.

Request

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

Response

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

            
            1242
            Draft
            
            EST6
            2010-10-12 00:00:00
            
            0
            
            
            
            
                
                    2947
                    San-10
                    Products
                    dummy description 
                    50.00
                    1.00
                    
                    Percent
                    
                    
                    
                    
                    
                    
                
                .
                .
                .

Send Estimate Mail

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

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="sendEstimateMail">
        <estimate_id>1065</estimate_id>
</request>

Response

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

Add Estimate Item

One or more items may be added to an existing estimate.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="addEstimateItem">
	<estimate_id>2623</estimate_id>
	<items>	<!-- Specify one or more items (Optional) -->
		<item>
			<name>San-55</name>							
			<type>Service</type>										<!-- Default is "Product" -->
			<description>Added item through API</description>			<!-- (Optional) -->
			<unit_cost>500</unit_cost>									<!-- Default is 0 -->
			<quantity>1.5</quantity>										<!-- Default is 0 -->
			<discount>10</discount>										<!-- (Optional) -->
			<discount_type></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"?>

    10459
        
 34052 
 34053

Update Estimate Item

Updates (an) existing item(s) on an existing estimate.

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

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="updateEstimateItem">
	<estimate_id>2623</estimate_id>
	<items>	<!-- Specify one or more items (Optional) -->
		<item>
				<estimate_item_id>6833</estimate_item_id>
				<name>San-126</name>										<!-- (Optional) -->
				<type>Service</type>										<!-- Default is "Product" -->
				<description>updated item through API</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></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 Estimate Item

Delete estimate items from an existing estimate.

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="deleteEstimateItem">
	<estimate_id>2613</estimate_id>
	<estimate_item_id>6816</estimate_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