Retrieves the instrument collection data
get
/service/v1/collectionChequeData
This endpoint provides the dashbaord data of instrument collection.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
corporateId(optional): string
Corporate Id for which data is required
-
frequency(optional): string
frequency as M or D
-
fromDate(optional): string
from date
-
toDate(optional): string
To Date
Header Parameters
-
appId: string
Application ID for SMS
-
branchCode: string
Unique Branch Code
-
contentType(optional): string
Content of a file
-
tenantId(optional): string
Tenant ID for SMS
-
userId: string
User id for SMS
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Root Schema : ReportDataCollection
Type:
object
Collection of Report Data
Show Source
-
branchCcy(optional):
string
-
cashCollection(optional):
array cashCollection
-
cashWithdrawal(optional):
array cashWithdrawal
-
chequeCollection(optional):
array chequeCollection
-
collectionType(optional):
string
-
corporateId(optional):
string
-
error(optional):
object ReportErrorDTO
Report Error Model
-
frequency(optional):
string
-
fromDate(optional):
string
-
toDate(optional):
string
Nested Schema : cashCollection
Type:
Show Source
array
-
Array of:
object ReportDataModel
Collection of Report Data
Nested Schema : cashWithdrawal
Type:
Show Source
array
-
Array of:
object ReportDataModel
Collection of Report Data
Nested Schema : chequeCollection
Type:
Show Source
array
-
Array of:
object ChequeDataModel
Model for cheque data
Nested Schema : ReportErrorDTO
Type:
object
Report Error Model
Show Source
-
errorCode(optional):
string
Error Code
-
errorDescription(optional):
string
Error Description
Nested Schema : ReportDataModel
Type:
object
Collection of Report Data
Show Source
-
amount(optional):
number
Amount
-
monthYear(optional):
string
Month Year
-
type(optional):
string
recipient type for cw
Nested Schema : ChequeDataModel
Type:
object
Model for cheque data
Show Source
-
amount(optional):
number
Amount
-
monthYear(optional):
string
Month Year
-
status(optional):
string
Instrument status for cheque
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error