{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bank Feeds Account mapping Excel reports API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Excel reports",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Excel report status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/data/companies/:companyId/assess/excel",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "reportType",
                "value": "",
                "type": "query",
                "description": "The type of report you want to generate and download."
              }
            ]
          },
          "docs": "The *Get Excel report status* returns the status of the report mostly recently requested for Excel generation. It does not return the status of any historical report requests. \n\nPoll this endpoint to check the progress of the report once you have requested its generation. This will not affect the generation of the report. \n\nWhen the report generation completes successfully, the `inProgress` property will be marked as `false` and the `success` field will be marked as `true`."
        },
        {
          "info": {
            "name": "Generate Excel report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.codat.io/data/companies/:companyId/assess/excel",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "reportType",
                "value": "",
                "type": "query",
                "description": "The type of report you want to generate and download."
              }
            ]
          },
          "docs": "The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter.\n\nIn response, the endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/ExcelStatus) detailing the current state of the report generation request.\n\n### Report types\n\n| reportType                                                                           | Description                                                            "
        },
        {
          "info": {
            "name": "Download Excel report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/data/companies/:companyId/assess/excel/download",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "reportType",
                "value": "",
                "type": "query",
                "description": "The type of report you want to generate and download."
              }
            ]
          },
          "docs": "The *Download Excel report* endpoint downloads the latest successfully generated Excel report of a specified report type for a given company. \n\nThe downloadable Excel file is returned in the response. You can save it to your local machine.\n\nYou can [learn more](https://docs.codat.io/lending/features/excel-download-overview#feature-components) about valid Excel report types."
        }
      ]
    }
  ],
  "bundled": true
}