The date from when results are to be retrieved in the format RFC 3339.

Defaults to 6 months ago.

Examples:

• 2023-01-17T17:29:51Z
• 2023-01-17T17:29:51-08:00

The date up to when results are to be retrieved in the format RFC 3339.

Defaults to today.

Examples:

• 2023-03-17T17:29:51Z
• 2023-03-17T17:29:51-08:00

The account ID to retrieve data for.

Use this parameter to filter the results returned on the currency associated with each result. Multiple values are accepted. If this parameter is not provided then results of any currency will be returned.

The merchants to include, comma separated. Defaults to include all.

The merchants to exclude, comma separated. Defaults to exclude none.

Use this parameter to filter the results on l1 categories to include.
Accepts multiple values, or values separated by comma.

To specify l2 categories to include, use the following format: l1.l2.

Examples:

• shopping - Filters the result set to only include data where the l1 category is shopping.
• shopping.groceries - Filters the result set to only include data where the l1 category is shopping and the l2 category is groceries.

Use this parameter to filter the results on l1 categories to exclude.
Accepts multiple values, or values separated by comma.

To specify l2 categories to exclude, use the following format: l1.l2.

Examples:

• shopping - Filters the result set to exclude data where the l1 category is shopping.
• shopping.groceries - Filters the result set to only exclude data where the l1 category is shopping and the l2 category is groceries.

Specifies in what interval the balance over time should be retrieved.

Currently supported values include (but are not necessarily limited to):

• daily
• weekly
• biweekly
• monthly
• quarterly
• six_monthly
• annually

Defaults to monthly.

Filters the categories included in the totals to just those with the label(s) specified by this parameter.
For the SOT on which categories have which filters see the Retrieve Categories endpoint.

The API Client Identifier (Service Application Identifier).

Use the internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3, in place of an X-Customer-Id header.

The Bud Customer secret used to encrypt customer data. This is required only if the customer secret is not already stored with Bud.