Skip to main content
GET
Retrieve a credit note
Requires the credit_notes: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.) credit_notes:read (List and look up credit notes, and where their credit was applied.)

Path Parameters

id
string
required

The Saasybill id of the credit note.

Example:

"c2d7e1a4-8b36-4d19-a5f0-7e3b9c1d2f66"

Response

Success.

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

Xero's credit note 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
credit_note_date
string<date-time> | null
required

ISO 8601, UTC.

subtotal
string
required

Excluding tax.

total
string
required

Including tax, as Xero returns it.

remaining_credit
string
required

What is left to apply to invoices.

allocation_status
enum<string> | null
required
Available options:
applied,
partial,
unapplied,
error
sent
boolean
required
xero
object
required
created
string<date-time>
required

ISO 8601, UTC.

lines
object[]
allocations
object[]

Where this credit has been applied. A reverted one no longer counts.