v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Resource Benefits

Executes the Change action for the Resource Benefits data object.

Update an existing Resource Benefits record.

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

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

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).

SeriesTwoCodestring nullable

Series Two Code.

__custom_fieldsobject

Custom fields for this object.

Response

Success

idstring

operationstring

statusstring