Create Bank Transaction with Xero Accounting API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for Xero Accounting, Typeform and 2,200+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create Bank Transaction with the Xero Accounting 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 Xero Accounting 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 Bank Transaction action
1. Connect your Xero Accounting account
2. Optional- Configure bank_account_code
3. Optional- Configure bank_account_id
4. Optional- Configure contact_id
5. Optional- Configure contact_name
6. Configure tenant_id
7. Select a type
8. Configure line_items
9. Optional- Configure is_reonciled
10. Optional- Configure date
11. Optional- Configure reference
12. Optional- Configure currency_code
13. Optional- Configure currency_rate
14. Optional- Configure url
15. Optional- Select a status
16. Optional- Select a line_amount_types
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 Bank Transaction on Xero Accounting

Description:

Version:0.1.1

Key:xero_accounting_api-create-bank-transaction

View on GitHub

Xero Accounting Overview#

The Xero Accounting API offers a powerful gateway to access and manipulate financial data within Xero. Leveraging Pipedream's capabilities, developers can build custom workflows that streamline accounting processes, sync financial data with external systems, and trigger actions based on financial events. This API allows for the automation of tasks such as invoicing, bank reconciliation, bill payments, and reporting, which can lead to significant time savings and enhanced data accuracy.

Action Code#

// legacy_hash_id: a_WYiwz2
import { axios } from "@pipedream/platform";

export default {
  key: "xero_accounting_api-create-bank-transaction",
  name: "Create Bank Transaction",
  version: "0.1.1",
  type: "action",
  props: {
    xero_accounting_api: {
      type: "app",
      app: "xero_accounting_api",
    },
    bank_account_code: {
      type: "string",
      description: "The Account Code of the Bank Account of the transaction. If Code is not included then AccountID is required.",
      optional: true,
    },
    bank_account_id: {
      type: "string",
      description: "The ID of the Bank Account transaction. If AccountID is not included then Code is required.",
      optional: true,
    },
    contact_id: {
      type: "string",
      description: "Id of the contact associated to the bank transaction.",
      optional: true,
    },
    contact_name: {
      type: "string",
      description: "Name of the contact associated to the bank transaction. If there is no contact matching this name, a new contact is created.",
      optional: true,
    },
    tenant_id: {
      type: "string",
      description: "Id of the organization tenant to use on the Xero Accounting API. See [Get Tenant Connections](https://pipedream.com/@sergio/xero-accounting-api-get-tenant-connections-p_OKCzOgn/edit) for a workflow example on how to pull this data.",
    },
    type: {
      type: "string",
      description: "See [Bank Transaction Types](https://developer.xero.com/documentation/api/types#BankTransactionTypes)",
      options: [
        "RECEIVE",
        "RECEIVE-OVERPAYMENT",
        "RECEIVE-PREPAYMENT",
        "SPEND",
        "SPEND-OVERPAYMENT",
        "SPEND-PREPAYMENT",
      ],
    },
    line_items: {
      type: "object",
      description: "See [LineItems](https://developer.xero.com/documentation/api/banktransactions#LineItemsPOST). The LineItems element can contain any number of individual LineItem sub-elements. At least **one** is required to create a bank transaction.",
    },
    is_reonciled: {
      type: "boolean",
      description: "Boolean to show if transaction is reconciled. Conversion related apps can set the IsReconciled flag in scenarios when a matching bank statement line is not available. [Learn more](http://help.xero.com/#Q_BankRecNoImport)",
      optional: true,
    },
    date: {
      type: "string",
      description: "Date of transaction - YYYY-MM-DD",
      optional: true,
    },
    reference: {
      type: "string",
      description: "Reference for the transaction. Only supported for SPEND and RECEIVE transactions.",
      optional: true,
    },
    currency_code: {
      type: "string",
      description: "The currency that bank transaction has been raised in (see [Currencies](https://developer.xero.com/documentation/api/currencies)). Setting currency is only supported on overpayments.",
      optional: true,
    },
    currency_rate: {
      type: "string",
      description: "Exchange rate to base currency when money is spent or received. e.g. 0.7500 Only used for bank transactions in non base currency. If this isn't specified for non base currency accounts then either the user-defined rate (preference) or the [XE.com day rate](http://help.xero.com/#CurrencySettings$Rates) will be used. Setting currency is only supported on overpayments.",
      optional: true,
    },
    url: {
      type: "string",
      description: "URL link to a source document - shown as \"Go to App Name\"",
      optional: true,
    },
    status: {
      type: "string",
      description: "See [Bank Transaction Status Codes](https://developer.xero.com/documentation/api/types#BankTransactionStatuses)",
      optional: true,
      options: [
        "AUTHORISED",
        "DELETED",
      ],
    },
    line_amount_types: {
      type: "string",
      description: "Line amounts are exclusive of tax by default if you don't specify this element. See [Line Amount Types](https://developer.xero.com/documentation/api/types#LineAmountTypes)",
      optional: true,
      options: [
        "Exclusive",
        "Inclusive",
        "NoTax",
      ],
    },
  },
  async run({ $ }) {
  //See the API docs: https://developer.xero.com/documentation/api/banktransactions#PUT

    if ((!this.bank_account_code && !this.bank_account_id)
    || (!this.contact_id && !this.contact_name)
    || !this.tenant_id || !this.type || !this.line_items) {
      throw new Error("Must provide one of bank_account_code or bank_account_id, contact_id or contact_name, tenant_id, type, and line_items parameters.");
    }

    return await axios($, {
      method: "put",
      url: "https://api.xero.com/api.xro/2.0/BankTransactions",
      headers: {
        "Authorization": `Bearer ${this.xero_accounting_api.$auth.oauth_access_token}`,
        "xero-tenant-id": this.tenant_id,
      },
      data: {
        Type: this.type,
        BankAccount: {
          Code: this.bank_account_code,
          AccountID: this.bank_account_id,
        },
        Contact: {
          ContactID: this.contact_id,
          Name: this.contact_name,
        },
        IsReconciled: this.is_reonciled,
        Date: this.date,
        Reference: this.reference,
        CurrencyCode: this.currency_code,
        CurrencyRate: this.currency_rate,
        Url: this.url,
        Status: this.status,
        Lineitems: this.line_items,
        LineAmountTypes: this.line_amount_types,
      },
    });
  },
};

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
Xero Accounting	`xero_accounting_api`	`app`	This component uses the Xero Accounting app.
bank_account_code	`bank_account_code`	`string`	The Account Code of the Bank Account of the transaction. If Code is not included then AccountID is required.
bank_account_id	`bank_account_id`	`string`	The ID of the Bank Account transaction. If AccountID is not included then Code is required.
contact_id	`contact_id`	`string`	Id of the contact associated to the bank transaction.
contact_name	`contact_name`	`string`	Name of the contact associated to the bank transaction. If there is no contact matching this name, a new contact is created.
tenant_id	`tenant_id`	`string`	Id of the organization tenant to use on the Xero Accounting API. See Get Tenant Connections for a workflow example on how to pull this data.
type	`type`	`string`	Select a value from the drop down menu:`RECEIVERECEIVE-OVERPAYMENTRECEIVE-PREPAYMENTSPENDSPEND-OVERPAYMENTSPEND-PREPAYMENT`
line_items	`line_items`	`object`	See LineItems. The LineItems element can contain any number of individual LineItem sub-elements. At least one is required to create a bank transaction.
is_reonciled	`is_reonciled`	`boolean`	Boolean to show if transaction is reconciled. Conversion related apps can set the IsReconciled flag in scenarios when a matching bank statement line is not available. Learn more
date	`date`	`string`	Date of transaction - YYYY-MM-DD
reference	`reference`	`string`	Reference for the transaction. Only supported for SPEND and RECEIVE transactions.
currency_code	`currency_code`	`string`	The currency that bank transaction has been raised in (see Currencies). Setting currency is only supported on overpayments.
currency_rate	`currency_rate`	`string`	Exchange rate to base currency when money is spent or received. e.g. 0.7500 Only used for bank transactions in non base currency. If this isn't specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments.
url	`url`	`string`	URL link to a source document - shown as "Go to App Name"
status	`status`	`string`	Select a value from the drop down menu:`AUTHORISEDDELETED`
line_amount_types	`line_amount_types`	`string`	Select a value from the drop down menu:`ExclusiveInclusiveNoTax`

Action Authentication#

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

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

offline_accessopenidprofileemailaccounting.transactionsaccounting.reports.readaccounting.settingsaccounting.settings.readaccounting.contactsaccounting.attachmentsaccounting.journals.read