Interface IInvoiceParams

The IBaseParams interface provides a structure for query parameters commonly used in API requests to manipulate the presentation and organization of returned data.

Hierarchy

Properties

GrandTotal? PaidAtAfter? PaidAtBefore? PaidAtStartsWith? RefIdContains? StatusContains? format? include? jsconfig? orderBy? orderByDesc? skip? take?

Properties

Optional GrandTotal

GrandTotal?: number

Optional PaidAtAfter

PaidAtAfter?: string

Optional PaidAtBefore

PaidAtBefore?: string

Optional PaidAtStartsWith

PaidAtStartsWith?: string

Optional RefIdContains

RefIdContains?: string

Optional StatusContains

StatusContains?: string

Optional format

format?: string

The desired format of the response (e.g., 'json', 'xml').

Optional include

include?: string

A way to include data from related tables/entities.

Optional jsconfig

jsconfig?: string

JavaScript configuration for client-side handling of the response.

Optional orderBy

orderBy?: string

A parameter to specify the field to order the results by in ascending order.

Optional orderByDesc

orderByDesc?: string

A parameter to specify the field to order the results by in descending order.

Optional skip

skip?: number

The number of records to skip before starting to collect the response set.

Optional take

take?: number

The limit on the number of records to return in the response set.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc