Jump to

• Request
• Response

Retrieves the list of total effective balances

get

/effectivebalance

This endpoint is used to get effective balances

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 : LmdTbEffectiveBalanceCollection

Type: object

Collection of Effective Balances

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmdTbEffectiveBalanceDTO
  EffectiveBalance DTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

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

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