{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference accounts billReporting API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "billReporting",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve Bill Reporting View Set",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/consumers/:consumer_id/bill-reporting/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "consumer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              }
            ]
          },
          "docs": "1) Validate the Request Token and get the Partner\n2) Get the Bill Reporting for the consumer associated with the request\n3) Return the Bill Reporting info"
        },
        {
          "info": {
            "name": "Retrieve Bill Details View Set",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/consumers/:consumer_id/bill-reporting/bill-details/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "consumer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              }
            ]
          },
          "docs": "1) Validate the Request Token and get the Partner\n2) Get the Bill Details tradelines for the consumer associated with the request\n3) Return the Bill Detailed TradeLines"
        },
        {
          "info": {
            "name": "Retrieve Open Tradelines View Set",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/consumers/:consumer_id/bill-reporting/open-tradelines/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "consumer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              }
            ]
          },
          "docs": "1) Validate the Request Token and get the Partner\n2) Get the Open Tradelines for the consumer associated with the request with all transactions lists\n3) Return TradeLines and its transactions"
        },
        {
          "info": {
            "name": "Retrieve Trade Line View Set",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/consumers/:consumer_id/bill-reporting/tradeline/:tradeline_id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "consumer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "tradeline_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              }
            ]
          },
          "docs": "1) Validate the Request Token and get the Partner\n2) Get the tradeline for the consumer associated with the request\n3) Return the TradeLine"
        },
        {
          "info": {
            "name": "Get All Bill Reportings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/bill-reporting/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              }
            ]
          },
          "docs": "1) Validate the Request Token, Get the Partner and Check if it's scoped\n2) Get the list of Bill Reportings available for that token\n3) Paginate and return the response"
        },
        {
          "info": {
            "name": "Get Consumer Bill Reporting",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://host.com/v2/bill-reporting/:external_id/consumers/:consumer_id/bill-reporting/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "external_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "consumer_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search term."
              }
            ]
          },
          "docs": "1) Validate the Request Token and get the Partner\n2) Get the Bill Reporting for the consumer associated with the request\n3) Return the Bill Reporting info"
        },
        {
          "info": {
            "name": "Create Close Tradeline View Set",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://host.com/v2/consumers/:consumer_id/bill-reporting/close-tradeline/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "consumer_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "0) Validate the Request input params\n1) Validate the Request Token and get the Partner\n2) Get tradeline by the id\n3) Make some validation for the tradeline (eligible, already open, etc.)\n4) Close an Opened tradeline for the consumer (CANNOT BE OPENED AGAIN)"
        },
        {
          "info": {
            "name": "Create Attestation View Set",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://host.com/v2/consumers/:consumer_id/bill-reporting/attestation/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "consumer_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "0) Validate the Request input params\n1) Validate the Request Token and get the Partner\n2) Check that consumer is onboarded on Bloom Enablement\n3) Get tradeline by the id\n4) Make some validation for the tradeline (eligible, already open, etc.)\n6) Check category to define the vars to send\n7) Open a tradeline for the consumer"
        },
        {
          "info": {
            "name": "Create Reported Bill",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://host.com/v2/bill-reporting/:external_id/reported-bills/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "external_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a new bill to be reported for a consumer"
        }
      ]
    }
  ],
  "bundled": true
}