Create Item 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 Item 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 Item action
1. Connect your Xero Accounting account
2. Configure tenant_id
3. Configure code
4. Optional- Configure inventory_asset_account_code
5. Optional- Configure name
6. Optional- Configure is_sold
7. Optional- Configure is_purchased
8. Optional- Configure description
9. Optional- Configure purchase_description
10. Optional- Configure purchase_details
11. Optional- Configure sales_details
12. Optional- Select a unitdp
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 Item on Xero Accounting

Description:Creates a new item.

Version:0.1.1

Key:xero_accounting_api-create-item

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_a4ivOG
import { axios } from "@pipedream/platform";

export default {
  key: "xero_accounting_api-create-item",
  name: "Create Item",
  description: "Creates a new item.",
  version: "0.1.1",
  type: "action",
  props: {
    xero_accounting_api: {
      type: "app",
      app: "xero_accounting_api",
    },
    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.",
    },
    code: {
      type: "string",
      description: "User defined item code (max length = 30)",
    },
    inventory_asset_account_code: {
      type: "string",
      description: "The inventory asset [account](https://developer.xero.com/documentation/api/accounts/) for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item",
      optional: true,
    },
    name: {
      type: "string",
      description: "The name of the item (max length = 50)",
      optional: true,
    },
    is_sold: {
      type: "boolean",
      description: "Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled.",
      optional: true,
    },
    is_purchased: {
      type: "boolean",
      description: "Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled.",
      optional: true,
    },
    description: {
      type: "string",
      description: "The sales description of the item (max length = 4000)",
      optional: true,
    },
    purchase_description: {
      type: "string",
      description: "The purchase description of the item (max length = 4000)",
      optional: true,
    },
    purchase_details: {
      type: "string",
      description: "See Purchases & Sales. The [PurchaseDetails](https://developer.xero.com/documentation/api/items#PurchasesSales) element can contain a number of individual sub-elements.",
      optional: true,
    },
    sales_details: {
      type: "string",
      description: "See Purchases & Sales. The [SalesDetails](https://developer.xero.com/documentation/api/items#PurchasesSales) element can contain a number of individual sub-elements.",
      optional: true,
    },
    unitdp: {
      type: "string",
      description: "By default UnitPrice is returned to two decimal places.",
      optional: true,
      options: [
        "2",
        "4",
      ],
    },
  },
  async run({ $ }) {
  //See the API docs: https://developer.xero.com/documentation/api/items#POST

    if (!this.tenant_id || !this.code) {
      throw new Error("Must provide tenant_id, and code parameters.");
    }

    return await axios($, {
      method: "put",
      url: "https://api.xero.com/api.xro/2.0/Items",
      headers: {
        "Authorization": `Bearer ${this.xero_accounting_api.$auth.oauth_access_token}`,
        "Accept": "application/json",
        "xero-tenant-id": this.tenant_id,
      },
      data: {
        Code: this.code,
        InventoryAssetAccountCode: this.inventory_asset_account_code,
        Name: this.name,
        IsSold: this.is_sold,
        IsPurchased: this.is_purchased,
        Description: this.description,
        PurchaseDescription: this.purchase_description,
        PurchaseDetails: this.purchase_details,
        SalesDetails: this.sales_details,
      },
      params: {
        unitdp: this.unitdp,
      },
    });
  },
};

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.
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.
code	`code`	`string`	User defined item code (max length = 30)
inventory_asset_account_code	`inventory_asset_account_code`	`string`	The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item
name	`name`	`string`	The name of the item (max length = 50)
is_sold	`is_sold`	`boolean`	Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled.
is_purchased	`is_purchased`	`boolean`	Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled.
description	`description`	`string`	The sales description of the item (max length = 4000)
purchase_description	`purchase_description`	`string`	The purchase description of the item (max length = 4000)
purchase_details	`purchase_details`	`string`	See Purchases & Sales. The PurchaseDetails element can contain a number of individual sub-elements.
sales_details	`sales_details`	`string`	See Purchases & Sales. The SalesDetails element can contain a number of individual sub-elements.
unitdp	`unitdp`	`string`	Select a value from the drop down menu:`24`

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