Update Sales Order with Zoho Books API on New Requests (Payload Only) from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Zoho Books, HTTP / Webhook and 2,900+ other apps remarkably fast.

Trigger workflow on

New Requests (Payload Only) from the HTTP / Webhook API

Next, do this

Update Sales Order 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 HTTP / Webhook 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 Requests (Payload Only) trigger
1. Connect your HTTP / Webhook account
Configure the Update Sales Order action
1. Connect your Zoho Books account
2. Select a Salesorder Id
3. Optional- Select a Customer Id
4. Optional- Select one or more Contact Persons
5. Optional- Configure date
6. Optional- Configure Shipment Date
7. Optional- Configure Custom Fields
8. Optional- Select a Place Of Supply
9. Optional- Configure Salesperson Id
10. Optional- Configure Merchant Id
11. Optional- Select a GST Treatment
12. Optional- Configure GST No
13. Optional- Configure Is Inclusive Tax
14. Optional- Configure Line Items
15. Optional- Configure Notes
16. Optional- Configure Terms
17. Optional- Configure Billing Address Id
18. Optional- Configure Shipping Address Id
19. Optional- Configure CRM Owner Id
20. Optional- Configure CRM Custom Reference Id
21. Optional- Configure VAT Treatment
22. Optional- Select a Tax Treatment
23. Optional- Configure Salesorder Number
24. Optional- Configure Reference Number
25. Optional- Configure Is Update Customer
26. Optional- Configure Discount
27. Optional- Configure Exchange Rate
28. Optional- Configure Salesperson Name
29. Optional- Configure Notes Default
30. Optional- Configure Terms Default
31. Optional- Select a Tax Id
32. Optional- Select a Tax Authority Id
33. Optional- Select a Tax Exemption Id
34. Optional- Configure Tax Authority Name
35. Optional- Configure Tax Exemption Code
36. Optional- Select a Tax Exemption Id
37. Optional- Configure Avatax Use Code
38. Optional- Configure Shipping Charge
39. Optional- Configure Adjustment
40. Optional- Configure Delivery Method
41. Optional- Configure Estimate Id
42. Optional- Configure Is Discount Before Tax
43. Optional- Select a Discount Type
44. Optional- Configure Adjustment Description
45. Optional- Configure Pricebook Id
46. Optional- Configure Template Id
47. Optional- Configure Documents
48. Optional- Configure ZCRM Potential Id
49. Optional- Configure ZCRM Potential Name
50. Optional- Configure Ignore Auto Number Generation
51. Optional- Configure Can Send In Mail
52. Optional- Configure Total Files
53. Optional- Configure doc
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 Requests (Payload Only) on HTTP / Webhook

Description:Get a URL and emit the HTTP body as an event on every request

Version:0.1.1

Key:http-new-requests-payload-only

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

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
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Update Sales Order on Zoho Books

Description:Updates an existing sales order. [See the documentation](https://www.zoho.com/books/api/v3/sales-order/#update-a-sales-order)

Version:0.3.1

Key:zoho_books-update-salesorder

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_m8iYLJ
import { ConfigurationError } from "@pipedream/platform";
import {
  clearObj, parseObject,
} from "../../common/utils.mjs";
import zohoBooks from "../../zoho_books.app.mjs";

export default {
  key: "zoho_books-update-salesorder",
  name: "Update Sales Order",
  description: "Updates an existing sales order. [See the documentation](https://www.zoho.com/books/api/v3/sales-order/#update-a-sales-order)",
  version: "0.3.1",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    zohoBooks,
    salesorderId: {
      propDefinition: [
        zohoBooks,
        "salesorderId",
      ],
    },
    customerId: {
      propDefinition: [
        zohoBooks,
        "customerId",
      ],
      description: "ID of the customer to whom the sales order has to be created.",
      optional: true,
    },
    contactPersons: {
      propDefinition: [
        zohoBooks,
        "contactPersons",
        ({ customerId }) => ({
          customerId,
        }),
      ],
      description: "A list of contact person(s) for whom sales order has to be sent.",
      optional: true,
    },
    date: {
      propDefinition: [
        zohoBooks,
        "date",
      ],
      optional: true,
    },
    shipmentDate: {
      propDefinition: [
        zohoBooks,
        "shipmentDate",
      ],
      optional: true,
    },
    customFields: {
      propDefinition: [
        zohoBooks,
        "customFields",
      ],
      optional: true,
    },
    placeOfSupply: {
      propDefinition: [
        zohoBooks,
        "placeOfSupply",
      ],
      optional: true,
    },
    salespersonId: {
      propDefinition: [
        zohoBooks,
        "salespersonId",
      ],
      optional: true,
    },
    merchantId: {
      propDefinition: [
        zohoBooks,
        "merchantId",
      ],
      optional: true,
    },
    gstTreatment: {
      propDefinition: [
        zohoBooks,
        "gstTreatment",
      ],
      optional: true,
    },
    gstNo: {
      propDefinition: [
        zohoBooks,
        "gstNo",
      ],
      optional: true,
    },
    isInclusiveTax: {
      propDefinition: [
        zohoBooks,
        "isInclusiveTax",
      ],
      optional: true,
    },
    lineItems: {
      propDefinition: [
        zohoBooks,
        "lineItems",
      ],
      optional: true,
    },
    notes: {
      propDefinition: [
        zohoBooks,
        "notes",
      ],
      optional: true,
    },
    terms: {
      propDefinition: [
        zohoBooks,
        "terms",
      ],
      optional: true,
    },
    billingAddressId: {
      propDefinition: [
        zohoBooks,
        "billingAddressId",
      ],
      optional: true,
    },
    shippingAddressId: {
      propDefinition: [
        zohoBooks,
        "shippingAddressId",
      ],
      optional: true,
    },
    crmOwnerId: {
      propDefinition: [
        zohoBooks,
        "crmOwnerId",
      ],
      optional: true,
    },
    crmCustomReferenceId: {
      propDefinition: [
        zohoBooks,
        "crmCustomReferenceId",
      ],
      optional: true,
    },
    vatTreatment: {
      propDefinition: [
        zohoBooks,
        "vatTreatment",
      ],
      optional: true,
    },
    taxTreatment: {
      propDefinition: [
        zohoBooks,
        "taxTreatment",
      ],
      optional: true,
    },
    salesorderNumber: {
      propDefinition: [
        zohoBooks,
        "salesorderNumber",
      ],
      optional: true,
    },
    referenceNumber: {
      propDefinition: [
        zohoBooks,
        "referenceNumber",
      ],
      optional: true,
    },
    isUpdateCustomer: {
      propDefinition: [
        zohoBooks,
        "isUpdateCustomer",
      ],
      optional: true,
    },
    discount: {
      propDefinition: [
        zohoBooks,
        "discount",
      ],
      optional: true,
    },
    exchangeRate: {
      propDefinition: [
        zohoBooks,
        "exchangeRate",
      ],
      optional: true,
    },
    salespersonName: {
      propDefinition: [
        zohoBooks,
        "salespersonName",
      ],
      optional: true,
    },
    notesDefault: {
      propDefinition: [
        zohoBooks,
        "notesDefault",
      ],
      optional: true,
    },
    termsDefault: {
      propDefinition: [
        zohoBooks,
        "termsDefault",
      ],
      optional: true,
    },
    taxId: {
      propDefinition: [
        zohoBooks,
        "taxId",
      ],
      optional: true,
    },
    taxAuthorityId: {
      propDefinition: [
        zohoBooks,
        "taxAuthorityId",
      ],
      optional: true,
    },
    taxExemptionId: {
      propDefinition: [
        zohoBooks,
        "taxExemptionId",
      ],
      optional: true,
    },
    taxAuthorityName: {
      propDefinition: [
        zohoBooks,
        "taxAuthorityName",
      ],
      optional: true,
    },
    taxExemptionCode: {
      propDefinition: [
        zohoBooks,
        "taxExemptionCode",
      ],
      optional: true,
    },
    avataxExemptNo: {
      propDefinition: [
        zohoBooks,
        "taxExemptionId",
      ],
      optional: true,
    },
    avataxUseCode: {
      propDefinition: [
        zohoBooks,
        "avataxUseCode",
      ],
      optional: true,
    },
    shippingCharge: {
      propDefinition: [
        zohoBooks,
        "shippingCharge",
      ],
      optional: true,
    },
    adjustment: {
      propDefinition: [
        zohoBooks,
        "adjustment",
      ],
      optional: true,
    },
    deliveryMethod: {
      propDefinition: [
        zohoBooks,
        "deliveryMethod",
      ],
      optional: true,
    },
    estimateId: {
      type: "string",
      label: "Estimate Id",
      description: "ID of the estimate associated with the Sales Order.",
      optional: true,
    },
    isDiscountBeforeTax: {
      propDefinition: [
        zohoBooks,
        "isDiscountBeforeTax",
      ],
      optional: true,
    },
    discountType: {
      propDefinition: [
        zohoBooks,
        "discountType",
      ],
      optional: true,
    },
    adjustmentDescription: {
      propDefinition: [
        zohoBooks,
        "adjustmentDescription",
      ],
      optional: true,
    },
    pricebookId: {
      propDefinition: [
        zohoBooks,
        "pricebookId",
      ],
      optional: true,
    },
    templateId: {
      propDefinition: [
        zohoBooks,
        "pdfTemplateId",
      ],
      optional: true,
    },
    documents: {
      propDefinition: [
        zohoBooks,
        "documents",
      ],
      optional: true,
    },
    zcrmPotentialId: {
      propDefinition: [
        zohoBooks,
        "zcrmPotentialId",
      ],
      optional: true,
    },
    zcrmPotentialName: {
      propDefinition: [
        zohoBooks,
        "zcrmPotentialName",
      ],
      optional: true,
    },
    ignoreAutoNumberGeneration: {
      propDefinition: [
        zohoBooks,
        "ignoreAutoNumberGeneration",
      ],
      optional: true,
    },
    canSendInMail: {
      propDefinition: [
        zohoBooks,
        "canSendInMail",
      ],
      optional: true,
    },
    totalFiles: {
      propDefinition: [
        zohoBooks,
        "totalFiles",
      ],
      optional: true,
    },
    doc: {
      propDefinition: [
        zohoBooks,
        "doc",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const data = clearObj({
      customer_id: this.customerId,
      contact_persons: this.contactPersons,
      date: this.date,
      shipment_date: this.shipmentDate,
      custom_fields: parseObject(this.customFields),
      place_of_supply: this.placeOfSupply,
      salesperson_id: this.salespersonId,
      merchant_id: this.merchantId,
      gst_treatment: this.gstTreatment,
      gst_no: this.gstNo,
      is_inclusive_tax: this.isInclusiveTax,
      line_items: parseObject(this.lineItems),
      notes: this.notes,
      terms: this.terms,
      billing_address_id: this.billingAddressId,
      shipping_address_id: this.shippingAddressId,
      crm_owner_id: this.crmOwnerId,
      crm_custom_reference_id: this.crmCustomReferenceId,
      vat_treatment: this.vatTreatment,
      tax_treatment: this.taxTreatment,
      salesorder_number: this.salesorderNumber,
      reference_number: this.referenceNumber,
      is_update_customer: this.isUpdateCustomer,
      discount: this.discount,
      exchange_rate: this.exchangeRate && parseFloat(this.exchangeRate),
      salesperson_name: this.salespersonName,
      notes_default: this.notesDefault,
      terms_default: this.termsDefault,
      tax_id: this.taxId,
      tax_authority_id: this.taxAuthorityId,
      tax_exemption_id: this.taxExemptionId,
      tax_authority_name: this.taxAuthorityName,
      tax_exemption_code: this.taxExemptionCode,
      avatax_exempt_no: this.avataxExemptNo,
      avatax_use_code: this.avataxUseCode,
      shipping_charge: this.shippingCharge && parseFloat(this.shippingCharge),
      adjustment: this.adjustment && parseFloat(this.adjustment),
      delivery_method: this.deliveryMethod,
      estimate_id: this.estimateId,
      is_discount_before_tax: this.isDiscountBeforeTax,
      discount_type: this.discountType,
      adjustment_description: this.adjustmentDescription,
      pricebook_id: this.pricebookId,
      template_id: this.templateId,
      documents: parseObject(this.documents),
      zcrm_potential_id: this.zcrmPotentialId,
      zcrm_potential_name: this.zcrmPotentialName,
    });

    if (!Object.keys(data).length) {
      throw new ConfigurationError("You must provide at least one field.");
    }
    const response = await this.zohoBooks.updateSalesorder({
      $,
      salesorderId: this.salesorderId,
      params: clearObj({
        ignore_auto_number_generation: this.ignoreAutoNumberGeneration,
        can_send_in_mail: this.canSendInMail,
        totalFiles: this.totalFiles,
        doc: this.doc,
      }),
      data,
    });

    $.export("$summary", `Salesorder successfully updated with Id: ${this.salesorderId}`);
    return response;
  },
};

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	`zohoBooks`	`app`	This component uses the Zoho Books app.
Salesorder Id	`salesorderId`	`string`	Select a value from the drop down menu.
Customer Id	`customerId`	`string`	Select a value from the drop down menu.
Contact Persons	`contactPersons`	`string[]`	Select a value from the drop down menu.
date	`date`	`string`	The date, the sales order is created.
Shipment Date	`shipmentDate`	`string`	Shipping date of sales order.
Custom Fields	`customFields`	`string[]`	A list of custom field objects for a sales order. Example: {"customfield_id": "1352827000000156060", "value": "value" } See the documentation for further details.
Place Of Supply	`placeOfSupply`	`string`	Select a value from the drop down menu:`{ "label": "Abu Dhabi (UAE Supported)", "value": "AB" }{ "label": "Ajman (UAE Supported)", "value": "AJ" }{ "label": "Dubai (UAE Supported)", "value": "DU" }{ "label": "Fujairah (UAE Supported)", "value": "FU" }{ "label": "Ras al-Khaimah (UAE Supported)", "value": "RA" }{ "label": "Sharjah (UAE Supported)", "value": "SH" }{ "label": "Umm al-Quwain (UAE Supported)", "value": "UM" }{ "label": "United Arab Emirates (GCC Supported)", "value": "AE" }{ "label": "Saudi Arabia (GCC Supported)", "value": "SA" }{ "label": "Bahrain (GCC Supported)", "value": "BH" }{ "label": "Kuwait (GCC Supported)", "value": "KW" }{ "label": "Oman (GCC Supported)", "value": "OM" }{ "label": "Qatar (GCC Supported)", "value": "QA" }`
Salesperson Id	`salespersonId`	`string`	ID of the salesperson.
Merchant Id	`merchantId`	`string`	ID of the merchant.
GST Treatment	`gstTreatment`	`string`	Select a value from the drop down menu:`business_gstbusiness_noneoverseasconsumer`
GST No	`gstNo`	`string`	15 digit GST identification number of the customer.
Is Inclusive Tax	`isInclusiveTax`	`boolean`	Used to specify whether the line item rates are inclusive or exclusive of tax.
Line Items	`lineItems`	`string[]`	A list of line items objects of a sales order. Example: {"item_order": "1352827000000156060", "name": "name", "description": "description", "quantity": "1" } See the documentation for further details.
Notes	`notes`	`string`	Notes for this Sales Order.
Terms	`terms`	`string`	The terms added below expressing gratitude or for conveying some information.
Billing Address Id	`billingAddressId`	`string`	ID of the Billing Address
Shipping Address Id	`shippingAddressId`	`string`	ID of the Shipping Address.
CRM Owner Id	`crmOwnerId`	`string`
CRM Custom Reference Id	`crmCustomReferenceId`	`string`
VAT Treatment	`vatTreatment`	`string`	Enter vat treatment.
Tax Treatment	`taxTreatment`	`string`	Select a value from the drop down menu:`vat_registeredvat_not_registeredgcc_vat_not_registeredgcc_vat_registerednon_gccdz_vat_registereddz_vat_not_registeredhome_country_mexicoborder_region_mexiconon_mexicovat_registered` `vat_not_registered` `non_kenyavat_registeredvat_not_registeredoverseas`
Salesorder Number	`salesorderNumber`	`string`	Mandatory if auto number generation is disabled.
Reference Number	`referenceNumber`	`string`	For Customer Only : If a contact is assigned to any particular user, that user can manage transactions for the contact
Is Update Customer	`isUpdateCustomer`	`boolean`	Boolean to update billing address of customer.
Discount	`discount`	`string`	Discount applied to the sales order. It can be either in % or in amount. e.g. 12.5% or 190.
Exchange Rate	`exchangeRate`	`string`	Exchange rate of the currency.
Salesperson Name	`salespersonName`	`string`	Name of the sales person.
Notes Default	`notesDefault`	`string`	Default Notes for the Sales Order
Terms Default	`termsDefault`	`string`	Default Terms of the Sales Order.
Tax Id	`taxId`	`string`	Select a value from the drop down menu.
Tax Authority Id	`taxAuthorityId`	`string`	Select a value from the drop down menu.
Tax Exemption Id	`taxExemptionId`	`string`	Select a value from the drop down menu.
Tax Authority Name	`taxAuthorityName`	`string`	Tax Authority's name.
Tax Exemption Code	`taxExemptionCode`	`string`	Code of Tax Exemption that is applied.
Tax Exemption Id	`avataxExemptNo`	`string`	Select a value from the drop down menu.
Avatax Use Code	`avataxUseCode`	`string`	Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.
Shipping Charge	`shippingCharge`	`string`	Shipping charges applied to the invoice.
Adjustment	`adjustment`	`string`
Delivery Method	`deliveryMethod`	`string`
Estimate Id	`estimateId`	`string`	ID of the estimate associated with the Sales Order.
Is Discount Before Tax	`isDiscountBeforeTax`	`boolean`	Used to specify how the discount has to applied. Either before or after the calculation of tax.
Discount Type	`discountType`	`string`	Select a value from the drop down menu:`entity_levelitem_level`
Adjustment Description	`adjustmentDescription`	`string`
Pricebook Id	`pricebookId`	`string`
Template Id	`templateId`	`string`	ID of the PDF template.
Documents	`documents`	`string[]`	A list of documents.
ZCRM Potential Id	`zcrmPotentialId`	`string`
ZCRM Potential Name	`zcrmPotentialName`	`string`
Ignore Auto Number Generation	`ignoreAutoNumberGeneration`	`boolean`	Ignore auto sales order number generation for this sales order. This mandates the sales order number.
Can Send In Mail	`canSendInMail`	`string`	Can the file be sent in mail.
Total Files	`totalFiles`	`string`	Total number of files.
doc	`doc`	`string`	Document that is to be attached

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 + HTTP / Webhook#

Other Popular Integrations#

Send any HTTP Request with HTTP / Webhook API on New Customer from Zoho Books API

Zoho Books + HTTP / Webhook