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.
Generate the challan in the system with the defined attributes
Body
Responses
202
Application submitted successfully
*/*
400
Failed to process the application
*/*
post
POST /eChallan/v1/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 6860
{
"Challan": {
"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": {
"children": [
{
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": {
"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": {
"children": [
{
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": {
"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": {
"children": [
{
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": "[Circular Reference]",
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"RequestInfo": {
"action": "text",
"apiId": "text",
"authToken": "text",
"correlationId": "text",
"did": "text",
"key": "text",
"msgId": "text",
"ts": 1,
"userInfo": {
"emailId": "text",
"id": 1,
"mobileNumber": "text",
"name": "text",
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ver": "text"
}
}{
"challanValidity": 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": {
"children": [
"[Circular Reference]"
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": {
"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": {
"children": [
"[Circular Reference]"
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": "[Circular Reference]",
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
}
],
"countOfServices": 1,
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
},
"totalAmountCollected": 1,
"totalCount": 1
}Update the existing challan details
Body
Responses
202
Application submitted successfully
*/*
400
Failed to process the application
*/*
post
POST /eChallan/v1/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 6860
{
"Challan": {
"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": {
"children": [
{
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": {
"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": {
"children": [
{
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": {
"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": {
"children": [
{
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": "[Circular Reference]",
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"RequestInfo": {
"action": "text",
"apiId": "text",
"authToken": "text",
"correlationId": "text",
"did": "text",
"key": "text",
"msgId": "text",
"ts": 1,
"userInfo": {
"emailId": "text",
"id": 1,
"mobileNumber": "text",
"name": "text",
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ver": "text"
}
}{
"challanValidity": 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": {
"children": [
"[Circular Reference]"
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": {
"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": {
"children": [
"[Circular Reference]"
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": "[Circular Reference]",
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
}
],
"countOfServices": 1,
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
},
"totalAmountCollected": 1,
"totalCount": 1
}Gets the list of service requests for a particular ULB based on search criteria.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
serviceCodestring[]Optional
Allows search for service type - comma separated list
idsstring[]Optional
Search by list of UUID
mobileNostringOptional
Search by mobile number citizen
Responses
202
Successful response sorted by reverse chrnological order of creation
*/*
400
Invalid input.
*/*
post
POST /eChallan/v1/_search?tenantId=text HTTP/1.1
Host:
Accept: */*
{
"challanValidity": 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": {
"children": [
"[Circular Reference]"
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": {
"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": {
"children": [
"[Circular Reference]"
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": "[Circular Reference]",
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
}
],
"countOfServices": 1,
"responseInfo": {
"apiId": "text",
"msgId": "text",
"resMsgId": "text",
"status": "text",
"ts": 1,
"ver": "text"
},
"totalAmountCollected": 1,
"totalCount": 1
}Query parameters
tenantIdstringRequired
tenantId
Body
actionstringOptional
apiIdstringOptional
authTokenstringOptional
correlationIdstringOptional
didstringOptional
keystringOptional
msgIdstringOptional
tsinteger · int64Optional
verstringOptional
Responses
200
OK
*/*
Responseobject
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /eChallan/v1/_count?tenantId=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 337
{
"action": "text",
"apiId": "text",
"authToken": "text",
"correlationId": "text",
"did": "text",
"key": "text",
"msgId": "text",
"ts": 1,
"userInfo": {
"emailId": "text",
"id": 1,
"mobileNumber": "text",
"name": "text",
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ver": "text"
}{}Body
Responses
200
OK
*/*
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /eChallan/v1/_test HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 6860
{
"Challan": {
"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": {
"children": [
{
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": {
"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": {
"children": [
{
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": {
"challan": {
"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": {
"children": [
{
"children": "[Circular Reference]",
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
}
],
"code": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"materializedPath": "text",
"name": "text"
},
"longitude": 1,
"pincode": "text",
"plotNo": "text",
"region": "text",
"state": "text",
"street": "text",
"tenantId": "text",
"type": "text"
},
"amount": [
{
"amount": 1,
"taxHeadCode": "text"
}
],
"applicationStatus": "ACTIVE",
"auditDetails": {
"createdBy": "text",
"createdTime": 1,
"lastModifiedBy": "text",
"lastModifiedTime": 1
},
"businessService": "text",
"calculation": "[Circular Reference]",
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"challanNo": "text",
"taxHeadEstimates": [
{
"category": "ADVANCE_COLLECTION",
"estimateAmount": 1,
"taxHeadCode": "text"
}
],
"tenantId": "text"
},
"challanNo": "text",
"citizen": {
"aadhaarNumber": "text",
"accountLocked": true,
"active": true,
"additionalroles": [
{
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text"
}
],
"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",
"primaryrole": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"pwdExpiryDate": 1,
"roles": [
{
"code": "text",
"id": 1,
"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",
"taxPeriodFrom": 1,
"taxPeriodTo": 1,
"tenantId": "text"
},
"RequestInfo": {
"action": "text",
"apiId": "text",
"authToken": "text",
"correlationId": "text",
"did": "text",
"key": "text",
"msgId": "text",
"ts": 1,
"userInfo": {
"emailId": "text",
"id": 1,
"mobileNumber": "text",
"name": "text",
"roles": [
{
"code": "text",
"id": 1,
"name": "text",
"tenantId": "text"
}
],
"tenantId": "text",
"type": "text",
"userName": "text",
"uuid": "text"
},
"ver": "text"
}
}{
"body": {},
"statusCode": "ACCEPTED",
"statusCodeValue": 1
}Last updated
Was this helpful?