Create Bank Transaction with Xero Accounting API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Xero Accounting, Twilio SendGrid and 2,000+ other apps remarkably fast.

Trigger workflow on

New Events (Instant) from the Twilio SendGrid 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 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Twilio SendGrid 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 Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.5

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        id,
        summary,
        ts,
      };
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid 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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

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

Create Bank Transaction with Xero Accounting API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Xero Accounting, Twilio SendGrid and 2,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

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