Skip to main content

Get invoices

Required scopes:

  • partner.invoice.read

OData supported operators:

  • logical operators: Or, And, Equal
  • arithmetic operators: None
  • functions: None

OData filtering syntax can be seen here. Ordering syntax can be seen here.

Query Parameters
$filter string

Filter the results using OData syntax. Supported properties: invoiceId, created, currency, state, issuerId, receiverId, payerId, correlationId

$orderby string

Order the results using OData syntax. Supported properties: created

$skip number

Skip the specified number of entries

$top number

Get the top X number of records. Default value: 50. Max value: 100

Responses
200

Success

Schema
items object[] REQUIRED

The page items.

invoiceId uuid REQUIRED
amount object REQUIRED

Represents an amount denominated in fiat or crypto currencies.

currency string REQUIRED

Possible values: [BTC, USD, EUR, USDT, GBP]

Currency code

amount string REQUIRED

Currency amount in decimal format

state string REQUIRED

Possible values: [UNPAID, PENDING, PAID, CANCELLED]

created date-time REQUIRED
correlationId string

Invoice correlation id

description string

Invoice description

issuerId uuid REQUIRED

Id of the invoice issuer

receiverId uuid REQUIRED

Id of the invoice receiver

payerId uuid

Id of the invoice payer. Present only when invoice was created for the dedicated payer

count int64 REQUIRED

Total number of records.