Miscellaneous Collection API

eChallan Service

Create new challan request

Generate the challan in the system with the defined attributes

post

/eChallan/v1/_create

Body

requestInfoobjectrequired

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.

challanobjectrequired

Capture the challan details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{},"deviceDetail":{},"ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"code":"text","tenantId":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"code":"text","tenantId":"text"}]}]}},"challan":{"citizen":{"tenantId":"text","userName":"text","primaryrole":[{"code":"text","tenantId":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"code":"text","tenantId":"text"}]}]},"tenantId":"text","accountId":"text","additionalDetail":{},"source":"whatsapp, ivr etc","address":{"tenantId":"text","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]},"geoLocation":{"additionalDetails":{}}},"auditDetails":{},"amount":[{}]}}'

202

400

202

{
  "responseInfo": {
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    },
    "information": {},
    "debug": {},
    "additionalInfo": {},
    "status": "COMPLETED"
  },
  "challans": [
    {
      "citizen": {
        "tenantId": "text",
        "userName": "text",
        "primaryrole": [
          {
            "code": "text",
            "tenantId": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "code": "text",
                "tenantId": "text"
              }
            ]
          }
        ]
      },
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "challanNo": "text",
      "referenceId": "text",
      "description": "text",
      "accountId": "text",
      "additionalDetail": {},
      "applicationStatus": "text",
      "source": "whatsapp, ivr etc",
      "address": {
        "tenantId": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "additionalDetails": {}
        }
      },
      "auditDetails": {},
      "amount": [
        {}
      ]
    }
  ]
}

Application submitted successfully

Update the existing challan details

Update the existing challan details

post

/eChallan/v1/_update

Body

requestInfoobjectrequired

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.

challanobjectrequired

Capture the challan details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{},"deviceDetail":{},"ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"code":"text","tenantId":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"code":"text","tenantId":"text"}]}]}},"challan":{"citizen":{"tenantId":"text","userName":"text","primaryrole":[{"code":"text","tenantId":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"code":"text","tenantId":"text"}]}]},"tenantId":"text","accountId":"text","additionalDetail":{},"source":"whatsapp, ivr etc","address":{"tenantId":"text","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]},"geoLocation":{"additionalDetails":{}}},"auditDetails":{},"amount":[{}]}}'

202

400

202

{
  "responseInfo": {
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    },
    "information": {},
    "debug": {},
    "additionalInfo": {},
    "status": "COMPLETED"
  },
  "challans": [
    {
      "citizen": {
        "tenantId": "text",
        "userName": "text",
        "primaryrole": [
          {
            "code": "text",
            "tenantId": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "code": "text",
                "tenantId": "text"
              }
            ]
          }
        ]
      },
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "challanNo": "text",
      "referenceId": "text",
      "description": "text",
      "accountId": "text",
      "additionalDetail": {},
      "applicationStatus": "text",
      "source": "whatsapp, ivr etc",
      "address": {
        "tenantId": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "additionalDetails": {}
        }
      },
      "auditDetails": {},
      "amount": [
        {}
      ]
    }
  ]
}

Application submitted successfully

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

tenantIdstring · varcharrequired

Unique id for a tenant.

serviceCodestring[]

Allows search for service type - comma separated list

idsstring[]

Search by list of UUID

mobileNostring

Search by mobile number citizen

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_search?tenantId=text'

202

400

202

{
  "responseInfo": {
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    },
    "information": {},
    "debug": {},
    "additionalInfo": {},
    "status": "COMPLETED"
  },
  "challans": [
    {
      "citizen": {
        "tenantId": "text",
        "userName": "text",
        "primaryrole": [
          {
            "code": "text",
            "tenantId": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "code": "text",
                "tenantId": "text"
              }
            ]
          }
        ]
      },
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "challanNo": "text",
      "referenceId": "text",
      "description": "text",
      "accountId": "text",
      "additionalDetail": {},
      "applicationStatus": "text",
      "source": "whatsapp, ivr etc",
      "address": {
        "tenantId": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "additionalDetails": {}
        }
      },
      "auditDetails": {},
      "amount": [
        {}
      ]
    }
  ]
}

Successful response sorted by reverse chrnological order of creation

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

tenantIdstring · varcharrequired

Unique id for a tenant.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_count?tenantId=text'

200

400

200

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

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

Miscellaneous Collection Calculator API Specs

Create new challan request

Generate the challan in the system with the defined attributes

post

/eChallan/v1/_create

Body

requestInfoobjectrequired

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.

challanobjectrequired

Capture the challan details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{},"deviceDetail":{},"ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"code":"text","tenantId":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"code":"text","tenantId":"text"}]}]}},"challan":{"citizen":{"tenantId":"text","userName":"text","primaryrole":[{"code":"text","tenantId":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"code":"text","tenantId":"text"}]}]},"tenantId":"text","accountId":"text","additionalDetail":{},"source":"whatsapp, ivr etc","address":{"tenantId":"text","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]},"geoLocation":{"additionalDetails":{}}},"auditDetails":{},"amount":[{}]}}'

202

400

202

{
  "responseInfo": {
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    },
    "information": {},
    "debug": {},
    "additionalInfo": {},
    "status": "COMPLETED"
  },
  "challans": [
    {
      "citizen": {
        "tenantId": "text",
        "userName": "text",
        "primaryrole": [
          {
            "code": "text",
            "tenantId": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "code": "text",
                "tenantId": "text"
              }
            ]
          }
        ]
      },
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "challanNo": "text",
      "referenceId": "text",
      "description": "text",
      "accountId": "text",
      "additionalDetail": {},
      "applicationStatus": "text",
      "source": "whatsapp, ivr etc",
      "address": {
        "tenantId": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "additionalDetails": {}
        }
      },
      "auditDetails": {},
      "amount": [
        {}
      ]
    }
  ]
}

Application submitted successfully

Update the existing challan details

Update the existing challan details

post

/eChallan/v1/_update

Body

requestInfoobjectrequired

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.

challanobjectrequired

Capture the challan details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiInfo":{},"deviceDetail":{},"ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"code":"text","tenantId":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"code":"text","tenantId":"text"}]}]}},"challan":{"citizen":{"tenantId":"text","userName":"text","primaryrole":[{"code":"text","tenantId":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"code":"text","tenantId":"text"}]}]},"tenantId":"text","accountId":"text","additionalDetail":{},"source":"whatsapp, ivr etc","address":{"tenantId":"text","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]},"geoLocation":{"additionalDetails":{}}},"auditDetails":{},"amount":[{}]}}'

202

400

202

{
  "responseInfo": {
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    },
    "information": {},
    "debug": {},
    "additionalInfo": {},
    "status": "COMPLETED"
  },
  "challans": [
    {
      "citizen": {
        "tenantId": "text",
        "userName": "text",
        "primaryrole": [
          {
            "code": "text",
            "tenantId": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "code": "text",
                "tenantId": "text"
              }
            ]
          }
        ]
      },
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "challanNo": "text",
      "referenceId": "text",
      "description": "text",
      "accountId": "text",
      "additionalDetail": {},
      "applicationStatus": "text",
      "source": "whatsapp, ivr etc",
      "address": {
        "tenantId": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "additionalDetails": {}
        }
      },
      "auditDetails": {},
      "amount": [
        {}
      ]
    }
  ]
}

Application submitted successfully

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

tenantIdstring · varcharrequired

Unique id for a tenant.

serviceCodestring[]

Allows search for service type - comma separated list

idsstring[]

Search by list of UUID

mobileNostring

Search by mobile number citizen

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_search?tenantId=text'

202

400

202

{
  "responseInfo": {
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "signature": "text",
    "error": {
      "code": "text",
      "message": "text",
      "description": "text",
      "params": [
        "text"
      ]
    },
    "information": {},
    "debug": {},
    "additionalInfo": {},
    "status": "COMPLETED"
  },
  "challans": [
    {
      "citizen": {
        "tenantId": "text",
        "userName": "text",
        "primaryrole": [
          {
            "code": "text",
            "tenantId": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "code": "text",
                "tenantId": "text"
              }
            ]
          }
        ]
      },
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "challanNo": "text",
      "referenceId": "text",
      "description": "text",
      "accountId": "text",
      "additionalDetail": {},
      "applicationStatus": "text",
      "source": "whatsapp, ivr etc",
      "address": {
        "tenantId": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "geoLocation": {
          "additionalDetails": {}
        }
      },
      "auditDetails": {},
      "amount": [
        {}
      ]
    }
  ]
}

Successful response sorted by reverse chrnological order of creation

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

tenantIdstring · varcharrequired

Unique id for a tenant.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_count?tenantId=text'

200

400

200

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

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