1 of 4

Bill Amendment Service Configuration

UI Configuration

Employee: Bill Amendment - Create Flow

Objective: The create Bill Amendment feature is used for applying for amendments on Water and Sewerage Bills.

Workflow Details

Bill amendment can be applied on any Water and Sewerage connection for which the bill has been generated and an amount is due. Counter Employee can apply for a bill amendment i.e., User with these roles “WS_CEMP”, “SW_CEMP”.

Every bill amendment application is part of the workflow.

The Create Bill Amendment flow starts when the user clicks on the action Bill Amendment from the Connection Details page of Water/Sewerage Connection and a Required Documents acknowledge screen is rendered.

Bill Amendment action will only be enabled when a bill is generated and an amount is due.

Clicking on apply continues the flow and renders the bill amendment apply page.

Here the user can enter the required details, like whether the user wants to apply for a Reduced amount(Rebate) or an additional amount(penalty). Other details can be understood from the screen itself.
Apart from the details users also have the option to add a Rebate/ Penalty that is not covered under the default tax heads and is shown at the bottom as an Adhoc rebate/penalty.

When a user clicks on Submit and all the validations on frontend are successful then a create post request is sent the this API endpoint “/billing-service/amendment/_create?“ with an Amendment Object in the body(payload) which contains all the required details to apply for the amendment and a corresponding success/failure acknowledgement screen is shown on the screen.

Technical Implementation Details

Bill Amendment File path:

Bill Amendment Apply File Path:

The payload sent to the “/billing-service/amendment/_create" endpoint looks like the following:

{
    "consumerCode": "WS/107/2021-22/227166",
    "tenantId": "pb.amritsar",
    "businessService": "WS",
    "amendmentReason": "COURT_CASE_SETTLEMENT",
    "reasonDocumentNumber": "1234",
    "effectiveFrom": 1652227200000,
    "effectiveTill": 1652313600000,
    "documents": [
        {
            "fileName": "consumer-PB-TL-2022-03-27-024497.pdf",
            "fileStoreId": "8c9ec928-a18f-41ee-b4ff-283e715d31ad",
            "fileStore": "8c9ec928-a18f-41ee-b4ff-283e715d31ad",
            "documentType": "PASTBILLS",
            "fileUrl": "https://egov-rainmaker.s3-ap-south-1.amazonaws.com/pb.amritsar/WS/May/11/1652243671676UFiQJSMWqv.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA42DEGMQ2NZVNTLNI%2F20220511%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220511T043431Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=c2d089faac71ee0ee3597b26d450555e5a4b9d1a27a29d7cb51b3a37632dcd76"
        },
        {
            "fileName": "consumer-PB-TL-2022-03-27-024497.pdf",
            "fileStoreId": "6292701a-00a2-4dc3-ba83-528373934767",
            "fileStore": "6292701a-00a2-4dc3-ba83-528373934767",
            "documentType": "IDENTITYPROOF",
            "fileUrl": "https://egov-rainmaker.s3-ap-south-1.amazonaws.com/pb.amritsar/WS/May/11/1652243675149sIkVhbTMFg.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA42DEGMQ2NZVNTLNI%2F20220511%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220511T043435Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=a5ff23c0c145792086e0cbc08e060becbea2c8ee3792ba039bbb9125c0f03b26"
        },
        {
            "fileName": "consumer-PB-TL-2022-03-27-024497.pdf",
            "fileStoreId": "9bab8541-ed04-4a9b-99c9-51407ebf0021",
            "fileStore": "9bab8541-ed04-4a9b-99c9-51407ebf0021",
            "documentType": "ADDRESSPROOF",
            "fileUrl": "https://egov-rainmaker.s3-ap-south-1.amazonaws.com/pb.amritsar/WS/May/11/1652243678618FJZAJZkOjr.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA42DEGMQ2NZVNTLNI%2F20220511%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220511T043438Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=e74b3e374d93571815a0ad321addec3634e4f88af2b2f9aee9aab6083d496c81"
        },
        {
            "fileName": "consumer-PB-TL-2022-03-27-024497.pdf",
            "fileStoreId": "0ba7df45-9767-4969-a7b6-a3ca21ebd354",
            "fileStore": "0ba7df45-9767-4969-a7b6-a3ca21ebd354",
            "documentType": "COURTORDER",
            "fileUrl": "https://egov-rainmaker.s3-ap-south-1.amazonaws.com/pb.amritsar/WS/May/11/1652243668712ndmiSGTcuP.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA42DEGMQ2NZVNTLNI%2F20220511%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220511T043429Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=e62a348748677e73b93b71d8721050a1cd428d488be7a478593d7f070c4119b9"
        },
        {
            "fileName": "acknowledgement.pdf",
            "fileStoreId": "0d759e3e-acc2-4f4a-9098-18df24ae3967",
            "fileStore": "0d759e3e-acc2-4f4a-9098-18df24ae3967",
            "documentType": "SELFDECLARATION",
            "fileUrl": "https://egov-rainmaker.s3-ap-south-1.amazonaws.com/pb.amritsar/WS/May/11/1652243682179UKJXrGkfAR.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA42DEGMQ2NZVNTLNI%2F20220511%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220511T043442Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=aaf389d422b7520761230a4623a89bb71a3dbce878bddabfde7cabe7c4eaf3d7"
        }
    ],
    "demandDetails": [
        {
            "taxHeadMasterCode": "WS_CHARGE",
            "taxAmount": -100
        },
        {
            "taxHeadMasterCode": "WS_TIME_PENALTY",
            "taxAmount": -10
        },
        {
            "taxHeadMasterCode": "WS_TIME_INTEREST",
            "taxAmount": -5
        },
        {
            "taxHeadMasterCode": "WS_WATER_CESS",
            "taxAmount": -5
        }
    ],
    "additionalDetails": {
        "searchBillDetails": {
            "WS_CHARGE": "100",
            "WS_TIME_PENALTY": "10",
            "WS_TIME_INTEREST": "5",
            "WS_WATER_CESS": "5",
            "TOTAL": 120
        }
    }
}

MDMS Data

Role Action Mapping

API

ROLES

ACTION ID

/billing-service/amendment/_create

WS_CEMP,SW_CEMP

2047

/egov-mdms-service/v1/_search

WS_CEMP,SW_CEMP

954

/filestore/v1/files/url

EMPLOYEE

Employee: Bill Amendment - Search, Edit & Resubmit, Approve, Reject & Send-Back Flows

Objective: To provide employees with search, edit, resubmit, approve, reject and option to send back amendment bills.

Workflow Details

Search Bill Amendment

When the Bill Amendment application is created by the counter employee a bill amendment application number is generated. Using this number as well as other parameters, a user can search for the application on the Bill Amendment Inbox page.

Insert Bill Amend inbox Screenshot here (not developed yet in new-UI)

The first column of the result is the Bill Amendment number and every cell in this column is a link that leads the user to the Bill Amendment application details. This page has all details regarding the amendment application.

A download option is provided to download the application acknowledgement

Timelines Panel shows the status history and current status of the application

Once the application is approved the download button has the option to download coupon-pdf as well that looks as follows:

Approve, Reject & Send-Back Bill Amendment

Only users with the role of approver i.e., “WS-AP”, “SW-AP” can approve the application.

The Application Details page of the bill amendment contains the Take Action button on the action bar at the bottom of the screen. The Take Action button opens a dropdown that contains some options described below. After clicking any of the given options an Action modal window is rendered.

Approve → After verifying approver can approve the application
Reject → Approver can Reject the application by giving a reason in the comments section displayed in the action modal.
Send-Back → Approver can send back the application to the counter employee after giving the reason in the action modal. This option is used when there is an error in the application or something needs to be changed by the counter employee.

For Counter Employees, the action bar is not visible until the approver sends the application back to the counter employee. It is visible when the approver sends back the application and it shows an option to resubmit using which the counter employee can submit the application again.

Implementation Details

File Path:

MDMS Data

API Details

API

API description

inbox/v1/_search?_

WS_CEMP, SW_CEMP

Bill Amendment Search

/billing-service/amendment/_update

WS_CEMP, WS_AP,

To Update bill amendment application(For edit,resubmit,approve and reject)

Employee: Bill Amendment - Search, Edit & Resubmit, Approve, Reject & Send-Back Flows

Objective: To provide employees with search, edit, resubmit, approve, reject and option to send back amendment bills.

Workflow Details

Search Bill Amendment

Insert Bill Amend inbox Screenshot here (not developed yet in new-UI)

A download option is provided to download the application acknowledgement

Timelines Panel shows the status history and current status of the application

Once the application is approved the download button has the option to download coupon-pdf as well that looks as follows:

Approve, Reject & Send-Back Bill Amendment

Only users with the role of approver i.e., “WS-AP”, “SW-AP” can approve the application.

Approve → After verifying approver can approve the application
Reject → Approver can Reject the application by giving a reason in the comments section displayed in the action modal.
Send-Back → Approver can send back the application to the counter employee after giving the reason in the action modal. This option is used when there is an error in the application or something needs to be changed by the counter employee.

Implementation Details

File Path:

https://github.com/egovernments/DIGIT-Dev/blob/fed230dba3b9698a01310968bf052dc68de85801/frontend/micro-ui/web/micro-ui-internals/packages/modules/ws/src/pages/employee/ApplicationDetailsBillAmendment.jsgithub.com

MDMS Data

API Details

API

API description

inbox/v1/_search?_

WS_CEMP, SW_CEMP

Bill Amendment Search

/billing-service/amendment/_update

WS_CEMP, WS_AP,

To Update bill amendment application(For edit,resubmit,approve and reject)

Employee: Bill Amendment - Create Flow

Objective: The create Bill Amendment feature is used for applying for amendments on Water and Sewerage Bills.

Workflow Details

Every bill amendment application is part of the workflow.

Bill Amendment action will only be enabled when a bill is generated and an amount is due.

Clicking on apply continues the flow and renders the bill amendment apply page.

Here the user can enter the required details, like whether the user wants to apply for a Reduced amount(Rebate) or an additional amount(penalty). Other details can be understood from the screen itself.
Apart from the details users also have the option to add a Rebate/ Penalty that is not covered under the default tax heads and is shown at the bottom as an Adhoc rebate/penalty.

Technical Implementation Details

Bill Amendment File path:

https://github.com/egovernments/DIGIT-Dev/blob/6fe9842a7c175f0d38ec007ec14bc0eeb958e707/frontend/micro-ui/web/micro-ui-internals/packages/modules/ws/src/pages/employee/RequiredDocuments.jsgithub.com

Bill Amendment Apply File Path:

https://github.com/egovernments/DIGIT-Dev/blob/6fe9842a7c175f0d38ec007ec14bc0eeb958e707/frontend/micro-ui/web/micro-ui-internals/packages/modules/ws/src/pages/employee/ApplicationBillAmendment.jsgithub.com

The payload sent to the “/billing-service/amendment/_create" endpoint looks like the following:

{
    "consumerCode": "WS/107/2021-22/227166",
    "tenantId": "pb.amritsar",
    "businessService": "WS",
    "amendmentReason": "COURT_CASE_SETTLEMENT",
    "reasonDocumentNumber": "1234",
    "effectiveFrom": 1652227200000,
    "effectiveTill": 1652313600000,
    "documents": [
        {
            "fileName": "consumer-PB-TL-2022-03-27-024497.pdf",
            "fileStoreId": "8c9ec928-a18f-41ee-b4ff-283e715d31ad",
            "fileStore": "8c9ec928-a18f-41ee-b4ff-283e715d31ad",
            "documentType": "PASTBILLS",
            "fileUrl": "https://egov-rainmaker.s3-ap-south-1.amazonaws.com/pb.amritsar/WS/May/11/1652243671676UFiQJSMWqv.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA42DEGMQ2NZVNTLNI%2F20220511%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220511T043431Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=c2d089faac71ee0ee3597b26d450555e5a4b9d1a27a29d7cb51b3a37632dcd76"
        },
        {
            "fileName": "consumer-PB-TL-2022-03-27-024497.pdf",
            "fileStoreId": "6292701a-00a2-4dc3-ba83-528373934767",
            "fileStore": "6292701a-00a2-4dc3-ba83-528373934767",
            "documentType": "IDENTITYPROOF",
            "fileUrl": "https://egov-rainmaker.s3-ap-south-1.amazonaws.com/pb.amritsar/WS/May/11/1652243675149sIkVhbTMFg.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA42DEGMQ2NZVNTLNI%2F20220511%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220511T043435Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=a5ff23c0c145792086e0cbc08e060becbea2c8ee3792ba039bbb9125c0f03b26"
        },
        {
            "fileName": "consumer-PB-TL-2022-03-27-024497.pdf",
            "fileStoreId": "9bab8541-ed04-4a9b-99c9-51407ebf0021",
            "fileStore": "9bab8541-ed04-4a9b-99c9-51407ebf0021",
            "documentType": "ADDRESSPROOF",
            "fileUrl": "https://egov-rainmaker.s3-ap-south-1.amazonaws.com/pb.amritsar/WS/May/11/1652243678618FJZAJZkOjr.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA42DEGMQ2NZVNTLNI%2F20220511%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220511T043438Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=e74b3e374d93571815a0ad321addec3634e4f88af2b2f9aee9aab6083d496c81"
        },
        {
            "fileName": "consumer-PB-TL-2022-03-27-024497.pdf",
            "fileStoreId": "0ba7df45-9767-4969-a7b6-a3ca21ebd354",
            "fileStore": "0ba7df45-9767-4969-a7b6-a3ca21ebd354",
            "documentType": "COURTORDER",
            "fileUrl": "https://egov-rainmaker.s3-ap-south-1.amazonaws.com/pb.amritsar/WS/May/11/1652243668712ndmiSGTcuP.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA42DEGMQ2NZVNTLNI%2F20220511%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220511T043429Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=e62a348748677e73b93b71d8721050a1cd428d488be7a478593d7f070c4119b9"
        },
        {
            "fileName": "acknowledgement.pdf",
            "fileStoreId": "0d759e3e-acc2-4f4a-9098-18df24ae3967",
            "fileStore": "0d759e3e-acc2-4f4a-9098-18df24ae3967",
            "documentType": "SELFDECLARATION",
            "fileUrl": "https://egov-rainmaker.s3-ap-south-1.amazonaws.com/pb.amritsar/WS/May/11/1652243682179UKJXrGkfAR.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA42DEGMQ2NZVNTLNI%2F20220511%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20220511T043442Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=aaf389d422b7520761230a4623a89bb71a3dbce878bddabfde7cabe7c4eaf3d7"
        }
    ],
    "demandDetails": [
        {
            "taxHeadMasterCode": "WS_CHARGE",
            "taxAmount": -100
        },
        {
            "taxHeadMasterCode": "WS_TIME_PENALTY",
            "taxAmount": -10
        },
        {
            "taxHeadMasterCode": "WS_TIME_INTEREST",
            "taxAmount": -5
        },
        {
            "taxHeadMasterCode": "WS_WATER_CESS",
            "taxAmount": -5
        }
    ],
    "additionalDetails": {
        "searchBillDetails": {
            "WS_CHARGE": "100",
            "WS_TIME_PENALTY": "10",
            "WS_TIME_INTEREST": "5",
            "WS_WATER_CESS": "5",
            "TOTAL": 120
        }
    }
}