Transactions

List cash transactions

Changed on

Returns the list of cash transactions for an account group.

Cash movements are recorded at account group level, so this endpoint is filtered by account_group_id rather than by account. Restrict the period with the start_date and end_date query parameters, and page through results with offset and limit; meta.total_count gives the total number of matching transactions.

See the transactions reports guide (TOL / BYOL / Omnibus) for the full list of transaction types.

get/transactions/cash

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/transactions/cash
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: transactions:read)

Query parameters

account_group_idstring uuid

Universally Unique Identifier (UUID) of the account group.

Filters the list to show only transactions associated with a certain account group ID.

start_datestring date

Returns transactions starting from and including this date (UTC).

Example:2023-01-03
end_datestring date

Returns transactions up until this date (UTC)

Example:2023-01-11
sort'booking_date'

Sort the result by booking_date.

order'ASC' | 'DESC'

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

offsetinteger

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

limitinteger

Use the limit argument to specify the maximum number of items returned.

Response

Cash Transactions

Changes

  • d148910c1b92Revision changes
    • warning

      added the new PENSION_DE_ALLOWANCE enum value to the //// response property for the response status

    • warning

      added the new PENSION_DE_ALLOWANCE_UPDATE enum value to the //// response property for the response status

  • 052750ba3a1eRevision changes
    • warning

      added the new CHARGED_BY_CLIENT_NET enum value to the //// response property for the response status