Skip to main content

Get invoices

Required scopes:

  • partner.invoice.read

OData supported operators:

  • logical operators: Or, And, Equal, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual
  • 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 int32

Skip the specified number of entries

$top int32

Possible values: value ≤ 100

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

Responses
200

Success

Schema OPTIONAL
items object[]

The page items.

invoiceId uuid
amount object
amount string

Currency amount in decimal format

currency string

Possible values: [BTC, USD, USDT]

Currency code

state string

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

created date-time
correlationId string OPTIONAL

Invoice correlation id

description string OPTIONAL

Invoice description

issuerId uuid

Id of the invoice issuer

receiverId uuid

Id of the invoice receiver

payerId uuid OPTIONAL

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

count int64

Total number of records.