Returns a sum total of the transactions for a user in a specific transaction group, optionally filtered by transaction type and time period.

Endpoint ID:

5003

Method:

GET

URL:

/entity/id/{entity-id}/transactions/{transaction-group-id}/sum?type={transaction-type-id}&from={from-date}&to={to-date}

/entity/ext-key/{ext-key}/{ext-type}/transactions/{transaction-group-id}/sum?type={transaction-type-id}&from={from-date}&to={to-date}

entity-id

Rubiq entity ID that uniquely identifies the account to sum transactions for

ext-key

External key that uniquely identifies the account to sum transactions for

ext-type

Type of external key

transaction-group-id

Numeric value identifying the transaction group to include in the sum. This ID is documented in the contract between dialogportal™ and the application

transaction-type-id

Optional numeric value identifying the transaction types to include in the sum. This ID is documented in the contract between dialogportal™ and the application

from-date

Optional date value limiting the search to only include transactions after this date in the sum. The date must be in UTC and formatted as "yyyymmddZ", for example "20140321Z" (21 March 2014).

to-date

Optional date value limiting the search to only include transactions before this date in the sum. The date must be in UTC and formatted as "yyyymmddZ", for example "20140321Z" (21 March 2014).

Request body:

None

Response body:

Decimal sum of the selected transaction values.

Status codes:

200

Transaction sum value calculated with success

404

Account, transaction group or transaction type was not found

The following sub codes may be returned:

404.1	User not found
404.2	External user could not be found
404.4	Transaction group not found
404.5	Transaction type not found