v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Benefit Codes

Executes the Add action for the Benefit Codes data object.

Adds a new HR Benefit Codes record.

post/direct/subscribers/{subscriber_code}/vista/hr/2/data/benefit_codes/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

HR Company (Primary Key Component)

BenefitCodestring required

Benefit Code (Primary Key Component)

Descriptionstring nullable
PlanNamestring nullable
PlanNumberstring nullable
ReportInfostring nullable
VendorGroupinteger
Vendorinteger nullable
Addressstring nullable
Citystring nullable
Statestring nullable
Zipstring nullable
Contactstring nullable
Phonestring nullable
Faxstring nullable
Emailstring nullable
EligBasisstring nullable
EligPeriodinteger nullable
Notesstring nullable
UpdatePRYN'Y' | 'N' | 'null' nullable
UniqueAttchIDstring nullable
Countrystring nullable
ACAHealthCareYN'Y' | 'N'
ACAMinEssenCoverageYN'Y' | 'N'
ACASelfInsuredYN'Y' | 'N'
__custom_fieldsobject

Response

Success

idstring
operationstring
statusstring