Executes the Add action for the Employees data object.

post

https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/pr/2/data/employees/actions/add

Adds a new Employee record.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscriber_code

string

required

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

Body Params

PRCo

integer

required

Employee

1 to 999999

Maximum 6 digits. Optional, if omitted this value will behave as if { "default": "default" } was provided.

provide the value.

SortName

string

length ≤ 15

Optional, if omitted This value will be calculated based on Vista defaulting logic with trailing digits incase of non unique results.

LastName

string

required

length ≤ 30

FirstName

string | null

Optional, if omitted null will be defaulted.

MidName

string | null

Optional, if omitted null will be defaulted.

Suffix

string | null

Optional, if omitted null will be defaulted.

Address

string | null

Optional, if omitted null will be defaulted.

Address2

string | null

Optional, if omitted null will be defaulted.

City

string | null

Optional, if omitted null will be defaulted.

State

string | null

Optional, if omitted null will be defaulted. If provided and Address.Country is provided, this value must exist in the States array on the hq/contries object.

Zip

string | null

Optional, if omitted null will be defaulted.

Country

string | null

Optional, if omitted null will be defaulted. Key to hq/countries (country).

string | null

Optional, if omitted null will be defaulted.

Phone

string | null

Optional, if omitted null will be defaulted.

CellPhone

string | null

Optional, if omitted null will be defaulted.

SSN

string

required

length ≤ 11

[PROTECTED FIELD]

Race

string

required

length ≤ 2

[PROTECTED FIELD] Part of key to PR/races object (PRCo, Race).

Sex

string

required

length ≤ 1

[PROTECTED FIELD] Options: F-Female, M-Male.

BirthDate

date | null

[PROTECTED FIELD] Format: YYYY-MM-DD. Optional, if omitted null will be defaulted.

Notes

string | null

Optional, if omitted null will be defaulted.

ActiveYN

string

enum

Optional, if omitted Y will be defaulted.

Allowed:

HireDate

date | null

Format: YYYY-MM-DD. Optional, if omitted null will be defaulted.

TermDate

date | null

Format: YYYY-MM-DD. Optional, if omitted null will be defaulted.

RecentRehireDate

date | null

Format: YYYY-MM-DD. Optional, if omitted null will be defaulted.

RecentSeparationDate

date | null

Format: YYYY-MM-DD. Optional, if omitted null will be defaulted.

NewHireActStartDate

date | null

Format: YYYY-MM-DD. Optional, if omitted null will be defaulted.

NewHireActEndDate

date | null

Format: YYYY-MM-DD. Optional, if omitted null will be defaulted.

TimesheetRevGroup

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.

OccupCat

string | null

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

CatStatus

string | null

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

TradeSeq

integer | null

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

NonResAlienYN

string

length ≤ 1

[PROTECTED FIELD] Optional, if omitted N will be defaulted.

APVendorGroup

integer | null

Optional, if omitted null will be defaulted.

APVendor

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

required

CurrentJob

object

StandardPay

object

required

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

X-Application-Key

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.

Language

Loading…

Response

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

application/json

200Success

400Describes issues with the request.