Docs

Update Employee

POST

Body

Arguments
objectrequired

Required employee key. Provide either Key ID or PR Company and Employee.

number

Employee record key ID. Use this or the PR Company and Employee pair.

number

Payroll company for the employee natural key. Use with Employee when Key ID is not supplied.

number

Employee number for the natural key. Use with PR Company when Key ID is not supplied.

string

Optional employee sort name. Maximum 15 characters.

string

Optional employee last name. Maximum 30 characters.

string

Optional employee first name. Maximum 30 characters.

string

Optional employee middle name. Maximum 15 characters.

string

Optional street address. Maximum 60 characters.

string

Optional second address line. Maximum 60 characters.

string

Optional city. Maximum 30 characters.

string

Optional state. Must exist in the selected country’s Vista states.

string

Optional postal code. Maximum 12 characters.

string

Optional country code. Key to Vista countries. Maximum 2 characters.

string

Optional email address. Maximum 255 characters.

string

Optional phone number. Maximum 20 characters.

string

Optional cell phone number. Maximum 20 characters.

string

Optional employee notes.

string

Optional status. Allowed values: Y or N.

Uncommon arguments
string

Optional name suffix. Maximum 4 characters.

string

Protected field. Optional Social Security number. Maximum 11 characters.

string

Protected field. Optional race code. Maximum 2 characters.

string

Protected field. Optional code: F or M.

string

Protected field. Optional date in YYYY-MM-DD format.

string

Optional date in YYYY-MM-DD format.

string

Optional date in YYYY-MM-DD format.

string

Optional date in YYYY-MM-DD format.

string

Optional date in YYYY-MM-DD format.

string

Optional date in YYYY-MM-DD format.

string

Optional date in YYYY-MM-DD format.

string

Optional timesheet reviewer group. Maximum 10 characters.

string

Optional occupational category. Maximum 10 characters.

string

Optional status: A, J, T, or N.

number

Optional CHAMP equal-opportunity trade sequence.

string

Protected field. Optional Y/N value.

number

Optional AP vendor group.

number

Optional AP vendor.

object

Optional Vista user-defined fields, keyed by field name.

object

Optional payroll defaults object. Send documented fields that need changing.

object

Optional current job object. Send documented fields that need changing.

object

Optional standard pay object. Send documented fields that need changing.

object

Optional primary direct deposit object. Send documented fields that need changing.

object

Optional garnishment allocation object. Send documented fields that need changing.

object

Optional Canada-specific payroll data object.

object

Optional Australia-specific payroll data object.

Field selectionChoose which fields should be included in the response. Learn more
string

Comma-separated response fields to include.

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is
One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.
Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.
Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.