Miscellaneous Collection API
eChallan Service
Generate the challan in the system with the defined attributes
Body
Request object to fetch the report data
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: 970
{
"requestInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"signature": "text"
},
"challan": {
"tenantId": "text",
"businessService": "text",
"referenceId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"amount": [
{
"taxHeadCode": "text",
"amount": 1
}
],
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
}
}
}{
"responseInfo": {
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "COMPLETED",
"signature": "text",
"error": {
"code": "text",
"message": "text",
"description": "text",
"params": [
"text"
]
},
"information": {},
"debug": {},
"additionalInfo": {}
},
"challans": [
{
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"businessService": "text",
"challanNo": "text",
"referenceId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"amount": [
{
"taxHeadCode": "text",
"amount": 1
}
],
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}Update the existing challan details
Body
Request object to fetch the report data
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: 970
{
"requestInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"signature": "text"
},
"challan": {
"tenantId": "text",
"businessService": "text",
"referenceId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"amount": [
{
"taxHeadCode": "text",
"amount": 1
}
],
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
}
}
}{
"responseInfo": {
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "COMPLETED",
"signature": "text",
"error": {
"code": "text",
"message": "text",
"description": "text",
"params": [
"text"
]
},
"information": {},
"debug": {},
"additionalInfo": {}
},
"challans": [
{
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"businessService": "text",
"challanNo": "text",
"referenceId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"amount": [
{
"taxHeadCode": "text",
"amount": 1
}
],
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 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: */*
{
"responseInfo": {
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "COMPLETED",
"signature": "text",
"error": {
"code": "text",
"message": "text",
"description": "text",
"params": [
"text"
]
},
"information": {},
"debug": {},
"additionalInfo": {}
},
"challans": [
{
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"businessService": "text",
"challanNo": "text",
"referenceId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"amount": [
{
"taxHeadCode": "text",
"amount": 1
}
],
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}Get the list of count of paid, active, cancelled and total number of challan for given tenant Id.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
Responses
200
Successful response, present the list of count of challans for given tenant Id.
*/*
400
Invalid input.
*/*
post
POST /eChallan/v1/_count?tenantId=text HTTP/1.1
Host:
Accept: */*
{
"responseInfo": {
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "COMPLETED",
"signature": "text",
"error": {
"code": "text",
"message": "text",
"description": "text",
"params": [
"text"
]
},
"information": {},
"debug": {},
"additionalInfo": {}
},
"ChallanCount": {
"paidChallan": "text",
"cancelledChallan": "text",
"activeChallan": "text",
"totalChallan": "text"
}
}Miscellaneous Collection Calculator API Specs
Generate the challan in the system with the defined attributes
Body
Request object to fetch the report data
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: 970
{
"requestInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"signature": "text"
},
"challan": {
"tenantId": "text",
"businessService": "text",
"referenceId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"amount": [
{
"taxHeadCode": "text",
"amount": 1
}
],
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
}
}
}{
"responseInfo": {
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "COMPLETED",
"signature": "text",
"error": {
"code": "text",
"message": "text",
"description": "text",
"params": [
"text"
]
},
"information": {},
"debug": {},
"additionalInfo": {}
},
"challans": [
{
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"businessService": "text",
"challanNo": "text",
"referenceId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"amount": [
{
"taxHeadCode": "text",
"amount": 1
}
],
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}Update the existing challan details
Body
Request object to fetch the report data
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: 970
{
"requestInfo": {
"apiInfo": {
"id": "text",
"version": "text",
"path": "text"
},
"deviceDetail": {
"id": "text",
"signature": "text"
},
"ts": 1,
"action": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"signature": "text"
},
"challan": {
"tenantId": "text",
"businessService": "text",
"referenceId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"source": "whatsapp, ivr etc",
"amount": [
{
"taxHeadCode": "text",
"amount": 1
}
],
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
]
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
}
}
}{
"responseInfo": {
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "COMPLETED",
"signature": "text",
"error": {
"code": "text",
"message": "text",
"description": "text",
"params": [
"text"
]
},
"information": {},
"debug": {},
"additionalInfo": {}
},
"challans": [
{
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"businessService": "text",
"challanNo": "text",
"referenceId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"amount": [
{
"taxHeadCode": "text",
"amount": 1
}
],
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 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: */*
{
"responseInfo": {
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "COMPLETED",
"signature": "text",
"error": {
"code": "text",
"message": "text",
"description": "text",
"params": [
"text"
]
},
"information": {},
"debug": {},
"additionalInfo": {}
},
"challans": [
{
"citizen": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"tenantId": "text",
"description": "text"
}
]
}
]
},
"id": "text",
"tenantId": "text",
"businessService": "text",
"challanNo": "text",
"referenceId": "text",
"description": "text",
"accountId": "text",
"additionalDetail": {},
"applicationStatus": "text",
"source": "whatsapp, ivr etc",
"amount": [
{
"taxHeadCode": "text",
"amount": 1
}
],
"address": {
"tenantId": "text",
"doorNo": "text",
"plotNo": "text",
"id": "text",
"landmark": "text",
"city": "text",
"district": "text",
"region": "text",
"state": "text",
"country": "text",
"pincode": "text",
"additionDetails": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
},
"geoLocation": {
"latitude": 1,
"longitude": 1,
"additionalDetails": {}
}
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}Get the list of count of paid, active, cancelled and total number of challan for given tenant Id.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
Responses
200
Successful response, present the list of count of challans for given tenant Id.
*/*
400
Invalid input.
*/*
post
POST /eChallan/v1/_count?tenantId=text HTTP/1.1
Host:
Accept: */*
{
"responseInfo": {
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "COMPLETED",
"signature": "text",
"error": {
"code": "text",
"message": "text",
"description": "text",
"params": [
"text"
]
},
"information": {},
"debug": {},
"additionalInfo": {}
},
"ChallanCount": {
"paidChallan": "text",
"cancelledChallan": "text",
"activeChallan": "text",
"totalChallan": "text"
}
}Last updated
Was this helpful?