Executes the Add action for the Resource Benefits data object.

post

https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/hr/2/data/resource_benefits/actions/add

Adds a new Resource Benefits record.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscriber_code

string

required

The code of the subscriber that you are making this request for.

Body Params

HRCo

integer

required

Company Code. REQUIRED.

HRRef

integer

required

Employee/Resource Reference ID. REQUIRED.

BenefitCode

string

required

length ≤ 10

Benefit Code. REQUIRED.

DependentSeq

integer

required

Dependent Sequence (0 for employee, > 0 for dependent). REQUIRED.

EligDate

string | null

Eligibility Date. Format: YYYY-MM-DD.

ReminderDate

string | null

Reminder Date. Format: YYYY-MM-DD.

ActiveYN

string | null

enum

Active Y/N indicator. Options: Y-Yes, N-No.

Allowed:

EffectDate

string | null

Effective Date. Format: YYYY-MM-DD.

EndDate

string | null

End Date. Format: YYYY-MM-DD.

ReinstateYN

string | null

enum

Reinstate Y/N indicator. Options: Y-Yes, N-No.

Allowed:

ReinstateDate

string | null

Reinstate Date. Format: YYYY-MM-DD.

SmokerYN

string | null

enum

Smoker Y/N indicator. Options: Y-Yes, N-No.

Allowed:

string | null

Insurance/Benefit ID.

EmployerCost

string | null

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

Employer Cost (decimal, max 2 decimal places).

HistSeq

integer | null

History Sequence.

UpdatedYN

string | null

enum

Updated Y/N indicator. Options: Y-Yes, N-No.

Allowed:

Notes

string | null

CafePlanYN

string | null

enum

Cafeteria Plan Y/N indicator. Options: Y-Yes, N-No.

Allowed:

CafePlanAmt

string | null

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

Cafeteria Plan Amount (decimal, max 2 decimal places).

BatchId

integer | null

Batch ID.

InUseBatchId

integer | null

In Use Batch ID.

InUseMth

string | null

Ben1

string | null

Beneficiary 1.

Rel1

string | null

Relationship 1.

Ben2

string | null

Beneficiary 2.

Rel2

string | null

Relationship 2.

UniqueAttchID

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 (UUID/GUID).

SeriesTwoCode

string | null

enum

Series Two Code. Options: 2A-Employee not employed during the month, 2B-Employee not a full-time employee, 2C-Employee enrolled in coverage offered, 2D-Employee in a section 4980H(b) Limited Non-Assessment Period, 2E-Multi-employer interim rule relief, 2F-Section 4980H affordability from W-2 safe harbor, 2G-Section 4980H affordability federal poverty line safe harbor, 2H-Section 4980H affordability rate of pay safe harbor, 2I-Non-calendar year transition relief applies to this employee

__custom_fields

object

Custom fields for this object.

DLCodes

array of objects

Deduction/Liability Codes (Child Collection).

DLCodes

EarnCodes

array of objects

Earnings Codes (Child Collection).

EarnCodes

ACACoverageHist

array of objects

ACA Coverage History (Child Collection).

ACACoverageHist

Headers

X-Application-Key

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.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Describes issues with the request.