Skip to main content
GET
Get invoice by number (public)

Authorizations

Authorization
string
header
required

API key for /api/v1/* endpoints

Path Parameters

invoice_number
string
required

Invoice number e.g. INV-ABC123

Response

Invoice retrieved successfully.

id
string
required
business_id
string
required
mode
object
required
customer_id
string | null
required
invoice_number
string
required
status
enum<string>
required
Available options:
draft,
sent,
viewed,
paid,
overdue,
cancelled,
void
currency
string
required
line_items
object[]
required
subtotal
number
required
tax_rate
number
required
tax_amount
number
required
discount_amount
number
required
total
number
required
due_date
string<date-time> | null
required
paid_at
string<date-time> | null
required
notes
string | null
required
provider_invoice_reference
string | null
required
cc_invoice_url
string | null
required
metadata
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
business
object
required
customer
object
required