Skip to main content
GET
Get an invoice

What this endpoint does

Returns line items and status for one invoice.

When to use it

Use it for invoice detail, accounting export, or support investigation.

Before you call

Authenticate with invoice read access and pass an invoice ID owned by the same tenant account.

Money and balance effect

This is a read-only request. It does not reserve, debit, credit, or settle money.

States and completion

Use the invoice status and amounts as returned; a listed invoice is not necessarily settled.

Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an Idempotency-Key. Read Revenue and invoices for the complete workflow.

Authorizations

Authorization
string
header
required

Send the same Wayex API key as Authorization: Bearer <key>.

Path Parameters

id
string
required

Response

The invoice.

id
string
required
Minimum string length: 1
number
string
required
Pattern: ^INV-\d{6}-\d{4}$
counterpartyId
string
required
Minimum string length: 1
periodFrom
string<date-time>
required
periodTo
string<date-time>
required
status
enum<string>
required
Available options:
draft,
issued,
settled,
void
currency
enum<string>
required
Available options:
AUD
lines
object[]
required
platformFeesDue
string
required
Pattern: ^-?\d+(\.\d+)?$
platformFeesDueMinor
string
required
Pattern: ^-?\d+$
developerFeesCredit
string
required
Pattern: ^-?\d+(\.\d+)?$
developerFeesCreditMinor
string
required
Pattern: ^-?\d+$
tax
string
required
Pattern: ^\d+(\.\d+)?$
taxMinor
string
required
Pattern: ^\d+$
netDue
string
required
Pattern: ^-?\d+(\.\d+)?$
netDueMinor
string
required
Pattern: ^-?\d+$
inflowCollected
object[]
required
generatedAt
string<date-time>
required
generatedBy
string
required
Minimum string length: 1
issuedAt
string<date-time>
issuedBy
string
Minimum string length: 1
settledAt
string<date-time>
settledBy
string
Minimum string length: 1
voidedAt
string<date-time>
voidedBy
string
Minimum string length: 1