For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get access
Getting Started Key Concepts Integration Types Core Components Embed Hosted API API Reference
  • API Reference
    • Contribution Reports
      • GETRetrieve a contribution report
      • GETList all contribution reports
      • POSTFinalize a contribution report
      • GETRetrieve an employee breakdown
      • GETList all employee breakdowns
    • Events and Webhooks
    • API Errors
Get access
LogoLogo
API ReferenceContribution Reports

List all contribution reports

GET
/contribution_reports
GET
/contribution_reports
$curl https://test.api.kota.io/contribution_reports \
>     -H "Authorization: Bearer <apiKey>"
200Retrieved
1{
2  "items": [
3    {
4      "id": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
5      "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
6      "period": {
7        "from_date": "2024-12-01",
8        "to_date": "2024-12-01"
9      },
10      "status": "open",
11      "created_at": "2024-12-01T00:00:00Z",
12      "last_updated_at": "2024-12-01T00:00:00Z",
13      "object": "string",
14      "finalized_at": "2024-12-01T00:00:00Z"
15    }
16  ],
17  "page": 123,
18  "page_size": 123,
19  "total_count": 123,
20  "has_next_page": true,
21  "has_previous_page": true
22}

Returns a list of contribution reports. The reports are returned sorted by creation date, with the most recent reports appearing first.

Previous

Retrieve a contribution report

Next

Finalize a contribution report

Built with

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Query parameters

employer_idstringOptionalformat: "er_.+"
Unique identifier of the employer for filtering reports
statusstringOptional

Multiple values can be provided by separating them with a comma. Allowed values are: open, finalized.

monthintegerOptional

Month for filtering reports, used together with year (MM format)

yearintegerOptional

Year for filtering reports, can be used standalone or with month (YYYY format)

external_customer_idstringOptional
Unique identifier of the customer for EoR platforms, used to filter reports for a logical employer
pageintegerOptional
The page of results to return. Defaults to 1 if not provided.
page_sizeintegerOptional
The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

Response

OK
itemslist of objects
A paginated array containing the response elements
pageinteger
The current page of the results
page_sizeinteger
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_countinteger
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_pagebooleanRead-only
Whether there are more pages available after this page
has_previous_pagebooleanRead-only
Whether there are more pages available before this page