Fetch record from Zoho Billing using the record ID

Table of Contents

Note:

  • Each time the zoho.billing.retrieve integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
  • Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.billing.retrieve integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script. 

Overview

This task is used to fetch a record from Zoho Billing by specifying the record ID. This task is based on Zoho Billing API <ModuleName> -> Receive a <ModuleName>.

Syntax

<variable> = zoho.billing.retrieve(<module_name>, <org_ID>, <record_ID>, <connection>);

where:

Params Data typeDescription
<variable> KEY-VALUEis the response returned by Zoho Billing.
<module_name> TEXTis the name of the module in Zoho Billing from where the record will be fetched.
<org_id>TEXT

Org ID of the organization from which the record will be fetched.

Note: Learn how to fetch organization ID from the UI and from the response of zoho.billing.getOrganization task.
<record_ID>TEXT

ID of the record which will be fetched.

Note: Learn how to fetch the record ID after creating or fetching records.

<connection>TEXT

specifies the link name of the Zoho Billing connection.

Note:

  • In view of stopping new authtoken generation, a Zoho OAuth connection with appropriate scopes is mandatory in order for new integration tasks (created after the deadline specified in the post) to work as expected. Existing integration tasks will continue to work with or without the connections parameter until you manually delete the authtoken from accounts.
  • Add relevant scopes mentioned in Zoho Billing API while creating the connection.
  • Refer to this post for the list of Zoho services that support the connections page.
  • Learn more about connections

Fetch a record from Zoho Billing using the record ID

Let’s take an example of fetching a record from the "Hosted Pages" module in Zoho Billing using the following snippet.

 response = zoho.billing.retrieve("hostedpages", "10982991", "1687000000116001", "billing_connection");

where:

response
is the KEY-VALUE variable returned by Zoho Billing
"hosted pages"
is the TEXT that represents the module from which the record that will be fetched
"10982991"
is the TEXT org id of the organization from which the record will be fetched.
"1687000000116001"
is the TEXT that represents the ID of the record that will be fetched
"billing_connection"
is the TEXT that represents Zoho Billing connection link name

Sample Response

The following is a sample success response:

{  
   "custom_fields":"[]",
   "message":"success",
   "status":"fresh",
   "hostedpage_id":"2-1a76024dc81f1bb6dd4a78d3a5c6f2b16cf56ec5a5b67151097ba494318be79b8a3668c64f1e146cd07b01e06e3e282a",
   "action":"new_subscription",
   "expiring_time":"2015-03-10T11:53:07+0530",
   "code":0,
   "created_time":"2015-03-10T10:53:07+0530",
   "url":"https://billing.zoho.com/hostedpage/2-1a76024dc81f1bb6dd4a78d3a5c6f2b16cf56ec5a5b67151097ba494318be79b8a3668c64f1e146cd07b01e06e3e282a/checkout"
}

The following is a sample failure response:

{
"message":"Please specify a valid hosted page.",
"code":107401
}

Related Links