Jump to

• Request
• Response

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

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

{
    "description":"Collection of Report Data",
    "type":"object",
    "properties":{
        "branchCcy":{
            "type":"string"
        },
        "fromDate":{
            "type":"string"
        },
        "toDate":{
            "type":"string"
        },
        "corporateId":{
            "type":"string"
        },
        "frequency":{
            "type":"string"
        },
        "collectionType":{
            "type":"string"
        },
        "cashCollection":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReportDataModel"
            }
        },
        "cashWithdrawal":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReportDataModel"
            }
        },
        "chequeCollection":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChequeDataModel"
            }
        },
        "error":{
            "$ref":"#/definitions/ReportErrorDTO"
        }
    }
}

Nested Schema : cashCollection

Type: array

Show Source

• Array of: object ReportDataModel
  Collection of Report Data

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

Nested Schema : cashWithdrawal

Type: array

Show Source

• Array of: object ReportDataModel
  Collection of Report Data

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

Nested Schema : chequeCollection

Type: array

Show Source

• Array of: object ChequeDataModel
  Model for cheque data

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

Nested Schema : ReportErrorDTO

Type: object

Report Error Model

Show Source

• errorCode(optional): string
  Error Code
• errorDescription(optional): string
  Error Description

{
    "type":"object",
    "description":"Report Error Model",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDescription":{
            "type":"string",
            "description":"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

{
    "description":"Collection of Report Data",
    "type":"object",
    "properties":{
        "monthYear":{
            "description":"Month Year",
            "type":"string"
        },
        "amount":{
            "description":"Amount",
            "type":"number"
        },
        "type":{
            "description":"recipient type for cw",
            "type":"string"
        }
    }
}

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

{
    "description":"Model for cheque data",
    "type":"object",
    "properties":{
        "monthYear":{
            "description":"Month Year",
            "type":"string"
        },
        "amount":{
            "description":"Amount",
            "type":"number"
        },
        "status":{
            "description":"Instrument status for cheque",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top