Jump to

• Request
• Response

Query IC Entries

get

/icQuery/ictbEntries/brn/{brn}/accNo/{accNo}

This endpoint is used to query the IC entries.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• accNo: string
  Account Number
• brn: string
  Branch Code

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated maintque

Body ()

Root Schema : IcEntriesDtoList

Type: object

Show Source

• errors(optional): array errors
  Error Code List
• IcEntriesList(optional): array IcEntriesList
• warnings(optional): array warnings
  Warning Code List

{
    "type":"object",
    "properties":{
        "IcEntriesList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IcEntriesDto"
            }
        },
        "warnings":{
            "description":"Warning Code List",
            "type":"array",
            "items":{
                "$ref":"#/definitions/WarningCodeDTO"
            }
        },
        "errors":{
            "description":"Error Code List",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorCodeDTO"
            }
        }
    }
}

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

Type: array

Show Source

• Array of: object IcEntriesDto

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

Nested Schema : warnings

Type: array

Warning Code List

Show Source

• Array of: object WarningCodeDTO

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

Nested Schema : ErrorCodeDTO

Type: object

Show Source

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

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

Nested Schema : IcEntriesDto

Type: object

Show Source

• acc(optional): string
  Account Nuimber
• brn(optional): string
  Branch Code
• calcamt(optional): number
  Calc Amount
• curraccr(optional): number
  Current Accrual
• drcr(optional): string
  Debit/Credit
• enddate(optional): string(date)
  End Date
• frmno(optional): integer
  Frm No
• pendingaccr(optional): number
  Amount to Accrue
• product(optional): string
  Product Code
• totalaccr(optional): number
  Accrued Amount

{
    "type":"object",
    "properties":{
        "brn":{
            "type":"string",
            "description":"Branch Code"
        },
        "acc":{
            "type":"string",
            "description":"Account Nuimber"
        },
        "product":{
            "type":"string",
            "description":"Product Code"
        },
        "frmno":{
            "type":"integer",
            "description":"Frm No"
        },
        "calcamt":{
            "type":"number",
            "description":"Calc Amount"
        },
        "totalaccr":{
            "type":"number",
            "description":"Accrued Amount"
        },
        "pendingaccr":{
            "type":"number",
            "description":"Amount to Accrue"
        },
        "curraccr":{
            "type":"number",
            "description":"Current Accrual"
        },
        "enddate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "drcr":{
            "type":"string",
            "description":"Debit/Credit"
        }
    }
}

Nested Schema : WarningCodeDTO

Type: object

Show Source

• warningCode(optional): string
• warningDesc(optional): string

{
    "type":"object",
    "properties":{
        "warningCode":{
            "type":"string"
        },
        "warningDesc":{
            "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