Create Bank Transaction with Xero Accounting API on New Requests from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Xero Accounting, HTTP / Webhook and 2,400+ other apps remarkably fast.

Trigger workflow on

New Requests from the HTTP / Webhook 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 HTTP / Webhook 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 Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
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 Requests on HTTP / Webhook

Description:Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Version:0.1.1

Key:http-new-requests

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

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	`httpInterface`	`$.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.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

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

About Xero Accounting#

Accounting Software

More Ways to Connect Xero Accounting + HTTP / Webhook#

Other Popular Integrations#

Send any HTTP Request with HTTP / Webhook API on New or updated contact from Xero Accounting API

Xero Accounting + HTTP / Webhook