{
  "opencollection": "1.0.0",
  "info": {
    "name": "Customer Bill Management API",
    "version": "v1.0"
  },
  "items": [
    {
      "info": {
        "name": "customerBill",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List or find CustomerBills",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/customerBill",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              },
              {
                "name": "targetSystem",
                "value": ""
              },
              {
                "name": "countryCode",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerType",
                "value": "",
                "type": "query",
                "description": "This parameter will be used to query the bill information at Service level or Account level or Invoice Level. 1 refers to Service level, 2 refers to Account level and 3 refers to Invoice Level."
              },
              {
                "name": "customerId",
                "value": "",
                "type": "query",
                "description": "Value of 'customerType'"
              },
              {
                "name": "queryType",
                "value": "",
                "type": "query",
                "description": "This will be used to make the specific request. Either the request will be for unpaid bill or paid bill or complete bill. In case of 'unpaidBill', customer bill information along with due amount detail , related party and bill cycle information will be returned. In case of 'paidBill', applied payment information along with unpaid bill details will be returned. In case of 'completeBill', all other information like billing account,financial,taxItem,billDocument etc. will be returned along with paid and unpaid bill details."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Requested index for start of resources to be provided in response"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Requested number of resources to be provided in response"
              },
              {
                "name": "billingFlag",
                "value": "",
                "type": "query",
                "description": "This field contains three segments, like 000 or 100 etc.First segment means if include unbilled amount for current month, second segment means if include credit limit and third segment means if include deposit. 1 refers to 'include' and 0 refers to 'Not include'. Default value will be 0 "
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "Start date of bill information requested for. Date type format: yyyy-mm-dd"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "End date of bill information requested for. Date type format: yyyy-mm-dd"
              },
              {
                "name": "billingCycleId",
                "value": "",
                "type": "query",
                "description": "Billing cycle ID"
              },
              {
                "name": "custom",
                "value": "",
                "type": "query",
                "description": "Reserve for future use. Can hold the additional filter criteria."
              }
            ]
          },
          "docs": "Retrieves list of paid and unpaid bill details."
        },
        {
          "info": {
            "name": "Retrieves a CustomerBill by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/customerBill/:id",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              },
              {
                "name": "targetSystem",
                "value": ""
              },
              {
                "name": "countryCode",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "This can be Customer's masisdn with countrycode or Account Number or Invoice Number. Example - 23712345678"
              },
              {
                "name": "customerType",
                "value": "",
                "type": "query",
                "description": "This parameter will be used to query the bill information at Service level or Account level or Invoice Level. 1 refers to Service level, 2 refers to Account level and 3 refers to Invoice Level "
              },
              {
                "name": "queryType",
                "value": "",
                "type": "query",
                "description": "This will be used to make the specific request. Either the request will be for unpaid bill or paid bill or complete bill. In case of 'unpaidBill', customer bill information along with due amount detail , related party and bill cycle information will be returned. In case of 'paidBill', applied payment information along with unpaid bill details will be returned. In case of 'completeBill', all other information like billing account,financial,taxItem,billDocument etc. will be returned along with paid and unpaid bill details."
              },
              {
                "name": "billingFlag",
                "value": "",
                "type": "query",
                "description": "This field contains three segments, like 000 or 100 etc.First segment means if include unbilled amount for current month, second segment means if include credit limit and third segment means if include deposit. 1 refers to 'include' and 0 refers to 'Not include'. Default value will be 0 "
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "Start date of bill information requested for. Date type format: yyyy-mm-dd"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "End date of bill information requested for. Date type format: yyyy-mm-dd"
              },
              {
                "name": "billingCycleId",
                "value": "",
                "type": "query",
                "description": "Billing cycle ID"
              },
              {
                "name": "custom",
                "value": "",
                "type": "query",
                "description": "Reserve for future use. Can hold the additional filter criteria."
              }
            ]
          },
          "docs": "Provides the ability for a consumer to retrieve list of unpaid bill amount, advance payment amount and total due amount"
        },
        {
          "info": {
            "name": "Updates partially a CustomerBill",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/customerBill/:id",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              },
              {
                "name": "countryCode",
                "value": ""
              },
              {
                "name": "targetSystem",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique id of the customer it could be service / account id"
              }
            ]
          },
          "docs": "Provides the ability for a consumer to update postpaid bill balance"
        }
      ]
    }
  ],
  "bundled": true
}