Operations

Get Client Deposits

GET
/operations/client-deposits

Authorization

appToken read
AuthorizationBearer <token>

App access token issued by POST /tokens (client credentials). Full-access Apps hold the read and write scopes, read-only Apps hold read only. Send it as Authorization: Bearer <token>.

In: header

Scope: read

Query Parameters

limit?integer
Default20
offset?integer
Default0
filter[clientExternalId]?integer
filter[clientName]?string

Partial, case-insensitive match on the name of the client's current live profile (resolved by clientExternalId).

filter[clientEmail]?string

Partial, case-insensitive match on the email of the client's current live profile (resolved by clientExternalId).

filter[profileId]?string

All deposits of the client whose live profile this is, including those recorded before the profile existed.

filter[userId]?string

Comma-separated IB user ids. Returns all deposits of the clients currently in these IBs' trees, including those made before a client joined; figures follow the client.

filter[operationId]?integer
filter[currencyCode]?string
filter[startTime]?string

Records at or after this moment. The offset is taken into account; a value without an offset is treated as UTC

Formatdate-time
filter[endTime]?string

Records at or before this moment. The offset is taken into account; a value without an offset is treated as UTC

Formatdate-time
filter[userTags]?string

Tags of the client's current live profile.

sort_by?string

Value in

  • "createTime"
  • "amount"
sort_order?string

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/operations/client-deposits"
{  "total": 0,  "deposits": [    {      "depositId": "33504022-daeb-4ddf-96f2-fc15aa4e6a52",      "clientExternalId": 0,      "profileId": "string",      "clientName": "string",      "clientEmail": "string",      "operationId": 0,      "amount": "string",      "amountInUsd": "string",      "currencyCode": "string",      "createTime": "2019-08-24T14:15:22Z"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}