Skip to main content
GET
How much of an invoice is already credited, and what is still open

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Path Parameters

id
string
required

Response

invoiceId
string
required
creditedTotal
number
required

Sum of issued (non-draft) credit notes chained to this invoice

outstanding
number
required

grossTotal - amountPaid: what a further credit note may still cover

creditNoteIds
string[]
required