View as Markdown
Xero Accounting icon

Xero Accounting ACTION

List Invoices

Lists information from invoices in the given tenant id as per filter parameters.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Xero Accounting account once, then configure and run List Invoices from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "xero_accounting_api-list-invoices",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    xero_accounting_api: { authProvisionId: "apn_xxxxxxx" },
    tenantId: "Tenant ID",
    modifiedAfter: "Modified After",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Invoices inputs
Property Type Description
tenantId Tenant ID string
Select an organization tenant to use, or provide a tenant ID
Required Dynamic
modifiedAfter Modified After 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
Optional
ids IDs string
Filter by a comma-separated list of InvoicesIDs. See details.
Optional
invoiceNumbers Invoice Numbers string
Filter by a comma-separated list of InvoiceNumbers. See details.
Optional
contactIds Contact IDs string[]
Filter by an array of ContactIDs. See details.
Optional Dynamic
statuses Statuses string
Filter by a comma-separated list of Statuses. See details.
Optional
where Where string
Filter using the where parameter. We recommend you limit filtering to the optimised elements only.
Optional
createdByMyApp Created By My App boolean
When set to true you'll only retrieve Invoices created by your app.
Optional
order Order string
Order by any element returned ( see Order By ).
Optional
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
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
xero_accounting_api-list-invoices
Version
0.3.2
App
Xero Accounting
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes