Jump to

• Request
• Response

Get Accured Amount Web API

get

/uiAccruedAmt

This endpoint is used to get accured amount from web API.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• acc: string
  Fetch Based on Account Number, default value is true
• brn: string
  Fetch Based on Branch Code, default value is true
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• source: string
  Fetch Based on Account Number, default value is true

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns message of succes or failure

Body ()

Root Schema : UIAccruedAmtCollection

Type: object

UIAccruedAmtCollection.

Show Source

• data(optional): array data
• errors(optional): array errors
  Error Code List
• paging(optional): object PagingDto

{
    "description":"UIAccruedAmtCollection.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UIAccruedAmtMasterDTO"
            }
        },
        "errors":{
            "description":"Error Code List",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorCodeDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object UIAccruedAmtMasterDTO
  UI Accrued Amt Master DTO

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

Nested Schema : errors

Type: array

Error Code List

Show Source

• Array of: object ErrorCodeDTO

{
    "description":"Error Code List",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ErrorCodeDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : UIAccruedAmtMasterDTO

Type: object

UI Accrued Amt Master DTO

Show Source

• acc(optional): string
• accruedAmt(optional): number
• brn(optional): string
• drcr(optional): string
• frmNo(optional): number
• prod(optional): string
• source(optional): string

{
    "description":"UI Accrued Amt Master DTO",
    "type":"object",
    "properties":{
        "acc":{
            "type":"string",
            "description":""
        },
        "brn":{
            "type":"string",
            "description":""
        },
        "source":{
            "type":"string",
            "description":""
        },
        "prod":{
            "type":"string",
            "description":""
        },
        "frmNo":{
            "type":"number",
            "description":""
        },
        "accruedAmt":{
            "type":"number",
            "description":""
        },
        "drcr":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : ErrorCodeDTO

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top