List Invoices with Xero Accounting API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

List Invoices 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#

Create a workflow to List Invoices with the Xero Accounting API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the List Invoices action
1. Connect your Xero Accounting account
2. Select a Tenant ID
3. Optional- Configure Modified After
4. Optional- Configure IDs
5. Optional- Configure Invoice Numbers
6. Optional- Configure Contact IDs
7. Optional- Configure Statuses
8. Optional- Configure Where
9. Optional- Configure Created By My App
10. Optional- Configure Order
11. Optional- Configure Page
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

List Invoices with Xero Accounting API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Xero Accounting

Try it

List Invoices with Xero Accounting API on New Item in Feed from RSS API

RSS + Xero Accounting

Try it

List Invoices with Xero Accounting API on New Message from Discord API

Discord + Xero Accounting

Try it

List Invoices with Xero Accounting API on New Message In Channels from Slack API

Slack + Xero Accounting

Try it

List Invoices with Xero Accounting API on New Message in Channel from Discord Bot API

Discord Bot + Xero Accounting

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

List Invoices on Xero Accounting

Description:Lists information from invoices in the given tenant id as per filter parameters.

Version:0.3.0

Key:xero_accounting_api-list-invoices

View on GitHub

Code#

import xeroAccountingApi from "../../xero_accounting_api.app.mjs";

export default {
  key: "xero_accounting_api-list-invoices",
  name: "List Invoices",
  description: "Lists information from invoices in the given tenant id as per filter parameters.",
  version: "0.3.0",
  type: "action",
  props: {
    xeroAccountingApi,
    tenantId: {
      propDefinition: [
        xeroAccountingApi,
        "tenantId",
      ],
    },
    modifiedAfter: {
      label: "Modified After",
      type: "string",
      description: "The ModifiedAfter filter is actually an HTTP header: **'If-Modified-Since'.**\nA UTC timestamp (yyyy-mm-ddThh:mm:ss). Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00",
      optional: true,
    },
    ids: {
      label: "IDs",
      type: "string",
      description: "Filter by a comma-separated list of InvoicesIDs. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).",
      optional: true,
    },
    invoiceNumbers: {
      label: "Invoice Numbers",
      type: "string",
      description: "Filter by a comma-separated list of InvoiceNumbers. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).",
      optional: true,
    },
    contactIds: {
      label: "Contact IDs",
      type: "string",
      description: "Filter by a comma-separated list of ContactIDs. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).",
      optional: true,
    },
    statuses: {
      label: "Statuses",
      type: "string",
      description: "Filter by a comma-separated list of Statuses. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).",
      optional: true,
    },
    where: {
      label: "Where",
      type: "string",
      description: "Filter using the *where* parameter. We recommend you limit filtering to the [optimised elements](https://developer.xero.com/documentation/api/invoices#optimised-parameters) only.",
      optional: true,
    },
    createdByMyApp: {
      label: "Created By My App",
      type: "boolean",
      description: "When set to true you'll only retrieve Invoices created by your app.",
      optional: true,
    },
    order: {
      label: "Order",
      type: "string",
      description: "Order by any element returned ( see [Order By](https://developer.xero.com/documentation/api/requests-and-responses#ordering) ).",
      optional: true,
    },
    page: {
      label: "Page",
      type: "string",
      description: "Up to 100 invoices will be returned per call, with line items shown for each, when the page parameter is used e.g. page=1",
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const response = await this.xeroAccountingApi.listInvoices({
        $,
        tenantId: this.tenantId,
        modifiedSince: this.modifiedAfter,
        params: {
          IDs: this.ids,
          InvoiceNumbers: this.invoiceNumbers,
          ContactIDs: this.contactIds,
          Statuses: this.statuses,
          Where: this.where,
          createdByMyApp: this.createdByMyApp,
          order: this.order,
          page: this.page,
        },
      });

      $.export("$summary", `Successfully fetched ${response.Invoices.length} invoices`);
      return response;
    } catch (e) {
      $.export("$summary", "No invoices found");
      return {};
    }
  },
};

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
Xero Accounting	`xeroAccountingApi`	`app`	This component uses the Xero Accounting app.
Tenant ID	`tenantId`	`string`	Select a value from the drop down menu.
Modified After	`modifiedAfter`	`string`	The ModifiedAfter filter is actually an HTTP header: 'If-Modified-Since'. A UTC timestamp (yyyy-mm-ddThh:mm:ss). Only invoices created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
IDs	`ids`	`string`	Filter by a comma-separated list of InvoicesIDs. See details
Invoice Numbers	`invoiceNumbers`	`string`	Filter by a comma-separated list of InvoiceNumbers. See details
Contact IDs	`contactIds`	`string`	Filter by a comma-separated list of ContactIDs. See details
Statuses	`statuses`	`string`	Filter by a comma-separated list of Statuses. See details
Where	`where`	`string`	Filter using the where parameter. We recommend you limit filtering to the optimised elements only.
Created By My App	`createdByMyApp`	`boolean`	When set to true you'll only retrieve Invoices created by your app.
Order	`order`	`string`	Order by any element returned ( see Order By ).
Page	`page`	`string`	Up to 100 invoices will be returned per call, with line items shown for each, when the page parameter is used e.g. page=1

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