Skip to content

Get a single invoice by id

GET
/invoices/{id}
id
required
string

DocumentId

OK

object
data
object
invoice_number
required
string
users_permissions_user
One of:

DocumentId reference to plugin::users-permissions.user

string
total_amount
required
number
currency
required
string
Allowed values: EUR USD CZK PLN HUF RON BGN SEK DKK NOK
state
required
string
Allowed values: draft pending paid cancelled refunded
invoice_items
required

Arbitrary JSON value (object, array, string, number, boolean, or null)

issue_date
required
string format: date-time
due_date
string format: date-time
paid_date
string format: date-time
payment_method
string
Allowed values: free stripe bank_transfer
notes
string
tax_amount
number
subtotal
required
number
pdf_url
string
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

Missing or invalid authentication

Not authorized (tenant scope or capability)

Not found