Getting StartedAPI Reference
API Reference

Executes the Change action for the Automatic Earnings data object.

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

Updates existing employee earnings record

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

Schema for a 'change' action payload to update an existing Automatic Earnings record (dbo.PRAE).

__key
required

The key fields required to uniquely identify the record to be changed.

integer | null
0 to 255

Pay Sequence

string | null

Payroll Department (varchar(10), null)

string | null

Insurance Code (varchar(10), null)

string | null

Craft (varchar(10), null)

string | null

Class (varchar(10), null)

integer | null
0 to 255

Job Cost Company ID (tinyint, null)

string | null

Job ID (varchar(10), null)

integer | null
0 to 255

Phase Group (tinyint, null)

string | null

Phase (varchar(20), null)

integer | null
0 to 255

GL Company ID (tinyint, null)

integer | null
0 to 255

Equipment Management Company ID (tinyint, null)

string | null

Equipment ID (varchar(10), null)

integer | null
0 to 255

Equipment Management Group (tinyint, null)

string | null

Revenue Code (varchar(10), null)

number

Usage Units (numeric(10,2), not null)

string
length ≤ 1

Standard Hours Flag (char(1), not null)

number

Hours (numeric(10,2), not null)

number

Rate Amount (numeric(16,5), not null)

number

Limit Override Amount (numeric(12,2), not null)

string
length ≤ 10

Frequency (varchar(10), not null)

string | null

Notes (varchar(max), null)

string
length ≤ 1

Override Standard Limit Y/N (char(1), not null)

uuid | null

Unique Attachment ID (uniqueidentifier, null)

string | null

Mechanics Cost Code (varchar(10), null)

string
length ≤ 1

Equipment Mechanic Option (char(1), not null)

string
length ≤ 1

Use Regular Rate Y/N (char(1), not null)

__custom_fields
object

Custom fields defined for 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 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