Create Sales Invoice with The Bookie API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for The Bookie, Typeform and 2,400+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create Sales Invoice with the The Bookie 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 Typeform trigger and The Bookie action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Create Sales Invoice action
1. Connect your The Bookie account
2. Select a Contact ID
3. Configure Invoice Number
4. Configure Invoice Date
5. Configure Expiration Date
6. Optional- Select a VAT shifted
7. Optional- Configure Journal Entry Lines
8. Optional- Configure Attachment
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#

New Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Create Sales Invoice on The Bookie

Description:Creates a new sales invoice. [See the documentation](https://app.thebookie.nl/nl/help/article/api-documentatie/#salesentry_create)

Version:0.0.1

Key:the_bookie-create-sales-invoice

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import fs from "fs";
import {
  checkTmp, parseObject,
} from "../../common/utils.mjs";
import theBookie from "../../the_bookie.app.mjs";

export default {
  key: "the_bookie-create-sales-invoice",
  name: "Create Sales Invoice",
  description: "Creates a new sales invoice. [See the documentation](https://app.thebookie.nl/nl/help/article/api-documentatie/#salesentry_create)",
  version: "0.0.1",
  type: "action",
  props: {
    theBookie,
    contactId: {
      propDefinition: [
        theBookie,
        "contactId",
      ],
    },
    invoiceNumber: {
      type: "string",
      label: "Invoice Number",
      description: "The number of the invoice",
    },
    invoiceDate: {
      type: "string",
      label: "Invoice Date",
      description: "The date of the invoice. **Format: YYYY-MM-DD**",
    },
    expirationDate: {
      type: "string",
      label: "Expiration Date",
      description: "The expiration date of the invoice. **Format: YYYY-MM-DD**",
    },
    btwShifted: {
      type: "string",
      label: "VAT shifted",
      description: "The VAT type",
      options: [
        {
          label: "No (standard)",
          value: "NONE",
        },
        {
          label: "Shifted within The Netherlands",
          value: "NL",
        },
        {
          label: "Shifted within EU",
          value: "EU",
        },
        {
          label: "Shifted outside EU",
          value: "NON_EU",
        },
      ],
      optional: true,
    },
    journalEntryLines: {
      type: "string[]",
      label: "Journal Entry Lines",
      description: "An array of stringified objects of item entry lines. **Example: { \"description\": \"Boekregel 1\", \"btw_type\": \"PROCENT_21\", \"amount\": \"1200.0\", \"quantity\": \"2.00\"}** btw_type can be only 'PERCENT_9', 'PERCENT_21' or 'PERCENT_0'",
      optional: true,
    },
    attachment: {
      type: "string",
      label: "Attachment",
      description: "The path to the pdf file saved to the `/tmp` directory (e.g. `/tmp/example.pdf`). [See the documentation](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory).",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.journalEntryLines) {
      throw new ConfigurationError("At least one (1) 'Journal Entry Line' should be added");
    }
    if (this.attachment) {
      this.attachment = fs.readFileSync(checkTmp(this.attachment), {
        encoding: "base64",
      });
    }
    const response = await this.theBookie.createInvoice({
      $,
      data: {
        contact_id: this.contactId,
        invoice_number: this.invoiceNumber,
        invoice_date: this.invoiceDate,
        expiration_date: this.expirationDate,
        btw_shifted: this.btwShifted,
        journal_entry_lines: parseObject(this.journalEntryLines),
        attachment: this.attachment,
      },
    });

    $.export("$summary", `Successfully created invoice with number ${this.invoiceNumber}`);
    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
The Bookie	`theBookie`	`app`	This component uses the The Bookie app.
Contact ID	`contactId`	`string`	Select a value from the drop down menu.
Invoice Number	`invoiceNumber`	`string`	The number of the invoice
Invoice Date	`invoiceDate`	`string`	The date of the invoice. Format: YYYY-MM-DD
Expiration Date	`expirationDate`	`string`	The expiration date of the invoice. Format: YYYY-MM-DD
VAT shifted	`btwShifted`	`string`	Select a value from the drop down menu:`{ "label": "No (standard)", "value": "NONE" }{ "label": "Shifted within The Netherlands", "value": "NL" }{ "label": "Shifted within EU", "value": "EU" }{ "label": "Shifted outside EU", "value": "NON_EU" }`
Journal Entry Lines	`journalEntryLines`	`string[]`	An array of stringified objects of item entry lines. Example: { "description": "Boekregel 1", "btw_type": "PROCENT_21", "amount": "1200.0", "quantity": "2.00"} btw_type can be only 'PERCENT_9', 'PERCENT_21' or 'PERCENT_0'
Attachment	`attachment`	`string`	The path to the pdf file saved to the `/tmp` directory (e.g. `/tmp/example.pdf`). See the documentation.

Action Authentication#

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

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