← Zoho Books

Create Sales Order with Zoho Books API

Pipedream makes it easy to connect APIs for Zoho Books and 2,000+ 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
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

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.

  1. Configure the Create Sales Order action
    1. Connect your Zoho Books account
    2. Configure organization_id
    3. Configure customer_id
    4. Optional- Configure line_items
    5. Optional- Configure contact_persons
    6. Optional- Configure date
    7. Optional- Configure shipment_date
    8. Optional- Configure custom_fields
    9. Optional- Configure place_of_supply
    10. Optional- Configure salesperson_id
    11. Optional- Configure merchant_id
    12. Optional- Configure gst_treatment
    13. Optional- Configure gst_no
    14. Optional- Configure is_inclusive_tax
    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- Configure 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- Configure tax_id
    32. Optional- Configure tax_authority_id
    33. Optional- Configure tax_exemption_id
    34. Optional- Configure tax_authority_name
    35. Optional- Configure tax_exemption_code
    36. Optional- Configure avatax_exempt_no
    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- Configure 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 totalFiles
    53. Optional- Configure doc
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. 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.
Version:0.2.1
Key:zoho_books-create-salesorder

Code

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

export default {
  key: "zoho_books-create-salesorder",
  name: "Create Sales Order",
  description: "Creates a sales order.",
  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: "ID of the customer to whom the sales order has to be created.",
    },
    line_items: {
      type: "any",
      description: "Line items of a sales order.",
      optional: true,
    },
    contact_persons: {
      type: "any",
      description: "Array of contact person(s) for whom sales order has to be sent.",
      optional: true,
    },
    date: {
      type: "string",
      description: "The date, the sales order is created.",
      optional: true,
    },
    shipment_date: {
      type: "string",
      description: "Shipping date of sales order.",
      optional: true,
    },
    custom_fields: {
      type: "any",
      description: "Custom fields for a sales order.",
      optional: true,
    },
    place_of_supply: {
      type: "string",
      description: "Place where the goods/services are supplied to. (If not given, `place of contact` given for the contact will be taken)\nSupported codes for UAE emirates are :\nAbu Dhabi - AB`,\nAjman - `AJ`,\nDubai - `DU`,\nFujairah - `FU`,\nRas al-Khaimah - `RA`,\nSharjah - `SH`,\nUmm al-Quwain - `UM`\nSupported codes for the GCC countries are :\nUnited Arab Emirates - `AE`,\nSaudi Arabia - `SA`,\nBahrain - `BH`,\nKuwait - `KW`,\nOman - `OM`,\nQatar - `QA`.",
      optional: true,
    },
    salesperson_id: {
      type: "string",
      description: "ID of the salesperson.",
      optional: true,
    },
    merchant_id: {
      type: "string",
      description: "ID of the merchant.",
      optional: true,
    },
    gst_treatment: {
      type: "string",
      description: "Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are `business_gst`, `business_none`, `overseas`, `consumer`.",
      optional: true,
    },
    gst_no: {
      type: "string",
      description: "15 digit GST identification number of the customer.",
      optional: true,
    },
    is_inclusive_tax: {
      type: "boolean",
      description: "Used to specify whether the line item rates are inclusive or exclusive of tax.",
      optional: true,
    },
    notes: {
      type: "string",
      description: "Notes for this Sales Order.",
      optional: true,
    },
    terms: {
      type: "string",
      optional: true,
    },
    billing_address_id: {
      type: "string",
      description: "ID of the Billing Address",
      optional: true,
    },
    shipping_address_id: {
      type: "string",
      description: "ID of the Shipping Address.",
      optional: true,
    },
    crm_owner_id: {
      type: "string",
      optional: true,
    },
    crm_custom_reference_id: {
      type: "string",
      optional: true,
    },
    vat_treatment: {
      type: "string",
      description: "Enter vat treatment.",
      optional: true,
    },
    tax_treatment: {
      type: "string",
      description: "VAT treatment for the invoice .Choose whether the contact falls under: `vat_registered`, `vat_not_registered`, `gcc_vat_not_registered`, `gcc_vat_registered`, `non_gcc` , `dz_vat_registered` and `dz_vat_not_registered` supported only for UAE.",
      optional: true,
    },
    salesorder_number: {
      type: "string",
      description: "Mandatory if auto number generation is disabled.",
      optional: true,
    },
    reference_number: {
      type: "string",
      description: "**For Customer Only** : If a contact is assigned to any particular user, that user can manage transactions for the contact",
      optional: true,
    },
    is_update_customer: {
      type: "boolean",
      description: "Boolean to update billing address of customer.",
      optional: true,
    },
    discount: {
      type: "string",
      description: "Discount applied to the sales order. It can be either in % or in amount. e.g. 12.5% or 190.",
      optional: true,
    },
    exchange_rate: {
      type: "string",
      description: "Exchange rate of the currency.",
      optional: true,
    },
    salesperson_name: {
      type: "string",
      description: "Name of the sales person.",
      optional: true,
    },
    notes_default: {
      type: "string",
      description: "Default Notes for the Sales Order",
      optional: true,
    },
    terms_default: {
      type: "string",
      description: "Default Terms of the Sales Order.",
      optional: true,
    },
    tax_id: {
      type: "string",
      description: "Tax ID for the Sales Order.",
      optional: true,
    },
    tax_authority_id: {
      type: "string",
      description: "ID of the tax authority. Tax authority depends on the location of the customer.",
      optional: true,
    },
    tax_exemption_id: {
      type: "string",
      description: "ID of the tax exemption applied.",
      optional: true,
    },
    tax_authority_name: {
      type: "string",
      description: "Tax Authority's name.",
      optional: true,
    },
    tax_exemption_code: {
      type: "string",
      description: "Code of Tax Exemption that is applied.",
      optional: true,
    },
    avatax_exempt_no: {
      type: "string",
      description: "Exemption certificate number of the customer.",
      optional: true,
    },
    avatax_use_code: {
      type: "string",
      description: "Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.",
      optional: true,
    },
    shipping_charge: {
      type: "string",
      optional: true,
    },
    adjustment: {
      type: "string",
      optional: true,
    },
    delivery_method: {
      type: "string",
      optional: true,
    },
    estimate_id: {
      type: "string",
      description: "ID of the estimate associated with the Sales Order.",
      optional: true,
    },
    is_discount_before_tax: {
      type: "boolean",
      description: "Used to specify how the discount has to applied. Either before or after the calculation of tax.",
      optional: true,
    },
    discount_type: {
      type: "string",
      description: "How the discount is specified. Allowed values are entity_level or item_level. Allowed Values: `entity_level` and `item_level`.",
      optional: true,
    },
    adjustment_description: {
      type: "string",
      optional: true,
    },
    pricebook_id: {
      type: "string",
      optional: true,
    },
    template_id: {
      type: "string",
      description: "ID of the pdf template.",
      optional: true,
    },
    documents: {
      type: "any",
      optional: true,
    },
    zcrm_potential_id: {
      type: "string",
      optional: true,
    },
    zcrm_potential_name: {
      type: "string",
      optional: true,
    },
    ignore_auto_number_generation: {
      type: "string",
      description: "Ignore auto sales order number generation for this sales order. This mandates the sales order number.",
      optional: true,
    },
    can_send_in_mail: {
      type: "string",
      description: "Can the file be sent in mail.",
      optional: true,
    },
    totalFiles: {
      type: "string",
      description: "Total number of files.",
      optional: true,
    },
    doc: {
      type: "string",
      description: "Document that is to be attached",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs: https://www.zoho.com/books/api/v3/#Sales-Order_Create_a_sales_order

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

    return await axios($, {
      method: "post",
      url: `https://books.${this.zoho_books.$auth.base_api_uri}/api/v3/salesorders?organization_id=${this.organization_id}`,
      headers: {
        Authorization: `Zoho-oauthtoken ${this.zoho_books.$auth.oauth_access_token}`,
      },
      data: {
        customer_id: this.customer_id,
        contact_persons: this.contact_persons,
        date: this.date,
        shipment_date: this.shipment_date,
        custom_fields: this.custom_fields,
        place_of_supply: this.place_of_supply,
        salesperson_id: this.salesperson_id,
        merchant_id: this.merchant_id,
        gst_treatment: this.gst_treatment,
        gst_no: this.gst_no,
        is_inclusive_tax: this.is_inclusive_tax,
        line_items: this.line_items,
        notes: this.notes,
        terms: this.terms,
        billing_address_id: this.billing_address_id,
        shipping_address_id: this.shipping_address_id,
        crm_owner_id: this.crm_owner_id,
        crm_custom_reference_id: this.crm_custom_reference_id,
        vat_treatment: this.vat_treatment,
        tax_treatment: this.tax_treatment,
        salesorder_number: this.salesorder_number,
        reference_number: this.reference_number,
        is_update_customer: this.is_update_customer,
        discount: this.discount,
        exchange_rate: this.exchange_rate,
        salesperson_name: this.salesperson_name,
        notes_default: this.notes_default,
        terms_default: this.terms_default,
        tax_id: this.tax_id,
        tax_authority_id: this.tax_authority_id,
        tax_exemption_id: this.tax_exemption_id,
        tax_authority_name: this.tax_authority_name,
        tax_exemption_code: this.tax_exemption_code,
        avatax_exempt_no: this.avatax_exempt_no,
        avatax_use_code: this.avatax_use_code,
        shipping_charge: this.shipping_charge,
        adjustment: this.adjustment,
        delivery_method: this.delivery_method,
        estimate_id: this.estimate_id,
        is_discount_before_tax: this.is_discount_before_tax,
        discount_type: this.discount_type,
        adjustment_description: this.adjustment_description,
        pricebook_id: this.pricebook_id,
        template_id: this.template_id,
        documents: this.documents,
        zcrm_potential_id: this.zcrm_potential_id,
        zcrm_potential_name: this.zcrm_potential_name,
      },
      params: {
        ignore_auto_number_generation: this.ignore_auto_number_generation,
        can_send_in_mail: this.can_send_in_mail,
        totalFiles: this.totalFiles,
        doc: this.doc,
      },
    });
  },
};

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.
LabelPropTypeDescription
Zoho Bookszoho_booksappThis component uses the Zoho Books app.
organization_idstring

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_idstring

ID of the customer to whom the sales order has to be created.

line_itemsany

Line items of a sales order.

contact_personsany

Array of contact person(s) for whom sales order has to be sent.

datestring

The date, the sales order is created.

shipment_datestring

Shipping date of sales order.

custom_fieldsany

Custom fields for a sales order.

place_of_supplystring

Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
Supported codes for UAE emirates are :
Abu Dhabi - AB, Ajman - AJ, Dubai - DU, Fujairah - FU, Ras al-Khaimah - RA, Sharjah - SH, Umm al-Quwain - UMSupported codes for the GCC countries are : United Arab Emirates -AE, Saudi Arabia - SA, Bahrain - BH, Kuwait - KW, Oman - OM, Qatar - QA`.

salesperson_idstring

ID of the salesperson.

merchant_idstring

ID of the merchant.

gst_treatmentstring

Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst, business_none, overseas, consumer.

gst_nostring

15 digit GST identification number of the customer.

is_inclusive_taxboolean

Used to specify whether the line item rates are inclusive or exclusive of tax.

notesstring

Notes for this Sales Order.

termsstring
billing_address_idstring

ID of the Billing Address

shipping_address_idstring

ID of the Shipping Address.

crm_owner_idstring
crm_custom_reference_idstring
vat_treatmentstring

Enter vat treatment.

tax_treatmentstring

VAT treatment for the invoice .Choose whether the contact falls under: vat_registered, vat_not_registered, gcc_vat_not_registered, gcc_vat_registered, non_gcc , dz_vat_registered and dz_vat_not_registered supported only for UAE.

salesorder_numberstring

Mandatory if auto number generation is disabled.

reference_numberstring

For Customer Only : If a contact is assigned to any particular user, that user can manage transactions for the contact

is_update_customerboolean

Boolean to update billing address of customer.

discountstring

Discount applied to the sales order. It can be either in % or in amount. e.g. 12.5% or 190.

exchange_ratestring

Exchange rate of the currency.

salesperson_namestring

Name of the sales person.

notes_defaultstring

Default Notes for the Sales Order

terms_defaultstring

Default Terms of the Sales Order.

tax_idstring

Tax ID for the Sales Order.

tax_authority_idstring

ID of the tax authority. Tax authority depends on the location of the customer.

tax_exemption_idstring

ID of the tax exemption applied.

tax_authority_namestring

Tax Authority's name.

tax_exemption_codestring

Code of Tax Exemption that is applied.

avatax_exempt_nostring

Exemption certificate number of the customer.

avatax_use_codestring

Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.

shipping_chargestring
adjustmentstring
delivery_methodstring
estimate_idstring

ID of the estimate associated with the Sales Order.

is_discount_before_taxboolean

Used to specify how the discount has to applied. Either before or after the calculation of tax.

discount_typestring

How the discount is specified. Allowed values are entity_level or item_level. Allowed Values: entity_level and item_level.

adjustment_descriptionstring
pricebook_idstring
template_idstring

ID of the pdf template.

documentsany
zcrm_potential_idstring
zcrm_potential_namestring
ignore_auto_number_generationstring

Ignore auto sales order number generation for this sales order. This mandates the sales order number.

can_send_in_mailstring

Can the file be sent in mail.

totalFilesstring

Total number of files.

docstring

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

About Zoho Books

Online accounting software

More Ways to Use Zoho Books

Actions

Create Customer Payment with the Zoho Books API

Creates a new payment.

 
Try it
Create Employee with the Zoho Books API

Creates an employee for an expense.

 
Try it
Create Invoice with the Zoho Books API

Creates an invoice for your customer.

 
Try it
Create Item with the Zoho Books API

Creates a new item.

 
Try it
Delete Contact with the Zoho Books API

Deletes an existing contact.

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Salesforce (REST API)
Salesforce (REST API)
Web services API for interacting with Salesforce
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Snowflake
Snowflake
A data warehouse built for the cloud
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.