Create Customer Order with Workbooks CRM API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Customer Order with the Workbooks CRM 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 Customer Order with the Workbooks CRM API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Customer Order action
1. Connect your Workbooks CRM account
2. Select a Assigned To
3. Configure Customer Order Name
4. Configure Document Currency
5. Configure Customer Order Date
6. Configure Status
7. Configure Tax Point Date
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 Customer Order with Workbooks CRM API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Workbooks CRM

Try it

Create Customer Order with Workbooks CRM API on New Item in Feed from RSS API

RSS + Workbooks CRM

Try it

Create Customer Order with Workbooks CRM API on New Submission from Typeform API

Typeform + Workbooks CRM

Try it

Create Customer Order with Workbooks CRM API on Custom Events from Zoom API

Zoom + Workbooks CRM

Try it

Create Customer Order with Workbooks CRM API on New Submission (Instant) from Jotform API

Jotform + Workbooks CRM

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 Customer Order on Workbooks CRM

Description:Creates an order from your customers for your goods or services.

Version:0.0.1

Key:workbooks_crm-create-customer-order

View on GitHub

Code#

import app from "../../workbooks_crm.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "workbooks_crm-create-customer-order",
  name: "Create Customer Order",
  description: "Creates an order from your customers for your goods or services.",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    assignedTo: {
      label: "Assigned To",
      description: "A queue that this Customer Order could be assigned to.",
      propDefinition: [
        app,
        "orderQueue",
      ],
    },
    description: {
      type: "string",
      label: "Customer Order Name",
      description: "The description of this Customer Order.",
    },
    documentCurrency: {
      type: "string",
      label: "Document Currency",
      description: "The currency of this Transaction in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. E.g. `USD`.",
    },
    documentDate: {
      type: "string",
      label: "Customer Order Date",
      description: "The official date for this Customer Order.",
      default: utils.getCurrentDate(),
    },
    status: {
      type: "string",
      label: "Status",
      description: "The status of this Transaction.",
      default: "DRAFT",
    },
    taxPointDate: {
      type: "string",
      label: "Tax Point Date",
      description: "The date that sales tax will be calculated for this Transaction.",
      default: utils.getCurrentDate(),
    },
  },
  async run({ $: step }) {
    const {
      assignedTo,
      description,
      documentCurrency,
      documentDate,
      status,
      taxPointDate,
    } = this;

    const response = await this.app.createOrder({
      step,
      data: {
        assigned_to: [
          assignedTo,
        ],
        description: [
          description,
        ],
        document_currency: [
          documentCurrency,
        ],
        document_date: [
          documentDate,
        ],
        status: [
          status,
        ],
        tax_point_date: [
          taxPointDate,
        ],
      },
    });

    step.export("$summary", `Successfully created customer order with ID ${response.affected_objects[0].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
Workbooks CRM	`app`	`app`	This component uses the Workbooks CRM app.
Assigned To	`assignedTo`	`string`	Select a value from the drop down menu.
Customer Order Name	`description`	`string`	The description of this Customer Order.
Document Currency	`documentCurrency`	`string`	The currency of this Transaction in ISO 4217 format. E.g. `USD`.
Customer Order Date	`documentDate`	`string`	The official date for this Customer Order.
Status	`status`	`string`	The status of this Transaction.
Tax Point Date	`taxPointDate`	`string`	The date that sales tax will be calculated for this Transaction.

Authentication#

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

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