Skip to main content
GET
Get an invoice

Authorizations

Authorization
string
header
required

An organization API key (bg_live_…), created in BrandGate under Settings → Developers.

Path Parameters

id
string<uuid>
required

Response

Success.

id
string<uuid>
required
object
any
required
number
string
required
Maximum string length: 100
status
enum<string>
required
Available options:
pending,
paid,
overdue,
credited
invoice_date
string
required
Pattern: ^\d{4}-\d{2}-\d{2}$
due_date
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
paid_date
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
currency
string
required
Maximum string length: 3
total
string
required
Pattern: ^-?\d{1,15}(\.\d{1,6})?$
vat
string
required
Pattern: ^-?\d{1,15}(\.\d{1,6})?$
ocr_reference
string | null
required
Maximum string length: 100
order_id
string<uuid> | null
required
customer_id
string<uuid>
required
lines
object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required