API

API

Home  Customers
How do I add a Customer?
 

Method name
https://invoice.zoho.com/api/customers/create

Method type
POST

API description
Adds a customer in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, XMLString, apikey

Sample Request

<Customer>
    <Name>Sample Customer</Name>	<!-- Mandatory -->
    <PaymentsDue>0</PaymentsDue>
    <CurrencyCode>CNY</CurrencyCode>
    <BillingAddress>B-1104, 11F, Horizon International Tower, No. 6, ZhiChun Road, HaiDian District,</BillingAddress>
    <BillingCity>Beijing</BillingCity>
    <BillingZip>100088</BillingZip>
    <BillingCountry>China</BillingCountry>
    <BillingFax>+86-10-82637827</BillingFax>
    <ShippingAddress>4900 Hopyard Rd, Suit 310</ShippingAddress>
    <ShippingCity>Pleasanton</ShippingCity>
    <ShippingState>CA</ShippingState>
    <ShippingZip>94588</ShippingZip>
    <ShippingCountry>USA</ShippingCountry>
    <ShippingFax>+1-925-924-9600</ShippingFax>
    <Contacts>
        <Contact>            
            <Salutation>Mr.</Salutation>
            <FirstName>John</FirstName>
            <LastName>Smith</LastName>
            <EMail>johnsmith@flaster.com</EMail>
            <Phone>+1-925-921-9201</Phone>
            <Mobile>+1-4054439562</Mobile>
        </Contact>
        <Contact>
            <Salutation>Ms.</Salutation>
            <FirstName>Shawla</FirstName>
            <LastName>Malkonni</LastName>
            <EMail>shawla@flaster.com</EMail>
            <Phone>+1-925-921-9111</Phone>
            <Mobile>+1-4054528653</Mobile>
        </Contact>
    </Contacts>
    <CustomFields>
        <CustomFieldLabel1>VAT ID</CustomFieldLabel1>
        <CustomFieldValue1>756399371</CustomFieldValue1>
        <CustomFieldLabel2>Reg.ID</CustomFieldLabel2>
        <CustomFieldValue2>673856</CustomFieldValue2>
        <CustomFieldLabel3>Website</CustomFieldLabel3>
        <CustomFieldValue3>www.zoho.com</CustomFieldValue3>
    </CustomFields>
    <Notes>Customer Notes</Notes>

</Customer>

Sample Response

<Response status="1">
    <Customer uri="/api/customers/4000000002030">
        <CustomerID>4000000002030</CustomerID>
        <Name>Sample Customer</Name>
        <PaymentsDue>0</PaymentsDue>	<!-- From the date of invoicing the number of days allowed for the customer to make the payment. -->
        <CurrencyCode>CNY</CurrencyCode>
        <AvailableCredit>0.00</AvailableCredit>
        <OutstandingBalance>0.00</OutstandingBalance>
        <BillingAddress>B-1104, 11F, Horizon International Tower, No. 6, ZhiChun Road, HaiDian District,</BillingAddress>
        <BillingCity>Beijing</BillingCity>
        </BillingState>
        <BillingZip>100088</BillingZip>
        <BillingCountry>China</BillingCountry>
        <BillingFax>+86-10-82637827</BillingFax>
        <ShippingAddress>4900 Hopyard Rd, Suit 310</ShippingAddress>
        <ShippingCity>Pleasanton</ShippingCity>
        <ShippingState>CA</ShippingState>
        <ShippingZip>94588</ShippingZip>
        <ShippingCountry>USA</ShippingCountry>
        <ShippingFax>+1-925-924-9600</ShippingFax>
        <Contacts>
            <Contact>
                <ContactID>5000000017022</ContactID>
                <Salutation>Mr.</Salutation>
                <FirstName>John</FirstName>
                <LastName>Smith</LastName>
                <EMail>johnsmith@flaster.com</EMail>
                <Phone>+1-925-921-9201</Phone>
                <Mobile>+1-4054439562</Mobile>
            </Contact>
            <Contact>

                <ContactID>5000000017024</ContactID>
                <Salutation>Ms.</Salutation>
                <FirstName>Shawla</FirstName>
                <LastName>Malkonni</LastName>
                <EMail>shawla@flaster.com</EMail>
                <Phone>+1-925-921-9111</Phone>
                <Mobile>+1-4054528653</Mobile>
            </Contact>
        </Contacts>
        <CustomFields>
            <CustomFieldLabel1>VAT ID</CustomFieldLabel1>
            <CustomFieldValue1>756399371</CustomFieldValue1>
            <CustomFieldLabel2>Reg.ID</CustomFieldLabel2>
            <CustomFieldValue2>673856</CustomFieldValue2>
            <CustomFieldLabel3>Website</CustomFieldLabel3>
            <CustomFieldValue3>www.zoho.com</CustomFieldValue3>
        </CustomFields>
        <Notes>Customer Notes</Notes>
    </Customer>
</Response>

How do I add a Customer and get a formatted response?
 

Method name
https://invoice.zoho.com/api/view/customers/create

Method type
POST

API description
Adds a customer in your Zoho Invoice account and gets a formatted response.

Parameters to be passed
authtoken, scope, XMLString, apikey

Sample Request

<Customer>
    <Name>Sample Customer</Name>	<!-- Mandatory -->
    <PaymentsDue>0</PaymentsDue>
    <CurrencyCode>CNY</CurrencyCode>
    <BillingAddress>B-1104, 11F, Horizon International Tower, No. 6, ZhiChun Road, HaiDian District,</BillingAddress>
    <BillingCity>Beijing</BillingCity>
    <BillingZip>100088</BillingZip>
    <BillingCountry>China</BillingCountry>
    <BillingFax>+86-10-82637827</BillingFax>
    <ShippingAddress>4900 Hopyard Rd, Suit 310</ShippingAddress>
    <ShippingCity>Pleasanton</ShippingCity>
    <ShippingState>CA</ShippingState>
    <ShippingZip>94588</ShippingZip>
    <ShippingCountry>USA</ShippingCountry>
    <ShippingFax>+1-925-924-9600</ShippingFax>
    <Contacts>
        <Contact>            
            <Salutation>Mr.</Salutation>
            <FirstName>John</FirstName>
            <LastName>Smith</LastName>
            <EMail>johnsmith@flaster.com</EMail>
            <Phone>+1-925-921-9201</Phone>
            <Mobile>+1-4054439562</Mobile>
        </Contact>
        <Contact>
            <Salutation>Ms.</Salutation>
            <FirstName>Shawla</FirstName>
            <LastName>Malkonni</LastName>
            <EMail>shawla@flaster.com</EMail>
            <Phone>+1-925-921-9111</Phone>
            <Mobile>+1-4054528653</Mobile>
        </Contact>
    </Contacts>
    <CustomFields>
        <CustomFieldLabel1>VAT ID</CustomFieldLabel1>
        <CustomFieldValue1>756399371</CustomFieldValue1>
        <CustomFieldLabel2>Reg.ID</CustomFieldLabel2>
        <CustomFieldValue2>673856</CustomFieldValue2>
        <CustomFieldLabel3>Website</CustomFieldLabel3>
        <CustomFieldValue3>www.zoho.com</CustomFieldValue3>
    </CustomFields>
    <Notes>Need to remind him of payments</Notes>
</Customer>

Sample Response

<Response status="1">
    <Customers uri="/api/view/customers/3000000000328">
        <CustomerID>3000000000328</CustomerID>
        <Name>Sample Customer</Name>
        <PaymentsDue>Due On Receipt</PaymentsDue>
        <CurrencyCode>CNY</CurrencyCode>
        <AvailableCredit>CNY0.000</AvailableCredit>
        <OutstandingBalance>CNY0.00</OutstandingBalance>
        <BillingAddress>B-1104, 11F, Horizon International Tower, No. 6, ZhiChun Road, HaiDian District,</BillingAddress>
        <BillingCity>Beijing</BillingCity>
        </BillingState>
        <BillingZip>100088</BillingZip>
        <BillingCountry>China</BillingCountry>
        <BillingFax>+86-10-82637827</BillingFax>
        <ShippingAddress>4900 Hopyard Rd, Suit 310</ShippingAddress>
        <ShippingCity>Pleasanton</ShippingCity>
        <ShippingState>CA</ShippingState>
        <ShippingZip>94588</ShippingZip>
        <ShippingCountry>USA</ShippingCountry>
        <ShippingFax>+1-925-924-9600</ShippingFax>
        <Contacts>
            <Contact>
                <ContactID>5000000017022</ContactID>
                <Salutation>Mr.</Salutation>
                <FirstName>John</FirstName>
                <LastName>Smith</LastName>
                <EMail>johnsmith@flaster.com</EMail>
                <Phone>+1-925-921-9201</Phone>
                <Mobile>+1-4054439562</Mobile>
            </Contact>
            <Contact>
                <ContactID>5000000017024</ContactID>
                <Salutation>Ms.</Salutation>
                <FirstName>Shawla</FirstName>
                <LastName>Malkonni</LastName>
                <EMail>shawla@flaster.com</EMail>
                <Phone>+1-925-921-9111</Phone>
                <Mobile>+1-4054528653</Mobile>
            </Contact>
        </Contacts>
        <CustomFields>
            <CustomFieldLabel1>VAT ID</CustomFieldLabel1>
            <CustomFieldValue1>756399371</CustomFieldValue1>
            <CustomFieldLabel2>Reg.ID</CustomFieldLabel2>
            <CustomFieldValue2>673856</CustomFieldValue2>
            <CustomFieldLabel3>Website</CustomFieldLabel3>
            <CustomFieldValue3>www.zoho.com</CustomFieldValue3>
        </CustomFields>
        <Notes>Customer Notes</Notes>
    </Customer>
</Response>

How do I update a customer?
 

Method name
https://invoice.zoho.com/api/customers/update

Method type
POST

API description
Update an existing customer's name in your Zoho Invoice account.

You can change the values of the following fields of a customer

  • PaymentsDue
  • BillingAddress
  • BillingCity
  • BillingState
  • BillingZip
  • BillingCountry
  • BillingFax
  • ShippingAddress
  • ShippingCity
  • ShippingState
  • ShippingZip
  • ShippingCountry
  • ShippingFax
  • FirstName
  • LastName
  • EMail
  • Phone
  • CustomFields

Parameters to be passed
authtoken, scope, XMLString, apikey

Sample Request

<Customer>
    <CustomerID>3000000000330</CustomerID>
    <Name>Sample Customer 1</Name>   <!-- Changes customer Name -->
    <BillingCity></BillingCity>   <!-- To reset a field, do not specify a value for the tag enclosing this field -->
    <Contacts>
    	<Contact>
            <Salutation>Mr.</Salutation>
            <FirstName>John</FirstName>   <!-- Associates a contact to an existing customer. -->
            <LastName>Smith</LastName>
            <EMail>johnsmith@flaster.com</EMail>
            <Phone>+1-925-921-9201</Phone>
            <Mobile>+1-4054439562</Mobile>
        </Contact>
        <Contact delete="true"> <!-- Deletes a contact associated with an existing customer -->
            <ContactID>5000000017024</ContactID>
        </Contact>
    </Contacts>		
</Customer>

Sample Response

<Response  status="1">
    <Customer uri="/api/customers/3000000000330">
        <CustomerID>3000000000330</CustomerID>
        <Name>Sample Customer 1</Name>
        <PaymentsDue>30</PaymentsDue>
        <CurrencyCode>CNY</CurrencyCode>
        <AvailableCredit>0.00</AvailableCredit>
        <OutstandingBalance>100.00</OutstandingBalance>
        <BillingAddress>B-1104, 11F, Horizon International Tower, No. 6, ZhiChun Road, HaiDian District,</BillingAddress>
        <BillingCity/>
        <BillingState/>
        <BillingZip>100088</BillingZip>
        <BillingCountry>China</BillingCountry>
        <BillingFax>+86-10-82637827</BillingFax>
        <ShippingAddress>4900 Hopyard Rd, Suit 310</ShippingAddress>
        <ShippingCity>Pleasanton</ShippingCity>
        <ShippingState>CA</ShippingState>
        <ShippingZip>94588</ShippingZip>
        <ShippingCountry>USA</ShippingCountry>
        <ShippingFax>+1-925-924-9600</ShippingFax>
        <Contacts>
            <Contact>
                <ContactID>5000000017022</ContactID>
                <Salutation>Mr.</Salutation>
                <FirstName>John</FirstName>
                <LastName>Smith</LastName>
                <EMail>johnsmith@flaster.com</EMail>
                <Phone>+1-925-921-9201</Phone>
                <Mobile>+1-4054439562</Mobile>
            </Contact>
        </Contacts>
        <CustomFields>
            <CustomFieldLabel1>VAT ID</CustomFieldLabel1>
            <CustomFieldValue1>756399371</CustomFieldValue1>
            <CustomFieldLabel2>Reg.ID</CustomFieldLabel2>
            <CustomFieldValue2>673856</CustomFieldValue2>
            <CustomFieldLabel3>Website</CustomFieldLabel3>
            <CustomFieldValue3>www.zoho.com</CustomFieldValue3>
        </CustomFields>
        </Notes>
    </Customer>
</Response>

How do I update a customer and get a formatted response?
 

Method name
https://invoice.zoho.com/api/view/customers/update

Method type
POST

API description
Updates an existing customer details in your Zoho Invoice account and gets a formatted response.

You can change the values of the following fields of a customer

  • PaymentsDue
  • BillingAddress
  • BillingCity
  • BillingState
  • BillingZip
  • BillingCountry
  • BillingFax
  • ShippingAddress
  • ShippingCity
  • ShippingState
  • ShippingZip
  • ShippingCountry
  • ShippingFax
  • FirstName
  • LastName
  • EMail
  • Phone
  • CustomFields

Parameters to be passed
authtoken, scope, XMLString, apikey

Sample Request

<Customer>
    <CustomerID>3000000000328</CustomerID>
    <Name>Sample Customer 1</Name>   <!-- Changes customer Name -->
    <BillingCity></BillingCity>   <!-- To reset a field, do not specify a value for the tag enclosing this field -->
    <Contacts>    	
        <Contact delete="true"> <!-- Deletes a contact associated with an existing customer -->
            <ContactID>5000000017024</ContactID>
        </Contact>
    </Contacts>
</Customer>

Sample Response

<Response status="1">
    <Customers uri="/api/view/customers/3000000000328">
        <CustomerID>3000000000328</CustomerID>
        <Name>Sample Customer 1</Name>
        <PaymentsDue>Net 30</PaymentsDue>
        <CurrencyCode>CNY</CurrencyCode>
        <AvailableCredit>CNY0.000</AvailableCredit>
        <OutstandingBalance>CNY100.00</OutstandingBalance>
        <BillingAddress>B-1104, 11F, Horizon International Tower, No. 6, ZhiChun Road, HaiDian District,</BillingAddress>
        <BillingCity></BillingCity>
        </BillingState>
        <BillingZip>100088</BillingZip>
        <BillingCountry>China</BillingCountry>
        <BillingFax>+86-10-82637827</BillingFax>
        <ShippingAddress>4900 Hopyard Rd, Suit 310</ShippingAddress>
        <ShippingCity>Pleasanton</ShippingCity>
        <ShippingState>CA</ShippingState>
        <ShippingZip>94588</ShippingZip>
        <ShippingCountry>USA</ShippingCountry>
        <ShippingFax>+1-925-924-9600</ShippingFax>
        <Contacts>
            <Contact>
                <ContactID>5000000017022</ContactID>
                <Salutation>Mr.</Salutation>
                <FirstName>John</FirstName>
                <LastName>Smith</LastName>
                <EMail>johnsmith@flaster.com</EMail>
                <Phone>+1-925-921-9201</Phone>
                <Mobile>+1-4054439562</Mobile>
            </Contact>
        </Contacts>
        <CustomFields>
            <CustomFieldLabel1>VAT ID</CustomFieldLabel1>
            <CustomFieldValue1>756399371</CustomFieldValue1>
            <CustomFieldLabel2>Reg.ID</CustomFieldLabel2>
            <CustomFieldValue2>673856</CustomFieldValue2>
            <CustomFieldLabel3>Website</CustomFieldLabel3>
            <CustomFieldValue3>www.zoho.com</CustomFieldValue3>
        </CustomFields>
        <Notes>Customer Notes</Notes>
    </Customer>
</Response>

How do I mark a customer inactive?
 

Method name
https://invoice.zoho.com/api/customers/markasinactive/<customer ID>

Method type
POST

API description
Make a customer inactive.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">

How do I delete a customer?
 

Method name
https://invoice.zoho.com/api/customers/delete/<customer ID>

Method type
POST

API description
Deletes a customer from your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">

How do I find a customer?
 

Method name
http://invoice.zoho.com/api/view/search/customers/

Method type
GET

API description
Search for a customer by passing either "Customer Name" or "Customer Notes". Only active customers will be listed.

Parameters to be passed
authtoken, scope, apikey, searchtext

Sample Response

<Response status="1">
    <Customers uri="/api/view/search/customers/">
        <Customer uri="/api/customers/3000000000328">
            <CustomerID>3000000000328</CustomerID>
            <Name>Sample Customer</Name>
            <PaymentsDue>Due On Receipt</PaymentsDue>
            <CurrencyCode>INR</CurrencyCode>
            <AvailableCredit>Rs.0.00</AvailableCredit>
            <OutstandingBalance>Rs.1,409.00</OutstandingBalance>
        </Customer>
        <Customer uri="/api/customers/4000000002030">
            <CustomerID>4000000002030</CustomerID>
            <Name>Sample Customer 1</Name>
            <PaymentsDue>Net 30</PaymentsDue>
            <CurrencyCode>USD</CurrencyCode>
            <AvailableCredit>$0.00</AvailableCredit>
            <OutstandingBalance>$10.00</OutstandingBalance>
        </Customer>
        <Customer uri="/api/customers/4000000002031">
            <CustomerID>4000000002031</CustomerID>
            <Name>Sample Customer 2</Name>
            <PaymentsDue>Net 30</PaymentsDue>
            <CurrencyCode>CNY</CurrencyCode>
            <AvailableCredit>CNY0.000</AvailableCredit>
            <OutstandingBalance>$10.00</OutstandingBalance>
        </Customer>
    </Customers>
    <PageContext Page="1" Per_Page="200" Total="3" Total_Pages="1"/>
</Response>

How to customize the number of customers to be shown on a page?

How do I view my active customers (Unformatted)?
 

Method name
https://invoice.zoho.com/api/customers/

Method type
GET

API description
View list of active customers in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Customers uri="/api/customers/">
        <Customer uri="/api/customers/4000000002031">
            <CustomerID>4000000002031</CustomerID>
            <Name>Sample Customer 1</Name>
            <PaymentsDue>30</PaymentsDue>
            <CurrencyCode>CNY</CurrencyCode>
            <AvailableCredit>0.000</AvailableCredit>
            <OutstandingBalance>10.00</OutstandingBalance>
        </Customer>
        <Customer uri="/api/customers/4000000002032">
            <CustomerID>4000000002032</CustomerID>
            <Name>Sample Customer 2</Name>
            <PaymentsDue>0</PaymentsDue>
            <CurrencyCode>INR</CurrencyCode>
            <AvailableCredit>0.00</AvailableCredit>
            <OutstandingBalance>10.00</OutstandingBalance>
        </Customer>
        <Customer uri="/api/customers/4000000002033">
            <CustomerID>4000000002033</CustomerID>
            <Name>Sample Customer 3</Name>
            <PaymentsDue>28</PaymentsDue>
            <CurrencyCode>CAD</CurrencyCode>
            <AvailableCredit>0.00</AvailableCredit>
            <OutstandingBalance>0.00</OutstandingBalance>
        </Customer>
        <Customer uri="/api/customers/4000000002034">
            <CustomerID>4000000002034</CustomerID>
            <Name>Sample Customer 4</Name>
            <PaymentsDue>30</PaymentsDue>
            <CurrencyCode>USD</CurrencyCode>
            <AvailableCredit>0.00</AvailableCredit>
            <OutstandingBalance>1013.00</OutstandingBalance>
        </Customer>
        <Customer uri="/api/customers/4000000002035">
            <CustomerID>4000000002035</CustomerID>
            <Name>Sample Customer 5</Name>
            <PaymentsDue>30</PaymentsDue>
            <CurrencyCode>CNY</CurrencyCode>
            <AvailableCredit>0.000</AvailableCredit>
            <OutstandingBalance>1409.00</OutstandingBalance>
        </Customer>
    </Customers>
    <PageContext Page="1" Per_Page="200" Total="5" Total_Pages="1"/>
</Response>

How to customize the number of customers to be shown on a page?

How do I view my active customer (formatted)?
 

Method name
https://invoice.zoho.com/api/view/customers/

Method type
GET

API description
View list of active customers in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Customers uri="/api/view/customers/">
    	<Customer uri="/api/customers/4000000002030">
            <CustomerID>4000000002030</CustomerID>
            <Name>Sample Customer</Name>
            <PaymentsDue>Net 30</PaymentsDue>
            <CurrencyCode>CNY</CurrencyCode>
            <AvailableCredit>CNY0.000</AvailableCredit>
            <OutstandingBalance>CNY10.000</OutstandingBalance>
        </Customer>
    	<Customer uri="/api/customers/4000000002031">
            <CustomerID>4000000002031</CustomerID>
            <Name>Sample Customer 1</Name>
            <PaymentsDue>Due On Receipt</PaymentsDue>
            <CurrencyCode>INR</CurrencyCode>
            <AvailableCredit>Rs.0.00</AvailableCredit>
            <OutstandingBalance>Rs.10.00</OutstandingBalance>
        </Customer>
    	<Customer uri="/api/customers/4000000002032">
            <CustomerID>4000000002032</CustomerID>
            <Name>Sample Customer 2</Name>
            <PaymentsDue>Net 20</PaymentsDue>
            <CurrencyCode>INR</CurrencyCode>
            <AvailableCredit>Rs.0.00</AvailableCredit>
            <OutstandingBalance>Rs.10.00</OutstandingBalance>
        </Customer>
    	<Customer uri="/api/customers/4000000002033">
            <CustomerID>4000000002033</CustomerID>
            <Name>Sample Customer 3</Name>
            <PaymentsDue>Net 30</PaymentsDue>
            <CurrencyCode>USD</CurrencyCode>
            <AvailableCredit>$0.00</AvailableCredit>
            <OutstandingBalance>$1013.00</OutstandingBalance>
        </Customer>
    </Customers>
    <PageContext Page="1" Per_Page="200" Total="4" Total_Pages="1"/>
</Response>

How to customize the number of customers to be shown on a page?

How do I view my inactive customer (Unformatted)?
 

Method name
https://invoice.zoho.com/api/customers/inactive

Method type
GET

API description
View list of inactive customers in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Customers uri="/api/customers/inactive/">
        <Customer uri="/api/customers/4000000002031">
            <CustomerID>4000000002031</CustomerID>
            <Name>Sample Customer 1</Name>
            <PaymentsDue>30</PaymentsDue>
            <CurrencyCode>CNY</CurrencyCode>
            <AvailableCredit>0.000</AvailableCredit>
            <OutstandingBalance>10.00</OutstandingBalance>
        </Customer>
        <Customer uri="/api/customers/4000000002032">
            <CustomerID>4000000002032</CustomerID>
            <Name>Sample Customer 2</Name>
            <PaymentsDue>0</PaymentsDue>
            <CurrencyCode>INR</CurrencyCode>
            <AvailableCredit>0.00</AvailableCredit>
            <OutstandingBalance>10.00</OutstandingBalance>
        </Customer>
        <Customer uri="/api/customers/4000000002033">
            <CustomerID>4000000002033</CustomerID>
            <Name>Sample Customer 3</Name>
            <PaymentsDue>28</PaymentsDue>
            <CurrencyCode>CAD</CurrencyCode>
            <AvailableCredit>0.00</AvailableCredit>
            <OutstandingBalance>0.00</OutstandingBalance>
        </Customer>
        <Customer uri="/api/customers/4000000002034">
            <CustomerID>4000000002034</CustomerID>
            <Name>Sample Customer 4</Name>
            <PaymentsDue>30</PaymentsDue>
            <CurrencyCode>USD</CurrencyCode>
            <AvailableCredit>0.00</AvailableCredit>
            <OutstandingBalance>1013.00</OutstandingBalance>
        </Customer>
        <Customer uri="/api/customers/4000000002035">
            <CustomerID>4000000002035</CustomerID>
            <Name>Sample Customer 5</Name>
            <PaymentsDue>30</PaymentsDue>
            <CurrencyCode>CNY</CurrencyCode>
            <AvailableCredit>0.000</AvailableCredit>
            <OutstandingBalance>1409.00</OutstandingBalance>
        </Customer>
    </Customers>
    <PageContext Page="1" Per_Page="200" Total="5" Total_Pages="1"/>
</Response>

How to customize the number of customers to be shown on a page?

How do I view my inactive customer (formatted)?
 

Method name
https://invoice.zoho.com/api/view/customers/inactive

Method type
GET

API description
View list of inactive customers in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Customers uri="/api/view/customers/inactive">
    	<Customer uri="/api/customers/4000000002031">
            <CustomerID>4000000002031</CustomerID>
            <Name>Sample Customer 1</Name>
            <PaymentsDue>Net 30</PaymentsDue>
            <CurrencyCode>CNY</CurrencyCode>
            <AvailableCredit>CNY0.000</AvailableCredit>
            <OutstandingBalance>CNY10.00</OutstandingBalance>
        </Customer>
    	<Customer uri="/api/customers/4000000002032">
            <CustomerID>4000000002032</CustomerID>
            <Name>Sample Customer 2</Name>
            <PaymentsDue>Due On Receipt</PaymentsDue>
            <CurrencyCode>INR</CurrencyCode>
            <AvailableCredit>Rs.0.00</AvailableCredit>
            <OutstandingBalance>Rs.10.00</OutstandingBalance>
        </Customer>
    	<Customer uri="/api/customers/4000000002033">
            <CustomerID>4000000002033</CustomerID>
            <Name>Sample Customer 3</Name>
            <PaymentsDue>Net 20</PaymentsDue>
            <CurrencyCode>CAD</CurrencyCode>
            <AvailableCredit>CAD0.00</AvailableCredit>
            <OutstandingBalance>CAD0.00</OutstandingBalance>
        </Customer>
    	<Customer uri="/api/customers/4000000002034">
            <CustomerID>4000000002034</CustomerID>
            <Name>Sample Customer 4</Name>
            <PaymentsDue>Net 30</PaymentsDue>
            <CurrencyCode>USD</CurrencyCode>
            <AvailableCredit>$0.00</AvailableCredit>
            <OutstandingBalance>$1013.00</OutstandingBalance>
        </Customer>
    	<Customer uri="/api/customers/4000000002035">
            <CustomerID>4000000002035</CustomerID>
            <Name>Sample Customer 5</Name>
            <PaymentsDue>Net 30</PaymentsDue>
            <CurrencyCode>CNY</CurrencyCode>
            <AvailableCredit>CNY0.000</AvailableCredit>
            <OutstandingBalance>CNY1409.00</OutstandingBalance>
        </Customer>
    </Customers>
    <PageContext Page="1" Per_Page="200" Total="5" Total_Pages="1"/>
</Response>

How to customize the number of customers to be shown on a page?

How do I view my customer details (unformatted)?
 

Method name
https://invoice.zoho.com/api/customers/<customer ID>

Method type
GET

API description
View detailed information of a particular customer.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Customers uri="/api/customers/3000000000328">
        <CustomerID>3000000000328</CustomerID>
        <Name>Sample Customer</Name>
        <PaymentsDue>30</PaymentsDue>
        <CurrencyCode>CNY</CurrencyCode>
        <AvailableCredit>0.000</AvailableCredit>
        <OutstandingBalance>10.00</OutstandingBalance>
        <BillingAddress>B-1104, 11F, Horizon International Tower, No. 6, ZhiChun Road, HaiDian District,</BillingAddress>
        <BillingCity>Beijing</BillingCity>
        </BillingState>
        <BillingZip>100088</BillingZip>
        <BillingCountry>China</BillingCountry>
        <BillingFax>+86-10-82637827</BillingFax>
        <ShippingAddress>4900 Hopyard Rd, Suit 310</ShippingAddress>
        <ShippingCity>Pleasanton</ShippingCity>
        <ShippingState>CA</ShippingState>
        <ShippingZip>94588</ShippingZip>
        <ShippingCountry>USA</ShippingCountry>
        <ShippingFax>+1-925-924-9600</ShippingFax>
        <Contacts>
            <Contact>
                <ContactID>5000000017022</ContactID>
                <Salutation>Mr.</Salutation>
                <FirstName>John</FirstName>
                <LastName>Smith</LastName>
                <EMail>johnsmith@flaster.com</EMail>
                <Phone>+1-925-921-9201</Phone>
                <Mobile>+1-4054439562</Mobile>
            </Contact>
        </Contacts>
        <CustomFields>
            <CustomFieldLabel1>VAT ID</CustomFieldLabel1>
            <CustomFieldValue1>756399371</CustomFieldValue1>
            <CustomFieldLabel2>Reg.ID</CustomFieldLabel2>
            <CustomFieldValue2>673856</CustomFieldValue2>
            <CustomFieldLabel3>Website</CustomFieldLabel3>
            <CustomFieldValue3>www.zoho.com</CustomFieldValue3>
        </CustomFields>
        <Notes>Need to remind him of payments</Notes>
    </Customer>
</Response>

How do I view my customer details (formatted)?
 

Method name
https://invoice.zoho.com/api/view/customers/<customer ID>

Method type
GET

API description
View detailed information of a particular customer.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Customers uri="/api/view/customers/3000000000328">
        <CustomerID>3000000000328</CustomerID>
        <Name>Sample Customer</Name>
        <PaymentsDue>Net 30</PaymentsDue>
        <CurrencyCode>CNY</CurrencyCode>
        <AvailableCredit>CNY0.000</AvailableCredit>
        <OutstandingBalance>CNY10.00</OutstandingBalance>
        <BillingAddress>B-1104, 11F, Horizon International Tower, No. 6, ZhiChun Road, HaiDian District,</BillingAddress>
        <BillingCity>Beijing</BillingCity>
        </BillingState>
        <BillingZip>100088</BillingZip>
        <BillingCountry>China</BillingCountry>
        <BillingFax>+86-10-82637827</BillingFax>
        <ShippingAddress>4900 Hopyard Rd, Suit 310</ShippingAddress>
        <ShippingCity>Pleasanton</ShippingCity>
        <ShippingState>CA</ShippingState>
        <ShippingZip>94588</ShippingZip>
        <ShippingCountry>USA</ShippingCountry>
        <ShippingFax>+1-925-924-9600</ShippingFax>
        <Contacts>
            <Contact>
                <ContactID>5000000017022</ContactID>
                <Salutation>Mr.</Salutation>
                <FirstName>John</FirstName>
                <LastName>Smith</LastName>
                <EMail>johnsmith@flaster.com</EMail>
                <Phone>+1-925-921-9201</Phone>
                <Mobile>+1-4054439562</Mobile>
            </Contact>
        </Contacts>
        <CustomFields>
            <CustomFieldLabel1>VAT ID</CustomFieldLabel1>
            <CustomFieldValue1>756399371</CustomFieldValue1>
            <CustomFieldLabel2>Reg.ID</CustomFieldLabel2>
            <CustomFieldValue2>673856</CustomFieldValue2>
            <CustomFieldLabel3>Website</CustomFieldLabel3>
            <CustomFieldValue3>www.zoho.com</CustomFieldValue3>
        </CustomFields>
        <Notes>Need to remind him of payments</Notes>
    </Customer>
</Response>

How to customize the number of customers to be shown on a page?
 

Using "PageContext" tag you can customize the number of customers you would like to view per page. Pass "Per_Page" parameter in the request.

    <PageContext Page="1" Per_Page="200" Total="2" Total_Pages="1"/>

For navigating to next page, pass "Page" parameter in the request

In the above example,

Page The current page you are viewing.
Total_Pages Total pages present.
Per_Page Number of customers per page (Default value is 200).
Total Total customers present.
How do I send a customer statement?
 

Method name
https://invoice.zoho.com/api/customers/sendstatement

Method type
POST

API description
Sends a statement to the Customer specified.

Parameters to be passed
authtoken, scope, apikey, Custom.Subject, Custom.Body, CustomerID, StartDate, EndDate, ToEMailIDs, CCEMailIDs

Date must be in yyyy-MM-dd format.
EMailIDs must be comma separated if there are more than one.

Sample Response

<Response status="1">
    <Code/>
    <Message>Statement has been sent to the customer</Message>
</Response>
How do I view a customer statement?
 

Method name
https://invoice.zoho.com/api/view/customers/getstatement

Method type
POST

API description
View a customer statement.

Parameters to be passed
authtoken, scope, apikey, CustomerID, StartDate, EndDate

Date must be in yyyy-MM-dd format

Sample Request

<Response  status="1">
    <Statement uri="/api/view/customers/getstatement">
        <CustomerName>John Robert (Sample Customer)</CustomerName>
        <FromDate>01 Apr 2010</FromDate>
        <ToDate>25 Apr 2010</ToDate>
        <OpeningBalance>Rs.0.00</OpeningBalance>
        <InvoicedAmount>Rs.120.00</InvoicedAmount>
        <AmountPaid>Rs.20.00</AmountPaid>
        <BalanceDue>Rs.100.00</BalanceDue>
        <Transactions>
            <Transaction>
                <Date>16 Apr 2010</Date>
                <Description>INV-1</Description>
                <Amount>120.00</Amount>
                <Balance>120.00</Balance>
            </Transaction>
            <Transaction>
                <Date>16 Apr 2010</Date>
                <Description>Payment for INV-1</Description>
                <Amount>-10.00</Amount>
                <Balance>110.00</Balance>
            </Transaction>
            <Transaction>
                <Date>16 Apr 2010</Date>
                <Description>Payment for INV-1</Description>
                <Amount>-10.00</Amount>
                <Balance>100.00</Balance>
            </Transaction>
        </Transactions>
    </Statement>
</Response>
What is the difference between unformatted and formatted API?
 

In Zoho Invoice, the View APIs are of two types - Formatted and Unformatted.

Formatted APIs are used to display the values in the client. The date shown will be formatted based on the date format selected in the settings page. Currency code will be appended to the Invoice Total, balance, Item Total, Price, Payment Amount shown and the amount will also be formatted based on the currency format selected in the Currency settings page.

Unformatted APIs are used for processing values in the program. The date will be shown in the default format "yyyy-MM-dd". The amounts shown will not be formatted.

Got more questions?

Submit your request to us and we will help you out.

Zoho Invoice API

Quick Links
Features
Zoho services
Recent Blogs
Spread the Word

© 2013, ZOHO Corp. Invoice Software 4900 Hopyard Rd, Suite 310, Pleasanton, CA 94588, USA Support: +1 888-900-9646 | Sales: +1 888-204-3539,