Getting StartedAPI Reference
API Reference

Executes the Add action for the Benefit Codes data object.

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

Adds a new HR Benefit Codes 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 adding a new Benefit Code.

integer
required

HR Company (Primary Key Component)

string
required
length ≤ 10

Benefit Code (Primary Key Component)

string | null
string | null
string | null
string | null
integer
integer | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
integer | null
string | null
string | null
enum
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}
string | null
string
enum
Allowed:
string
enum
Allowed:
string
enum
Allowed:
__custom_fields
object
BenefitCodesEC
array of objects

Associated Earnings Codes.

BenefitCodesEC
BenefitOptions
array of objects

Associated Benefit Options.

BenefitOptions
BenefitCodesDL
array of objects

Associated Deduction/Liability Codes.

BenefitCodesDL
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