Jump to

• Request
• Response

Get all valid interest accrual report

post

/interestaccrualreport

This endpoint is used to get all valid interest accrual maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched

Body ()

Request Body that contains data required for creating a new oblm-report-services

Root Schema : InterestAccrualReportInputDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object InterestAccrualReportInputDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "customerId":{
                    "type":"string",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "structureId":{
                    "type":"string",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "accountType":{
                    "type":"string"
                },
                "accountNumber":{
                    "type":"string"
                },
                "versionNo":{
                    "type":"integer"
                },
                "fromDate":{
                    "type":"string",
                    "format":"date"
                },
                "toDate":{
                    "description":"To Date of Exceptions",
                    "type":"string",
                    "format":"date"
                }
            },
            "required":[
                "customerId",
                "fromDate",
                "toDate"
            ]
        }
    ]
}

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 : InterestAccrualReportInputDTO-allOf[1]

Type: object

Show Source

• accountNumber(optional): string
• accountType(optional): string
• customerId: string
  Pattern: [a-zA-Z0-9]{1,20}
• fromDate: string(date)
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}
• toDate: string(date)
  To Date of Exceptions
• versionNo(optional): integer

{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "structureId":{
            "type":"string",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "accountType":{
            "type":"string"
        },
        "accountNumber":{
            "type":"string"
        },
        "versionNo":{
            "type":"integer"
        },
        "fromDate":{
            "type":"string",
            "format":"date"
        },
        "toDate":{
            "description":"To Date of Exceptions",
            "type":"string",
            "format":"date"
        }
    },
    "required":[
        "customerId",
        "fromDate",
        "toDate"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : InterestAccrualDTOCollection

Type: object

Collection of entries.

Show Source

• data(optional): array data
• messages(optional): object ResponseDto
• paging(optional): object PagingDto
• userInfo(optional): object userInfo

{
    "description":"Collection of entries.",
    "type":"object",
    "properties":{
        "userInfo":{
            "type":"object",
            "items":{
                "$ref":"#/definitions/UserInformationDTO"
            }
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InterestAccrualDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object InterestAccrualDTO

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

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : userInfo

Type: object

Show Source

• Array of: object UserInformationDTO

{
    "type":"object",
    "items":{
        "$ref":"#/definitions/UserInformationDTO"
    }
}

Nested Schema : InterestAccrualDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object InterestAccrualDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "structureId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "accountNumber":{
                    "type":"string",
                    "description":""
                },
                "accountCurrency":{
                    "type":"string",
                    "description":""
                },
                "drcr":{
                    "type":"string",
                    "description":""
                },
                "interest":{
                    "type":"number",
                    "description":""
                },
                "entryDate":{
                    "type":"string",
                    "description":""
                },
                "cashCCMethod":{
                    "type":"string",
                    "description":""
                }
            }
        }
    ]
}

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 : InterestAccrualDTO-allOf[1]

Type: object

Show Source

• accountCurrency(optional): string
• accountNumber(optional): string
• cashCCMethod(optional): string
• drcr(optional): string
• entryDate(optional): string
• interest(optional): number
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}

{
    "type":"object",
    "properties":{
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "accountNumber":{
            "type":"string",
            "description":""
        },
        "accountCurrency":{
            "type":"string",
            "description":""
        },
        "drcr":{
            "type":"string",
            "description":""
        },
        "interest":{
            "type":"number",
            "description":""
        },
        "entryDate":{
            "type":"string",
            "description":""
        },
        "cashCCMethod":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : UserInformationDTO

Type: object

Show Source

• dateAndTime(optional): string
  Generated At time
• userId(optional): string
  Generated By user id

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "description":"Generated By user id"
        },
        "dateAndTime":{
            "type":"string",
            "description":"Generated At time"
        }
    }
}

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