Create Purchase Document with Clear Books API on Card Due Date Reminder from Pipedream API

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

Trigger workflow on

Card Due Date Reminder from the Pipedream API

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#

This integration creates a workflow with a Pipedream trigger and Clear Books action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Card Due Date Reminder trigger
1. Connect your Pipedream account
2. Connect your Pipedream account
3. Select a Board
4. Select a Time Before
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
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Card Due Date Reminder on Pipedream

Description:Emit new event at a specified time before a card is due.

Version:0.1.3

Key:trello-card-due-date-reminder

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import ms from "ms";
import taskScheduler from "../../../pipedream/sources/new-scheduled-tasks/new-scheduled-tasks.mjs";
import constants from "../../common/constants.mjs";
import trello from "../../trello.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "trello-card-due-date-reminder",
  name: "Card Due Date Reminder", /* eslint-disable-line pipedream/source-name */
  description: "Emit new event at a specified time before a card is due.",
  version: "0.1.3",
  type: "source",
  dedupe: "unique",
  props: {
    pipedream: taskScheduler.props.pipedream,
    trello,
    db: "$.service.db",
    http: "$.interface.http",
    board: {
      propDefinition: [
        trello,
        "board",
      ],
    },
    timeBefore: {
      type: "string",
      label: "Time Before",
      description: "How far before the due time the event should trigger. For example, `5 minutes`, `10 minutes`, `1 hour`.",
      default: "5 minutes",
      options: constants.NOTIFICATION_TIMES,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.timeBefore) {
      props.timer = {
        type: "$.interface.timer",
        description: "Poll the API to schedule alerts for any newly created events",
        default: {
          intervalSeconds: ms(this.timeBefore) / 1000,
        },
      };
    }
    return props;
  },
  hooks: {
    async deactivate() {
      const ids = this._getScheduledEventIds();
      if (!ids?.length) {
        return;
      }
      for (const id of ids) {
        if (await this.deleteEvent({
          body: {
            id,
          },
        })) {
          console.log("Cancelled scheduled event");
        }
      }
      this._setScheduledEventIds();
    },
  },
  methods: {
    ...taskScheduler.methods,
    generateMeta({
      id, name: summary,
    }, now) {
      return {
        id,
        summary,
        ts: now,
      };
    },
    _getScheduledEventIds() {
      return this.db.get("scheduledEventIds");
    },
    _setScheduledEventIds(ids) {
      this.db.set("scheduledEventIds", ids);
    },
    _getScheduledCardIds() {
      return this.db.get("scheduledCardIds");
    },
    _setScheduledCardIds(ids) {
      this.db.set("scheduledCardIds", ids);
    },
    _hasDeployed() {
      const result = this.db.get("hasDeployed");
      this.db.set("hasDeployed", true);
      return result;
    },
    emitEvent(card, now) {
      const meta = this.generateMeta(card, now);
      this.$emit(card, meta);
    },
  },
  async run(event) {
    const now = event.timestamp * 1000;

    // self subscribe only on the first time
    if (!this._hasDeployed()) {
      await this.selfSubscribe();
    }

    let scheduledEventIds = this._getScheduledEventIds() || [];

    // incoming scheduled event
    if (event.$channel === this.selfChannel()) {
      const remainingScheduledEventIds = scheduledEventIds.filter((id) => id !== event["$id"]);
      this._setScheduledEventIds(remainingScheduledEventIds);
      this.emitEvent(event, now);
      return;
    }

    // schedule new events
    const scheduledCardIds = this._getScheduledCardIds() || {};
    const cards = await this.trello.getCards({
      boardId: this.board,
    });

    for (const card of cards) {
      const dueDate = card.due
        ? new Date(card.due)
        : null;
      if (!dueDate || dueDate.getTime() < Date.now()) {
        delete scheduledCardIds[card.id];
        continue;
      }

      const later = new Date(dueDate.getTime() - ms(this.timeBefore));

      if (scheduledCardIds[card.id]) {
        // reschedule if card's due date has changed
        if (card.due !== scheduledCardIds[card.id].dueDate) {
          await this.deleteEvent({
            body: {
              id: scheduledCardIds[card.id].eventId,
            },
          });
          scheduledEventIds = scheduledEventIds
            .filter((id) => id !== scheduledCardIds[card.id].eventId);
        } else {
          continue;
        }
      }

      const scheduledEventId = this.emitScheduleEvent(card, later);
      scheduledEventIds.push(scheduledEventId);
      scheduledCardIds[card.id] = {
        eventId: scheduledEventId,
        dueDate: card.due,
      };
    }
    this._setScheduledEventIds(scheduledEventIds);
    this._setScheduledCardIds(scheduledCardIds);
  },
  sampleEmit,
};

Trigger 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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Pipedream	`trello`	`app`	This component uses the Pipedream app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Board	`board`	`string`	Select a value from the drop down menu.
Time Before	`timeBefore`	`string`	Select a value from the drop down menu:`5 minutes10 minutes15 minutes30 minutes1 hour2 hours3 hours6 hours12 hours1 day2 days3 days1 week`

Trigger Authentication#

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

About Pipedream#

Integration platform for developers

Action#

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.2

Key:clear_books-create-purchase-document

View on GitHub

Action 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.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

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

Action 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

Create Purchase Document with Clear Books API on Card Due Date Reminder from Pipedream API

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

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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