Creator Help

Get Invoice Info

Overview

The Deluge task zoho.invoice.getInvoiceInfo(<InvoiceID>) returns a map object containing the status of zoho invoice. This task is a wrapper task for invoices API in Zoho Invoice. The return type will be a map object containing the keys as specified below.

Deluge syntax

//to get the status of Zoho Invoice
<map-variable> = zoho.invoice.getInvoiceInfo(<InvoiceID>,<Optional Company Name>);

where,
<InvoiceID> refers to the ID of the invoice created in Zoho invoice
<map-variable> refers to the map object that contains the following keys.

"CreatedTimeInMillis", "PaymentsDue", "CreatedTime", "InvoiceID", "DueDate", "InvoiceDate", "LateFeeAmount",
"CurrencyCode", "CustomerName", "InvoiceNumber","Source", "Notes", "Status", "ExchangeRate","InvoiceItemTotal",
"CustomerID", "TaxTotal", "LastModifiedTime","Balance", "Total"

Sample Map Object

{
"Items":"
[
{
ItemID=600000000012026, Quantity=1.000000, ProductID=600000000012012, Tax2Name=,
Tax2ID=, Tax1Type=0, Tax1ID=, Tax1Name=, Tax1Percentage=0.000000, ItemName=Copperwire,
Price=100.000000, ItemTotal=100.000, Tax2Percentage=, Discount=0.00, Tax2Type=0,
ItemDescription=
},

{
ItemID=600000000012028, Quantity=2.000000, ProductID=600000000012020, Tax2Name=,
Tax2ID=, Tax1Type=0, Tax1ID=, Tax1Name=, Tax1Percentage=0.000000, ItemName=Brasscable,
Price=35.000000, ItemTotal=70.000, Tax2Percentage=, Discount=0.00, Tax2Type=0,
ItemDescription=
}
{
ItemID=600000000012028, Quantity=2.000000, ProductID=600000000012020, Tax2Name
Tax2ID=, Tax1Type=0, Tax1ID=, Tax1Name=, Tax1Percentage=0.000000, ItemName=Brasscable,
Price=35.000000, ItemTotal=70.000, Tax2Percentage=, Discount=0.00, Tax2Type=0,
ItemDescription=
}
]",
"CreatedTimeInMillis":"1296814495279",
"PaymentsDue":"15",
"CreatedTime":"2011-02-04 15:44:55 IST",
"InvoiceID":"600000000012022",
"DueDate":"2011-02-19",
"InvoiceDate":"2011-02-04",
"LateFeeAmount":"0.000",
"CurrencyCode":"INR",
"CustomerName":"GMR Infra",
"InvoiceNumber":"INV-2",
"Source":"1",
"Notes":"Thanks for your business.",
"Status":"1",
"ExchangeRate":"1.000000",
"InvoiceIteTotal":"170.000",
"CustomerID":"600000000012008",
"TaxTotal":"0.0"
"LastModifiedTime":"2011-02-04 15:44:55 IST",
"Balance":"170.000",
"Total":"170.000"
}

Related Links

http://www.zoho.com/invoice/api/invoices/invoices.html#how-do-i-view-my-invoice-details-unformatted?

Top