Get Company Earnings
Returns a paginated list of earning types configured for companies. A company earning is a pay code that defines how employees are compensated (e.g., Regular, Overtime, or Bonus).
Optional Filters:
organization-id— limit to earnings for companies belonging to these organizationscompany-ids— limit to earnings for these companies
Multiple filters combine with AND logic; values within one parameter combine with OR.
Access control: Results are limited to companies your integration has access to. When organization-id is supplied, only results from organizations containing at least one accessible company are included. Inaccessible IDs in filter parameters are silently excluded; if none match, an empty list is returned.
Authorization
XApiKey Your API key.
In: header
Query Parameters
API version
"3.0""3.0"Limit results to earnings for companies belonging to this organization.
uuidLimit results to earnings for these companies.
Page number (1-based). Defaults to 1 if not specified.
int321 <= value <= 2147483647Number of items per page. Defaults to 100 if not specified. Maximum 500.
int321 <= value <= 500Response Body
curl -X GET "https://external-app-prod.netchexonline.net/company-earnings?api-version=3.0"{
"pageNumber": 0,
"pageSize": 0,
"totalItemsCount": 0,
"items": [
{
"id": 0,
"code": "string",
"name": "string",
"calculationMethod": "flatAmount",
"companyId": 0
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}Get Company Deductions GET
Returns a paginated list of deduction types configured for companies. A company deduction is a deduction template defined at the company level (e.g., Health Insurance or 401k) that can be applied to employee paychecks. **Optional Filters:** - `organization-id` — limit to deductions for companies belonging to these organizations - `company-ids` — limit to deductions for these companies - `category` — limit to deductions of a specific category Multiple filters combine with AND logic; values within one parameter combine with OR. **Access control:** Results are limited to companies your integration has access to. When `organization-id` is supplied, only results from organizations containing at least one accessible company are included. Inaccessible IDs in filter parameters are silently excluded; if none match, an empty list is returned.
Get Company Tax Codes GET
Returns a paginated list of tax codes configured for companies. A company tax code identifies a tax jurisdiction or withholding obligation the company is registered for (e.g., a state income tax or local withholding code). **Optional Filters:** - `organization-id` — limit to tax codes for companies belonging to these organizations - `company-ids` — limit to tax codes for these companies - `include-federal` — set to `true` to include federal tax codes alongside state and local codes Multiple filters combine with AND logic; values within one parameter combine with OR. **Access control:** Results are limited to companies your integration has access to. When `organization-id` is supplied, only results from organizations containing at least one accessible company are included. Inaccessible IDs in filter parameters are silently excluded; if none match, an empty list is returned.