Previous Next JavaScript must be enabled to correctly display this content

## Retrieves the data for RM dashboard

get

/rmdashboard

This endpoint is used to get the data for RM dashboard.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
  fetch record according to customerId
- limit(optional): integer
  limit is maximum no of records to be fetched
- offset(optional): integer
  offset is starting no of records to be fetched
- structureId(optional): string
  Pattern: `[A-Z0-9]{1,30}`
  fetch record according to structureId

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Successful performs the operation
Body ()
Root Schema : RmDashboardCollection
Type: `object`
Show Source

- accountmap(optional): array accountmap
- currencybalance(optional): array currencybalance
- effectivebalance(optional): array effectivebalance
- interestdetails(optional): array interestdetails
- investmentdetails(optional): array investmentdetails
- scheduledsweeps(optional): array scheduledsweeps

    {
        "type":"object",
        "properties":{
            "accountmap":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmdRdAccountMapDTO"
                }
            },
            "currencybalance":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmdTbCurrencyBalanceDTO"
                }
            },
            "scheduledsweeps":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmdTbScheduledSweepsDTO"
                }
            },
            "effectivebalance":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmdTbEffectiveBalanceDTO"
                }
            },
            "interestdetails":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/InterestDetailsDTO"
                }
            },
            "investmentdetails":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmdRdInvestmentDetailsDTO"
                }
            }
        }
    }

Nested Schema : accountmap
Type: `array`
Show Source

- Array of: object LmdRdAccountMapDTO
  AccountMap DTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmdRdAccountMapDTO"
        }
    }

Nested Schema : currencybalance
Type: `array`
Show Source

- Array of: object LmdTbCurrencyBalanceDTO
  CurrencyBalance DTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmdTbCurrencyBalanceDTO"
        }
    }

Nested Schema : effectivebalance
Type: `array`
Show Source

- Array of: object LmdTbEffectiveBalanceDTO
  EffectiveBalance DTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmdTbEffectiveBalanceDTO"
        }
    }

Nested Schema : interestdetails
Type: `array`
Show Source

- Array of: object InterestDetailsDTO
  InterestDetails DTO for view

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/InterestDetailsDTO"
        }
    }

Nested Schema : investmentdetails
Type: `array`
Show Source

- Array of: object LmdRdInvestmentDetailsDTO
  InvestmentDetails DTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmdRdInvestmentDetailsDTO"
        }
    }

Nested Schema : scheduledsweeps
Type: `array`
Show Source

- Array of: object LmdTbScheduledSweepsDTO
  ScheduledSweeps DTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmdTbScheduledSweepsDTO"
        }
    }

Nested Schema : LmdRdAccountMapDTO
Type: `object`
AccountMap DTO
Match All
Show Source

- allOf GenericDto
- object LmdRdAccountMapDTO-allOf[1]

    {
        "description":"AccountMap DTO",
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "customerId":{
                        "description":"Customer Id for Account Map",
                        "type":"string",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "availableBalance":{
                        "description":"Available Balance in Account Map",
                        "type":"number"
                    },
                    "currencyCode":{
                        "description":"Currency code in Account Map",
                        "type":"string"
                    },
                    "latitude":{
                        "description":"latitude  in the Account Map",
                        "type":"number"
                    },
                    "longitude":{
                        "description":"longitude  in the Account Map",
                        "type":"number"
                    },
                    "cityName":{
                        "description":"City Name in Account Map",
                        "type":"string"
                    },
                    "countryName":{
                        "description":"Country Name in Account Map",
                        "type":"string"
                    }
                }
            }
        ]
    }

Nested Schema : GenericDto
Match All
Show Source

- object GenericDto-allOf[0]
  Discriminator: `resource_type`

    {
        "allOf":[
            {
                "type":"object",
                "discriminator":"resource_type"
            }
        ]
    }

Nested Schema : GenericDto-allOf[0]
Type: `object`
Discriminator: `resource_type`
Nested Schema : LmdRdAccountMapDTO-allOf[1]
Type: `object`
Show Source

- availableBalance(optional): number
  Available Balance in Account Map
- cityName(optional): string
  City Name in Account Map
- countryName(optional): string
  Country Name in Account Map
- currencyCode(optional): string
  Currency code in Account Map
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
  Customer Id for Account Map
- latitude(optional): number
  latitude in the Account Map
- longitude(optional): number
  longitude in the Account Map

    {
        "type":"object",
        "properties":{
            "customerId":{
                "description":"Customer Id for Account Map",
                "type":"string",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "availableBalance":{
                "description":"Available Balance in Account Map",
                "type":"number"
            },
            "currencyCode":{
                "description":"Currency code in Account Map",
                "type":"string"
            },
            "latitude":{
                "description":"latitude  in the Account Map",
                "type":"number"
            },
            "longitude":{
                "description":"longitude  in the Account Map",
                "type":"number"
            },
            "cityName":{
                "description":"City Name in Account Map",
                "type":"string"
            },
            "countryName":{
                "description":"Country Name in Account Map",
                "type":"string"
            }
        }
    }

Nested Schema : LmdTbCurrencyBalanceDTO
Type: `object`
CurrencyBalance DTO
Match All
Show Source

- allOf GenericDto
- object LmdTbCurrencyBalanceDTO-allOf[1]

    {
        "description":"CurrencyBalance DTO",
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "structureId":{
                        "description":"structure id in Currency Balance",
                        "type":"string",
                        "pattern":"[A-Z0-9]{1,30}"
                    },
                    "valueDate":{
                        "description":"value date in Currency Balance",
                        "type":"string",
                        "format":"date"
                    },
                    "accountNumber":{
                        "description":"account number in Currency Balance",
                        "type":"string"
                    },
                    "branchCode":{
                        "description":"branch Code in Currency Balance",
                        "type":"string"
                    },
                    "availableBalance":{
                        "description":"Available Balance in Currency Balance",
                        "type":"integer"
                    },
                    "currencyCode":{
                        "description":"Currency code in Customer Balance",
                        "type":"string"
                    },
                    "customerId":{
                        "description":"Customer Id for Currency Balance",
                        "type":"string",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "userId":{
                        "description":"User Id  of the Currency Balance",
                        "type":"string"
                    }
                },
                "required":[
                    "id"
                ]
            }
        ]
    }

Nested Schema : LmdTbCurrencyBalanceDTO-allOf[1]
Type: `object`
Show Source

- accountNumber(optional): string
  account number in Currency Balance
- availableBalance(optional): integer
  Available Balance in Currency Balance
- branchCode(optional): string
  branch Code in Currency Balance
- currencyCode(optional): string
  Currency code in Customer Balance
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
  Customer Id for Currency Balance
- structureId(optional): string
  Pattern: `[A-Z0-9]{1,30}`
  structure id in Currency Balance
- userId(optional): string
  User Id of the Currency Balance
- valueDate(optional): string(date)
  value date in Currency Balance

    {
        "type":"object",
        "properties":{
            "structureId":{
                "description":"structure id in Currency Balance",
                "type":"string",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "valueDate":{
                "description":"value date in Currency Balance",
                "type":"string",
                "format":"date"
            },
            "accountNumber":{
                "description":"account number in Currency Balance",
                "type":"string"
            },
            "branchCode":{
                "description":"branch Code in Currency Balance",
                "type":"string"
            },
            "availableBalance":{
                "description":"Available Balance in Currency Balance",
                "type":"integer"
            },
            "currencyCode":{
                "description":"Currency code in Customer Balance",
                "type":"string"
            },
            "customerId":{
                "description":"Customer Id for Currency Balance",
                "type":"string",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "userId":{
                "description":"User Id  of the Currency Balance",
                "type":"string"
            }
        },
        "required":[
            "id"
        ]
    }

Nested Schema : LmdTbEffectiveBalanceDTO
Type: `object`
EffectiveBalance DTO
Match All
Show Source

- allOf GenericDto
- object LmdTbEffectiveBalanceDTO-allOf[1]

    {
        "description":"EffectiveBalance DTO",
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "structureId":{
                        "description":"structure id in Effective Balance",
                        "type":"string",
                        "pattern":"[A-Z0-9]{1,30}"
                    },
                    "valueDate":{
                        "description":"value date in Effective Balance",
                        "type":"string",
                        "format":"date"
                    },
                    "accountNumber":{
                        "description":"account number in Effective Balance",
                        "type":"string"
                    },
                    "branchCode":{
                        "description":"branch Code in Effective Balance",
                        "type":"string"
                    },
                    "availableBalance":{
                        "description":"Available Balance in Effective Balance",
                        "type":"integer"
                    },
                    "currencyCode":{
                        "description":"Currency code in Effective Balance",
                        "type":"string"
                    },
                    "customerId":{
                        "description":"Customer Id for Effective Balance",
                        "type":"string",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "userId":{
                        "description":"User Id  of the Effective Balance",
                        "type":"string"
                    }
                },
                "required":[
                    "id"
                ]
            }
        ]
    }

Nested Schema : LmdTbEffectiveBalanceDTO-allOf[1]
Type: `object`
Show Source

- accountNumber(optional): string
  account number in Effective Balance
- availableBalance(optional): integer
  Available Balance in Effective Balance
- branchCode(optional): string
  branch Code in Effective Balance
- currencyCode(optional): string
  Currency code in Effective Balance
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
  Customer Id for Effective Balance
- structureId(optional): string
  Pattern: `[A-Z0-9]{1,30}`
  structure id in Effective Balance
- userId(optional): string
  User Id of the Effective Balance
- valueDate(optional): string(date)
  value date in Effective Balance

    {
        "type":"object",
        "properties":{
            "structureId":{
                "description":"structure id in Effective Balance",
                "type":"string",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "valueDate":{
                "description":"value date in Effective Balance",
                "type":"string",
                "format":"date"
            },
            "accountNumber":{
                "description":"account number in Effective Balance",
                "type":"string"
            },
            "branchCode":{
                "description":"branch Code in Effective Balance",
                "type":"string"
            },
            "availableBalance":{
                "description":"Available Balance in Effective Balance",
                "type":"integer"
            },
            "currencyCode":{
                "description":"Currency code in Effective Balance",
                "type":"string"
            },
            "customerId":{
                "description":"Customer Id for Effective Balance",
                "type":"string",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "userId":{
                "description":"User Id  of the Effective Balance",
                "type":"string"
            }
        },
        "required":[
            "id"
        ]
    }

Nested Schema : InterestDetailsDTO
Type: `object`
InterestDetails DTO for view
Match All
Show Source

- allOf GenericDto
- object InterestDetailsDTO-allOf[1]

    {
        "description":"InterestDetails DTO for view",
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "interestEarned":{
                        "description":"interest earned",
                        "type":"integer"
                    },
                    "interestPaid":{
                        "description":"interest paid",
                        "type":"integer"
                    },
                    "customerId":{
                        "description":"customer Id",
                        "type":"string",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "month":{
                        "description":"month",
                        "type":"string"
                    },
                    "structureId":{
                        "description":"structureId",
                        "type":"string",
                        "pattern":"[A-Z0-9]{1,30}"
                    }
                }
            }
        ]
    }

Nested Schema : InterestDetailsDTO-allOf[1]
Type: `object`
Show Source

- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
  customer Id
- interestEarned(optional): integer
  interest earned
- interestPaid(optional): integer
  interest paid
- month(optional): string
  month
- structureId(optional): string
  Pattern: `[A-Z0-9]{1,30}`
  structureId

    {
        "type":"object",
        "properties":{
            "interestEarned":{
                "description":"interest earned",
                "type":"integer"
            },
            "interestPaid":{
                "description":"interest paid",
                "type":"integer"
            },
            "customerId":{
                "description":"customer Id",
                "type":"string",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "month":{
                "description":"month",
                "type":"string"
            },
            "structureId":{
                "description":"structureId",
                "type":"string",
                "pattern":"[A-Z0-9]{1,30}"
            }
        }
    }

Nested Schema : LmdRdInvestmentDetailsDTO
Type: `object`
InvestmentDetails DTO
Match All
Show Source

- allOf GenericDto
- object LmdRdInvestmentDetailsDTO-allOf[1]

    {
        "description":"InvestmentDetails DTO",
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "structureId":{
                        "description":"structure id in Investment details",
                        "type":"string",
                        "pattern":"[A-Z0-9]{1,30}"
                    },
                    "valueDate":{
                        "description":"value date in Investment details",
                        "type":"string",
                        "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
                    },
                    "accountNumber":{
                        "description":"account number in Investment details",
                        "type":"string",
                        "maxLength":30
                    },
                    "parentAccountNumber":{
                        "description":"Parent account number in Investment details",
                        "type":"string",
                        "maxLength":30
                    },
                    "availableBalance":{
                        "description":"Available Balance in Investment details",
                        "type":"number"
                    },
                    "currencyCode":{
                        "description":"Currency code in Investment details",
                        "type":"string",
                        "maxLength":3
                    },
                    "customerId":{
                        "description":"Customer Id for Investment details",
                        "type":"string",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "instrumentType":{
                        "description":"Instrument Type for Investment details",
                        "type":"string"
                    }
                }
            }
        ]
    }

Nested Schema : LmdRdInvestmentDetailsDTO-allOf[1]
Type: `object`
Show Source

- accountNumber(optional): string
  Maximum Length: `30`
  account number in Investment details
- availableBalance(optional): number
  Available Balance in Investment details
- currencyCode(optional): string
  Maximum Length: `3`
  Currency code in Investment details
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
  Customer Id for Investment details
- instrumentType(optional): string
  Instrument Type for Investment details
- parentAccountNumber(optional): string
  Maximum Length: `30`
  Parent account number in Investment details
- structureId(optional): string
  Pattern: `[A-Z0-9]{1,30}`
  structure id in Investment details
- valueDate(optional): string
  Pattern: `[0-9]{4}[-][0-9]{2}[-][0-9]{2}`
  value date in Investment details

    {
        "type":"object",
        "properties":{
            "structureId":{
                "description":"structure id in Investment details",
                "type":"string",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "valueDate":{
                "description":"value date in Investment details",
                "type":"string",
                "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}"
            },
            "accountNumber":{
                "description":"account number in Investment details",
                "type":"string",
                "maxLength":30
            },
            "parentAccountNumber":{
                "description":"Parent account number in Investment details",
                "type":"string",
                "maxLength":30
            },
            "availableBalance":{
                "description":"Available Balance in Investment details",
                "type":"number"
            },
            "currencyCode":{
                "description":"Currency code in Investment details",
                "type":"string",
                "maxLength":3
            },
            "customerId":{
                "description":"Customer Id for Investment details",
                "type":"string",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "instrumentType":{
                "description":"Instrument Type for Investment details",
                "type":"string"
            }
        }
    }

Nested Schema : LmdTbScheduledSweepsDTO
Type: `object`
ScheduledSweeps DTO
Match All
Show Source

- allOf GenericDto
- object LmdTbScheduledSweepsDTO-allOf[1]

    {
        "description":"ScheduledSweeps DTO",
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "accountNumber":{
                        "description":"accountNumber in Scheduled Sweeps",
                        "type":"string"
                    },
                    "branchCode":{
                        "description":"branchCode in Scheduled Sweeps",
                        "type":"string"
                    },
                    "currencyCode":{
                        "description":"currencyCode in Scheduled Sweeps",
                        "type":"string"
                    },
                    "customerId":{
                        "description":"customerId in Scheduled Sweeps",
                        "type":"string",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "instructionDesription":{
                        "description":"instructionDesription in Scheduled Sweeps",
                        "type":"string"
                    },
                    "instructionId":{
                        "description":"instructionId in Scheduled Sweeps",
                        "type":"string"
                    },
                    "parentAccountNumber":{
                        "description":"parentAccountNumber in Scheduled Sweeps",
                        "type":"string"
                    },
                    "parentBranchCode":{
                        "description":"parentBranchCode in Scheduled Sweeps",
                        "type":"string"
                    },
                    "parentCurrencyCode":{
                        "description":"parentCurrencyCode in Scheduled Sweeps",
                        "type":"string"
                    },
                    "productCode":{
                        "description":"productCode in Scheduled Sweeps",
                        "type":"string"
                    },
                    "productDescription":{
                        "description":"productDescription in Scheduled Sweeps",
                        "type":"string"
                    },
                    "structureDescription":{
                        "description":"structureDescription in Scheduled Sweeps",
                        "type":"string"
                    },
                    "structureId":{
                        "description":"structureId in Scheduled Sweeps",
                        "type":"string",
                        "pattern":"[0-9a-fA-Z-]{1,36}"
                    },
                    "nextRunDate":{
                        "description":"nextRunDate in Scheduled Sweeps",
                        "type":"string"
                    }
                },
                "required":[
                    "id"
                ]
            }
        ]
    }

Nested Schema : LmdTbScheduledSweepsDTO-allOf[1]
Type: `object`
Show Source

- accountNumber(optional): string
  accountNumber in Scheduled Sweeps
- branchCode(optional): string
  branchCode in Scheduled Sweeps
- currencyCode(optional): string
  currencyCode in Scheduled Sweeps
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
  customerId in Scheduled Sweeps
- instructionDesription(optional): string
  instructionDesription in Scheduled Sweeps
- instructionId(optional): string
  instructionId in Scheduled Sweeps
- nextRunDate(optional): string
  nextRunDate in Scheduled Sweeps
- parentAccountNumber(optional): string
  parentAccountNumber in Scheduled Sweeps
- parentBranchCode(optional): string
  parentBranchCode in Scheduled Sweeps
- parentCurrencyCode(optional): string
  parentCurrencyCode in Scheduled Sweeps
- productCode(optional): string
  productCode in Scheduled Sweeps
- productDescription(optional): string
  productDescription in Scheduled Sweeps
- structureDescription(optional): string
  structureDescription in Scheduled Sweeps
- structureId(optional): string
  Pattern: `[0-9a-fA-Z-]{1,36}`
  structureId in Scheduled Sweeps

    {
        "type":"object",
        "properties":{
            "accountNumber":{
                "description":"accountNumber in Scheduled Sweeps",
                "type":"string"
            },
            "branchCode":{
                "description":"branchCode in Scheduled Sweeps",
                "type":"string"
            },
            "currencyCode":{
                "description":"currencyCode in Scheduled Sweeps",
                "type":"string"
            },
            "customerId":{
                "description":"customerId in Scheduled Sweeps",
                "type":"string",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "instructionDesription":{
                "description":"instructionDesription in Scheduled Sweeps",
                "type":"string"
            },
            "instructionId":{
                "description":"instructionId in Scheduled Sweeps",
                "type":"string"
            },
            "parentAccountNumber":{
                "description":"parentAccountNumber in Scheduled Sweeps",
                "type":"string"
            },
            "parentBranchCode":{
                "description":"parentBranchCode in Scheduled Sweeps",
                "type":"string"
            },
            "parentCurrencyCode":{
                "description":"parentCurrencyCode in Scheduled Sweeps",
                "type":"string"
            },
            "productCode":{
                "description":"productCode in Scheduled Sweeps",
                "type":"string"
            },
            "productDescription":{
                "description":"productDescription in Scheduled Sweeps",
                "type":"string"
            },
            "structureDescription":{
                "description":"structureDescription in Scheduled Sweeps",
                "type":"string"
            },
            "structureId":{
                "description":"structureId in Scheduled Sweeps",
                "type":"string",
                "pattern":"[0-9a-fA-Z-]{1,36}"
            },
            "nextRunDate":{
                "description":"nextRunDate in Scheduled Sweeps",
                "type":"string"
            }
        },
        "required":[
            "id"
        ]
    }

#### 400 Response

Malformed syntax.

#### 401 Response

Request does not have sufficient credentials.

#### 403 Response

Request is not authorized.

#### 500 Response

Internal error
Back to Top