Getting StartedAPI Reference
API Reference

Executes the Add Pay Period action for the Pay Periods data object.

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

Add a pay period

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
string
required
string
required
integer
required
integer
required
integer
required
integer
required
integer
required
integer
required
string
string
enum
Allowed:
string
string | null
string | null
string
integer
string | null
string
enum
Allowed:
string
enum
Allowed:
string
enum
Allowed:
string
enum
Allowed:
string
enum
Allowed:
string | null
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
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.

PaySequences
array of objects
PaySequences
Holidays
array of objects
Holidays
Frequencies
array of objects
Frequencies
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