Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Resource Benefits

Executes the Add action for the Resource Benefits data object.

Adds a new Resource Benefits record.

post/direct/subscribers/{subscriber_code}/vista/hr/2/data/resource_benefits/actions/add

Path parameters

subscriber_codestring required

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

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

HRCointeger required

Company Code. REQUIRED.

HRRefinteger required

Employee/Resource Reference ID. REQUIRED.

BenefitCodestring required

Benefit Code. REQUIRED.

DependentSeqinteger required

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

EligDatestring nullable

Eligibility Date. Format: YYYY-MM-DD.

ReminderDatestring nullable

Reminder Date. Format: YYYY-MM-DD.

ActiveYN'Y' | 'N' | 'null' nullable

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

EffectDatestring nullable

Effective Date. Format: YYYY-MM-DD.

EndDatestring nullable

End Date. Format: YYYY-MM-DD.

ReinstateYN'Y' | 'N' | 'null' nullable

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

ReinstateDatestring nullable

Reinstate Date. Format: YYYY-MM-DD.

SmokerYN'Y' | 'N' | 'null' nullable

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

IDstring nullable

Insurance/Benefit ID.

EmployerCoststring nullable

Employer Cost (decimal, max 2 decimal places).

HistSeqinteger nullable

History Sequence.

UpdatedYN'Y' | 'N' | 'null' nullable

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

Notesstring nullable
CafePlanYN'Y' | 'N' | 'null' nullable

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

CafePlanAmtstring nullable

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

BatchIdinteger nullable

Batch ID.

InUseBatchIdinteger nullable

In Use Batch ID.

InUseMthstring nullable
Ben1string nullable

Beneficiary 1.

Rel1string nullable

Relationship 1.

Ben2string nullable

Beneficiary 2.

Rel2string nullable

Relationship 2.

UniqueAttchIDstring nullable

Unique Attachment ID (UUID/GUID).

SeriesTwoCode'2A' | '2B' | '2C' | '2D' | '2E' | '2F' | '2G' | '2H' | '2I' nullable

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_fieldsobject

Custom fields for this object.

Response

Success

idstring
operationstring
statusstring