Interface DocumentsApiListDocumentsRequest

Request parameters for listDocuments operation in DocumentsApi.

Export

DocumentsApiListDocumentsRequest

Hierarchy

  • DocumentsApiListDocumentsRequest

Properties

limit? offset? status? tilled_account

Properties

Optional Readonly limit

limit?: number

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

Memberof

DocumentsApiListDocuments

Optional Readonly offset

offset?: number

The (zero-based) offset of the first item in the collection to return.

Memberof

DocumentsApiListDocuments

Optional Readonly status

status?: ListDocumentsStatus

Memberof

DocumentsApiListDocuments

Readonly tilled_account

tilled_account: string

The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

Memberof

DocumentsApiListDocuments

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc