Retrieve an employee breakdown

1 curl https://test.api.kota.io/contribution_reports/ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a/employee_breakdowns/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a \ 2 -H "Authorization: Bearer <token>"

1 { 2 "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a", 3 "contribution_report_id": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a", 4 "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a", 5 "period": { 6 "from_date": "2024-12-01", 7 "to_date": "2024-12-01" 8 }, 9 "currency": "eur", 10 "status": "open", 11 "created_at": "foo", 12 "last_updated_at": "foo", 13 "health_insurance": { 14 "employer_contributions": [ 15 { 16 "id": "ct_3b1333d87d9d4fd6ad83ba7f6b0e951a", 17 "category": "gross_premium", 18 "member_type": "policyholder", 19 "adjustment": true, 20 "amount": 42, 21 "type": "recurring", 22 "cover_period": { 23 "from_date": "2024-12-01", 24 "to_date": "2024-12-01" 25 }, 26 "employee_policy_id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a", 27 "reporting_month": "2024-12-01", 28 "adjustment_for": "ct_3b1333d87d9d4fd6ad83ba7f6b0e951a", 29 "note": "foo" 30 } 31 ], 32 "employee_contributions": [ 33 { 34 "id": "ct_3b1333d87d9d4fd6ad83ba7f6b0e951a", 35 "category": "gross_premium", 36 "member_type": "policyholder", 37 "adjustment": true, 38 "amount": 42, 39 "type": "recurring", 40 "cover_period": { 41 "from_date": "2024-12-01", 42 "to_date": "2024-12-01" 43 }, 44 "employee_policy_id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a", 45 "reporting_month": "2024-12-01", 46 "adjustment_for": "ct_3b1333d87d9d4fd6ad83ba7f6b0e951a", 47 "note": "foo" 48 } 49 ] 50 }, 51 "object": "foo", 52 "external_customer_id": "foo", 53 "finalized_at": "foo" 54 }

Returns the employee breakdown for a contribution report.

Path parameters

contribution_report_idstringRequiredformat: "ctr_.+"

employee_idstringRequiredformat: "ee_.+"

Response

employee_idstringformat: "ee_.+"

Unique identifier of the employee for which the breakdown is created

contribution_report_idstringformat: "ctr_.+"

Unique identifier of the related contribution report

employer_idstringformat: "er_.+"

Unique identifier of the employer for which the breakdown is created

periodobject

Period covered by the employee breakdown

currencyenum

The currency in which all the amounts in this breakdown are presented (e.g. eur)

statusenum

Current status of the breakdown

Allowed values:

created_atstringformat: "date-time"

Date and time the breakdown was created

last_updated_atstringformat: "date-time"

Date and time of the last update to the breakdown

health_insuranceobject

Health insurance contribution details

objectstring or null

The object type

external_customer_idstring or null

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_atstring or nullformat: "date-time"

Date and time the breakdown was finalized, if applicable

Path parameters

Headers

Response

Errors