DocumentationAPI Reference
Request Access
Accounts

Get My Account

GET
/accounts/me

Returns basic information about the authenticated integration account, including contact details and whether webhooks are enabled.

Error Details:

  • 404 Not Found — the integration account associated with your credentials was not found

Authorization

XApiKey
X-API-KEY<token>

Your API key.

In: header

Query Parameters

api-version*string

API version

Default"3.0"
Value in"3.0"

Response Body

curl -X GET "https://external-app-prod.netchexonline.net/accounts/me?api-version=3.0"
{
  "id": 0,
  "applicationName": "string",
  "description": "string",
  "contactEmail": "string",
  "contactFirstName": "string",
  "contactLastName": "string",
  "logoLink": "string",
  "moreInfoLink": "string",
  "webhooksEnabled": true
}
{
  "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 Direct Entry Earnings GET

Returns a paginated list of direct entry earnings. A direct entry earning is a manually entered earning record for an employee — such as a bonus, reimbursement, or supplemental pay — entered directly rather than calculated from time clock punches. **Filters:** - `start-date` **Required.** Start of the date range (inclusive, YYYY-MM-DD). - `end-date` **Required.** End of the date range (inclusive, YYYY-MM-DD). - Exactly one of `organization-ids`, `company-ids`, or `employee-ids` is required; providing more than one or none returns 400. - `data-source` — optional, limit to earnings from a specific data source - `project-ids` — optional, further filter by project IDs - `client-ids` — optional, further filter by client IDs 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. Inaccessible IDs in filter parameters are silently excluded. **Error Details:** - **400 Bad Request** — `start-date` or `end-date` is missing or not in YYYY-MM-DD format, `end-date` is before `start-date`, more than one scope filter is provided, or no scope filter is provided - **404 Not Found** — no direct entry earnings were found for the specified filters