Getting StartedAPI Reference
API Reference

Executes the Add action for the Automatic Earnings data object.

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

Adds a new 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 an 'add' action payload to create a new Automatic Earnings record (dbo.PRAE).

integer
required
0 to 255

Payroll Company ID

integer
required

Employee ID

integer
required

Earning or Deduction Code

integer
required
0 to 255

Sequence

integer | null
0 to 255

Pay Sequence

string | null

Payroll Department

string | null

Insurance Code

string | null

Craft

string | null

Class

integer | null
0 to 255

Job Cost Company ID

string | null

Job ID

integer | null
0 to 255

Phase Group

string | null

Phase

integer | null
0 to 255

GL Company ID

integer | null
0 to 255

Equipment Management Company ID

string | null

Equipment ID

integer | null
0 to 255

Equipment Management Group

string | null

Revenue Code

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

Usage Units

string
enum

Standard Hours Flag

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

Hours

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

Rate Amount

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

Limit Override Amount

string
length ≤ 10

Frequency

string | null

Notes

string
enum

Override Standard Limit Y/N

Allowed:
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}

Unique Attachment ID

string | null

Mechanics Cost Code

string
enum

Equipment Mechanic Option. Options: N-None, E-Equipment Usage, M-Mechanic''s Time.

Allowed:
string
enum

Use Regular Rate Y/N

Allowed:
__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 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