eChallan

eChallan System APIs

API specs to generate new challans, update existing challans, search challans, and generate demand bills for the challan amount for collection purposes.

Create new challan request

Generate the challan in the system with the defined attributes

POST/eChallan/v1/_create

Body

application/json

Request schema.

ChallanChallanReq

RequestInfoRequestInfo

Response

202400

Application submitted successfully

Body

*/*

challanValidityinteger (int32)

challansarray of ChallanRes

countOfServicesinteger (int32)

responseInfoResponseInfo

totalAmountCollectedinteger (int32)

totalCountinteger (int32)

Request

JavaScriptCurlPython

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

Response

202400

{
  "challans": [
    {
      "accountId": "text",
      "address": {
        "addressId": "text",
        "addressLine1": "text",
        "addressLine2": "text",
        "addressNumber": "text",
        "buildingName": "text",
        "city": "text",
        "country": "text",
        "detail": "text",
        "district": "text",
        "doorNo": "text",
        "id": "text",
        "landmark": "text",
        "latitude": 0,
        "locality": {
          "children": [],
          "code": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "materializedPath": "text",
          "name": "text"
        },
        "longitude": 0,
        "pincode": "text",
        "plotNo": "text",
        "region": "text",
        "state": "text",
        "street": "text",
        "tenantId": "text",
        "type": "text"
      },
      "amount": [
        {
          "amount": 0,
          "taxHeadCode": "text"
        }
      ],
      "applicationStatus": "ACTIVE",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "businessService": "text",
      "calculation": {
        "challan": {
          "accountId": "text",
          "address": {
            "addressId": "text",
            "addressLine1": "text",
            "addressLine2": "text",
            "addressNumber": "text",
            "buildingName": "text",
            "city": "text",
            "country": "text",
            "detail": "text",
            "district": "text",
            "doorNo": "text",
            "id": "text",
            "landmark": "text",
            "latitude": 0,
            "locality": {
              "children": [],
              "code": "text",
              "label": "text",
              "latitude": "text",
              "longitude": "text",
              "materializedPath": "text",
              "name": "text"
            },
            "longitude": 0,
            "pincode": "text",
            "plotNo": "text",
            "region": "text",
            "state": "text",
            "street": "text",
            "tenantId": "text",
            "type": "text"
          },
          "amount": [
            {
              "amount": 0,
              "taxHeadCode": "text"
            }
          ],
          "applicationStatus": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "businessService": "text",
          "challanNo": "text",
          "citizen": {
            "aadhaarNumber": "text",
            "accountLocked": false,
            "active": false,
            "additionalroles": [
              {
                "roles": [
                  {
                    "code": "text",
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "tenantId": "text"
              }
            ],
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "email": "text",
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "idToken": "text",
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "primaryrole": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          },
          "description": "text",
          "filestoreid": "text",
          "id": "text",
          "receiptNumber": "text",
          "referenceId": "text",
          "source": "text",
          "tenantId": "text"
        },
        "challanNo": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 0,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text"
      },
      "challanNo": "text",
      "citizen": {
        "aadhaarNumber": "text",
        "accountLocked": false,
        "active": false,
        "additionalroles": [
          {
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text"
          }
        ],
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "email": "text",
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "idToken": "text",
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "primaryrole": [
          {
            "code": "text",
            "name": "text",
            "tenantId": "text"
          }
        ],
        "roles": [
          {
            "code": "text",
            "name": "text",
            "tenantId": "text"
          }
        ],
        "salutation": "text",
        "signature": "text",
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "description": "text",
      "filestoreid": "text",
      "id": "text",
      "receiptNumber": "text",
      "referenceId": "text",
      "source": "text",
      "tenantId": "text"
    }
  ],
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

Update the existing challan details

Update the existing challan details

POST/eChallan/v1/_update

Body

application/json

Request schema.

ChallanChallanReq

RequestInfoRequestInfo

Response

202400

Application submitted successfully

Body

*/*

challanValidityinteger (int32)

challansarray of ChallanRes

countOfServicesinteger (int32)

responseInfoResponseInfo

totalAmountCollectedinteger (int32)

totalCountinteger (int32)

Request

JavaScriptCurlPython

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

Response

202400

{
  "challans": [
    {
      "accountId": "text",
      "address": {
        "addressId": "text",
        "addressLine1": "text",
        "addressLine2": "text",
        "addressNumber": "text",
        "buildingName": "text",
        "city": "text",
        "country": "text",
        "detail": "text",
        "district": "text",
        "doorNo": "text",
        "id": "text",
        "landmark": "text",
        "latitude": 0,
        "locality": {
          "children": [],
          "code": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "materializedPath": "text",
          "name": "text"
        },
        "longitude": 0,
        "pincode": "text",
        "plotNo": "text",
        "region": "text",
        "state": "text",
        "street": "text",
        "tenantId": "text",
        "type": "text"
      },
      "amount": [
        {
          "amount": 0,
          "taxHeadCode": "text"
        }
      ],
      "applicationStatus": "ACTIVE",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "businessService": "text",
      "calculation": {
        "challan": {
          "accountId": "text",
          "address": {
            "addressId": "text",
            "addressLine1": "text",
            "addressLine2": "text",
            "addressNumber": "text",
            "buildingName": "text",
            "city": "text",
            "country": "text",
            "detail": "text",
            "district": "text",
            "doorNo": "text",
            "id": "text",
            "landmark": "text",
            "latitude": 0,
            "locality": {
              "children": [],
              "code": "text",
              "label": "text",
              "latitude": "text",
              "longitude": "text",
              "materializedPath": "text",
              "name": "text"
            },
            "longitude": 0,
            "pincode": "text",
            "plotNo": "text",
            "region": "text",
            "state": "text",
            "street": "text",
            "tenantId": "text",
            "type": "text"
          },
          "amount": [
            {
              "amount": 0,
              "taxHeadCode": "text"
            }
          ],
          "applicationStatus": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "businessService": "text",
          "challanNo": "text",
          "citizen": {
            "aadhaarNumber": "text",
            "accountLocked": false,
            "active": false,
            "additionalroles": [
              {
                "roles": [
                  {
                    "code": "text",
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "tenantId": "text"
              }
            ],
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "email": "text",
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "idToken": "text",
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "primaryrole": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          },
          "description": "text",
          "filestoreid": "text",
          "id": "text",
          "receiptNumber": "text",
          "referenceId": "text",
          "source": "text",
          "tenantId": "text"
        },
        "challanNo": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 0,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text"
      },
      "challanNo": "text",
      "citizen": {
        "aadhaarNumber": "text",
        "accountLocked": false,
        "active": false,
        "additionalroles": [
          {
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text"
          }
        ],
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "email": "text",
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "idToken": "text",
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "primaryrole": [
          {
            "code": "text",
            "name": "text",
            "tenantId": "text"
          }
        ],
        "roles": [
          {
            "code": "text",
            "name": "text",
            "tenantId": "text"
          }
        ],
        "salutation": "text",
        "signature": "text",
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "description": "text",
      "filestoreid": "text",
      "id": "text",
      "receiptNumber": "text",
      "referenceId": "text",
      "source": "text",
      "tenantId": "text"
    }
  ],
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "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

*/*

challanValidityinteger (int32)

challansarray of ChallanRes

countOfServicesinteger (int32)

responseInfoResponseInfo

totalAmountCollectedinteger (int32)

totalCountinteger (int32)

Request

JavaScriptCurlPython

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

Response

202400

{
  "challans": [
    {
      "accountId": "text",
      "address": {
        "addressId": "text",
        "addressLine1": "text",
        "addressLine2": "text",
        "addressNumber": "text",
        "buildingName": "text",
        "city": "text",
        "country": "text",
        "detail": "text",
        "district": "text",
        "doorNo": "text",
        "id": "text",
        "landmark": "text",
        "latitude": 0,
        "locality": {
          "children": [],
          "code": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "materializedPath": "text",
          "name": "text"
        },
        "longitude": 0,
        "pincode": "text",
        "plotNo": "text",
        "region": "text",
        "state": "text",
        "street": "text",
        "tenantId": "text",
        "type": "text"
      },
      "amount": [
        {
          "amount": 0,
          "taxHeadCode": "text"
        }
      ],
      "applicationStatus": "ACTIVE",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      },
      "businessService": "text",
      "calculation": {
        "challan": {
          "accountId": "text",
          "address": {
            "addressId": "text",
            "addressLine1": "text",
            "addressLine2": "text",
            "addressNumber": "text",
            "buildingName": "text",
            "city": "text",
            "country": "text",
            "detail": "text",
            "district": "text",
            "doorNo": "text",
            "id": "text",
            "landmark": "text",
            "latitude": 0,
            "locality": {
              "children": [],
              "code": "text",
              "label": "text",
              "latitude": "text",
              "longitude": "text",
              "materializedPath": "text",
              "name": "text"
            },
            "longitude": 0,
            "pincode": "text",
            "plotNo": "text",
            "region": "text",
            "state": "text",
            "street": "text",
            "tenantId": "text",
            "type": "text"
          },
          "amount": [
            {
              "amount": 0,
              "taxHeadCode": "text"
            }
          ],
          "applicationStatus": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          },
          "businessService": "text",
          "challanNo": "text",
          "citizen": {
            "aadhaarNumber": "text",
            "accountLocked": false,
            "active": false,
            "additionalroles": [
              {
                "roles": [
                  {
                    "code": "text",
                    "name": "text",
                    "tenantId": "text"
                  }
                ],
                "tenantId": "text"
              }
            ],
            "altContactNumber": "text",
            "bloodGroup": "text",
            "correspondenceAddress": "text",
            "correspondenceCity": "text",
            "correspondencePinCode": "text",
            "createdBy": "text",
            "email": "text",
            "emailId": "text",
            "fatherOrHusbandName": "text",
            "gender": "text",
            "idToken": "text",
            "identificationMark": "text",
            "lastModifiedBy": "text",
            "locale": "text",
            "mobileNumber": "text",
            "name": "text",
            "otpReference": "text",
            "pan": "text",
            "password": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPinCode": "text",
            "photo": "text",
            "primaryrole": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "salutation": "text",
            "signature": "text",
            "tenantId": "text",
            "type": "text",
            "userName": "text",
            "uuid": "text"
          },
          "description": "text",
          "filestoreid": "text",
          "id": "text",
          "receiptNumber": "text",
          "referenceId": "text",
          "source": "text",
          "tenantId": "text"
        },
        "challanNo": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION",
            "estimateAmount": 0,
            "taxHeadCode": "text"
          }
        ],
        "tenantId": "text"
      },
      "challanNo": "text",
      "citizen": {
        "aadhaarNumber": "text",
        "accountLocked": false,
        "active": false,
        "additionalroles": [
          {
            "roles": [
              {
                "code": "text",
                "name": "text",
                "tenantId": "text"
              }
            ],
            "tenantId": "text"
          }
        ],
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "email": "text",
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "idToken": "text",
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "primaryrole": [
          {
            "code": "text",
            "name": "text",
            "tenantId": "text"
          }
        ],
        "roles": [
          {
            "code": "text",
            "name": "text",
            "tenantId": "text"
          }
        ],
        "salutation": "text",
        "signature": "text",
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "description": "text",
      "filestoreid": "text",
      "id": "text",
      "receiptNumber": "text",
      "referenceId": "text",
      "source": "text",
      "tenantId": "text"
    }
  ],
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ver": "text"
  }
}

count

POST/eChallan/v1/_count

Query parameters

Body

application/json

actionstring

apiIdstring

authTokenstring

correlationIdstring

didstring

keystring

msgIdstring

tsinteger (int64)

userInfoUser

verstring

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurlPython

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

test

POST/eChallan/v1/_test

Body

application/json

ChallanChallanReq

RequestInfoRequestInfo

Response

200201401403404

OK

Body

*/*

bodyobject

statusCodeenum

ACCEPTEDALREADY_REPORTEDBAD_GATEWAYBAD_REQUESTBANDWIDTH_LIMIT_EXCEEDEDCHECKPOINTCONFLICTCONTINUECREATEDDESTINATION_LOCKEDEXPECTATION_FAILEDFAILED_DEPENDENCYFORBIDDENFOUNDGATEWAY_TIMEOUTGONEHTTP_VERSION_NOT_SUPPORTEDIM_USEDINSUFFICIENT_SPACE_ON_RESOURCEINSUFFICIENT_STORAGEINTERNAL_SERVER_ERRORI_AM_A_TEAPOTLENGTH_REQUIREDLOCKEDLOOP_DETECTEDMETHOD_FAILUREMETHOD_NOT_ALLOWEDMOVED_PERMANENTLYMOVED_TEMPORARILYMULTIPLE_CHOICESMULTI_STATUSNETWORK_AUTHENTICATION_REQUIREDNON_AUTHORITATIVE_INFORMATIONNOT_ACCEPTABLENOT_EXTENDEDNOT_FOUNDNOT_IMPLEMENTEDNOT_MODIFIEDNO_CONTENTOKPARTIAL_CONTENTPAYLOAD_TOO_LARGEPAYMENT_REQUIREDPERMANENT_REDIRECTPRECONDITION_FAILEDPRECONDITION_REQUIREDPROCESSINGPROXY_AUTHENTICATION_REQUIREDREQUESTED_RANGE_NOT_SATISFIABLEREQUEST_ENTITY_TOO_LARGEREQUEST_HEADER_FIELDS_TOO_LARGEREQUEST_TIMEOUTREQUEST_URI_TOO_LONGRESET_CONTENTSEE_OTHERSERVICE_UNAVAILABLESWITCHING_PROTOCOLSTEMPORARY_REDIRECTTOO_EARLYTOO_MANY_REQUESTSUNAUTHORIZEDUNAVAILABLE_FOR_LEGAL_REASONSUNPROCESSABLE_ENTITYUNSUPPORTED_MEDIA_TYPEUPGRADE_REQUIREDURI_TOO_LONGUSE_PROXYVARIANT_ALSO_NEGOTIATES

statusCodeValueinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/eChallan/v1/_test', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "statusCode": "ACCEPTED"
}