Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InvoicesListOptionalParams

Package version

interface

An interface representing InvoicesListOptionalParams. Optional Parameters.

extends

RequestOptionsBase

Hierarchy

  • any
    • InvoicesListOptionalParams

Index

Properties

Properties

Optional expand

expand: undefined | string
member

{string} [expand] May be used to expand the downloadUrl property within a list of invoices. This enables download links to be generated for multiple invoices at once. By default, downloadURLs are not included when listing invoices.

Optional filter

filter: undefined | string
member

{string} [filter] May be used to filter invoices by invoicePeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.

Optional skiptoken

skiptoken: undefined | string
member

{string} [skiptoken] Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.

Optional top

top: undefined | number
member

{number} [top] May be used to limit the number of results to the most recent N invoices.

Generated using TypeDoc