Zoho Books - Remind Customer
@sergio
code:
data:privatelast updated:3 years ago
today
Build integrations remarkably fast!
You're viewing a public workflow template.
Sign up to customize, add steps, modify code and more.
Join 1,000,000+ developers using the Pipedream platform
steps.
trigger
HTTP API
Deploy to generate unique URL
This workflow runs on Pipedream's servers and is triggered by HTTP / Webhook requests.
steps.
zoho_books_remind_customer
Remind your customer about an unpaid invoice by email. Reminder will be sent, only for the invoices which are in open or overdue status.
auth
(auths.zoho_books)
params
Organization id

In Zoho Books, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Books Organization with it’s own organization ID, base currency, time zone, language, contacts, reports, etc.

The parameter organization_id should be sent in with every API request to identify the organization.

The organization_id can be obtained from the GET /organizations API’s JSON response. Alternatively, it can be obtained from the Manage Organizations page in the admin console.

 
string ·params.organization_id
Invoice id

ID of the invoice to remind the customer about.

 
string ·params.invoice_id
To mail_ids

Array of email address of the recipients.

[0]:
 
array ·params.to_mail_ids
Subject

The subject of the mail.

 
string ·params.subject
Body

The body of the mail.

 
string ·params.body
Optional
code
async (params, auths) => {
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
}
24
// See the API docs: https://www.zoho.com/books/api/v3/#Invoices_Remind_Customer

if (!params.organization_id  || !params.invoice_id || !params.to_mail_ids|| !params.subject || !params.body) {
  throw new Error("Must provide organization_id, invoice_id, to_mail_ids, subject, and body parameters.");
}

return await require("@pipedreamhq/platform").axios(this, {
  method: "post",
  url: `https://books.${auths.zoho_books.base_api_uri}/api/v3/invoices/${params.invoice_id}/paymentreminder?organization_id=${params.organization_id}`,
  headers: {
    Authorization: `Zoho-oauthtoken ${auths.zoho_books.oauth_access_token}`,
  },
  data: {
    to_mail_ids: params.to_mail_ids,
    cc_mail_ids: params.cc_mail_ids,
    subject: params.subject,
    body: params.body,
    send_from_org_email_id: params.send_from_org_email_id,
    send_customer_statement: params.send_customer_statement,
    attachments: params.attachments
  }
})