Skip to main content
GET
Retrieve an invoice
Requires the invoices:read scope. See Authentication.

Authorizations

Authorization
string
header
required

An API key. Its scopes decide what it may call: customers:read (List and look up customers.) customers:write (Create customers, and Xero contacts where the organisation allows it.) catalogue:read (List plans and charges.) subscriptions:read (List and look up subscriptions.) subscriptions:write (Create subscriptions, change units, end and restore them.) invoices:read (List and look up invoices.)

Path Parameters

id
string
required

The Saasybill id of the invoice.

Example:

"5f8a3c9d-7e21-4b04-9c6d-0a2b4e8f1d55"

Response

Success.

id
string
required
object
string
required
Allowed value: "invoice"
customer
string
required
subscription
string | null
required
number
string | null
required

Xero's invoice number, once it is in Xero.

reference
string | null
required
status
enum<string>
required
Available options:
draft,
awaiting_approval,
approved,
paid,
voided,
deleted,
scheduled,
not_in_external
currency
string
required
invoice_date
string<date-time>
required

ISO 8601, UTC.

due_date
string<date-time> | null
required

ISO 8601, UTC.

subtotal
string
required

Excluding tax.

total
string
required

Including tax, as Xero returns it.

credit_note_amount
string
required

A decimal string, e.g. "19.9900".

amount_paid
string | null
required

A decimal string, e.g. "19.9900".

sent
boolean
required
xero
object
required
created
string<date-time>
required

ISO 8601, UTC.

lines
object[]