Previous Next JavaScript must be enabled to correctly display this content

## Retrieves the list of existing Interest Details

get

/interestdetails

This endpoint is used to get the list of existing interest details.

### 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 : InterestDetailsCollection
Type: `object`
Collection of InterestDetails
Show Source

- data(optional): array data
- paging(optional): object PagingDto

    {
        "description":"Collection of InterestDetails",
        "type":"object",
        "properties":{
            "data":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/InterestDetailsDTO"
                }
            },
            "paging":{
                "$ref":"#/definitions/PagingDto"
            }
        }
    }

Nested Schema : data
Type: `array`
Show Source

- Array of: object InterestDetailsDTO
  InterestDetails DTO for view

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

    {
        "type":"object",
        "properties":{
            "totalResults":{
                "type":"integer"
            }
        }
    }

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 : 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 : 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}"
            }
        }
    }

#### 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