Getting StartedAPI Reference
API Reference
Start typing to search…

Executes the Change action for the Employees data object.

post https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/pr/2/data/employees/actions/change

Changes an existing Employee Record.

Log in to see full request history
Path Params
string
required

The code of the subscriber that you are making this request for.

Body Params
required
string
length ≤ 15
string
length ≤ 30
string | null
string | null
string | null
string | null
string | null
string | null
string | null

If provided and Address.Country is on the record already or provided her, this value must exist in the States array on the hq/contries object.

string | null
string | null

Key to hq/countries natural(country).

string | null
string | null
string | null
string
length ≤ 11
string
length ≤ 2

Part of key to PR/races object (PRCo, Race).

string
length ≤ 1

Options: F-Female, M-Male.

date | null

Optional, if omitted null will be defaulted.

string | null

Optional, if omitted null will be defaulted.

string

Optional, if omitted Y will be defaulted.

date | null

Optional, if omitted null will be defaulted.

date | null

Optional, if omitted null will be defaulted.

date | null

Optional, if omitted null will be defaulted.

date | null

Optional, if omitted null will be defaulted.

date | null

Optional, if omitted null will be defaulted.

date | null

Optional, if omitted null will be defaulted.

string | null

Enter the timesheet reviewer group for this employee. Members of this group will review and approve timesheets that are entered for this employee must be found in HQ Reviewer Groups with a TimeSheet Group Type. Optional, if omitted null will be defaulted.

string | null

Part of key to pr/occupational_cats (PRCo, OccupCat). Optional, if omitted null will be defaulted.

string | null

Options: A-Apprentice, J-Journeyman, T-Trainer, N-Neither. Optional, if omitted null will be defaulted.

integer | null

CHAMP Equal Oppertunity trade sequence (overrides craft setting). Optional, if omitted null will be defaulted.

string
length ≤ 1

Optional, if omitted N will be defaulted.

integer | null

Optional, if omitted null will be defaulted.

integer | null

Optional, if omitted null will be defaulted.

__custom_fields
object

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

PayrollDefaults
object
CurrentJob
object
StandardPay
object
PrimaryDirectDeposit
object

Optional, if omitted each property will be defaulted as noted.

GarnishmentAllocation
object

Optional, if omitted each property will be defaulted as noted.

CanadaData
object

Only used if PRCo Country is AU. Optional, if omitted each property will be defaulted as noted.

AustraliaData
object

Optional, if omitted each property will be defaulted as noted.

Headers
string
required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Updated 12 months ago

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago