Create Bill with Xero Accounting API on New Message from AMQP API

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

Trigger workflow on

New Message from the AMQP API

Next, do this

Create Bill 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 AMQP 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 Message trigger
1. Connect your AMQP account
2. Configure Timer
3. Configure Receiver Name
4. Configure Queue Name
Configure the Create Bill action
1. Connect your Xero Accounting account
2. Select a Tenant ID
3. Optional- Configure Invoice number
4. Optional- Configure Reference
5. Configure Contact information
6. Configure Line items
7. Optional- Configure Invoice date
8. Optional- Configure Invoice due date
9. Optional- Configure The invoice currency
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 Message on AMQP

Description:Emit new event for each new message in an [AMQP 1.0](https://www.amqp.org/sites/amqp.org/files/amqp.pdf) queue. [See the library example here](https://github.com/amqp/rhea-promise#receiving-a-message).

Version:0.0.2

Key:amqp-receive-message

View on GitHub

AMQP Overview#

AMQP (Advanced Message Queuing Protocol) is a flexible protocol designed for high-performance messaging. Integrating the AMQP API within Pipedream workflows allows for robust messaging capabilities between various systems and services. You can use it to queue tasks, run asynchronous job processing, and facilitate communication between different parts of your application or different applications altogether. AMQP's reliability and standardization make it a go-to choice for enterprise-level messaging patterns.

Trigger Code#

import amqp from "../../amqp.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "amqp-receive-message",
  name: "New Message",
  description: "Emit new event for each new message in an [AMQP 1.0](https://www.amqp.org/sites/amqp.org/files/amqp.pdf) queue. [See the library example here](https://github.com/amqp/rhea-promise#receiving-a-message).",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  props: {
    amqp,
    timer: {
      type: "$.interface.timer",
      label: "Timer",
      description: "The timer to use to schedule the next poll.",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    receiverName: {
      type: "string",
      label: "Receiver Name",
      description: "The name of the receiver. e.g. (`my-receiver`)",
    },
    queueName: {
      propDefinition: [
        amqp,
        "queueName",
      ],
    },
  },
  async run(event) {
    const { timestamp } = event;
    const {
      host,
      port,
      username,
      password,
    } = this.amqp.$auth;

    const {
      receiverName,
      queueName,
    } = this;

    const connection = await this.amqp.openConnection({
      host,
      port,
      username,
      password,
    });

    console.log("Create receiver");
    const receiver = await this.amqp.createReceiver({
      connection,
      name: receiverName,
      source: {
        address: queueName,
      },
      onSessionError: (context) => {
        throw context.session.error ?? "Unknown Session Error";
      },
    });

    try {
      const messages = await this.amqp.onMessageReceiver(receiver);

      messages.forEach((message, idx) => {
        const id = timestamp + idx;
        this.$emit(message, {
          id,
          ts: id,
          summary: `New Message ${message.message_id}`,
        });
      });

    } catch (error) {
      if (error.innerError) {
        console.log("Inner error", JSON.stringify(error.innerError));
      }
      throw error;

    } finally {
      await this.amqp.close(receiver);
      await this.amqp.close(connection);
    }
  },
};

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
AMQP	`amqp`	`app`	This component uses the AMQP app.
Timer	`timer`	`$.interface.timer`	The timer to use to schedule the next poll.
Receiver Name	`receiverName`	`string`	The name of the receiver. e.g. (`my-receiver`)
Queue Name	`queueName`	`string`	The name of the queue to send the message to.

Trigger Authentication#

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

Setting up AMQP requires their users enter their AMQP settings host, post, username, and password in order to connect. For more info, refer to AMQP’s documentation

About AMQP#

AMQP (Advanced Message Queuing Protocol) Standard is a commonly used messaging protocol used in the open-source application development process.

Action#

Create Bill on Xero Accounting

Description:Creates a new bill (Accounts Payable)[See the docs here](https://developer.xero.com/documentation/api/accounting/invoices)

Version:0.0.2

Key:xero_accounting_api-create-bill

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 {
  removeNullEntries,
  deleteKeys,
  isValidDate,
  formatLineItems,
} from "../../common/util.mjs";
import xeroAccountingApi from "../../xero_accounting_api.app.mjs";

export default {
  key: "xero_accounting_api-create-bill",
  name: "Create Bill",
  description: "Creates a new bill (Accounts Payable)[See the docs here](https://developer.xero.com/documentation/api/accounting/invoices)",
  version: "0.0.2",
  type: "action",
  props: {
    xeroAccountingApi,
    tenantId: {
      propDefinition: [
        xeroAccountingApi,
        "tenantId",
      ],
    },
    invoiceNumber: {
      type: "string",
      optional: true,
      label: "Invoice number",
      description: "Unique alpha numeric code identifying invoice",
    },
    reference: {
      type: "string",
      optional: true,
      label: "Reference",
      description: "ACCREC only - additional reference number",
    },
    contact: {
      type: "object",
      label: "Contact information",
      description: `Provide an object. Enter the column name for the key and the corresponding column value. 
      [See object documentation](https://developer.xero.com/documentation/api/accounting/contacts/#post-contacts). 
        Example:
        \`{
            "ContactID":"Existing contact ID. *Note: If contactID is populated, other key-value pairs would be ignored",
            "Name":"MyCorp Inc",
            "FirstName":"Sir",
            "LastName":"Bush",
            "EmailAddress": "jonny@mailinator.com"
        }\``,
    },
    lineItems: {
      propDefinition: [
        xeroAccountingApi,
        "lineItems",
      ],
    },
    date: {
      type: "string",
      optional: true,
      label: "Invoice date",
      description: "Date invoice was issued - YYYY-MM-DD",
    },
    dueDate: {
      type: "string",
      optional: true,
      label: "Invoice due date",
      description: "Date invoice is due - YYYY-MM-DD",
    },
    currencyCode: {
      type: "string",
      optional: true,
      label: "The invoice currency",
      description:
        "The currency that invoice has been raised in. Refer to [object documentation](https://www.xe.com/iso4217.php)",
    },
  },
  async run({ $ }) {
    const {
      tenantId,
      contact,
      invoiceNumber,
      reference,
      lineItems,
      date,
      dueDate,
      currencyCode,
    } = this;
    const data = removeNullEntries({
      Type: "ACCPAY",
      Contact: contact?.ContactID
        ? deleteKeys(contact, [
          "Name",
          "FirstName",
          "LastName",
          "EmailAddress",
        ])
        : contact,
      LineItems: formatLineItems(lineItems),
      Date: isValidDate(date, "Date") && date,
      DueDate: isValidDate(dueDate, "DueDate") && dueDate,
      CurrencyCode: currencyCode,
      InvoiceNumber: invoiceNumber,
      Reference: reference,
    });
    const response = await this.xeroAccountingApi.createInvoice($, tenantId, data);
    response && $.export("$summary", "Bill successfully created");
    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.
Invoice number	`invoiceNumber`	`string`	Unique alpha numeric code identifying invoice
Reference	`reference`	`string`	ACCREC only - additional reference number
Contact information	`contact`	`object`	Provide an object. Enter the column name for the key and the corresponding column value. See object documentation. Example: `{ "ContactID":"Existing contact ID. *Note: If contactID is populated, other key-value pairs would be ignored", "Name":"MyCorp Inc", "FirstName":"Sir", "LastName":"Bush", "EmailAddress": "jonny@mailinator.com" }`
Line items	`lineItems`	`string[]`	The LineItems collection can contain any number of individual LineItem sub-elements. At least one is required to create a complete Invoice. Refer to Tax Type, Refer to Line Items Example: `[{"Description":"Football", "Quantity":"20", "UnitAmount":"50000", "TaxType":"OUTPUT" }]`
Invoice date	`date`	`string`	Date invoice was issued - YYYY-MM-DD
Invoice due date	`dueDate`	`string`	Date invoice is due - YYYY-MM-DD
The invoice currency	`currencyCode`	`string`	The currency that invoice has been raised in. Refer to object documentation

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