Create Purchase Document with Clear Books API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Purchase Document 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 Purchase Document 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 Purchase Document action
1. Connect your Clear Books account
2. Select a Purchase Type
3. Configure Date
4. Select a Supplier ID
5. Optional- Configure Description
6. Optional- Configure Number of Line Items
7. Optional- Configure Line Items JSON
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 Purchase Document with Clear Books API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Clear Books

Try it

Create Purchase Document with Clear Books API on New Submission from Typeform API

Typeform + Clear Books

Try it

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

Jotform + Clear Books

Try it

Create Purchase Document with Clear Books API on New Scheduled Tasks from Pipedream API

Pipedream + Clear Books

Try it

Create Purchase Document 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 Purchase Document on Clear Books

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

Version:0.0.1

Key:clear_books-create-purchase-document

View on GitHub

Code#

import clearBooks from "../../clear_books.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "clear_books-create-purchase-document",
  name: "Create Purchase Document",
  description: "Creates a new Purchase Document in Clear Books. [See the documentation](https://u.pcloud.link/publink/show?code=XZkThJ5Z4zKewgCL6VBpfxlPeHPDdXXj0Cc7)",
  version: "0.0.1",
  type: "action",
  props: {
    clearBooks,
    purchaseType: {
      propDefinition: [
        clearBooks,
        "purchaseType",
      ],
    },
    date: {
      type: "string",
      label: "Date",
      description: "The date of the purchase. Format: YYYY-MM-DD",
    },
    supplierId: {
      propDefinition: [
        clearBooks,
        "supplierId",
      ],
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description of the purchase document",
      optional: true,
    },
    numLineItems: {
      type: "integer",
      label: "Number of Line Items",
      description: "The number of line items. Use this to manually enter Unit Price, Quantity, and Description of each line item.",
      optional: true,
      reloadProps: true,
    },
    lineItemsJson: {
      type: "string",
      label: "Line Items JSON",
      description: "JSON value containing an array of Line Items. For example: `[{\"description\":\"Line Item 1 Description\",\"unitPrice\":1022,\"quantity\":1,\"accountCode\":\"2001001\"},{\"description\":\"Line Item 2 Description\",\"unitPrice\":1023,\"quantity\":2,\"accountCode\":\"2001001\"}]`. [See documentation](https://u.pcloud.link/publink/show?code=XZkThJ5Z4zKewgCL6VBpfxlPeHPDdXXj0Cc7)",
      optional: true,
    },
  },
  additionalProps() {
    const props = {};
    if (!this.numLineItems) {
      return props;
    }
    for (let i = 1; i <= this.numLineItems; i++) {
      props[`line_item_${i}_unit_price`] = {
        type: "string",
        label: `Line Item ${i} - Unit Price`,
      };
      props[`line_item_${i}_quantity`] = {
        type: "integer",
        label: `Line Item ${i} - Quantity`,
      };
      props[`line_item_${i}_description`] = {
        type: "string",
        label: `Line Item ${i} - Description`,
      };
    }
    return props;
  },
  methods: {
    buildLineItems() {
      const lineItems = [];
      for (let i = 1; i <= this.numLineItems; i++) {
        lineItems.push({
          unitPrice: this[`line_item_${i}_unit_price`],
          quantity: this[`line_item_${i}_quantity`],
          description: this[`line_item_${i}_description`],
        });
      }
      return lineItems;
    },
    parseLineItemsJson() {
      try {
        return Array.isArray(this.lineItemsJson)
          ? this.lineItemsJson.map((item) => typeof item === "string"
            ? JSON.parse(item)
            : item)
          : typeof this.lineItemsJson === "string"
            ? JSON.parse(this.lineItemsJson)
            : this.lineItemsJson;
      } catch {
        throw new ConfigurationError("Could not parse Line Items JSON");
      }
    },
  },
  async run({ $ }) {
    if (!this.numLineItems && !this.lineItemsJson) {
      throw new ConfigurationError("Please enter at least one line item");
    }

    const lineItems = [];
    if (this.numLineItems) {
      const lineItemsManual = this.buildLineItems();
      lineItems.push(...lineItemsManual);
    }
    if (this.lineItemsJson) {
      const lineItemsJson = this.parseLineItemsJson();
      lineItems.push(...lineItemsJson);
    }

    const response = await this.clearBooks.createPurchaseDocument({
      $,
      type: this.purchaseType,
      data: {
        date: this.date,
        supplierId: this.supplierId,
        description: this.description,
        lineItems,
      },
    });
    $.export("$summary", `Successfully created purchase document 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.
Purchase Type	`purchaseType`	`string`	Select a value from the drop down menu:`billscreditNotes`
Date	`date`	`string`	The date of the purchase. Format: YYYY-MM-DD
Supplier ID	`supplierId`	`string`	Select a value from the drop down menu.
Description	`description`	`string`	Description of the purchase document
Number of Line Items	`numLineItems`	`integer`	The number of line items. Use this to manually enter Unit Price, Quantity, and Description of each line item.
Line Items JSON	`lineItemsJson`	`string`	JSON value containing an array of Line Items. For example: `[{"description":"Line Item 1 Description","unitPrice":1022,"quantity":1,"accountCode":"2001001"},{"description":"Line Item 2 Description","unitPrice":1023,"quantity":2,"accountCode":"2001001"}]`. See documentation

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