Type Alias GetInvoicesBackendOptions

Backend options object type for Client.getInvoices and Client.getInvoicesPaginate methods

type GetInvoicesBackendOptions = {
    asset?: CryptoCurrencyCode;
    count?: number;
    fiat?: FiatCurrencyCode;
    invoice_ids?: string;
    offset?: number;
    status?: GetInvoicesStatus;
}

Index

Properties

asset? count? fiat? invoice_ids? offset? status?

Properties

`Optional`asset

asset?: CryptoCurrencyCode

Invoices crypto currency filter

`Optional`count

count?: number

Number of invoices returned

`Optional`fiat

fiat?: FiatCurrencyCode

Invoices fiat currency filter

`Optional`invoice_ids

invoice_ids?: string

Invoices identifiers filter

`Optional`offset

offset?: number

Number of invoices to skip

`Optional`status

status?: GetInvoicesStatus

Invoices status filter