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: string
Corporate Id for which data is required
-
frequency: string
frequency as M or D
-
fromDate: string
from date
-
toDate: string
To Date
Header Parameters
-
appId(required): string
Application ID for SMS
-
branchCode(required): string
Unique Branch Code
-
contentType: string
Content of a file
-
tenantId: string
Tenant ID for SMS
-
userId(required): string
User id for SMS
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
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:
string
Error Code
-
errorDescription:
string
Error Description
Nested Schema : ReportDataModel
Type:
object
Collection of Report Data
Show Source
-
amount:
number
Amount
-
monthYear:
string
Month Year
-
type:
string
recipient type for cw
Nested Schema : ChequeDataModel
Type:
object
Model for cheque data
Show Source
-
amount:
number
Amount
-
monthYear:
string
Month Year
-
status:
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