Interface BalanceTransactionsApiGetBalanceTransactionsSummaryRequest

Request parameters for getBalanceTransactionsSummary operation in BalanceTransactionsApi.

Export

BalanceTransactionsApiGetBalanceTransactionsSummaryRequest

Hierarchy

BalanceTransactionsApiGetBalanceTransactionsSummaryRequest

Index

Properties

created_at_gte? created_at_lte? include_connected_accounts? tilled_account time_unit? time_zone? types?

Properties

`Optional` `Readonly` created_at_gte

created_at_gte?: string

Minimum `created_at` value to filter by (inclusive). Defaults to the beginning of the current month.

Memberof

BalanceTransactionsApiGetBalanceTransactionsSummary

`Optional` `Readonly` created_at_lte

created_at_lte?: string

Maximum `created_at` value to filter by (inclusive). Defaults to midnight tonight.

Memberof

BalanceTransactionsApiGetBalanceTransactionsSummary

`Optional` `Readonly` include_connected_accounts

include_connected_accounts?: boolean

Whether or not to include the results from any connected accounts.

Memberof

BalanceTransactionsApiGetBalanceTransactionsSummary

`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

BalanceTransactionsApiGetBalanceTransactionsSummary

`Optional` `Readonly` time_unit

time_unit?: GetBalanceTransactionsSummaryTimeUnit

String indicating the unit of time to aggregate the summary of data.

Memberof

BalanceTransactionsApiGetBalanceTransactionsSummary

`Optional` `Readonly` time_zone

time_zone?: GetBalanceTransactionsSummaryTimeZone

Time Zone by which to aggregate the results.

Memberof

BalanceTransactionsApiGetBalanceTransactionsSummary

`Optional` `Readonly` types

types?: GetBalanceTransactionsSummaryTypes[]

An array containing specific balance transaction types. The data will be filtered to include only transactions with a matching type property.

Memberof

BalanceTransactionsApiGetBalanceTransactionsSummary

Generated using TypeDoc