v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Company Parameters

Gets one Company Parameters object from the cache.

Represents data found in Vista™ AP Company Parameters program.

Vista view: APCO

get/direct/subscribers/{subscriber_code}/vista/ap/2/data/company_parameters/cache/{ryvitId_value}

Path parameters

subscriber_codestring required

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

ryvitId_valuestring required

The code of the data object you want to get.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Response

Success

__ryvitKeysstring[]

Array of key paths that can be used to retrieve this object.

__modifiedUTCstring

UTC timestamp of when this object was last modified in the cache.

HRCointeger required

HR Company (Primary Key)

PRCointeger required

Processing Company (Primary Key)

DependHistYN'Y' | 'N' required

Dependent History Y/N flag

DependHistCodestring nullable

BenefitHistYN'Y' | 'N' required

Benefit History Y/N flag

BenefitHistCodestring nullable

SalaryHistYN'Y' | 'N' required

Salary History Y/N flag

SalaryHistCodestring nullable

ReviewHistYN'Y' | 'N' required

Review History Y/N flag

ReviewHistCodestring nullable

TrainHistYN'Y' | 'N' required

Training History Y/N flag

TrainHistCodestring nullable

SkillsHistYN'Y' | 'N' required

Skills History Y/N flag

SkillsHistCodestring nullable

RewardHistYN'Y' | 'N' required

Reward History Y/N flag

RewardHistCodestring nullable

DisciplineHistYN'Y' | 'N' required

Discipline History Y/N flag

DisciplineHistCodestring nullable

GrievHistYN'Y' | 'N' required

Grievance History Y/N flag

GrievanceHistCodestring nullable

AccidentHistYN'Y' | 'N' required

Accident History Y/N flag

AccidentHistCodestring nullable

DrugHistYN'Y' | 'N' required

Drug History Y/N flag

DrugHistCodestring nullable

FMLAReqMonthsinteger nullable

FMLA Required Months

FMLAReqHoursstring required

FMLA Required Hours

AuditCoYN'Y' | 'N' required

Audit Company Y/N flag

AuditResourceYN'Y' | 'N' required

Audit Resource Y/N flag

AuditBenefitsYN'Y' | 'N' required

Audit Benefits Y/N flag

AuditSalaryHistYN'Y' | 'N' required

Audit Salary History Y/N flag

AuditReviewYN'Y' | 'N' required

Audit Review Y/N flag

AuditSkillsYN'Y' | 'N' required

Audit Skills Y/N flag

AuditTrainingYN'Y' | 'N' required

Audit Training Y/N flag

AuditRewardsYN'Y' | 'N' required

Audit Rewards Y/N flag

AuditDisciplineYN'Y' | 'N' required

Audit Discipline Y/N flag

AuditGrievanceYN'Y' | 'N' required

Audit Grievance Y/N flag

AuditAccidentsYN'Y' | 'N' required

Audit Accidents Y/N flag

AuditPositionsYN'Y' | 'N' required

Audit Positions Y/N flag

AuditEmplHistYN'Y' | 'N' required

Audit Employment History Y/N flag

AuditDrugYN'Y' | 'N' required

Audit Drug Y/N flag

UpdateNameYN'Y' | 'N' required

Update Name Y/N flag

UpdateAddressYN'Y' | 'N' required

Update Address Y/N flag

UpdateHireDateYN'Y' | 'N' required

Update Hire Date Y/N flag

UpdateActiveYN'Y' | 'N' required

Update Active Status Y/N flag

UpdatePRGroupYN'Y' | 'N' required

Update PR Group Y/N flag

UpdateTimecardYN'Y' | 'N' required

Update Timecard Y/N flag

UpdateW4YN'Y' | 'N' required

Update W4 Y/N flag

UpdateSalaryYN'Y' | 'N' required

Update Salary Y/N flag

UpdateBenefitsYN'Y' | 'N' | 'null' nullable

Update Benefits Y/N flag

Notesstring nullable

Notes

UniqueAttchIDstring nullable

Unique Attachment ID

UpdateOccupCatYN'Y' | 'N' required

Update Occupation Category Y/N flag

AuditAssetYN'Y' | 'N' required

Audit Asset Y/N flag

UpdateSSNYN'Y' | 'N' required

Update SSN Y/N flag

KeyIDinteger required

Record Identifier (Internal Primary Key)

AuditPTOYN'Y' | 'N' required

Audit PTO Y/N flag

InitDrugTestStatusstring nullable

AttachBatchReportsYN'Y' | 'N' required

Attach Batch Reports Y/N flag

__custom_fieldsobject

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

Example response

{
  "__modifiedUTC": "2020-01-01T13:01:01.1234567Z"
}