Getting StartedAPI Reference
API Reference

Executes the Change action for the Leave Codes data object.

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

Updates an existing record in Payroll Leave Codes.

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
integer
required

Payroll Company

string
required
length ≤ 10

Unique code for the leave type

string | null
string
required
length ≤ 3

Unit of Measure (e.g., HRS)

string
enum
length ≤ 1

Accrual Type. Options: F-Fixed Amount, R-Rate of Earnings or Hours.

Allowed:
string | null
^[-+]?[0-9]{1,8}(?:.[0-9]{0,2})?$
string | null
string | null
string
^[-+]?[0-9]{1,8}(?:.[0-9]{0,2})?$
string | null
string
^[-+]?[0-9]{1,8}(?:.[0-9]{0,2})?$
string | null
string
^[-+]?[0-9]{1,8}(?:.[0-9]{0,2})?$
string
^[-+]?[0-9]{1,8}(?:.[0-9]{0,2})?$
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
enum
length ≤ 1

Negative Leave Balance Warning flag. Options: W-Allowed w/Warning, N-Allowed w/o Warning, E-Not Allowed.

Allowed:
AccrualUsageDetails
array of objects
AccrualUsageDetails
LeaveLevelOverrides
array of objects
LeaveLevelOverrides
__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.

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 2 months ago

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

Updated 2 months ago