Billing

Billing APIs

Manage demand, bill and amendments

create

POST//billing-service/amendment/_create

Body

application/json

Amendment*Amendment

RequestInfo*RequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('//billing-service/amendment/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Amendment": {
        "amendmentReason": "ARREAR_WRITE_OFF",
        "businessService": "text",
        "consumerCode": "text",
        "demandDetails": [
          {
            "collectionAmount": 0,
            "taxAmount": 0
          }
        ],
        "documents": [
          {
            "documentType": "text",
            "fileStoreId": "text"
          }
        ],
        "tenantId": "text"
      },
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

search

POST//billing-service/amendment/_search

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

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

update

POST//billing-service/amendment/_update

Body

application/json

AmendmentUpdate*AmendmentUpdate

RequestInfo*RequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('//billing-service/amendment/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "AmendmentUpdate": {
        "amendmentId": "text",
        "tenantId": "text",
        "workflow": {
          "action": "text",
          "businessId": "text",
          "businessService": "text",
          "moduleName": "text",
          "tenantId": "text"
        }
      },
      "RequestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

cancelBill

POST//billing-service/bill/v2/_cancelbill

Body

application/json

requestInfoRequestInfo (object)

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

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('//billing-service/bill/v2/_cancelbill', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

create

POST//billing-service/bill/v2/_create

Body

application/json

Billsarray of BillV2

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

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

fetchBill

POST//billing-service/bill/v2/_fetchbill

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('//billing-service/bill/v2/_fetchbill', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

genrateBill

POST//billing-service/bill/v2/_generate

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('//billing-service/bill/v2/_generate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

search

POST//billing-service/bill/v2/_search

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('//billing-service/bill/v2/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

search

POST//billing-service/businessservices/_search

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

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

create

POST//billing-service/demand/_create

Body

application/json

RequestInfoRequestInfo (object)

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.

Demandarray of Demand (object)

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

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

migrate

POST//billing-service/demand/_migratetov1

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

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

search

POST//billing-service/demand/_search

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

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

update

POST//billing-service/demand/_update

Body

application/json

RequestInfoRequestInfo (object)

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.

Demandarray of Demand (object)

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

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

search

POST//billing-service/taxheads/_search

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

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

search

POST//billing-service/taxperiods/_search

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurl

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