`IInvoicesRequest`

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IInvoicesRequest

Invoice selection criteria within the current account.

interfaces/orionplace/payments/IInvoice.ts

TypeScript

export interface IInvoicesRequest {
  // Invoice selection criteria within the current account.
  filters?: {
    // Exact invoice ID within the accessible invoices.
    id?: number;
    // Invoice category. Wallet results are empty when the storefront disables
    // the wallet.
    invoice_type?: 'wallet' | 'orders' | 'paid_subs' | 'writer_earning';
    // Order ID; includes its payment transactions and related refunds.
    order?: number;
  };
  // Page number and page size.
  paginate?: IApiPaginationRequest;
}