Getting StartedAPI Reference
API Reference

Executes the Change action for the Crafts data object.

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

Updates an existing record in the Payroll Craft 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 | null
string | null
string | null
string | null
string | null
string

Format: YYYY-MM-DD

string | null
integer | null
integer | null
integer | null
string | null
integer | 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

Options: Y-Yes, N-No.

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

Weekly Minimum for Superannuation (Kept in required list as per source schema)

__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.

AddonEarnings
array of objects

Array of Addon Earnings

AddonEarnings
DednLIabs
array of objects

Array of Deductions and Liabilities

DednLIabs
CappedCodes
array of objects

Array of Capped Codes

CappedCodes
CappedBasis
array of objects

Array of Capped Basis

CappedBasis
Holidays
array of objects

Array of Holidays

Holidays
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