Explore Plans
Xero

Look up an invoice

This query returns the details of the sales invoice whose number you specify.

Developer info

API endpoint slug
xero.look_up_invoice
Runtime method
performQuery("xero.look_up_invoice"}

Query fields

Organisation Dropdown list

Label
Which organisation?
Helper text
The Xero organisation to look in.
Slug
organisation
Required
true
Can have default value
false

Invoice number Text input > Other

Label
Invoice number
Helper text
The invoice number, e.g. INV-0042.
Slug
invoice_number
Required
true
Can have default value
true

Ingredients

Invoice

Slug
invoice_id
Filter
Xero.lookUpInvoice.InvoiceId
Type
String
Example
243216c5-369e-4056-ac67-05388f86dc81

Invoice number

Slug
invoice_number
Filter
Xero.lookUpInvoice.InvoiceNumber
Type
String
Example
INV-0042

Contact name

Slug
contact_name
Filter
Xero.lookUpInvoice.ContactName
Type
String
Example
Acme Ltd

Total

Slug
total
Filter
Xero.lookUpInvoice.Total
Type
String
Example
250.00

Amount due

Slug
amount_due
Filter
Xero.lookUpInvoice.AmountDue
Type
String
Example
250.00

Amount paid

Slug
amount_paid
Filter
Xero.lookUpInvoice.AmountPaid
Type
String
Example
0.00

Currency code

Slug
currency_code
Filter
Xero.lookUpInvoice.CurrencyCode
Type
String
Example
USD

Status

Slug
status
Filter
Xero.lookUpInvoice.Status
Type
String
Example
AUTHORISED

Invoice date

Slug
invoice_date
Filter
Xero.lookUpInvoice.InvoiceDate
Type
Date (ISO8601)
Example
2020-07-07

Due date

Slug
due_date
Filter
Xero.lookUpInvoice.DueDate
Type
Date (ISO8601)
Example
2020-07-07

Line items summary

Slug
line_items_summary
Filter
Xero.lookUpInvoice.LineItemsSummary
Type
String
Example
Consulting x2, Hosting x1

Online invoice url

Slug
online_invoice_url
Filter
Xero.lookUpInvoice.OnlineInvoiceUrl
Type
Web URL
Example
https://in.xero.com/abc123