Create Customer Payment with Zoho Books API on New Updated Field on Record (of Selectable Type) from Salesforce API

Pipedream makes it easy to connect APIs for Zoho Books, Salesforce and 2,400+ other apps remarkably fast.

Trigger workflow on

New Updated Field on Record (of Selectable Type) from the Salesforce API

Next, do this

Create Customer Payment with the Zoho Books API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Salesforce trigger and Zoho Books action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Updated Field on Record (of Selectable Type) trigger
1. Connect your Salesforce account
2. Configure timer
3. Select a Object Type
4. Select a Field
5. Optional- Configure Field Updated to
Configure the Create Customer Payment action
1. Connect your Zoho Books account
2. Configure organization_id
3. Configure customer_id
4. Select a payment_mode
5. Configure invoices
6. Configure amount
7. Configure date
8. Optional- Configure reference_number
9. Optional- Configure description
10. Optional- Configure exchange_rate
11. Optional- Configure bank_charges
12. Optional- Configure custom_fields
13. Optional- Configure invoice_id
14. Optional- Configure amount_applied
15. Optional- Configure tax_amount_withheld
16. Optional- Configure account_id
17. Optional- Configure contact_persons
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Updated Field on Record (of Selectable Type) on Salesforce

Description:Emit new event (at regular intervals) when a field of your choosing is updated on any record of a specified Salesforce object. Field history tracking must be enabled for the chosen field. See the docs on [field history tracking](https://sforce.co/3mtj0rF) and [history objects](https://sforce.co/3Fn4lWB) for more information.

Version:0.1.11

Key:salesforce_rest_api-updated-field-on-record

View on GitHub

Salesforce Overview#

The Salesforce (REST API) provides a powerful platform for creating and managing customer relationships with a wide array of features like data manipulation, querying, and complex automation. With Pipedream's serverless execution, you can create workflows that automate your sales processes, sync data with other platforms, enhance customer engagement, and trigger actions based on specific events. Dive into Salesforce data, streamline lead management, track customer interactions, and push or pull data to or from Salesforce seamlessly.

Trigger Code#

import words from "lodash/words.js";
import common from "../common.mjs";

const { salesforce } = common.props;

/**
 * Uses the Salesforce REST API's [sObject Get Updated endpoint](https://sforce.co/3yPSJZy) on the
 * [StandardObjectNamedHistory model](https://sforce.co/3Fn4lWB) to get changes to field values of
 * an sObject type. Associated sObject records are retrieved and emitted for history object records
 * matching configured `field` and `fieldUpdatedTo` prop values.
 */
export default {
  ...common,
  dedupe: "greatest",
  type: "source",
  name: "New Updated Field on Record (of Selectable Type)",
  key: "salesforce_rest_api-updated-field-on-record",
  description: "Emit new event (at regular intervals) when a field of your choosing is updated on any record of a specified Salesforce object. Field history tracking must be enabled for the chosen field. See the docs on [field history tracking](https://sforce.co/3mtj0rF) and [history objects](https://sforce.co/3Fn4lWB) for more information.",
  version: "0.1.11",
  props: {
    ...common.props,
    objectType: {
      type: common.props.objectType.type,
      label: common.props.objectType.label,
      description: common.props.objectType.description,
      propDefinition: [
        salesforce,
        "objectType",
        () => ({
          filter: ({
            replicateable,
            associateEntityType,
          }) => replicateable && associateEntityType === "History",
          mapper: ({ associateParentEntity: value }) => words(value).join(" "),
        }),
      ],
    },
    field: {
      propDefinition: [
        salesforce,
        "field",
        ({ objectType }) => ({
          objectType,
          filter: ({ updateable }) => updateable,
        }),
      ],
    },
    fieldUpdatedTo: {
      propDefinition: [
        salesforce,
        "fieldUpdatedTo",
      ],
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const {
        objectType,
        getObjectTypeDescription,
        setHistoryObjectType,
        setObjectTypeColumns,
      } = this;

      await common.hooks.activate.call(this);

      const historyObjectType = `${objectType}History`;

      const { fields } = await getObjectTypeDescription(historyObjectType);
      const columns = fields.map(({ name }) => name);

      setHistoryObjectType(historyObjectType);
      setObjectTypeColumns(columns);
    },
  },
  methods: {
    ...common.methods,
    getHistoryObjectType() {
      return this.db.get("historyObjectType");
    },
    setHistoryObjectType(historyObjectType) {
      this.db.set("historyObjectType", historyObjectType);
    },
    isRelevant(item) {
      const {
        field,
        fieldUpdatedTo,
      } = this;

      const isFieldRelevant =
        item.Field === field
        || item.Field === `${item.DataType}${field}`;

      const isFieldValueRelevant =
        !fieldUpdatedTo
        || item.NewValue === fieldUpdatedTo;

      return isFieldRelevant && isFieldValueRelevant;
    },
    generateMeta(event) {
      const {
        objectType,
        field,
      } = this;

      const {
        CreatedDate: createdDate,
        Id: id,
        [`${objectType}Id`]: objectId,
      } = event;

      const ts = Date.parse(createdDate);
      return {
        id: `${id}-${ts}`,
        summary: `${field} on ${objectType}: ${objectId}`,
        ts,
      };
    },
    async processEvent({
      startTimestamp, endTimestamp,
    }) {
      const {
        getHistoryObjectType,
        getObjectTypeColumns,
        setLatestDateCovered,
        isRelevant,
        paginate,
        generateMeta,
        $emit: emit,
      } = this;

      const objectType = getHistoryObjectType();
      const columns = getObjectTypeColumns();

      const events = await paginate({
        objectType,
        startTimestamp,
        endTimestamp,
        columns,
      });

      const [
        latestEvent,
      ] = events;

      if (latestEvent?.CreatedDate) {
        const latestDateCovered = new Date(latestEvent.CreatedDate);
        latestDateCovered.setSeconds(0);
        setLatestDateCovered(latestDateCovered.toISOString());
      }

      Array.from(events)
        .reverse()
        .filter(isRelevant)
        .forEach((event) => {
          const meta = generateMeta(event);
          emit(event, meta);
        });
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Salesforce	`salesforce`	`app`	This component uses the Salesforce app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Object Type	`objectType`	`string`	Select a value from the drop down menu.
Field	`field`	`string`	Select a value from the drop down menu.
Field Updated to	`fieldUpdatedTo`	`string`	If provided, the trigger will only fire when the updated field is an EXACT MATCH (including spacing and casing) to the value you provide in this field

Trigger Authentication#

Salesforce uses OAuth authentication. When you connect your Salesforce account, Pipedream will open a popup window where you can sign into Salesforce and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Salesforce API.

Pipedream requests the following authorization scopes when you connect your account:

About Salesforce#

Web services API for interacting with Salesforce

Action#

Create Customer Payment on Zoho Books

Description:Creates a new payment.

Version:0.2.1

Key:zoho_books-create-customer-payment

View on GitHub

Zoho Books Overview#

Zoho Books API unlocks the potential to automate and streamline accounting tasks by integrating with Pipedream's serverless platform. With this powerful combo, you can automate invoicing, manage your accounts, reconcile bank transactions, and handle contacts and items without manual input. By setting up event-driven workflows, you can ensure data consistency across platforms, trigger notifications, and generate reports, all while saving time and reducing human error.

Action Code#

// legacy_hash_id: a_XziR2J
import { axios } from "@pipedream/platform";

export default {
  key: "zoho_books-create-customer-payment",
  name: "Create Customer Payment",
  description: "Creates a new payment.",
  version: "0.2.1",
  type: "action",
  props: {
    zoho_books: {
      type: "app",
      app: "zoho_books",
    },
    organization_id: {
      type: "string",
      description: "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.\n\nThe parameter `organization_id` should be sent in with every API request to identify the organization.\n\nThe `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.",
    },
    customer_id: {
      type: "string",
      description: "Customer ID of the customer involved in the payment.",
    },
    payment_mode: {
      type: "string",
      description: "Mode through which payment is made. This can be `check`, `cash`, `creditcard`, `banktransfer`, `bankremittance`, `autotransaction` or `others`. Max-length [100]",
      options: [
        "check",
        "cash",
        "creditcard",
        "banktransfer",
        "bankremittance",
        "autotransaction",
        "others",
      ],
    },
    invoices: {
      type: "any",
      description: "List of invoices associated with the payment. Each invoice object contains `invoice_id`, `invoice_number`, `date`, `invoice_amount`, `amount_applied` and `balance_amount`.",
    },
    amount: {
      type: "string",
      description: "Amount paid in the respective payment.",
    },
    date: {
      type: "string",
      description: "Date on which payment is made. Format [yyyy-mm-dd]",
    },
    reference_number: {
      type: "string",
      description: "Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]",
      optional: true,
    },
    description: {
      type: "string",
      description: "Description about the payment.",
      optional: true,
    },
    exchange_rate: {
      type: "string",
      description: "Exchange rate for the currency used in the invoices and customer's currency. The payment amount would be the multiplicative product of the original amount and the exchange rate. Default is 1.",
      optional: true,
    },
    bank_charges: {
      type: "string",
      description: "Denotes any additional bank charges.",
      optional: true,
    },
    custom_fields: {
      type: "any",
      description: "Additional fields for the payments.",
      optional: true,
    },
    invoice_id: {
      type: "string",
      description: "ID of the invoice to get payments of.",
      optional: true,
    },
    amount_applied: {
      type: "string",
      description: "Amount paid for the invoice.",
      optional: true,
    },
    tax_amount_withheld: {
      type: "string",
      description: "Amount withheld for tax.",
      optional: true,
    },
    account_id: {
      type: "string",
      description: "ID of the cash/bank account the payment has to be deposited.",
      optional: true,
    },
    contact_persons: {
      type: "string",
      description: "IDs of the contact personsthe thank you mail has to be triggered.",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs: https://www.zoho.com/books/api/v3/#Customer-Payments_Create_a_payment

    if (!this.organization_id || !this.customer_id || !this.payment_mode || !this.invoices || !this.amount || !this.date) {
      throw new Error("Must provide organization_id, customer_id, payment_mode, invoices, amount, and date parameters.");
    }

    return await axios($, {
      method: "post",
      url: `https://books.${this.zoho_books.$auth.base_api_uri}/api/v3/customerpayments?organization_id=${this.organization_id}`,
      headers: {
        Authorization: `Zoho-oauthtoken ${this.zoho_books.$auth.oauth_access_token}`,
      },
      data: {
        customer_id: this.customer_id,
        payment_mode: this.payment_mode,
        amount: this.amount,
        date: this.date,
        reference_number: this.reference_number,
        description: this.description,
        invoices: this.invoices,
        exchange_rate: this.exchange_rate,
        bank_charges: this.bank_charges,
        custom_fields: this.custom_fields,
        invoice_id: this.invoice_id,
        amount_applied: this.amount_applied,
        tax_amount_withheld: this.tax_amount_withheld,
        account_id: this.account_id,
        contact_persons: this.contact_persons,
      },
    });
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Zoho Books	`zoho_books`	`app`	This component uses the Zoho Books app.
organization_id	`organization_id`	`string`	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.
customer_id	`customer_id`	`string`	Customer ID of the customer involved in the payment.
payment_mode	`payment_mode`	`string`	Select a value from the drop down menu:`checkcashcreditcardbanktransferbankremittanceautotransactionothers`
invoices	`invoices`	`any`	List of invoices associated with the payment. Each invoice object contains `invoice_id`, `invoice_number`, `date`, `invoice_amount`, `amount_applied` and `balance_amount`.
amount	`amount`	`string`	Amount paid in the respective payment.
date	`date`	`string`	Date on which payment is made. Format [yyyy-mm-dd]
reference_number	`reference_number`	`string`	Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]
description	`description`	`string`	Description about the payment.
exchange_rate	`exchange_rate`	`string`	Exchange rate for the currency used in the invoices and customer's currency. The payment amount would be the multiplicative product of the original amount and the exchange rate. Default is 1.
bank_charges	`bank_charges`	`string`	Denotes any additional bank charges.
custom_fields	`custom_fields`	`any`	Additional fields for the payments.
invoice_id	`invoice_id`	`string`	ID of the invoice to get payments of.
amount_applied	`amount_applied`	`string`	Amount paid for the invoice.
tax_amount_withheld	`tax_amount_withheld`	`string`	Amount withheld for tax.
account_id	`account_id`	`string`	ID of the cash/bank account the payment has to be deposited.
contact_persons	`contact_persons`	`string`	IDs of the contact personsthe thank you mail has to be triggered.

Action Authentication#

Zoho Books uses OAuth authentication. When you connect your Zoho Books account, Pipedream will open a popup window where you can sign into Zoho Books and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zoho Books API.

Pipedream requests the following authorization scopes when you connect your account:

ZohoBooks.fullaccess.all

About Zoho Books#

Online accounting software

More Ways to Connect Zoho Books + Salesforce#

Other Popular Integrations#

Create Customer Payment with Zoho Books API on New Outbound Message (Instant) from Salesforce API

Salesforce + Zoho Books

Create Customer Payment with Zoho Books API on New Updated Field on Record (of Selectable Type) from Salesforce API

Pipedream makes it easy to connect APIs for Zoho Books, Salesforce and 2,400+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular