{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bank Feeds Account mapping Manage reports API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Manage reports",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Generate report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.codat.io/companies/:companyId/reports/:reportType",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "reportType",
                "value": "",
                "type": "path",
                "description": "The type of the report"
              }
            ]
          },
          "docs": "Use the *Generate report* endpoint to initiate the generation of a report specified by the `reportType` parameter.\n\nThis action triggers the system to refresh and pull the necessary data from the company's data sources to ensure the report contains the most up-to-date information."
        },
        {
          "info": {
            "name": "Get report status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/reports/:reportType/:reportId/status",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "reportType",
                "value": "",
                "type": "path",
                "description": "The type of the report"
              },
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a report, use either the Id of the report or `latest` for the most recently generate report."
              },
              {
                "name": "maxAge",
                "value": "",
                "type": "query",
                "description": "The maximum age of report to fetch."
              }
            ]
          },
          "docs": "Use the *Get report status* endpoint to return the metadata about report generation, such as its current status, date of request, and date of generation.\n\nYou can either provide the ID of a report or use `latest` as the ID value to get the most recent generated *reportName* report for the company.\n\n"
        },
        {
          "info": {
            "name": "List reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/reports",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. [Read more](https://docs.codat.io/using-the-api/paging)."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."
              },
              {
                "name": "query",
                "value": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
                "type": "query",
                "description": "Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."
              }
            ]
          },
          "docs": "Use the *List reports* endpoint to return details (such as generation's current status, date of request, and date of generation) about all reports generated for a company. The query parameter can be used to filter the results."
        }
      ]
    }
  ],
  "bundled": true
}