Getting StartedAPI Reference
API Reference

Executes the Add action for the Craft Templates data object.

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

Adds a new record to the Payroll Craft 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
integer
required

Processing Company (Primary Key Component)

string
required
length ≤ 10

Craft Code (Primary Key Component)

integer
required

Template ID (Primary Key Component)

string
enum
required

Override Effective Date Flag

Allowed:
string | null

Effective Date

string
enum
required

Override Overtime Flag

Allowed:
integer | null

Overtime Schedule ID

string
required
length ≤ 1

Reciprocal Option

string | null

Job Craft Code

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

Record Identifier (Omitted from required list for Add action)

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

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

__custom_fields
object

Custom fields defined in Vista.

AddonEarnings
array of objects

Array of Addon Earnings

AddonEarnings
DednLiabs
array of objects

Array of Deductions and Liabilities

DednLiabs
CappedBasis
array of objects

Array of Capped Basis

CappedBasis
JobCraftItems
array of objects

Array of Job Craft Items

JobCraftItems
AllowanceEarnings
array of objects

Array of Allowance Earnings

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