Getting StartedAPI Reference
API Reference

Executes the Change action for the Class Templates data object.

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

Updates an existing record to the Payroll Craft Class Template program

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Body Params
__key
required
string
enum

Override Cap Limit Flag

Allowed:
string | null
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

[PROTECTED FIELD] Old Capital Limit (Omitted for Add Action)

string | null
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

New Capital Limit

string | null
string | null
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
string
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Superannuation Weekly Minimum

string | null
string | null
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

[PROTECTED FIELD] Old Basic Hourly Rate (Omitted for Add Action)

string | null
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

New Basic Hourly Rate

string | null
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

[PROTECTED FIELD] Old Fringe Benefit Rate (Omitted for Add Action)

string | null
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

New Fringe Benefit Rate

__custom_fields
object

Custom fields defined in Vista.

PayRates
array of objects

Shift Pay Rates associated with the Class Template

PayRates
VariableEarnings
array of objects

Variable Earnings associated with the Class Template

VariableEarnings
AddonEarnings
array of objects

Addon Earnings associated with the Class Template

AddonEarnings
DednLiabs
array of objects

Deductions and Liabilities associated with the Class Template

DednLiabs
AllowanceEarnings
array of objects

Allowance Earnings associated with the Class Template

AllowanceEarnings
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 4 months ago

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

Updated 4 months ago