Billing

Billing APIs

Manage demand, bill and amendments

create

post

/billing-service/amendment/_create

Body

AmendmentAmendmentrequired

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/amendment/_create' \
  --header 'Content-Type: application/json' \
  --data '{"Amendment":{"additionalDetails":{},"auditDetails":{},"businessService":"text","consumerCode":"text","tenantId":"text","workflow":{"action":"text","assigner":{"tenantId":"text","userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","accountLocked":false,"userDetails":{},"auditDetails":{},"roles":[{"name":"text"}]},"auditDetails":{},"businessId":"text","businessService":"text","entity":{},"moduleName":"text","state":{"auditDetails":{},"actions":[{"action":"text","auditDetails":{},"nextState":"text","roles":[null]}]},"tenantId":"text","assignes":[{"tenantId":"text","userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","accountLocked":false,"userDetails":{},"auditDetails":{},"roles":[{"name":"text"}]}],"documents":[{"additionalDetails":{},"documentType":"text","fileStoreId":"text"}],"nextActions":[{"action":"text","auditDetails":{},"nextState":"text","roles":[null]}]},"amendmentReason":"ARREAR_WRITE_OFF","status":"ACTIVE","demandDetails":[{"taxAmount":1,"collectionAmount":1,"auditDetails":{},"additionalDetails":{}}],"documents":[{"additionalDetails":{},"documentType":"text","fileStoreId":"text"}]},"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

200

{}

OK

search

post

/billing-service/amendment/_search

Query parameters

amendmentIdstring

businessServicestringrequired

consumerCodestring[]

mobileNumberstring

statusstring[]

tenantIdstringrequired

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/amendment/_search?businessService=text&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

200

{}

OK

update

post

/billing-service/amendment/_update

Body

AmendmentUpdateAmendmentUpdaterequired

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/amendment/_update' \
  --header 'Content-Type: application/json' \
  --data '{"AmendmentUpdate":{"additionalDetails":{},"amendmentId":"text","auditDetails":{},"tenantId":"text","workflow":{"action":"text","assigner":{"tenantId":"text","userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","accountLocked":false,"userDetails":{},"auditDetails":{},"roles":[{"name":"text"}]},"auditDetails":{},"businessId":"text","businessService":"text","entity":{},"moduleName":"text","state":{"auditDetails":{},"actions":[{"action":"text","auditDetails":{},"nextState":"text","roles":[null]}]},"tenantId":"text","assignes":[{"tenantId":"text","userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","accountLocked":false,"userDetails":{},"auditDetails":{},"roles":[{"name":"text"}]}],"documents":[{"additionalDetails":{},"documentType":"text","fileStoreId":"text"}],"nextActions":[{"action":"text","auditDetails":{},"nextState":"text","roles":[null]}]},"status":"ACTIVE","documents":[{"additionalDetails":{},"documentType":"text","fileStoreId":"text"}]},"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

200

{}

OK

cancelBill

post

/billing-service/bill/v2/_cancelbill

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

updateBillCriteriaUpdateBillCriteria

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/bill/v2/_cancelbill' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"updateBillCriteria":{"additionalDetails":{},"businessService":"text","tenantId":"text","statusToBeUpdated":"ACTIVE","billIds":[null],"consumerCodes":[null]}}'

200

201

401

403

404

200

{}

OK

create

post

/billing-service/bill/v2/_create

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

BillsBillV2[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/bill/v2/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Bills":[{"additionalDetails":{},"auditDetails":{},"status":"ACTIVE","billDetails":[{"additionalDetails":{},"billAccountDetails":[{"additionalDetails":{},"auditDetails":{}}]}]}]}'

200

201

401

403

404

200

{}

OK

fetchBill

post

/billing-service/bill/v2/_fetchbill

Query parameters

businessServicestring · max: 256required

consumerCodestring[]

demandIdstring · max: 64

emailstring

mobileNumberstring

Pattern: ^[0-9]{10}$

tenantIdstring · max: 256required

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/bill/v2/_fetchbill?businessService=text&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

200

{}

OK

genrateBill

post

/billing-service/bill/v2/_generate

Query parameters

businessServicestring · max: 256required

consumerCodestring[]

demandIdstring · max: 64

emailstring

mobileNumberstring

Pattern: ^[0-9]{10}$

tenantIdstring · max: 256required

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/bill/v2/_generate?businessService=text&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

200

{}

OK

search

post

/billing-service/bill/v2/_search

Query parameters

billIdstring[]

billNumberstring · max: 256

consumerCodestring[]

emailstring

fromPeriodinteger · int64

isActiveboolean

isCancelledboolean

mobileNumberstring

Pattern: ^[0-9]{10}$

offsetinteger · int64

orderByboolean

retrieveOldestboolean

servicestring · max: 256

sizeinteger · int64

statusstring · enum

Options: ACTIVE, CANCELLED, EXPIRED, PAID, PARTIALLY_PAID, PAYMENT_CANCELLED

tenantIdstring · max: 256required

toPeriodinteger · int64

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/bill/v2/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

200

{}

OK

search

post

/billing-service/businessservices/_search

Query parameters

businessServicestring[]required

idstring[]

tenantIdstringrequired

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/businessservices/_search?businessService=text&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

200

{}

OK

create

post

/billing-service/demand/_create

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Demandobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/demand/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Demand":[{"tenantId":"text","consumerCode":"text","consumerType":"text","businessService":"text","payer":{"tenantId":"text","userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","accountLocked":false,"userDetails":{},"auditDetails":{},"roles":[{"name":"text"}]},"taxPeriodFrom":1,"taxPeriodTo":1,"auditDetails":{},"status":"ACTIVE","additionalDetails":{},"demandDetails":[{"taxAmount":1,"collectionAmount":1,"auditDetails":{},"additionalDetails":{}}]}]}'

200

201

401

403

404

200

{}

OK

migrate

post

/billing-service/demand/_migratetov1

Query parameters

batchStartinteger · int32

batchStart

batchSizeInputinteger · int32required

batchSizeInput

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/demand/_migratetov1?batchSizeInput=1' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

200

{}

OK

search

post

/billing-service/demand/_search

Query parameters

businessServicestring

consumerCodestring[]

demandFromnumber · bigdecimal

demandIdstring[]

demandTonumber · bigdecimal

emailstring

isPaymentCompletedboolean

mobileNumberstring

payerstring[]

periodFrominteger · int64

periodTointeger · int64

receiptRequiredboolean

statusstring

tenantIdstringrequired

typestring · enum

Options: ARREARS, CURRENT, DUES

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/demand/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

200

{}

OK

update

post

/billing-service/demand/_update

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Demandobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/demand/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Demand":[{"tenantId":"text","consumerCode":"text","consumerType":"text","businessService":"text","payer":{"tenantId":"text","userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","accountLocked":false,"userDetails":{},"auditDetails":{},"roles":[{"name":"text"}]},"taxPeriodFrom":1,"taxPeriodTo":1,"auditDetails":{},"status":"ACTIVE","additionalDetails":{},"demandDetails":[{"taxAmount":1,"collectionAmount":1,"auditDetails":{},"additionalDetails":{}}]}]}'

200

201

401

403

404

200

{}

OK

search

post

/billing-service/taxheads/_search

Query parameters

categorystring

codestring[]

idstring[]

isActualDemandboolean

isDebitboolean

namestring

servicestringrequired

tenantIdstringrequired

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/taxheads/_search?service=text&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

200

{}

OK

search

post

/billing-service/taxperiods/_search

Query parameters

codestring

dateinteger · int64

fromDateinteger · int64

idstring[]

periodCyclestring · enum

Options: ANNUAL, HALFYEAR, MONTH, QUARTER

servicestring[]required

tenantIdstringrequired

toDateinteger · int64

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//billing-service/taxperiods/_search?service=text&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

200

{}

OK