Create Bill with Xero Accounting API on Return Status Updated (Instant) from Loop Returns API

Pipedream makes it easy to connect APIs for Xero Accounting, Loop Returns and 3,000+ other apps remarkably fast.

Trigger workflow on

Return Status Updated (Instant) from the Loop Returns 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 Loop Returns 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 Return Status Updated (Instant) trigger
1. Connect your Loop Returns account
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. Select a Contact ID
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#

Return Status Updated (Instant) on Loop Returns

Description:Emit new event when the status of a return has been updated. [See the documentation](https://docs.loopreturns.com/reference/return-webhook)

Version:0.0.1

Key:loop_returns-return-status-updated-instant

View on GitHub

Loop Returns Overview#

The Loop Returns API enables merchants to automate and streamline their returns and exchanges process. It offers endpoints that allow you to initiate returns, update return states, and manage return-related data, all programmable to fit into your existing e-commerce and customer service workflows. With Pipedream, you can trigger workflows based on events in Loop, or use actions to call the Loop API directly, automating tasks like syncing return data with customer service platforms, updating inventory management systems, or even issuing refunds.

Trigger Code#

import common from "../common/webhook.mjs";
import events from "../common/events.mjs";

export default {
  ...common,
  key: "loop_returns-return-status-updated-instant",
  name: "Return Status Updated (Instant)",
  description: "Emit new event when the status of a return has been updated. [See the documentation](https://docs.loopreturns.com/reference/return-webhook)",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    setReturnState(resource) {
      this.db.set(resource.id, resource.state);
    },
    getReturnState(returnId) {
      return this.db.get(returnId);
    },
    isResourceRelevant(resource) {
      const previousState = this.getReturnState(resource.id);

      if (!previousState) {
        return true;
      }

      return resource.state !== previousState;
    },
    processResource(resource) {
      if (this.isResourceRelevant(resource)) {
        this.setReturnState(resource);
        return this.$emit(resource, this.generateMeta(resource));
      }
      console.log("Skipping irrelevant resource", resource);
    },
    getResourcesFn() {
      return this.app.listReturns;
    },
    getEventData() {
      return {
        url: this.http.endpoint,
        topic: events.TOPIC.RETURN,
        trigger: events.TRIGGER.RETURN_UPDATED,
      };
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.updated_at);
      return {
        id: `${resource.id}-${ts}`,
        summary: `Return Status Updated: ${resource.order_name}`,
        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
Loop Returns	`app`	`app`	This component uses the Loop Returns app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.

Trigger Authentication#

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

About Loop Returns#

The best return experience, for your customers and for your team.

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.5

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 {
  formatLineItems,
  isValidDate,
  removeNullEntries,
} 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.5",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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",
    },
    contactId: {
      propDefinition: [
        xeroAccountingApi,
        "contactId",
        (c) => ({
          tenantId: c.tenantId,
        }),
      ],
    },
    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 response = await this.xeroAccountingApi.createInvoice({
      $,
      tenantId: this.tenantId,
      data: removeNullEntries({
        Type: "ACCPAY",
        Contact: {
          ContactID: this.contactId,
        },
        LineItems: formatLineItems(this.lineItems),
        Date: isValidDate(this.date, "Date") && this.date,
        DueDate: isValidDate(this.dueDate, "DueDate") && this.dueDate,
        CurrencyCode: this.currencyCode,
        InvoiceNumber: this.invoiceNumber,
        Reference: this.reference,
      }),
    });
    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 ID	`contactId`	`string`	Select a value from the drop down menu.
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

About Xero Accounting#

Accounting Software

More Ways to Connect Xero Accounting + Loop Returns#

Other Popular Integrations#

Cancel Return with Loop Returns API on New or updated contact from Xero Accounting API

Xero Accounting + Loop Returns

Create Bill with Xero Accounting API on Return Status Updated (Instant) from Loop Returns API

Pipedream makes it easy to connect APIs for Xero Accounting, Loop Returns and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

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