Skip to main content
GET
cURL

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:20

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

id
integer
id[]
integer[]
invoiceNumber
integer
invoiceNumber[]
integer[]
status
string
status[]
string[]
type
string
type[]
string[]
series
string
company
string
company[]
string[]
isMembership
boolean
isMembership[]
boolean[]
customerName
string

Search invoices by customer name across user (firstName/lastName), contact (name), or company (name/legalName).

order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc
order[id]
enum<string>
default:asc
Available options:
asc,
desc
order[invoiceNumber]
enum<string>
default:asc
Available options:
asc,
desc
order[invoicedFor]
enum<string>
default:asc
Available options:
asc,
desc
order[amount]
enum<string>
default:asc
Available options:
asc,
desc
order[status]
enum<string>
default:asc
Available options:
asc,
desc
order[type]
enum<string>
default:asc
Available options:
asc,
desc

Response

Invoice collection

id
integer
read-only
invoiceNumber
integer
user
object | null
contact
object | null
company
object | null
amount
number
invoicedFor
string
type
string
body
string | null
status
string | null
internalNotes
string | null
dateCreated
string<date-time>
read-only
dateUpdated
string<date-time> | null
read-only
invoiceDate
string<date-time> | null
dateRefunded
string<date-time> | null
refundedBy
object | null
membershipStartDate
string<date-time> | null
membershipEndDate
string<date-time> | null
isMembership
boolean | null
default:false
membershipProductPrice
string<iri-reference> | null
Example:

"/api/v1/product_prices/1"

series
string | null
invoiceDueDate
string<date-time> | null
quantity
integer | null
default:1
taxValue
integer | null
taxName
string | null
memo
string | null
customFields
(string | null)[] | null
billingName
string | null
billingAddress
string | null
billingRegistrationNumber
string | null
billingVatNumber
string | null
billingEmail
string | null
billingPhone
string | null
billingPhoneCountry
string | null
unitPrice
number | null
read-only
subtotal
number | null
read-only
taxAmount
number | null
read-only
totalWithTax
number | null
read-only