Skip to main content
GET
Get an employee's current pay package

Authorizations

Authorization
string
header
required

Authorization: Bearer atk_live_… (a sandbox's keys are atk_test_…). Created in the API keys section of the Integrations settings; the secret is shown once.

Path Parameters

id
string
required

The employee id.

Query Parameters

company_id
string

One of the key's companies.

Response

OK

effectiveDate
string
required

The day this package took effect.

Pattern: ^\d{4}-\d{2}-\d{2}$
basis
enum<string>
required

How base pay is paid, from the base pay component's frequency: hourly when it is hourly, annual when it is annual, otherwise monthly (a stipend is paid monthly).

Available options:
annual,
monthly,
hourly
currency
string
required

The currency of every amount.

Allowed value: "ZAR"
components
object[]
required
annualTotal
number | null
required

The package's total a year, as the tenant's compensation set-up computes it (its total package). Null when it has no total, or when the total counts an hourly rate.