Billing

Billing APIs

Manage demand, bill and amendments

PreviousAnalytics NextCollection

Last updated 1 year ago

Was this helpful?

create

post

Body

Amendmentobjectrequired

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 -L \
  --request POST \
  --url '//billing-service/amendment/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "Amendment": {
      "additionalDetails": {},
      "amendedDemandId": "text",
      "amendmentId": "text",
      "amendmentReason": "ARREAR_WRITE_OFF",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "businessService": "text",
      "consumerCode": "text",
      "demandDetails": [
        {
          "id": "text",
          "demandId": "text",
          "taxHeadMasterCode": "text",
          "taxAmount": 1,
          "collectionAmount": 1,
          "additionalDetails": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "tenantId": "text"
        }
      ],
      "documents": [
        {
          "additionalDetails": {},
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text"
        }
      ],
      "effectiveFrom": 1,
      "effectiveTill": 1,
      "id": "text",
      "reasonDocumentNumber": "text",
      "status": "ACTIVE",
      "tenantId": "text",
      "workflow": {
        "action": "text",
        "assigner": {
          "tenantId": "text",
          "id": 1,
          "userName": "text",
          "authToken": "password",
          "salutation": "text",
          "name": "text",
          "gender": "text",
          "mobileNumber": "text",
          "emailId": "text",
          "aadhaarNumber": "text",
          "active": true,
          "locale": "text",
          "type": "text",
          "accountLocked": true,
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ],
          "userDetails": {
            "firstName": "text",
            "middleName": "text",
            "lastName": "text",
            "dob": "2025-03-28",
            "altContactNumber": "text",
            "fatherName": "text",
            "husbandName": "text",
            "bloodGroup": "text",
            "pan": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPincode": "text",
            "correspondenceCity": "text",
            "correspondencePincode": "text",
            "correspondenceAddress": "text",
            "signature": "text",
            "identificationMark": "text",
            "photo": "text"
          },
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        },
        "assignes": [
          {
            "tenantId": "text",
            "id": 1,
            "userName": "text",
            "authToken": "password",
            "salutation": "text",
            "name": "text",
            "gender": "text",
            "mobileNumber": "text",
            "emailId": "text",
            "aadhaarNumber": "text",
            "active": true,
            "locale": "text",
            "type": "text",
            "accountLocked": true,
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ],
            "userDetails": {
              "firstName": "text",
              "middleName": "text",
              "lastName": "text",
              "dob": "2025-03-28",
              "altContactNumber": "text",
              "fatherName": "text",
              "husbandName": "text",
              "bloodGroup": "text",
              "pan": "text",
              "permanentAddress": "text",
              "permanentCity": "text",
              "permanentPincode": "text",
              "correspondenceCity": "text",
              "correspondencePincode": "text",
              "correspondenceAddress": "text",
              "signature": "text",
              "identificationMark": "text",
              "photo": "text"
            },
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            }
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "businessId": "text",
        "businessService": "text",
        "businesssServiceSla": 1,
        "comment": "text",
        "documents": [
          {
            "additionalDetails": {},
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text"
          }
        ],
        "entity": {},
        "id": "text",
        "moduleName": "text",
        "nextActions": [
          {
            "action": "text",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            },
            "currentState": "text",
            "nextState": "text",
            "roles": [
              "text"
            ],
            "tenantId": "text",
            "uuid": "text"
          }
        ],
        "previousStatus": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text",
                "createdTime": 1,
                "lastModifiedTime": 1
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "businessServiceId": "text",
          "docUploadRequired": true,
          "isStartState": true,
          "isStateUpdatable": true,
          "isTerminateState": true,
          "sla": 1,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "stateSla": 1,
        "tenantId": "text"
      }
    },
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

search

post

Query parameters

amendmentIdstringoptional

businessServicestringrequired

consumerCodestring[]optional

mobileNumberstringoptional

statusstring[]optional

tenantIdstringrequired

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

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",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

update

post

Body

AmendmentUpdateobjectrequired

RequestInfoobjectrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//billing-service/amendment/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "AmendmentUpdate": {
      "additionalDetails": {},
      "amendedDemandId": "text",
      "amendmentId": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "documents": [
        {
          "additionalDetails": {},
          "documentType": "text",
          "documentUid": "text",
          "fileStoreId": "text",
          "id": "text"
        }
      ],
      "status": "ACTIVE",
      "tenantId": "text",
      "workflow": {
        "action": "text",
        "assigner": {
          "tenantId": "text",
          "id": 1,
          "userName": "text",
          "authToken": "password",
          "salutation": "text",
          "name": "text",
          "gender": "text",
          "mobileNumber": "text",
          "emailId": "text",
          "aadhaarNumber": "text",
          "active": true,
          "locale": "text",
          "type": "text",
          "accountLocked": true,
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ],
          "userDetails": {
            "firstName": "text",
            "middleName": "text",
            "lastName": "text",
            "dob": "2025-03-28",
            "altContactNumber": "text",
            "fatherName": "text",
            "husbandName": "text",
            "bloodGroup": "text",
            "pan": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPincode": "text",
            "correspondenceCity": "text",
            "correspondencePincode": "text",
            "correspondenceAddress": "text",
            "signature": "text",
            "identificationMark": "text",
            "photo": "text"
          },
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        },
        "assignes": [
          {
            "tenantId": "text",
            "id": 1,
            "userName": "text",
            "authToken": "password",
            "salutation": "text",
            "name": "text",
            "gender": "text",
            "mobileNumber": "text",
            "emailId": "text",
            "aadhaarNumber": "text",
            "active": true,
            "locale": "text",
            "type": "text",
            "accountLocked": true,
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ],
            "userDetails": {
              "firstName": "text",
              "middleName": "text",
              "lastName": "text",
              "dob": "2025-03-28",
              "altContactNumber": "text",
              "fatherName": "text",
              "husbandName": "text",
              "bloodGroup": "text",
              "pan": "text",
              "permanentAddress": "text",
              "permanentCity": "text",
              "permanentPincode": "text",
              "correspondenceCity": "text",
              "correspondencePincode": "text",
              "correspondenceAddress": "text",
              "signature": "text",
              "identificationMark": "text",
              "photo": "text"
            },
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            }
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "businessId": "text",
        "businessService": "text",
        "businesssServiceSla": 1,
        "comment": "text",
        "documents": [
          {
            "additionalDetails": {},
            "documentType": "text",
            "documentUid": "text",
            "fileStoreId": "text",
            "id": "text"
          }
        ],
        "entity": {},
        "id": "text",
        "moduleName": "text",
        "nextActions": [
          {
            "action": "text",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            },
            "currentState": "text",
            "nextState": "text",
            "roles": [
              "text"
            ],
            "tenantId": "text",
            "uuid": "text"
          }
        ],
        "previousStatus": "text",
        "state": {
          "actions": [
            {
              "action": "text",
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text",
                "createdTime": 1,
                "lastModifiedTime": 1
              },
              "currentState": "text",
              "nextState": "text",
              "roles": [
                "text"
              ],
              "tenantId": "text",
              "uuid": "text"
            }
          ],
          "applicationStatus": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "businessServiceId": "text",
          "docUploadRequired": true,
          "isStartState": true,
          "isStateUpdatable": true,
          "isTerminateState": true,
          "sla": 1,
          "state": "text",
          "tenantId": "text",
          "uuid": "text"
        },
        "stateSla": 1,
        "tenantId": "text"
      }
    },
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

cancelBill

post

Body

requestInfoobjectoptional

updateBillCriteriaobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

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",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    },
    "updateBillCriteria": {
      "additionalDetails": {},
      "billIds": [
        "text"
      ],
      "businessService": "text",
      "consumerCodes": [
        "text"
      ],
      "statusToBeUpdated": "ACTIVE",
      "tenantId": "text"
    }
  }'

200

201

401

403

404

{}

create

post

Body

Billsobject[]optional

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//billing-service/bill/v2/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "Bills": [
      {
        "additionalDetails": {},
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "billDate": 1,
        "billDetails": [
          {
            "additionalDetails": {},
            "amount": 1,
            "amountPaid": 1,
            "billAccountDetails": [
              {
                "additionalDetails": {},
                "adjustedAmount": 1,
                "amount": 1,
                "auditDetails": {
                  "createdBy": "text",
                  "lastModifiedBy": "text",
                  "createdTime": 1,
                  "lastModifiedTime": 1
                },
                "billDetailId": "text",
                "demandDetailId": "text",
                "id": "text",
                "order": 1,
                "taxHeadCode": "text",
                "tenantId": "text"
              }
            ],
            "billId": "text",
            "demandId": "text",
            "expiryDate": 1,
            "fromPeriod": 1,
            "id": "text",
            "tenantId": "text",
            "toPeriod": 1
          }
        ],
        "billNumber": "text",
        "businessService": "text",
        "consumerCode": "text",
        "fileStoreId": "text",
        "id": "text",
        "mobileNumber": "text",
        "payerAddress": "text",
        "payerEmail": "text",
        "payerName": "text",
        "status": "ACTIVE",
        "tenantId": "text",
        "totalAmount": 1
      }
    ],
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

fetchBill

post

Query parameters

businessServicestring · max: 256required

consumerCodestring[]optional

demandIdstring · max: 64optional

emailstringoptional

mobileNumberstringoptional

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

tenantIdstring · max: 256required

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

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",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

genrateBill

post

Query parameters

businessServicestring · max: 256required

consumerCodestring[]optional

demandIdstring · max: 64optional

emailstringoptional

mobileNumberstringoptional

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

tenantIdstring · max: 256required

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

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",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

search

post

Query parameters

billIdstring[]optional

billNumberstring · max: 256optional

consumerCodestring[]optional

emailstringoptional

fromPeriodinteger · int64optional

isActivebooleanoptional

isCancelledbooleanoptional

mobileNumberstringoptional

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

offsetinteger · int64optional

orderBybooleanoptional

retrieveOldestbooleanoptional

servicestring · max: 256optional

sizeinteger · int64optional

statusstring · enumoptional

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

tenantIdstring · max: 256required

toPeriodinteger · int64optional

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

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",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

search

post

Query parameters

businessServicestring[]required

idstring[]optional

tenantIdstringrequired

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

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",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

create

post

Body

RequestInfoobjectoptional

Demandobject[]optional

A Object which holds the basic info about the revenue assessment for which the demand is generated like module name, consumercode, owner, etc.

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//billing-service/demand/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    },
    "Demand": [
      {
        "id": "text",
        "tenantId": "text",
        "consumerCode": "text",
        "consumerType": "text",
        "businessService": "text",
        "payer": {
          "tenantId": "text",
          "id": 1,
          "userName": "text",
          "authToken": "password",
          "salutation": "text",
          "name": "text",
          "gender": "text",
          "mobileNumber": "text",
          "emailId": "text",
          "aadhaarNumber": "text",
          "active": true,
          "locale": "text",
          "type": "text",
          "accountLocked": true,
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ],
          "userDetails": {
            "firstName": "text",
            "middleName": "text",
            "lastName": "text",
            "dob": "2025-03-28",
            "altContactNumber": "text",
            "fatherName": "text",
            "husbandName": "text",
            "bloodGroup": "text",
            "pan": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPincode": "text",
            "correspondenceCity": "text",
            "correspondencePincode": "text",
            "correspondenceAddress": "text",
            "signature": "text",
            "identificationMark": "text",
            "photo": "text"
          },
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        },
        "taxPeriodFrom": 1,
        "taxPeriodTo": 1,
        "demandDetails": [
          {
            "id": "text",
            "demandId": "text",
            "taxHeadMasterCode": "text",
            "taxAmount": 1,
            "collectionAmount": 1,
            "additionalDetails": {},
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            },
            "tenantId": "text"
          }
        ],
        "billExpiryTime": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "additionalDetails": {},
        "status": "ACTIVE"
      }
    ]
  }'

200

201

401

403

404

{}

migrate

post

Query parameters

batchStartinteger · int32optional

batchStart

batchSizeInputinteger · int32required

batchSizeInput

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

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",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

search

post

Query parameters

businessServicestringoptional

consumerCodestring[]optional

demandFromnumber · bigdecimaloptional

demandIdstring[]optional

demandTonumber · bigdecimaloptional

emailstringoptional

isPaymentCompletedbooleanoptional

mobileNumberstringoptional

payerstring[]optional

periodFrominteger · int64optional

periodTointeger · int64optional

receiptRequiredbooleanoptional

statusstringoptional

tenantIdstringrequired

typestring · enumoptional

Options: ARREARS, CURRENT, DUES

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

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",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

update

post

Body

RequestInfoobjectoptional

Demandobject[]optional

A Object which holds the basic info about the revenue assessment for which the demand is generated like module name, consumercode, owner, etc.

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '//billing-service/demand/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    },
    "Demand": [
      {
        "id": "text",
        "tenantId": "text",
        "consumerCode": "text",
        "consumerType": "text",
        "businessService": "text",
        "payer": {
          "tenantId": "text",
          "id": 1,
          "userName": "text",
          "authToken": "password",
          "salutation": "text",
          "name": "text",
          "gender": "text",
          "mobileNumber": "text",
          "emailId": "text",
          "aadhaarNumber": "text",
          "active": true,
          "locale": "text",
          "type": "text",
          "accountLocked": true,
          "roles": [
            {
              "name": "text",
              "description": "text"
            }
          ],
          "userDetails": {
            "firstName": "text",
            "middleName": "text",
            "lastName": "text",
            "dob": "2025-03-28",
            "altContactNumber": "text",
            "fatherName": "text",
            "husbandName": "text",
            "bloodGroup": "text",
            "pan": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPincode": "text",
            "correspondenceCity": "text",
            "correspondencePincode": "text",
            "correspondenceAddress": "text",
            "signature": "text",
            "identificationMark": "text",
            "photo": "text"
          },
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        },
        "taxPeriodFrom": 1,
        "taxPeriodTo": 1,
        "demandDetails": [
          {
            "id": "text",
            "demandId": "text",
            "taxHeadMasterCode": "text",
            "taxAmount": 1,
            "collectionAmount": 1,
            "additionalDetails": {},
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            },
            "tenantId": "text"
          }
        ],
        "billExpiryTime": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "additionalDetails": {},
        "status": "ACTIVE"
      }
    ]
  }'

200

201

401

403

404

{}

search

post

Query parameters

categorystringoptional

codestring[]optional

idstring[]optional

isActualDemandbooleanoptional

isDebitbooleanoptional

namestringoptional

servicestringrequired

tenantIdstringrequired

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

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",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

search

post

Query parameters

codestringoptional

dateinteger · int64optional

fromDateinteger · int64optional

idstring[]optional

periodCyclestring · enumoptional

Options: ANNUAL, HALFYEAR, MONTH, QUARTER

servicestring[]required

tenantIdstringrequired

toDateinteger · int64optional

Body

RequestInfoobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

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",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text"
              }
            ]
          }
        ]
      }
    }
  }'

200

201

401

403

404

{}

Billing APIs

Billing APIs

create

Show Amendment

Show child attributes

search

Show child attributes

update

Show AmendmentUpdate

Show child attributes

cancelBill

Show child attributes

Show UpdateBillCriteria

create

Show child attributes

Show child attributes

fetchBill

Show child attributes

genrateBill

Show child attributes

search

Show child attributes

search

Show child attributes

create

Show child attributes

Show child attributes

migrate

Show child attributes

search

Show child attributes

update

Show child attributes

Show child attributes

search

Show child attributes

search

Show child attributes