Create Customer with Clear Books API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Create Customer action
1. Connect your Clear Books account
2. Configure Name
3. Optional- Configure Email
4. Optional- Configure Phone
5. Optional- Configure Street Address
6. Optional- Configure Town
7. Optional- Configure County
8. Optional- Configure Postcode
9. Optional- Configure Country Code
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 with Clear Books API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Clear Books

Try it

Create Customer with Clear Books API on New Submission from Typeform API

Typeform + Clear Books

Try it

Create Customer with Clear Books API on New Submission (Instant) from Jotform API

Jotform + Clear Books

Try it

Create Customer with Clear Books API on New Scheduled Tasks from Pipedream API

Pipedream + Clear Books

Try it

Create Customer with Clear Books API on New Download Counts from npm API

npm + Clear 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 Customer on Clear Books

Description:Creates a new customer in Clear Books. [See the documentation](https://u.pcloud.link/publink/show?code=XZkThJ5Z4zKewgCL6VBpfxlPeHPDdXXj0Cc7)

Version:0.0.2

Key:clear_books-create-customer

View on GitHub

Code#

import clearBooks from "../../clear_books.app.mjs";

export default {
  key: "clear_books-create-customer",
  name: "Create Customer",
  description: "Creates a new customer in Clear Books. [See the documentation](https://u.pcloud.link/publink/show?code=XZkThJ5Z4zKewgCL6VBpfxlPeHPDdXXj0Cc7)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    clearBooks,
    name: {
      type: "string",
      label: "Name",
      description: "Name of the customer",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the customer",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Phone number of the customer",
      optional: true,
    },
    streetAddress: {
      type: "string",
      label: "Street Address",
      description: "Street address of the customer",
      optional: true,
    },
    town: {
      type: "string",
      label: "Town",
      description: "Town of the customer",
      optional: true,
    },
    county: {
      type: "string",
      label: "County",
      description: "County of the customer",
      optional: true,
    },
    postcode: {
      type: "string",
      label: "Postcode",
      description: "Postcode of the customer",
      optional: true,
    },
    countryCode: {
      type: "string",
      label: "Country Code",
      description: "Country code of the customer",
      optional: true,
    },
  },
  async run({ $ }) {
    const hasAddress = this.streetAddress
      || this.town
      || this.county
      || this.postcode
      || this.countryCode;

    const response = await this.clearBooks.createCustomer({
      $,
      data: {
        name: this.name,
        email: this.email,
        phone: this.phone,
        address: hasAddress && {
          line1: this.streetAddress,
          town: this.town,
          county: this.county,
          postcode: this.postcode,
          countryCode: this.countryCode,
        },
      },
    });
    $.export("$summary", `Successfully created customer with ID: ${response.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
Clear Books	`clearBooks`	`app`	This component uses the Clear Books app.
Name	`name`	`string`	Name of the customer
Email	`email`	`string`	Email address of the customer
Phone	`phone`	`string`	Phone number of the customer
Street Address	`streetAddress`	`string`	Street address of the customer
Town	`town`	`string`	Town of the customer
County	`county`	`string`	County of the customer
Postcode	`postcode`	`string`	Postcode of the customer
Country Code	`countryCode`	`string`	Country code of the customer

Authentication#

Clear Books uses OAuth authentication. When you connect your Clear Books account, Pipedream will open a popup window where you can sign into Clear 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 Clear Books API.

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

businesses:readaccounting.customers:readaccounting.customers:writeaccounting.suppliers:readaccounting.suppliers:writeaccounting.purchases:readaccounting.purchases:writeaccounting.transactions:read