Miscellaneous Collection API

eChallan Service

Create new challan request

Generate the challan in the system with the defined attributes

POST/eChallan/v1/_create

Body

application/json

Request schema.

requestInfo*RequestHeader (object)

RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.

challan*Challan (object)

Capture the challan details

Response

202400

Application submitted successfully

Body

*/*

responseInfoResponseHeader (object)

ResponseHeader should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseHeader should always correspond to the same values in respective request's RequestHeader.

challansarray of any

Request

JavaScriptCurlPython

const response = await fetch('/eChallan/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "challan": {
        "tenantId": "text",
        "accountId": "text"
      }
    }),
});
const data = await response.json();

Response

202400

{
  "responseInfo": {
    "resMsgId": "text",
    "msgId": "text",
    "status": "COMPLETED",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    }
  },
  "challans": []
}

Update the existing challan details

Update the existing challan details

POST/eChallan/v1/_update

Body

application/json

Request schema.

requestInfo*RequestHeader (object)

RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.

challan*Challan (object)

Capture the challan details

Response

202400

Application submitted successfully

Body

*/*

responseInfoResponseHeader (object)

ResponseHeader should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseHeader should always correspond to the same values in respective request's RequestHeader.

challansarray of Challan (object)

Request

JavaScriptCurlPython

const response = await fetch('/eChallan/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "challan": {
        "tenantId": "text",
        "accountId": "text"
      }
    }),
});
const data = await response.json();

Response

202400

{
  "responseInfo": {
    "resMsgId": "text",
    "msgId": "text",
    "status": "COMPLETED",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    }
  },
  "challans": [
    {
      "citizen": {
        "tenantId": "text",
        "uuid": "text",
        "userName": "text",
        "password": "text",
        "idToken": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "code": "text",
            "tenantId": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "code": "text",
                "tenantId": "text",
                "description": "text"
              }
            ]
          }
        ]
      },
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "challanNo": "text",
      "referenceId": "text",
      "description": "text",
      "accountId": "text",
      "applicationStatus": "text",
      "source": "whatsapp, ivr etc",
      "amount": [
        {
          "taxHeadCode": "text",
          "amount": 0
        }
      ],
      "address": {
        "tenantId": "text",
        "doorNo": "text",
        "plotNo": "text",
        "id": "text",
        "landmark": "text",
        "city": "text",
        "district": "text",
        "region": "text",
        "state": "text",
        "country": "text",
        "pincode": "text",
        "additionDetails": "text",
        "buildingName": "text",
        "street": "text",
        "geoLocation": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Get the list of existing challan details

Gets the list of service requests for a particular ULB based on search criteria.

POST/eChallan/v1/_search

Query parameters

Response

202400

Successful response sorted by reverse chrnological order of creation

Body

*/*

responseInfoResponseHeader (object)

ResponseHeader should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseHeader should always correspond to the same values in respective request's RequestHeader.

challansarray of any

Request

JavaScriptCurlPython

const response = await fetch('/eChallan/v1/_search?tenantId=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

202400

{
  "responseInfo": {
    "resMsgId": "text",
    "msgId": "text",
    "status": "COMPLETED",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    }
  },
  "challans": []
}

Get the list of count of paid, active, cancelled and total number of challan

Get the list of count of paid, active, cancelled and total number of challan for given tenant Id.

POST/eChallan/v1/_count

Query parameters

Response

200400

Successful response, present the list of count of challans for given tenant Id.

Body

*/*

responseInfoResponseHeader (object)

ResponseHeader should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseHeader should always correspond to the same values in respective request's RequestHeader.

ChallanCountChallanCount (object)

Capture the challan count details

Request

JavaScriptCurlPython

const response = await fetch('/eChallan/v1/_count?tenantId=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "resMsgId": "text",
    "msgId": "text",
    "status": "COMPLETED",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    }
  },
  "ChallanCount": {
    "paidChallan": "text",
    "cancelledChallan": "text",
    "activeChallan": "text",
    "totalChallan": "text"
  }
}

Miscellaneous Collection Calculator API Specs

Create new challan request

Generate the challan in the system with the defined attributes

POST/eChallan/v1/_create

Body

application/json

Request schema.

requestInfo*RequestHeader (object)

RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.

challan*Challan (object)

Capture the challan details

Response

202400

Application submitted successfully

Body

*/*

responseInfoResponseHeader (object)

ResponseHeader should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseHeader should always correspond to the same values in respective request's RequestHeader.

challansarray of any

Request

JavaScriptCurlPython

const response = await fetch('/eChallan/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "challan": {
        "tenantId": "text",
        "accountId": "text"
      }
    }),
});
const data = await response.json();

Response

202400

{
  "responseInfo": {
    "resMsgId": "text",
    "msgId": "text",
    "status": "COMPLETED",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    }
  },
  "challans": []
}

Update the existing challan details

Update the existing challan details

POST/eChallan/v1/_update

Body

application/json

Request schema.

requestInfo*RequestHeader (object)

RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.

challan*Challan (object)

Capture the challan details

Response

202400

Application submitted successfully

Body

*/*

any

Request

JavaScriptCurlPython

const response = await fetch('/eChallan/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestInfo": {
        "msgId": "text",
        "action": "text"
      },
      "challan": {
        "tenantId": "text",
        "accountId": "text"
      }
    }),
});
const data = await response.json();

Get the list of existing challan details

Gets the list of service requests for a particular ULB based on search criteria.

POST/eChallan/v1/_search

Query parameters

Response

202400

Successful response sorted by reverse chrnological order of creation

Body

*/*

responseInfoResponseHeader (object)

ResponseHeader should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseHeader should always correspond to the same values in respective request's RequestHeader.

challansarray of any

Request

JavaScriptCurlPython

const response = await fetch('/eChallan/v1/_search?tenantId=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

202400

{
  "responseInfo": {
    "resMsgId": "text",
    "msgId": "text",
    "status": "COMPLETED",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    }
  },
  "challans": []
}

Get the list of count of paid, active, cancelled and total number of challan

Get the list of count of paid, active, cancelled and total number of challan for given tenant Id.

POST/eChallan/v1/_count

Query parameters

Response

200400

Successful response, present the list of count of challans for given tenant Id.

Body

*/*

responseInfoResponseHeader (object)

ResponseHeader should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseHeader should always correspond to the same values in respective request's RequestHeader.

ChallanCountChallanCount (object)

Capture the challan count details

Request

JavaScriptCurlPython

const response = await fetch('/eChallan/v1/_count?tenantId=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "resMsgId": "text",
    "msgId": "text",
    "status": "COMPLETED",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    }
  },
  "ChallanCount": {
    "paidChallan": "text",
    "cancelledChallan": "text",
    "activeChallan": "text",
    "totalChallan": "text"
  }
}