Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kota Contribution Reports API

The Contribution Reports API from Kota — 5 operation(s) for contribution reports.

Kota Contribution Reports API is one of 33 APIs that Kota publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contribution Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://test.api.kota.io, https://api.kota.io.

5 operations 5 paths 14 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.kota.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kota Contribution Reports API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Authorization header using the Bearer scheme

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Contribution Reports 5
GET
/contribution_reports/{contribution_report_id}
Retrieve a contribution report
RetrieveContributionReport 1 param → 200404
GET
/contribution_reports
List all contribution reports
ListContributionReports 7 params → 200
POST
/contribution_reports/{contribution_report_id}/finalize
Finalize a contribution report
FinalizeContributionReport 1 param → 200400404
GET
/contribution_reports/{contribution_report_id}/employee_breakdowns/{employee_id}
Retrieve an employee breakdown
RetrieveEmployeeBreakdownForContributionReport 2 params → 200404
GET
/contribution_reports/{contribution_report_id}/employee_breakdowns
List all employee breakdowns
ListEmployeeBreakdownsForContributionReport 3 params → 200404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are GetEmployeeBreakdownContribution (12 properties), ContributionReportEmployeeBreakdownResponse (12 properties), ContributionReportResponse (9 properties), ContributionReportResponsePagedList (6 properties). Each schema is shown below with its type and property counts.

ContributionReportEmployeeBreakdownResponsePagedList
object
6 properties 4 required
HealthInsuranceContributionType
string
ContributionReportResponsePagedList
object
6 properties 4 required
HealthInsuranceContributionMemberType
string
ContributionReportEmployeeBreakdownResponse
object
12 properties 9 required
GetContributionReportPeriod
object
2 properties 2 required
GetEmployeeBreakdownPeriod
object
2 properties 2 required
CurrencyCode
string
ProblemDetails
object
5 properties
GetEmployeeBreakdownHealthInsurance
object
2 properties 2 required
HealthInsuranceContributionCategory
string
ContributionReportResponse
object
9 properties 6 required
ContributionReportStatus
string
GetEmployeeBreakdownContribution
object
12 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kota-contribution-reports-api-openapi.yml Raw ↑

Other APIs Kota publishes across the network.

Kota Associated Persons API
Kota associatedPersons API
Kota contributionReports API
Kota Dependents Management Intents API
Kota dependentsManagementIntents API
Kota Embed Sessions API
Kota embedSessions API
Kota employees API
Kota employers API
Kota Enrolment Intents API
Kota enrolmentIntents API
Kota events API