Create Sales Order with Zoho Books API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create 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#

Create a workflow to Create Sales Order with the Zoho Books API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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

Integrations#

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

HTTP / Webhook + Zoho Books

Try it

Create Sales Order with Zoho Books API on New Item in Feed from RSS API

RSS + Zoho Books

Try it

Create Sales Order with Zoho Books API on New Message from Discord API

Discord + Zoho Books

Try it

Create Sales Order with Zoho Books API on New Message In Channels from Slack API

Slack + Zoho Books

Try it

Create Sales Order with Zoho Books API on New Message in Channel from Discord Bot API

Discord Bot + Zoho Books

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Sales Order on Zoho Books

Description:Creates a sales order. [See the documentation](https://www.zoho.com/books/api/v3/sales-order/#create-a-sales-order)

Version:0.3.0

Key:zoho_books-create-salesorder

View on GitHub

Code#

// legacy_hash_id: a_WYi46K
import {
  clearObj, parseObject,
} from "../../common/utils.mjs";
import zohoBooks from "../../zoho_books.app.mjs";

export default {
  key: "zoho_books-create-salesorder",
  name: "Create Sales Order",
  description: "Creates a sales order. [See the documentation](https://www.zoho.com/books/api/v3/sales-order/#create-a-sales-order)",
  version: "0.3.0",
  type: "action",
  props: {
    zohoBooks,
    customerId: {
      propDefinition: [
        zohoBooks,
        "customerId",
      ],
      description: "ID of the customer to whom the sales order has to be created.",
    },
    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",
      ],
    },
    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,
    },
    adjustmentDescription: {
      propDefinition: [
        zohoBooks,
        "adjustmentDescription",
      ],
      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,
    },
    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 response = await this.zohoBooks.createSalesorder({
      $,
      params: clearObj({
        ignore_auto_number_generation: this.ignoreAutoNumberGeneration,
        can_send_in_mail: this.canSendInMail,
        totalFiles: this.totalFiles,
        doc: this.doc,
      }),
      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,
      }),
    });

    $.export("$summary", `Salesorder successfully created with Id: ${response.salesorder.salesorder_id}`);
    return response;
  },
};

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
Zoho Books	`zohoBooks`	`app`	This component uses the Zoho Books app.
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`
Adjustment Description	`adjustmentDescription`	`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`
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

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