{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference Associated Persons Contribution Reports API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Contribution Reports",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a contribution report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.api.kota.io/contribution_reports/:contribution_report_id",
            "params": [
              {
                "name": "contribution_report_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns a `contribution report` object."
        },
        {
          "info": {
            "name": "List all contribution reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.api.kota.io/contribution_reports",
            "params": [
              {
                "name": "employer_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier of the employer for filtering reports"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `open`, `finalized`."
              },
              {
                "name": "month",
                "value": "",
                "type": "query",
                "description": "Month for filtering reports, used together with `year` (MM format)"
              },
              {
                "name": "year",
                "value": "",
                "type": "query",
                "description": "Year for filtering reports, can be used standalone or with `month` (YYYY format)"
              },
              {
                "name": "external_customer_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier of the customer for EoR platforms, used to filter reports for a logical employer"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page of results to return. Defaults to 1 if not provided."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100."
              }
            ]
          },
          "docs": "Returns a list of `contribution reports`. The reports are returned sorted by creation date, with the most recent reports appearing first."
        },
        {
          "info": {
            "name": "Finalize a contribution report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.api.kota.io/contribution_reports/:contribution_report_id/finalize",
            "params": [
              {
                "name": "contribution_report_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint finalizes the `contribution report` object, making it immutable and preventing any further updates. Once finalized, its `status` changes to `finalized`, and it serves as a historical record for payroll reporting. Any changes or adjustments that occur after the finalization will roll into the next reporting period."
        },
        {
          "info": {
            "name": "Retrieve an employee breakdown",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.api.kota.io/contribution_reports/:contribution_report_id/employee_breakdowns/:employee_id",
            "params": [
              {
                "name": "contribution_report_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "employee_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns the `employee breakdown` for a `contribution report`."
        },
        {
          "info": {
            "name": "List all employee breakdowns",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.api.kota.io/contribution_reports/:contribution_report_id/employee_breakdowns",
            "params": [
              {
                "name": "contribution_report_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page of results to return. Defaults to 1 if not provided."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100."
              }
            ]
          },
          "docs": "Returns a list of `employee breakdowns` for a `contribution report`. The breakdowns are returned sorted by creation date, with the most recent breakdown appearing first."
        }
      ]
    }
  ],
  "bundled": true
}