Integration Documents of Cash/Cheque Remittance
- Mohammad Atiqurrahaman (Unlicensed)
The process to remit the collections of type Cash/Cheque to specific mapped ulb bankaccount.
Cash/Cheque Remittance:
The form page to search and list down the consolidated collections/receipt to remit.
Submit the form to remit the selected collections/receipts.
Form Page:
Field Parameters:
Account Number : Account Number is getting listed which is configured in mdms and getting fetched by mdms rest api call.
URI : http://localhost:8094/egov-mdms-service/v1/_search
Request Body :
{
"RequestInfo": {
"apiId": null,
"ver": null,
"ts": null,
"action": null,
"did": null,
"key": null,
"msgId": null,
"authToken": "1e37cf3b-ba38-447b-833e-7c2147e12323",
"correlationId": null,
"userInfo": null
},
"MdmsCriteria": {
"tenantId": "pb.jalandhar",
"moduleDetails": [
{
"moduleName": "FinanceModule",
"masterDetails": [
{
"name": "BankAccountServiceMapping",
"filter": null
}
]
}
]
}
}
While clicking on search button the below action will be processed.
First it will process to fetch the list of Instrument by making the below rest api.
Then it lists out the linked receipts for every fetched instrument by making the below rest api.
In case of cash remittance it will fetch collections/Receipts and will be consolidated by grouping by date, service name,fund and department and summing the total amounts.
In case of Cheque Remittance it will fetch collections/Receipts and will be listed out each receipt and corresponding instruments.
Post selecting the receipts when we will submit the form to remit then following actions will get processed at code level.
First it will fetch the receipt of status New for Selected business service for specific transaction date as below.
Then it will try to fetch the linked instruments as below.
Post this try to create the voucher for remittance and finally it will post a call to create the Remittance by making the rest call as below by setting the specific data and corresponding voucher number.
Then it will post a rest call to back update the Receipts by setting the status as REMIT as below.
After that it will post the rest call as below to update the instrument as Reconciled(in case of Cash Remittance) or Deposited(in case of Cheque Remittance).
These are the sample APIs used to get called while doing remittance.
Request Body :
{
"RequestInfo": {
"apiId": null,
"ver": null,
"ts": null,
"action": null,
"did": null,
"key": null,
"msgId": null,
"authToken": "1e37cf3b-ba38-447b-833e-7c2147e12323",
"correlationId": null,
"userInfo": null
}
}
URI :
Request Body :
{
"RequestInfo": {
"apiId": null,
"ver": null,
"ts": null,
"action": null,
"did": null,
"key": null,
"msgId": null,
"authToken": "1e37cf3b-ba38-447b-833e-7c2147e12323",
"correlationId": null,
"userInfo": {
"id": 26273,
"uuid": "d8e2c1d7-fb2d-43ef-a7ce-708da88a7c41",
"userName": "TEST-13",
"name": "Atique",
"type": "EMPLOYEE",
"mobileNumber": null,
"emailId": null,
"roles": [],
"tenantId": "pb.jalandhar"
}
}
}
URI :
Request Body :
{
"RequestInfo": {
"apiId": null,
"ver": null,
"ts": null,
"action": null,
"did": null,
"key": null,
"msgId": null,
"authToken": "1e37cf3b-ba38-447b-833e-7c2147e12323",
"correlationId": null,
"userInfo": {
"id": 26273,
"uuid": "d8e2c1d7-fb2d-43ef-a7ce-708da88a7c41",
"userName": "TEST-13",
"name": "Atique",
"type": "EMPLOYEE",
"mobileNumber": null,
"emailId": null,
"roles": [],
"tenantId": "pb.jalandhar"
}
}
}
URI :
Request Body :
{
"RequestInfo": {
"apiId": null,
"ver": null,
"ts": null,
"action": null,
"did": null,
"key": null,
"msgId": null,
"authToken": "1e37cf3b-ba38-447b-833e-7c2147e12323",
"correlationId": null,
"userInfo": null
}
}
URI :
http://localhost:8095/collection-services/remittances/_create
Request Body :
{
"RequestInfo": {
"apiId": null,
"ver": null,
"ts": null,
"action": null,
"did": null,
"key": null,
"msgId": null,
"authToken": "f4e4e8f0-a5cf-485c-8017-c3818d247b47",
"correlationId": null,
"userInfo": {
"id": 26273,
"uuid": null,
"userName": null,
"name": null,
"type": null,
"mobileNumber": null,
"emailId": null,
"roles": null,
"tenantId": null
}
},
"Remittance": [
{
"tenantId": "pb.jalandhar",
"id": null,
"referenceNumber": "REM/000023/06/2020-21",
"referenceDate": 1592677800000,
"voucherHeader": "1/CSL/00000015/06/2020-21",
"function": "000201",
"fund": "01",
"remarks": null,
"reasonForDelay": null,
"status": "Approved",
"bankaccount": "278465912123",
"remittanceDetails": [
{
"tenantId": "pb.jalandhar",
"id": null,
"remittance": null,
"chartOfAccount": "4501001",
"creditAmount": 831,
"debitAmount": 0
},
{
"tenantId": "pb.jalandhar",
"id": null,
"remittance": null,
"chartOfAccount": "4502105",
"creditAmount": 0,
"debitAmount": 831
}
],
"remittanceInstruments": [
{
"tenantId": "pb.jalandhar",
"id": null,
"remittance": null,
"instrument": "e38b890dd7c144b388f2db07a71a3fd6",
"reconciled": false
}
],
"remittanceReceipts": [
{
"tenantId": "pb.jalandhar",
"id": null,
"remittance": null,
"receipt": "9c80439e-419d-4656-bd9e-844857602361"
}
],
"auditDetails": null
}
]
}
URI :
http://localhost:8095/collection-services/payments/_workflow
Request Body :
{
"RequestInfo": {
"apiId": null,
"ver": null,
"ts": null,
"action": null,
"did": null,
"key": null,
"msgId": null,
"authToken": "1e37cf3b-ba38-447b-833e-7c2147e12323",
"correlationId": null,
"userInfo": {
"id": 26273,
"uuid": "d8e2c1d7-fb2d-43ef-a7ce-708da88a7c41",
"userName": "TEST-13",
"name": "Atique",
"type": "EMPLOYEE",
"mobileNumber": null,
"emailId": null,
"roles": [],
"tenantId": "pb.jalandhar"
}
},
"PaymentWorkflows": [
{
"paymentId": "9c80439e-419d-4656-bd9e-844857602361",
"action": "REMIT",
"tenantId": "pb.jalandhar",
"reason": "Payment got remitted from finance",
"additionalDetails": null
}
]
}
URI :
http://localhost:8097/egf-instrument/instruments/_update
Request Body :
{
"requestInfo": {
"apiId": null,
"ver": null,
"ts": null,
"action": null,
"did": null,
"key": null,
"msgId": null,
"authToken": "1e37cf3b-ba38-447b-833e-7c2147e12323",
"correlationId": null,
"userInfo": null
},
"instruments": [
{
"id": "e38b890dd7c144b388f2db07a71a3fd6",
"transactionNumber": "jalandhar1024241251",
"transactionDate": "21-06-2020",
"transactionDateInput": null,
"amount": 831,
"instrumentType": {
"id": null,
"name": "Cash",
"description": null,
"active": null
},
"instrumentDate": null,
"instrumentNumber": null,
"financialStatus": {
"id": null,
"moduleType": null,
"code": "Reconciled",
"name": null,
"description": null
},
"bank": {
"id": 1,
"code": null,
"name": null,
"description": null,
"active": null,
"type": null,
"tenantId": "pb.jalandhar"
},
"branchName": null,
"bankAccount": {
"id": null,
"accountNumber": "278465912123"
},
"ifscCode": null,
"transactionType": "Debit",
"payee": null,
"drawer": null,
"tenantId": "pb.jalandhar",
"serialNo": null,
"payinSlipId": null,
"reconciledAmount": null,
"reconciledOn": null,
"instrumentStatus": null,
"instrumentVouchers": [
{
"instrument": "e38b890dd7c144b388f2db07a71a3fd6",
"voucherHeaderId": "1/BRV/00000016/06/2020-21",
"receiptHeaderId": "9c80439e-419d-4656-bd9e-844857602361"
}
],
"dishonor": null
}
]
}
----------------------------------------------------------------------------------------------------------------------------