The date from when results are to be retrieved, either as a date (YYYY-MM-DD) or in the format RFC 3339.

When omitted from the request, a default value of 30 days before today's date will be used. If only to is provided, all earlier transactions are included.

Examples:

• 2022-01-28
• 2022-01-28T07:20:50Z

The date up to when results are to be retrieved, either as a date (YYYY-MM-DD) or in the format RFC 3339. A date is treated as the end of that day.

When omitted from the request, a default value of the end of today will be used.

Examples:

• 2022-02-28
• 2022-02-28T07:20:50Z

L1 transaction categories to include in the total.
Accepts multiple values, or values separated by comma (e.g. ?category=shopping&category=entertainment).

Defaults to include all.

L1 transaction categories to exclude from the total.
Accepts multiple values, or values separated by comma (e.g. ?exclude_category=bills&exclude_category=finances).

Defaults to exclude none.

Use this parameter to restrict the results to merchants carrying at least one of the given merchant tags.
Accepts multiple values, or values separated by comma (e.g. ?merchant_tag=energy&merchant_tag=broadband). Matching is case-insensitive.

A merchant is included if it carries a matching tag. Other filters still apply.

Example tag values include insurance, energy, phone, broadband and utilities.

Tag values are not validated: a tag that no merchant carries matches nothing, and an empty result set is returned rather than an error.

If this parameter is not provided, results are not filtered by merchant tag.

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.

Deprecated: use the from query parameter instead.

The date from when results are to be retrieved in the format ISO-8601. If provided, this takes precedence over the from query parameter.

Deprecated: use the to query parameter instead.

The date up to when results are to be retrieved in the format ISO-8601. If provided, this takes precedence over the to query parameter.

Deprecated: use the category query parameter instead.

Comma-separated list of transaction categories to include in the total. If provided alongside the category query parameter, the values are combined.

Deprecated: use the exclude_category query parameter instead.

Comma-separated list of transaction categories to exclude from the total. If provided alongside the exclude_category query parameter, the values are combined.