Create Payment with Xero Accounting API on New Query Results from Snowflake API

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

Trigger workflow on

New Query Results from the Snowflake API

Next, do this

Create Payment 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 Snowflake 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 Query Results trigger
1. Connect your Snowflake account
2. Configure timer
3. Configure SQL Query
4. Optional- Configure Primary key
5. Optional- Configure Emit individual events
Configure the Create Payment action
1. Connect your Xero Accounting account
2. Select a Tenant ID
3. Optional- Configure Account ID
4. Optional- Configure Account Code
5. Optional- Configure Invoice ID
6. Optional- Configure Credit Note ID
7. Optional- Configure Prepayment ID
8. Optional- Configure Overpayment ID
9. Optional- Configure Invoice Number
10. Optional- Configure Credit Note Number
11. Optional- Configure Date
12. Optional- Configure Currency Rate
13. Optional- Configure Amount
14. Optional- Configure Reference
15. Optional- Configure Is Reconciled
16. Optional- Configure Status
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 Query Results on Snowflake

Description:Run a SQL query on a schedule, triggering a workflow for each row of results

Version:0.2.3

Key:snowflake-query-results

View on GitHub

Snowflake Overview#

Snowflake offers a cloud database and related tools to help developers create robust, secure, and scalable data warehouses. See Snowflake's Key Concepts & Architecture

Getting Started

1. Create a user, role and warehouse in Snowflake

Snowflake recommends you create a new user, role, and warehouse when you integrate a third-party tool like Pipedream. This way, you can control permissions via the user / role, and separate Pipedream compute and costs with the warehouse. You can do this directly in the Snowflake UI

We recommend you create a read-only account if you only need to query Snowflake. If you need to insert data into Snowflake, add permissions on the appropriate objects after you create your user.

2. Enter those details in Pipedream

Visit https://pipedream.com/accounts. Click the button to Connect an App. Enter the required Snowflake account data.

You'll only need to connect your account once in Pipedream. You can connect this account to multiple workflows to run queries against Snowflake, insert data, and more.

3. Build your first workflow

Visit https://pipedream.com/new to build your first workflow. Pipedream workflows let you connect Snowflake with 1,000+ other apps. You can trigger workflows on Snowflake queries, sending results to Slack, Google Sheets, or any app that exposes an API. Or you can accept data from another app, transform it with Python, Node.js, Go or Bash code, and insert it into Snowflake.

Learn more at Pipedream University

Trigger Code#

import common from "../common.mjs";
import { v4 as uuidv4 } from "uuid";

export default {
  ...common,
  type: "source",
  key: "snowflake-query-results",
  name: "New Query Results",
  // eslint-disable-next-line
  description: "Run a SQL query on a schedule, triggering a workflow for each row of results",
  version: "0.2.3",
  props: {
    ...common.props,
    sqlQuery: {
      type: "string",
      label: "SQL Query",
      description: "Run this query on a schedule, triggering the workflow for each row of results",
    },
    // Ordering props correctly
    timer: common.props.timer,
    dedupeKey: {
      type: "string",
      label: "Primary key",
      description: "The column in your query to use for de-duplication. Duplicate rows won't trigger your workflow",
      optional: true,
    },
    emitIndividualEvents: {
      propDefinition: [
        common.props.snowflake,
        "emitIndividualEvents",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateMeta(data) {
      const {
        row: { [this.dedupeKey]: id = uuidv4() },
        timestamp: ts,
      } = data;
      const summary = `New event (ID: ${id})`;
      return {
        id,
        summary,
        ts,
      };
    },
    generateMetaForCollection(data) {
      const { timestamp: ts } = data;
      const id = uuidv4();
      const summary = `New event (ID: ${id})`;
      return {
        id,
        summary,
        ts,
      };
    },
    getStatement() {
      return {
        sqlText: this.sqlQuery,
      };
    },
  },
};

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
Snowflake	`snowflake`	`app`	This component uses the Snowflake app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	Watch for changes on this schedule
SQL Query	`sqlQuery`	`string`	Run this query on a schedule, triggering the workflow for each row of results
Primary key	`dedupeKey`	`string`	The column in your query to use for de-duplication. Duplicate rows won't trigger your workflow
Emit individual events	`emitIndividualEvents`	`boolean`	Defaults to `true`, triggering workflows on each record in the result set. Set to `false` to emit records in batch (advanced)

Trigger Authentication#

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

We recommend you create a read-only account if you only need to query Snowflake. If you need to insert data into Snowflake, add permissions on the appropriate objects after you create your user.

About Snowflake#

A data warehouse built for the cloud

Action#

Create Payment on Xero Accounting

Description:Creates a new payment

Version:0.1.3

Key:xero_accounting_api-create-payment

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#

import { ConfigurationError } from "@pipedream/platform";
import xeroAccountingApi from "../../xero_accounting_api.app.mjs";

export default {
  key: "xero_accounting_api-create-payment",
  name: "Create Payment",
  description: "Creates a new payment",
  version: "0.1.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    xeroAccountingApi,
    tenantId: {
      propDefinition: [
        xeroAccountingApi,
        "tenantId",
      ],
    },
    accountId: {
      label: "Account ID",
      type: "string",
      description: "ID of account you are using to make the payment e.g. 294b1dc5-cc47-2afc-7ec8-64990b8761b8. This account needs to be either an account of type BANK or have enable payments to this accounts switched on (see [GET Accounts](https://developer.xero.com/documentation/api/Accounts)) . See the edit account screen of your Chart of Accounts in Xero if you wish to enable payments for an account other than a bank account",
      optional: true,
    },
    accountCode: {
      label: "Account Code",
      type: "string",
      description: "Code of account you are using to make the payment e.g. 001 ( note: *not all accounts have a code value*)",
      optional: true,
    },
    invoiceId: {
      label: "Invoice ID",
      type: "string",
      description: "ID of the invoice you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9",
      optional: true,
    },
    creditNoteId: {
      label: "Credit Note ID",
      type: "string",
      description: "ID of the credit note you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9",
      optional: true,
    },
    prepaymentId: {
      label: "Prepayment ID",
      type: "string",
      description: "ID of the prepayment you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9",
      optional: true,
    },
    overpaymentId: {
      label: "Overpayment ID",
      type: "string",
      description: "ID of the overpayment you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9",
      optional: true,
    },
    invoiceNumber: {
      label: "Invoice Number",
      type: "string",
      description: "Number of invoice you are applying payment to e.g. INV-4003",
      optional: true,
    },
    creditNoteNumber: {
      label: "Credit Note Number",
      type: "string",
      description: "Number of credit note you are applying payment to e.g. INV-4003",
      optional: true,
    },
    date: {
      label: "Date",
      type: "string",
      description: "Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06",
      optional: true,
    },
    currencyRate: {
      label: "Currency Rate",
      type: "string",
      description: "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500",
      optional: true,
    },
    amount: {
      label: "Amount",
      type: "string",
      description: "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00",
      optional: true,
    },
    reference: {
      label: "Reference",
      type: "string",
      description: "An optional description for the payment e.g. Direct Debit",
      optional: true,
    },
    isReconciled: {
      label: "Is Reconciled",
      type: "boolean",
      description: "A boolean indicating whether the payment has been reconciled.",
      optional: true,
    },
    status: {
      label: "Status",
      type: "string",
      description: "The [status](https://developer.xero.com/documentation/api/types#PaymentStatusCodes) of the payment.",
      optional: true,
    },
  },
  async run({ $ }) {
    if ((!this.accountId && !this.accountCode) ||
    (!this.invoiceId &&
    !this.creditNoteId &&
    !this.prepaymentId &&
    !this.overpaymentId &&
    !this.invoiceNumber &&
    !this.creditNoteNumber) ||
    !this.tenantId) {
      throw new ConfigurationError("Must provide **Account ID** or **Account Code**, and", "\n", "**Invoice ID** or **Credit Note ID** or **Prepayment ID** or **Overpayment ID** or **Invoice Number** or **Credit Note Number**,\nand **Tenant ID** parameters.");
    }

    const data = {
      Date: this.date,
      CurrencyRate: this.currencyRate,
      Amount: this.amount,
      Reference: this.reference,
      IsReconciled: this.isReconciled,
      Status: this.status,
    };

    if (this.accountId) {
      data["Account"] = {
        AccountID: this.accountId,
      };
    } else {
      data["Account"] = {
        Code: this.account_code,
      };
    }

    if (this.invoiceId) {
      data["Invoice"] = {
        InvoiceID: this.invoiceId,
      };
    } else if (this.creditNoteId) {
      data["CreditNote"] = {
        CreditNoteID: this.creditNoteId,
      };
    } else if (this.prepaymentId) {
      data["Prepayment"] = {
        PrepaymentID: this.prepaymentId,
      };
    } else if (this.overpaymentId) {
      data["Overpayment"] = {
        OverpaymentID: this.overpaymentId,
      };
    } else if (this.invoiceNumber) {
      data["Invoice"] = {
        InvoiceNumber: this.invoiceNumber,
      };
    } else if (this.creditNoteNumber) {
      data["CreditNote"] = {
        CreditNoteNumber: this.creditNoteNumber,
      };
    }

    const response = await this.xeroAccountingApi.createPayment({
      $,
      tenantId: this.tenantId,
      data,
    });

    $.export("$summary", `Successfully created payment with reference: ${this.reference}`);
    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
Xero Accounting	`xeroAccountingApi`	`app`	This component uses the Xero Accounting app.
Tenant ID	`tenantId`	`string`	Select a value from the drop down menu.
Account ID	`accountId`	`string`	ID of account you are using to make the payment e.g. 294b1dc5-cc47-2afc-7ec8-64990b8761b8. This account needs to be either an account of type BANK or have enable payments to this accounts switched on (see GET Accounts) . See the edit account screen of your Chart of Accounts in Xero if you wish to enable payments for an account other than a bank account
Account Code	`accountCode`	`string`	Code of account you are using to make the payment e.g. 001 ( note: not all accounts have a code value)
Invoice ID	`invoiceId`	`string`	ID of the invoice you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
Credit Note ID	`creditNoteId`	`string`	ID of the credit note you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
Prepayment ID	`prepaymentId`	`string`	ID of the prepayment you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
Overpayment ID	`overpaymentId`	`string`	ID of the overpayment you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
Invoice Number	`invoiceNumber`	`string`	Number of invoice you are applying payment to e.g. INV-4003
Credit Note Number	`creditNoteNumber`	`string`	Number of credit note you are applying payment to e.g. INV-4003
Date	`date`	`string`	Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
Currency Rate	`currencyRate`	`string`	Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500
Amount	`amount`	`string`	The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00
Reference	`reference`	`string`	An optional description for the payment e.g. Direct Debit
Is Reconciled	`isReconciled`	`boolean`	A boolean indicating whether the payment has been reconciled.
Status	`status`	`string`	The status of the payment.

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.transactions.readaccounting.reports.readaccounting.settingsaccounting.settings.readaccounting.contactsaccounting.attachmentsaccounting.journals.read