Billing

Billing APIs

Manage demand, bill and amendments

create

post

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /amendment/_create HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 3932

{
  "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-05-09",
          "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-05-09",
            "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"
            }
          ]
        }
      ]
    }
  }
}

{}

search

post

Query parameters

amendmentIdstringOptional

businessServicestringRequired

consumerCodestring[]Optional

mobileNumberstringOptional

statusstring[]Optional

tenantIdstringRequired

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /amendment/_search?businessService=text&tenantId=text HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "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"
            }
          ]
        }
      ]
    }
  }
}

{}

update

post

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /amendment/_update HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 3526

{
  "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-05-09",
          "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-05-09",
            "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"
            }
          ]
        }
      ]
    }
  }
}

{}

cancelBill

post

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /bill/v2/_cancelbill HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 538

{
  "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"
  }
}

{}

create

post

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /bill/v2/_create HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 1212

{
  "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"
            }
          ]
        }
      ]
    }
  }
}

{}

fetchBill

post

Query parameters

businessServicestring · max: 256Required

consumerCodestring[]Optional

demandIdstring · max: 64Optional

emailstringOptional

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

tenantIdstring · max: 256Required

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /bill/v2/_fetchbill?businessService=text&tenantId=text HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "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"
            }
          ]
        }
      ]
    }
  }
}

{}

genrateBill

post

Query parameters

businessServicestring · max: 256Required

consumerCodestring[]Optional

demandIdstring · max: 64Optional

emailstringOptional

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

tenantIdstring · max: 256Required

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /bill/v2/_generate?businessService=text&tenantId=text HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "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"
            }
          ]
        }
      ]
    }
  }
}

{}

search

post

Query parameters

billIdstring[]Optional

billNumberstring · max: 256Optional

consumerCodestring[]Optional

emailstringOptional

fromPeriodinteger · int64Optional

isActivebooleanOptional

isCancelledbooleanOptional

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

offsetinteger · int64Optional

orderBybooleanOptional

retrieveOldestbooleanOptional

servicestring · max: 256Optional

sizeinteger · int64Optional

statusstring · enumOptionalPossible values:

tenantIdstring · max: 256Required

toPeriodinteger · int64Optional

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /bill/v2/_search?tenantId=text HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "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"
            }
          ]
        }
      ]
    }
  }
}

{}

search

post

Query parameters

businessServicestring[]Required

idstring[]Optional

tenantIdstringRequired

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /businessservices/_search?businessService=text&tenantId=text HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "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"
            }
          ]
        }
      ]
    }
  }
}

{}

create

post

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /demand/_create HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 1745

{
  "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-05-09",
          "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"
    }
  ]
}

{}

migrate

post

Query parameters

batchStartinteger · int32Optional

batchStart

batchSizeInputinteger · int32Required

batchSizeInput

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /demand/_migratetov1?batchSizeInput=1 HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "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"
            }
          ]
        }
      ]
    }
  }
}

{}

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 · enumOptionalPossible values:

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /demand/_search?tenantId=text HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "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"
            }
          ]
        }
      ]
    }
  }
}

{}

update

post

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /demand/_update HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 1745

{
  "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-05-09",
          "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"
    }
  ]
}

{}

search

post

Query parameters

categorystringOptional

codestring[]Optional

idstring[]Optional

isActualDemandbooleanOptional

isDebitbooleanOptional

namestringOptional

servicestringRequired

tenantIdstringRequired

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /taxheads/_search?service=text&tenantId=text HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "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"
            }
          ]
        }
      ]
    }
  }
}

{}

search

post

Query parameters

codestringOptional

dateinteger · int64Optional

fromDateinteger · int64Optional

idstring[]Optional

periodCyclestring · enumOptionalPossible values:

servicestring[]Required

tenantIdstringRequired

toDateinteger · int64Optional

Body

Responses

200

OK

*/*

Responseobject

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST /taxperiods/_search?service=text&tenantId=text HTTP/1.1
Host: billing-service
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "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"
            }
          ]
        }
      ]
    }
  }
}

{}