> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.kota.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.kota.io/_mcp/server. # List all employee breakdowns GET https://test.api.kota.io/contribution_reports/{contribution_report_id}/employee_breakdowns 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. Reference: https://docs.kota.io/api-reference/contribution-reports/list-employee-breakdowns-for-contribution-report ## Authentication - `Authorization` header (bearer token, required) — Authorization header using the Bearer scheme ## Servers - `https://test.api.kota.io` (test, default) - `https://api.kota.io` (production) ## Request ### Path parameters - `contribution_report_id` (string, required) ### Query parameters - `page` (integer, optional) — The page of results to return. Defaults to 1 if not provided. - `page_size` (integer, optional) — The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100. ### Headers - `X-Platform-Id` (string, optional) — The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers. ## Response ### 200 OK - `items` (list of ContributionReportEmployeeBreakdownResponse, required) — A paginated array containing the response elements - `page` (integer, required) — The current page of the results - `page_size` (integer, required) — The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size - `total_count` (integer, required) — The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page. - `has_next_page` (boolean, optional) — Whether there are more pages available after this page - `has_previous_page` (boolean, optional) — Whether there are more pages available before this page ## Errors ### 404 Not Found Error Not Found - `type` (string, optional, nullable) - `title` (string, optional, nullable) - `status` (integer, optional, nullable) - `detail` (string, optional, nullable) - `instance` (string, optional, nullable) ## Types ### ContributionReportEmployeeBreakdownResponse - `employee_id` (string, required) — Unique identifier of the employee for which the breakdown is created - `contribution_report_id` (string, required) — Unique identifier of the related contribution report - `employer_id` (string, required) — Unique identifier of the employer for which the breakdown is created - `period` (GetEmployeeBreakdownPeriod, required) — Period covered by the employee breakdown - `currency` (enum, required) — The currency in which all the amounts in this breakdown are presented (e.g. `eur`) - Allowed values: `eur`, `aed`, `afn`, `xcd`, `all`, `amd`, `aoa`, `ars`, `usd`, `aud`, `awg`, `azn`, `bam`, `bbd`, `bdt`, `xof`, `bgn`, `bhd`, `bif`, `bmd`, `bnd`, `bob`, `bov`, `brl`, `bsd`, `inr`, `btn`, `nok`, `bwp`, `byn`, `bzd`, `cad`, `xaf`, `cdf`, `chf`, `che`, `chw`, `nzd`, `clp`, `clf`, `cny`, `cop`, `cou`, `crc`, `cup`, `cuc`, `cve`, `ang`, `czk`, `djf`, `dkk`, `dop`, `dzd`, `egp`, `mad`, `ern`, `etb`, `fjd`, `fkp`, `mdl`, `gbp`, `gel`, `ghs`, `gip`, `gmd`, `gnf`, `gtq`, `gyd`, `hkd`, `hnl`, `hrk`, `htg`, `huf`, `idr`, `xdr`, `ils`, `iqd`, `irr`, `isk`, `jmd`, `jod`, `jpy`, `kes`, `kgs`, `khr`, `kmf`, `kpw`, `krw`, `kwd`, `kyd`, `kzt`, `lak`, `lbp`, `lkr`, `lrd`, `lsl`, `zar`, `lyd`, `mga`, `mkd`, `mmk`, `mnt`, `mop`, `mru`, `mur`, `mvr`, `mwk`, `mxn`, `mxv`, `myr`, `mzn`, `nad`, `xpf`, `ngn`, `nio`, `npr`, `omr`, `pab`, `pen`, `pgk`, `php`, `pkr`, `pln`, `pyg`, `qar`, `ron`, `rsd`, `rub`, `rwf`, `sar`, `sbd`, `scr`, `sdg`, `sek`, `sgd`, `shp`, `sll`, `sos`, `srd`, `ssp`, `stn`, `svc`, `xsu`, `syp`, `twd`, `szl`, `thb`, `tjs`, `tmt`, `tnd`, `top`, `try`, `ttd`, `tzs`, `uah`, `ugx`, `usn`, `uyu`, `uyi`, `uyw`, `uzs`, `ves`, `vnd`, `vuv`, `wst`, `yer`, `xua`, `zmw`, `zwl` - `status` (enum, required) — Current status of the breakdown - Allowed values: `open`, `finalized` - `created_at` (datetime, required) — Date and time the breakdown was created - `last_updated_at` (datetime, required) — Date and time of the last update to the breakdown - `health_insurance` (GetEmployeeBreakdownHealthInsurance, required) — Health insurance contribution details - `object` (string, optional) — The object type - `external_customer_id` (string, optional, nullable) — Unique identifier of the customer for which the breakdown is created. This identifier is assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This parameter is only available to EoR platforms. - `finalized_at` (datetime, optional, nullable) — Date and time the breakdown was finalized, if applicable ### GetEmployeeBreakdownPeriod - `from_date` (date, required) — Start date of the period - `to_date` (date, required) — End date of the period ### GetEmployeeBreakdownHealthInsurance - `employer_contributions` (list of GetEmployeeBreakdownContribution, required) — Employer health insurance contributions - `employee_contributions` (list of GetEmployeeBreakdownContribution, required) — Employee health insurance contributions ### GetEmployeeBreakdownContribution - `id` (string, required) — Unique identifier for the contribution entry - `category` (enum, required) — Category of the contribution - Allowed values: `gross_premium`, `tax`, `tax_relief` - `member_type` (enum, required) — Type of member for the contribution - Allowed values: `policyholder`, `partner_dependant`, `child_dependant` - `adjustment` (boolean, required) — Indicates if this contribution is an adjustment to a previous charge - `amount` (double, required) — The monetary value of the contribution - `type` (enum, required) — Type of the contribution - Allowed values: `recurring`, `one_off` - `cover_period` (GetEmployeeBreakdownPeriod, required) — The health insurance period the contribution applies to - `policy_id` (string, required) — The policy the contribution applies to. Prefixed with `p_`. - `reporting_month` (date, required) — The primary month for which the contribution is relevant, helping to align contributions with standard monthly reporting cycles. It allows for consistent monthly categorisation in systems that require calendar-based reporting. Provided in `YYYY-MM-DD` format (with the day set to `01` as a convention), only the year and month are relevant. - `employee_policy_id` (string, required, deprecated) — DEPRECATED: Use `policy_id` instead. The employee health insurance policy the contribution applies to. Prefixed with `eehp_`. - `adjustment_for` (string, optional, nullable) — Unique identifier of the original contribution being adjusted, if applicable - `note` (string, optional, nullable) — Optional field for additional context, e.g. if the amount is pro-rated or backdated ## Examples **Response** ```json { "items": [ { "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a", "contribution_report_id": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a", "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a", "period": { "from_date": "2024-12-01", "to_date": "2024-12-01" }, "currency": "eur", "status": "open", "created_at": "2024-12-01T00:00:00Z", "last_updated_at": "2024-12-01T00:00:00Z", "health_insurance": { "employer_contributions": [ { "id": "ct_3b1333d87d9d4fd6ad83ba7f6b0e951a", "category": "gross_premium", "member_type": "policyholder", "adjustment": true, "amount": 123.45, "type": "recurring", "cover_period": { "from_date": "2024-12-01", "to_date": "2024-12-01" }, "policy_id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a", "reporting_month": "2024-12-01", "employee_policy_id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a", "adjustment_for": "ct_3b1333d87d9d4fd6ad83ba7f6b0e951a", "note": null } ], "employee_contributions": [ { "id": "ct_3b1333d87d9d4fd6ad83ba7f6b0e951a", "category": "gross_premium", "member_type": "policyholder", "adjustment": true, "amount": 123.45, "type": "recurring", "cover_period": { "from_date": "2024-12-01", "to_date": "2024-12-01" }, "policy_id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a", "reporting_month": "2024-12-01", "employee_policy_id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a", "adjustment_for": "ct_3b1333d87d9d4fd6ad83ba7f6b0e951a", "note": null } ] }, "object": "string", "external_customer_id": null, "finalized_at": "2024-12-01T00:00:00Z" } ], "page": 1, "page_size": 20, "total_count": 1, "has_next_page": false, "has_previous_page": false } ``` **SDK Code** ```python import requests url = "https://test.api.kota.io/contribution_reports/ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a/employee_breakdowns" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://test.api.kota.io/contribution_reports/ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a/employee_breakdowns'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://test.api.kota.io/contribution_reports/ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a/employee_breakdowns" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://test.api.kota.io/contribution_reports/ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a/employee_breakdowns") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://test.api.kota.io/contribution_reports/ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a/employee_breakdowns") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://test.api.kota.io/contribution_reports/ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a/employee_breakdowns', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://test.api.kota.io/contribution_reports/ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a/employee_breakdowns"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://test.api.kota.io/contribution_reports/ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a/employee_breakdowns")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```