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

ChallanChallanReq

RequestInfoRequestInfo

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"Challan":{"additionalDetail":{},"address":{"locality":{"code":"text","children":[{"code":"text","children":"[Circular Reference]"}]}},"auditDetails":{},"calculation":{"challan":{"additionalDetail":{},"address":{"locality":{"code":"text","children":[{"code":"text","children":"[Circular Reference]"}]}},"auditDetails":{},"calculation":{"challan":{"additionalDetail":{},"address":{"locality":{"code":"text","children":[{"code":"text","children":"[Circular Reference]"}]}},"auditDetails":{},"calculation":"[Circular Reference]","citizen":{"mobileNumber":"text","name":"text","additionalroles":[{"roles":[{}]}],"primaryrole":[{}],"roles":[{}]},"applicationStatus":"ACTIVE","amount":[{}]},"tenantId":"text","taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"citizen":{"mobileNumber":"text","name":"text","additionalroles":[{"roles":[{}]}],"primaryrole":[{}],"roles":[{}]},"applicationStatus":"ACTIVE","amount":[{}]},"tenantId":"text","taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"citizen":{"mobileNumber":"text","name":"text","additionalroles":[{"roles":[{}]}],"primaryrole":[{}],"roles":[{}]},"applicationStatus":"ACTIVE","amount":[{}]},"RequestInfo":{"userInfo":{"roles":[{}]}}}'

202

400

202

{
  "challanValidity": 1,
  "countOfServices": 1,
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalAmountCollected": 1,
  "totalCount": 1,
  "challans": [
    {
      "accountId": "text",
      "additionalDetail": {},
      "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": 1,
        "locality": {
          "code": "text",
          "children": [
            {
              "code": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "longitude": 1,
        "pincode": "text",
        "plotNo": "text",
        "region": "text",
        "state": "text",
        "street": "text",
        "tenantId": "text",
        "type": "text"
      },
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "challan": {
          "additionalDetail": {},
          "address": {
            "locality": {
              "code": "text",
              "children": [
                {
                  "code": "text",
                  "children": "[Circular Reference]"
                }
              ]
            }
          },
          "auditDetails": {},
          "calculation": {
            "challan": {
              "additionalDetail": {},
              "address": {
                "locality": {
                  "code": "text",
                  "children": [
                    {
                      "code": "text",
                      "children": "[Circular Reference]"
                    }
                  ]
                }
              },
              "auditDetails": {},
              "calculation": "[Circular Reference]",
              "citizen": {
                "mobileNumber": "text",
                "name": "text",
                "additionalroles": [
                  {
                    "roles": [
                      {}
                    ]
                  }
                ],
                "primaryrole": [
                  {}
                ],
                "roles": [
                  {}
                ]
              },
              "applicationStatus": "ACTIVE",
              "amount": [
                {}
              ]
            },
            "tenantId": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION"
              }
            ]
          },
          "citizen": {
            "mobileNumber": "text",
            "name": "text",
            "additionalroles": [
              {
                "roles": [
                  {}
                ]
              }
            ],
            "primaryrole": [
              {}
            ],
            "roles": [
              {}
            ]
          },
          "applicationStatus": "ACTIVE",
          "amount": [
            {}
          ]
        },
        "challanNo": "text",
        "tenantId": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION"
          }
        ]
      },
      "challanNo": "text",
      "citizen": {
        "aadhaarNumber": "text",
        "accountLocked": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "email": "text",
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "idToken": "text",
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "salutation": "text",
        "signature": "text",
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text",
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ]
          }
        ],
        "primaryrole": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ]
      },
      "description": "text",
      "filestoreid": "text",
      "id": "text",
      "receiptNumber": "text",
      "referenceId": "text",
      "source": "text",
      "taxPeriodFrom": 1,
      "taxPeriodTo": 1,
      "tenantId": "text",
      "applicationStatus": "ACTIVE",
      "amount": [
        {
          "amount": 1,
          "taxHeadCode": "text"
        }
      ]
    }
  ]
}

Application submitted successfully

Update the existing challan details

Update the existing challan details

post

/eChallan/v1/_update

Body

ChallanChallanReq

RequestInfoRequestInfo

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"Challan":{"additionalDetail":{},"address":{"locality":{"code":"text","children":[{"code":"text","children":"[Circular Reference]"}]}},"auditDetails":{},"calculation":{"challan":{"additionalDetail":{},"address":{"locality":{"code":"text","children":[{"code":"text","children":"[Circular Reference]"}]}},"auditDetails":{},"calculation":{"challan":{"additionalDetail":{},"address":{"locality":{"code":"text","children":[{"code":"text","children":"[Circular Reference]"}]}},"auditDetails":{},"calculation":"[Circular Reference]","citizen":{"mobileNumber":"text","name":"text","additionalroles":[{"roles":[{}]}],"primaryrole":[{}],"roles":[{}]},"applicationStatus":"ACTIVE","amount":[{}]},"tenantId":"text","taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"citizen":{"mobileNumber":"text","name":"text","additionalroles":[{"roles":[{}]}],"primaryrole":[{}],"roles":[{}]},"applicationStatus":"ACTIVE","amount":[{}]},"tenantId":"text","taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"citizen":{"mobileNumber":"text","name":"text","additionalroles":[{"roles":[{}]}],"primaryrole":[{}],"roles":[{}]},"applicationStatus":"ACTIVE","amount":[{}]},"RequestInfo":{"userInfo":{"roles":[{}]}}}'

202

400

202

{
  "challanValidity": 1,
  "countOfServices": 1,
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalAmountCollected": 1,
  "totalCount": 1,
  "challans": [
    {
      "accountId": "text",
      "additionalDetail": {},
      "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": 1,
        "locality": {
          "code": "text",
          "children": [
            {
              "code": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "longitude": 1,
        "pincode": "text",
        "plotNo": "text",
        "region": "text",
        "state": "text",
        "street": "text",
        "tenantId": "text",
        "type": "text"
      },
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "challan": {
          "additionalDetail": {},
          "address": {
            "locality": {
              "code": "text",
              "children": [
                {
                  "code": "text",
                  "children": "[Circular Reference]"
                }
              ]
            }
          },
          "auditDetails": {},
          "calculation": {
            "challan": {
              "additionalDetail": {},
              "address": {
                "locality": {
                  "code": "text",
                  "children": [
                    {
                      "code": "text",
                      "children": "[Circular Reference]"
                    }
                  ]
                }
              },
              "auditDetails": {},
              "calculation": "[Circular Reference]",
              "citizen": {
                "mobileNumber": "text",
                "name": "text",
                "additionalroles": [
                  {
                    "roles": [
                      {}
                    ]
                  }
                ],
                "primaryrole": [
                  {}
                ],
                "roles": [
                  {}
                ]
              },
              "applicationStatus": "ACTIVE",
              "amount": [
                {}
              ]
            },
            "tenantId": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION"
              }
            ]
          },
          "citizen": {
            "mobileNumber": "text",
            "name": "text",
            "additionalroles": [
              {
                "roles": [
                  {}
                ]
              }
            ],
            "primaryrole": [
              {}
            ],
            "roles": [
              {}
            ]
          },
          "applicationStatus": "ACTIVE",
          "amount": [
            {}
          ]
        },
        "challanNo": "text",
        "tenantId": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION"
          }
        ]
      },
      "challanNo": "text",
      "citizen": {
        "aadhaarNumber": "text",
        "accountLocked": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "email": "text",
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "idToken": "text",
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "salutation": "text",
        "signature": "text",
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text",
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ]
          }
        ],
        "primaryrole": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ]
      },
      "description": "text",
      "filestoreid": "text",
      "id": "text",
      "receiptNumber": "text",
      "referenceId": "text",
      "source": "text",
      "taxPeriodFrom": 1,
      "taxPeriodTo": 1,
      "tenantId": "text",
      "applicationStatus": "ACTIVE",
      "amount": [
        {
          "amount": 1,
          "taxHeadCode": "text"
        }
      ]
    }
  ]
}

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

{
  "challanValidity": 1,
  "countOfServices": 1,
  "responseInfo": {
    "apiId": "text",
    "msgId": "text",
    "resMsgId": "text",
    "status": "text",
    "ts": 1,
    "ver": "text"
  },
  "totalAmountCollected": 1,
  "totalCount": 1,
  "challans": [
    {
      "accountId": "text",
      "additionalDetail": {},
      "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": 1,
        "locality": {
          "code": "text",
          "children": [
            {
              "code": "text",
              "children": "[Circular Reference]"
            }
          ]
        },
        "longitude": 1,
        "pincode": "text",
        "plotNo": "text",
        "region": "text",
        "state": "text",
        "street": "text",
        "tenantId": "text",
        "type": "text"
      },
      "auditDetails": {
        "createdBy": "text",
        "createdTime": 1,
        "lastModifiedBy": "text",
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "calculation": {
        "challan": {
          "additionalDetail": {},
          "address": {
            "locality": {
              "code": "text",
              "children": [
                {
                  "code": "text",
                  "children": "[Circular Reference]"
                }
              ]
            }
          },
          "auditDetails": {},
          "calculation": {
            "challan": {
              "additionalDetail": {},
              "address": {
                "locality": {
                  "code": "text",
                  "children": [
                    {
                      "code": "text",
                      "children": "[Circular Reference]"
                    }
                  ]
                }
              },
              "auditDetails": {},
              "calculation": "[Circular Reference]",
              "citizen": {
                "mobileNumber": "text",
                "name": "text",
                "additionalroles": [
                  {
                    "roles": [
                      {}
                    ]
                  }
                ],
                "primaryrole": [
                  {}
                ],
                "roles": [
                  {}
                ]
              },
              "applicationStatus": "ACTIVE",
              "amount": [
                {}
              ]
            },
            "tenantId": "text",
            "taxHeadEstimates": [
              {
                "category": "ADVANCE_COLLECTION"
              }
            ]
          },
          "citizen": {
            "mobileNumber": "text",
            "name": "text",
            "additionalroles": [
              {
                "roles": [
                  {}
                ]
              }
            ],
            "primaryrole": [
              {}
            ],
            "roles": [
              {}
            ]
          },
          "applicationStatus": "ACTIVE",
          "amount": [
            {}
          ]
        },
        "challanNo": "text",
        "tenantId": "text",
        "taxHeadEstimates": [
          {
            "category": "ADVANCE_COLLECTION"
          }
        ]
      },
      "challanNo": "text",
      "citizen": {
        "aadhaarNumber": "text",
        "accountLocked": true,
        "active": true,
        "altContactNumber": "text",
        "bloodGroup": "text",
        "correspondenceAddress": "text",
        "correspondenceCity": "text",
        "correspondencePinCode": "text",
        "createdBy": "text",
        "createdDate": 1,
        "dob": 1,
        "email": "text",
        "emailId": "text",
        "fatherOrHusbandName": "text",
        "gender": "text",
        "id": 1,
        "idToken": "text",
        "identificationMark": "text",
        "lastModifiedBy": "text",
        "lastModifiedDate": 1,
        "locale": "text",
        "mobileNumber": "text",
        "name": "text",
        "otpReference": "text",
        "pan": "text",
        "password": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPinCode": "text",
        "photo": "text",
        "pwdExpiryDate": 1,
        "salutation": "text",
        "signature": "text",
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text",
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "code": "text",
                "id": 1,
                "name": "text",
                "tenantId": "text"
              }
            ]
          }
        ],
        "primaryrole": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ],
        "roles": [
          {
            "code": "text",
            "id": 1,
            "name": "text",
            "tenantId": "text"
          }
        ]
      },
      "description": "text",
      "filestoreid": "text",
      "id": "text",
      "receiptNumber": "text",
      "referenceId": "text",
      "source": "text",
      "taxPeriodFrom": 1,
      "taxPeriodTo": 1,
      "tenantId": "text",
      "applicationStatus": "ACTIVE",
      "amount": [
        {
          "amount": 1,
          "taxHeadCode": "text"
        }
      ]
    }
  ]
}

Successful response sorted by reverse chrnological order of creation

count

post

/eChallan/v1/_count

Query parameters

tenantIdstringrequired

tenantId

Body

actionstring

apiIdstring

authTokenstring

correlationIdstring

didstring

keystring

msgIdstring

tsinteger · int64

userInfoUser

verstring

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_count?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"userInfo":{"roles":[{}]}}'

200

201

401

403

404

200

{}

OK

test

post

/eChallan/v1/_test

Body

ChallanChallanReq

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/eChallan/v1/_test' \
  --header 'Content-Type: application/json' \
  --data '{"Challan":{"additionalDetail":{},"address":{"locality":{"code":"text","children":[{"code":"text","children":"[Circular Reference]"}]}},"auditDetails":{},"calculation":{"challan":{"additionalDetail":{},"address":{"locality":{"code":"text","children":[{"code":"text","children":"[Circular Reference]"}]}},"auditDetails":{},"calculation":{"challan":{"additionalDetail":{},"address":{"locality":{"code":"text","children":[{"code":"text","children":"[Circular Reference]"}]}},"auditDetails":{},"calculation":"[Circular Reference]","citizen":{"mobileNumber":"text","name":"text","additionalroles":[{"roles":[{}]}],"primaryrole":[{}],"roles":[{}]},"applicationStatus":"ACTIVE","amount":[{}]},"tenantId":"text","taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"citizen":{"mobileNumber":"text","name":"text","additionalroles":[{"roles":[{}]}],"primaryrole":[{}],"roles":[{}]},"applicationStatus":"ACTIVE","amount":[{}]},"tenantId":"text","taxHeadEstimates":[{"category":"ADVANCE_COLLECTION"}]},"citizen":{"mobileNumber":"text","name":"text","additionalroles":[{"roles":[{}]}],"primaryrole":[{}],"roles":[{}]},"applicationStatus":"ACTIVE","amount":[{}]},"RequestInfo":{"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

200

{
  "body": {},
  "statusCodeValue": 1,
  "statusCode": "ACCEPTED"
}

OK