Proliant
API integration

list_all_proliant_companies

List Proliant companies available to the current client as a lookup list. Returns: value, description.

get_single_proliant_company_by_id

Get detailed information about a specific Proliant company by id. Returns: address1, address2, adminHold, aggregateFilings, aggregateLimits, allowBackDate, allowSameDate, autoPayEmployees, autoPostRecurring, batchByPaygroup, calendarId, costCenter1Description, costCenter2Description, costCenter3Description, costCenter4Description, costCenter5Description, checkCalcSettings, checkCalcWarnings,…. Required: id.

list_all_proliant_employees

List employees for a Proliant company with optional search criteria including cost centers, name, SSN, email, and change date range. Returns: directDeposits, taxes, emergencyContacts, rates, i9ExpirationDate, i9FormsReceived, i9Verified, visaExpirationDate, visaType, lastChangeDate, overrideSupervisorCostCenter1, overrideSupervisorCostCenter2, overrideSupervisorCostCenter3,…. Required: company_id.

create_a_proliant_employee

Create a new employee for a Proliant company. Returns the created employee identifier as a string. Required: company_id, employee.

get_single_proliant_employee_by_id

Get a single employee by id from a Proliant company. Returns: employee, directDeposits, emergencyContacts, taxes, rates. Required: id, company_id.

update_a_proliant_employee_by_id

Update an employee by id in a Proliant company. Returns the updated employee identifier as a string. Required: id, company_id, employee.

delete_a_proliant_employee_by_id

Delete an employee by id from a Proliant company. Returns an empty 202 response on success. Required: id, company_id.

list_all_proliant_dependents

List dependents for an employee in a Proliant company. Returns the dependent record including its id. Required: company_id, employee_id.

create_a_proliant_dependent

Create a dependent for an employee in a Proliant company. Returns a success message string. Required: company_id, employee_id, beneficiary, isDependent, dependentId, isHandicapped, smoker.

get_single_proliant_dependent_by_id

Get a single dependent for an employee in a Proliant company by id. Returns the dependent record including its id. Required: id, company_id, employee_id.

update_a_proliant_dependent_by_id

Update a dependent for an employee in a Proliant company by id. Returns a success message string. Required: id, company_id, employee_id, beneficiary, isDependent, dependentId, isHandicapped, smoker.

list_all_proliant_rates

List all rates for an employee in a Proliant company. Returns: code, salary, rate, ratePer, costCenter1, costCenter2, costCenter3, costCenter4, costCenter5, jobCode, startDate, endDate, payGrade, id, changeRateReasonCode, raisePercentage, lastChangeUserName, lastChangeDateTime. Required: company_id, employee_id.

create_a_proliant_rate

Create a new rate for an employee in a Proliant company. Returns a success string. Required: company_id, employee_id, code.

update_a_proliant_rate_by_id

Update an existing rate for an employee in a Proliant company. Returns a success string. Required: id, company_id, employee_id, code.

delete_a_proliant_rate_by_id

Delete a rate for an employee in a Proliant company by id. Returns an empty 202 response on success. Required: id, company_id, employee_id.

proliant_rates_bulk_update

Bulk update rates for an employee in a Proliant company. Returns a success string. Required: company_id, employee_id.

list_all_proliant_employee_accruals

List all accrual records for an employee in a Proliant company. Returns: code, startDate, endDate, lengthOfService, rate, amount, hours, maximum, carryOverMaximum, overrideRate, overrideHours, overrideAmount, usedHours, usedAmount, availableHours, availableAmount, lastAccrueDate, lastChangeDateTime, lastChangeUser, probationHours, probationDollars, accruedHours, accruedDollars, grantedHours,…. Required: company_id, employee_id.

create_a_proliant_employee_accrual

Create an accrual record for an employee in a Proliant company. Returns: code. Required: company_id, employee_id, code, startDate, lengthOfService, lastAccrueDate.

get_single_proliant_employee_accrual_by_id

Get a single accrual record for an employee in a Proliant company by id. Returns: code, startDate, endDate, lengthOfService, rate, amount, hours, maximum, carryOverMaximum, overrideRate, overrideHours, overrideAmount, usedHours, usedAmount, availableHours, availableAmount, lastAccrueDate, lastChangeDateTime, lastChangeUser, probationHours, probationDollars, accruedHours, accruedDollars,…. Required: id, company_id, employee_id.

update_a_proliant_employee_accrual_by_id

Update an accrual record for an employee in a Proliant company by id. Returns: code. Required: id, company_id, employee_id, code, startDate, lengthOfService, lastAccrueDate.

delete_a_proliant_employee_accrual_by_id

Delete an accrual record for an employee in a Proliant company by id. Returns an empty 202 response on success. Required: id, company_id, employee_id.

list_all_proliant_company_accruals

List all accrual records associated with a Proliant company. Returns each accrual record including its code. Required: company_id.

create_a_proliant_company_accrual

Create a new accrual record for a Proliant company. Returns the created accrual record including its code. Required: company_id, code, probationDays, hoursBased, hoursOrDollars, divisor, decimals, applyRulesESTA, allowRequests, allowNegativeRequests.

get_single_proliant_company_accrual_by_id

Get a single accrual record for a Proliant company by id. Returns the accrual record including its code. Required: id, company_id.

update_a_proliant_company_accrual_by_id

Update an existing accrual record for a company in Proliant. Returns: id, attributes. Required: id, company_id, code, probationDays, hoursBased, hoursOrDollars, divisor, decimals, applyRulesESTA, allowRequests, allowNegativeRequests.

delete_a_proliant_company_accrual_by_id

Delete an accrual record for a company in Proliant by id. Returns an empty 202 response on success. Required: id, company_id.

list_all_proliant_certifications

List certifications for an employee in Proliant. Returns: id, code, description, number, effectiveDate, expirationDate, companyPaid, employeePaid, reimbursed, notes. Required: company_id, employee_id.

create_a_proliant_certification

Create a certification for an employee in Proliant by submitting an EmployeeCertificationViewModel request body. Returns a string message confirming the certification was created. Required: company_id, employee_id, code.

update_a_proliant_certification_by_id

Update a certification for an employee in Proliant by id, submitting an EmployeeCertificationViewModel request body. Returns a string message confirming the certification was updated. Required: id, company_id, employee_id, code.

delete_a_proliant_certification_by_id

Delete a certification for an employee in Proliant by id. Returns an empty 202 response on success. Required: id, company_id, employee_id.

list_all_proliant_educations

List education records for an employee in a Proliant company. Returns: id, school, years, gpa, graduated, major, degree, classes, awards, notes. Required: company_id, employee_id.

create_a_proliant_education

Create a new education record for an employee in a Proliant company. Returns the created education record identifier as a string. Required: company_id, employee_id, school.

update_a_proliant_education_by_id

Update an education record for a specific employee in Proliant. Returns a string value (typically a success message or record identifier). Required: id, company_id, employee_id, school.

delete_a_proliant_education_by_id

Delete an education record for a specific employee in Proliant. Returns an empty 202 response on success. Required: id, company_id, employee_id.

list_all_proliant_deduction_codes

List all deduction code records for a Proliant company. Returns: code, description, shortDescription, dedType, priority, w2Field, printOnCheckStub, minimum, maximum, annualMaximum, rate, autoDrop, dropPartial, autoMakeup, frequency, calculationCode, agency, taxExempt, grossCheck, disallowOverrideCalcCode, disallowOverrideRate, disallowOverrideFrequency, disallowOverrideAgency,…. Required: company_id.

create_a_proliant_deduction_code

Create a new deduction code record for a Proliant company. Returns the created deduction code record. Required: company_id.

get_single_proliant_deduction_code_by_id

Get a single deduction code record by id in Proliant. Returns: code, description, shortDescription, dedType, priority, w2Field, printOnCheckStub, minimum, maximum, annualMaximum, rate, autoDrop, dropPartial, autoMakeup, frequency, calculationCode, agency, taxExempt, grossCheck, disallowOverrideCalcCode, disallowOverrideRate, disallowOverrideFrequency, disallowOverrideAgency,…. Required: id, company_id.

update_a_proliant_deduction_code_by_id

Update a deduction code record by id for a Proliant company. Returns the updated deduction code record. Required: id, company_id.

delete_a_proliant_deduction_code_by_id

Delete a deduction code record by id in Proliant. Returns an empty 202 response on success. Required: id, company_id.

list_all_proliant_employee_deduction_codes

List all employee deduction code records for a specific employee in a Proliant company. Returns the employee deduction code records including code, calculationCode, rate, amount, startDate, endDate and the remaining deduction configuration fields. Required: company_id, employee_id.

create_a_proliant_employee_deduction_code

Create a new employee deduction code record in Proliant. Returns the created deduction code object including code, activeDate, and deduction configuration fields. Required: company_id, employee_id.

get_single_proliant_employee_deduction_code_by_id

Get a single employee deduction code record from Proliant by code and active date. Returns the employee deduction code record including code, calculationCode, rate, amount, startDate, endDate and the remaining deduction configuration fields. Required: id, company_id, employee_id, code.

update_a_proliant_employee_deduction_code_by_id

Update an existing employee deduction code record in Proliant by code and active date. Returns the updated deduction code object including code, activeDate, and deduction configuration fields. Required: id, company_id, employee_id, code.

delete_a_proliant_employee_deduction_code_by_id

Delete an employee deduction code record from Proliant by code and active date. Returns an empty 202 response on success. Required: id, company_id, employee_id, code.

list_all_proliant_earning_codes

List all earning code records for a company in Proliant. Returns: code, description, shortDescription, earnType, minimum, maximum, annualMaximum, overrideRate, addToRate, rateMultiplier, overrideShift, unitDescription, autoDrop, calculationCode, rateCode, amount, frequency, units, rate, agency, dCode, reduceAutoPay, taxExempt, worked, disallowOverrideCalcCode, disallowOverrideRate,…. Required: company_id.

create_a_proliant_earning_code

Create a new earning code record for a company in Proliant. Returns the created earning code object whose properties are defined by Proliant's EarningCodeViewModel schema. Required: company_id, code.

get_single_proliant_earning_code_by_id

Get a single earning code record by id for a company in Proliant. Returns: code, description, shortDescription, earnType, minimum, maximum, annualMaximum, overrideRate, addToRate, rateMultiplier, overrideShift, unitDescription, autoDrop, calculationCode, rateCode, amount, frequency, units, rate, agency, dCode, reduceAutoPay, taxExempt, worked, disallowOverrideCalcCode, disallowOverrideRate,…. Required: id, company_id.

update_a_proliant_earning_code_by_id

Update an earning code record by id for a company in Proliant. Returns the updated earning code object whose properties are defined by Proliant's EarningCodeViewModel schema. Required: id, company_id, code.

delete_a_proliant_earning_code_by_id

Delete an earning code record by id for a company in Proliant. Returns an empty 202 response on success. Required: id, company_id.

list_all_proliant_employee_earning_codes

List all earning code records associated with an employee in Proliant. Returns: agency, amount, annualMaximum, calcCode, description, costCenter1, costCenter2, costCenter3, costCenter4, costCenter5, code, jobCode, endDate, frequency, goal, lastDate, maximum, minimum, miscInfo, otc1, otc2, otc3, paidTowardsGoal, rate, rateCode, ratePer, startDate, tabled, thirdPartyId, units. Required: company_id, employee_id.

create_a_proliant_employee_earning_code

Create a new earning code record for an employee in Proliant. Returns: code, startDate. Required: company_id, employee_id.

get_single_proliant_employee_earning_code_by_id

Get a single earning code record for an employee in Proliant by code and start date. Returns: agency, amount, annualMaximum, calcCode, description, costCenter1, costCenter2, costCenter3, costCenter4, costCenter5, code, jobCode, endDate, frequency, goal, lastDate, maximum, minimum, miscInfo, otc1, otc2, otc3, paidTowardsGoal, rate, rateCode, ratePer, startDate, tabled, thirdPartyId, units.…. Required: id, company_id, employee_id, code.

update_a_proliant_employee_earning_code_by_id

Update an earning code record for an employee in Proliant by code and start date. Returns: code, startDate. Required: id, company_id, employee_id, code.

delete_a_proliant_employee_earning_code_by_id

Delete an earning code record for an employee in Proliant by code and start date. Returns an empty 202 response on success. Required: id, company_id, employee_id, code.

list_all_proliant_employee_insurances

List insurance records for a specific employee in a Proliant company. Returns each insurance record including its id. Required: company_id, employee_id.

create_a_proliant_employee_insurance

Create an insurance record for an employee in a Proliant company by submitting an insurance model. Returns the unique identifier of the created insurance record as a string. Required: company_id, employee_id, deduct, code, isOnCobra, ovContribution, ovCoverage, ovCoverageAmount, ovPayPeriodsRemainingInYear, ovPremium, s125, startDate, useSalaryACA.

get_single_proliant_employee_insurance_by_id

Get a single insurance record for an employee in a Proliant company by id. Returns the insurance record including its id. Required: id, company_id, employee_id.

update_a_proliant_employee_insurance_by_id

Update an insurance record for an employee in a Proliant company by id, submitting an insurance model. Returns the unique identifier of the updated insurance record as a string. Required: id, company_id, employee_id, deduct, code, isOnCobra, ovContribution, ovCoverage, ovCoverageAmount, ovPayPeriodsRemainingInYear, ovPremium, s125, startDate, useSalaryACA.

list_all_proliant_company_insurances

List all insurance plan records associated with a company in Proliant. Returns: acaEmployerContributionPercentage, acaLowestCostPlan, acaOverridePercent, acaSafeHarborMethod, isAgeBased, ageCode, agentAddress1, agentAddress2, agentCity, agentName, agentState, agentZip, agePremiumDescription, allow125, allowCobra, childPlanOverrideOption, childPremiumDescription, co, cobraAdminPercentFee,…. Required: company_id.

get_single_proliant_company_insurance_by_id

Get a single insurance plan record for a company in Proliant by id. Returns: acaEmployerContributionPercentage, acaLowestCostPlan, acaOverridePercent, acaSafeHarborMethod, isAgeBased, ageCode, agentAddress1, agentAddress2, agentCity, agentName, agentState, agentZip, agePremiumDescription, allow125, allowCobra, childPlanOverrideOption, childPremiumDescription, co, cobraAdminPercentFee,…. Required: id, company_id.

list_all_proliant_cost_center_1_s

Gets all Cost Center 1 records associated for the provided company. Returns: active, address1, address2, code, city, country, county, name. Required: company_id.

create_a_proliant_cost_center_1

Creates a Cost Center 1 record for the provided company. Required: company_id, active.

get_single_proliant_cost_center_1_by_id

Gets a Cost Center 1 record for the provided company. Returns: active, address1, address2, code, city, country, county, name. Required: id, company_id.

update_a_proliant_cost_center_1_by_id

Updates a Cost Center 1 record for the provided company. Required: id, company_id, active.

delete_a_proliant_cost_center_1_by_id

Deletes a Cost Center 1 record for the provided company. Required: id, company_id.

list_all_proliant_cost_center_2_s

Gets all Cost Center 2 records associated for the provided company. Returns: active, address1, address2, code, city, country, county, name. Required: company_id.

create_a_proliant_cost_center_2

Creates a Cost Center 2 record for the provided company. Required: company_id, active.

get_single_proliant_cost_center_2_by_id

Gets a Cost Center 2 record for the provided company. Returns: active, address1, address2, code, city, country, county, name. Required: id, company_id.

update_a_proliant_cost_center_2_by_id

Updates a Cost Center 2 record for the provided company. Required: id, company_id, active.

delete_a_proliant_cost_center_2_by_id

Deletes a Cost Center 2 record for the provided company. Required: id, company_id.

list_all_proliant_cost_center_3_s

Gets all Cost Center 3 records associated for the provided company. Returns: active, address1, address2, code, city, country, county, name. Required: company_id.

create_a_proliant_cost_center_3

Creates a Cost Center 3 record for the provided company. Required: company_id, active.

get_single_proliant_cost_center_3_by_id

Gets a Cost Center 3 record for the provided company. Returns: active, address1, address2, code, city, country, county, name. Required: id, company_id.

update_a_proliant_cost_center_3_by_id

Updates a Cost Center 3 record for the provided company. Required: id, company_id, active.

delete_a_proliant_cost_center_3_by_id

Deletes a Cost Center 3 record for the provided company. Required: id, company_id.

list_all_proliant_cost_center_4_s

Gets all Cost Center 4 records associated for the provided company. Returns: active, address1, address2, code, city, country, county, name. Required: company_id.

create_a_proliant_cost_center_4

Creates a Cost Center 4 record for the provided company. Required: company_id, active.

get_single_proliant_cost_center_4_by_id

Gets a Cost Center 4 record for the provided company. Returns: active, address1, address2, code, city, country, county, name. Required: id, company_id.

update_a_proliant_cost_center_4_by_id

Updates a Cost Center 4 record for the provided company. Required: id, company_id, active.

delete_a_proliant_cost_center_4_by_id

Deletes a Cost Center 4 record for the provided company. Required: id, company_id.

list_all_proliant_cost_center_5_s

List all Cost Center 5 records for a Proliant company. Returns: active, address1, address2, code, city, country, county, name, overrideCheckAcctName, overrideRate, overrideRateCode, overrideShift, phone, state, supervisor, useThisAddrOnChecks, wcc, zip. Required: company_id.

create_a_proliant_cost_center_5

Create a Cost Center 5 record for a Proliant company. Returns: id. Required: company_id, active.

get_single_proliant_cost_center_5_by_id

Get a single Cost Center 5 record by id for a Proliant company. Returns: active, address1, address2, code, city, country, county, name, overrideCheckAcctName, overrideRate, overrideRateCode, overrideShift, phone, state, supervisor, useThisAddrOnChecks, wcc, zip. Required: id, company_id.

update_a_proliant_cost_center_5_by_id

Update a Cost Center 5 record by id for a Proliant company. Returns: id. Required: id, company_id, active.

delete_a_proliant_cost_center_5_by_id

Delete a Cost Center 5 record by id for a Proliant company. Returns: id. Required: id, company_id.

list_all_proliant_job_codes

List all Proliant job code records for a company. Returns: code, description, address1, address2, city, state, zip, overrideShift, overrideRateCode, overrideRate, addToRate, certifiedJob, rateMultiplier, startDate, endDate, projectNumber. Required: company_id.

create_a_proliant_job_code

Create a new Proliant job code record for a company. Returns: code, description, address1, address2, city, state, zip, overrideShift, overrideRateCode, overrideRate, addToRate, certifiedJob, rateMultiplier, startDate, endDate, projectNumber. Required: company_id.

get_single_proliant_job_code_by_id

Get a single Proliant job code record by id. Returns: code, description, address1, address2, city, state, zip, overrideShift, overrideRateCode, overrideRate, addToRate, certifiedJob, rateMultiplier, startDate, endDate, projectNumber. Required: id, company_id.

update_a_proliant_job_code_by_id

Update a Proliant job code record by id. Returns: code, description, address1, address2, city, state, zip, overrideShift, overrideRateCode, overrideRate, addToRate, certifiedJob, rateMultiplier, startDate, endDate, projectNumber. Required: id, company_id.

delete_a_proliant_job_code_by_id

Delete a Proliant job code record by id. Returns an empty 202 response on success. Required: id, company_id.

list_all_proliant_shift_codes

Gets all Shift code records associated for the provided company. Returns: code, description, addToRate, rate, rateMultiplier. Required: company_id.

create_a_proliant_shift_code

Creates a shift code record for the provided company. Required: company_id.

get_single_proliant_shift_code_by_id

Gets a shift code record for the provided company. Returns: code, description, addToRate, rate, rateMultiplier. Required: id, company_id.

update_a_proliant_shift_code_by_id

Updates a shift code record for the provided company. Required: id, company_id.

delete_a_proliant_shift_code_by_id

Deletes a shift code record for the provided company. Required: id, company_id.

list_all_proliant_positions

Get Positions. Returns: approvedDate, budgeted, costCenter1, costCenter2, costCenter3, costCenter4, costCenter5, closedDate. Required: company_id.

create_a_proliant_position

Create Position. Required: company_id, budgeted, positionCode.

get_single_proliant_position_by_id

Get Position. Returns: approvedDate, budgeted, costCenter1, costCenter2, costCenter3, costCenter4, costCenter5, closedDate. Required: id, company_id.

update_a_proliant_position_by_id

Update Position. Required: id, company_id, budgeted, positionCode.

delete_a_proliant_position_by_id

Delete Position. Required: id, company_id.

list_all_proliant_taxes

Gets all Company Tax records associated for the provided company. Returns: taxCode, description, startDate, endDate, taxType. Required: company_id.

get_single_proliant_tax_by_id

Gets a Company Tax record for the provided company. Returns: taxCode, description, startDate, endDate, taxType. Required: id, company_id.

proliant_employee_taxes_bulk_update

Updates taxes for an employee. Required: company_id, employee_id.

list_all_proliant_employee_groups

Get Employee Groups. Returns: id, code, title, description, groupType, updateFrequency, nextEvaluationDateTime, timeZone. Required: company_id.

get_single_proliant_employee_group_by_id

Get Employee Group Members. Returns: id, employeeGuid, employeeId, firstName, middleName, lastName, startDate, endDate. Required: id, company_id.

proliant_employee_direct_deposits_bulk_update

Updates direct deposits for an employee. Required: company_id, employee_id.

proliant_employee_informations_bulk_update

Updates demographics information for an employee. Required: company_id, employee_id, hireDate, employeeStatus, employeeType, lastName, firstName, payFrequency.

proliant_employee_emergency_contacts_bulk_update

Updates emergency contacts for an employee. Required: company_id, employee_id.

list_all_proliant_employee_ptos

Gets all pto requests for an employee in a company. Returns: approvalStatus, code, cancelledByEmployeeGuid, cancelledDateTime, displayCode, endDate, guidfield, id. Required: company_id, employee_id.

get_single_proliant_employee_pto_by_id

Gets all pto requests for an employee in a company. Returns: approvalStatus, code, cancelledByEmployeeGuid, cancelledDateTime, displayCode, endDate, guidfield, id. Required: id, company_id, employee_id.

list_all_proliant_company_ptos

Gets all pto requests within a date range for a company. Returns: approvalStatus, code, cancelledByEmployeeGuid, cancelledDateTime, displayCode, endDate, guidfield, id. Required: company_id.

list_all_proliant_kiosk_elections

Gets employee kiosk settings for an employee. Returns: electronicVoucher, onlineTaxForm, paystubNotification, online1095cForm. Required: company_id, employee_id.

create_a_proliant_kiosk_election

Creates employee settings for an employee. Required: company_id, employee_id, electronicVoucher, onlineTaxForm, paystubNotification, online1095cForm.

proliant_kiosk_elections_bulk_update

Updates employee kiosk settings for an employee. Required: company_id, employee_id, electronicVoucher, onlineTaxForm, paystubNotification, online1095cForm.

list_all_proliant_licenses

Gets licenses for an employee in a company. Returns: id, code, state, number, issueDate, expirationDate, notes, examDate. Required: company_id, employee_id.

create_a_proliant_license

Creates license for an employee in a company. Required: company_id, employee_id, code.

update_a_proliant_license_by_id

Updates license for an employee in a company. Required: id, company_id, employee_id, code.

delete_a_proliant_license_by_id

Deletes a license for an employee in a company. Required: id, company_id, employee_id.

list_all_proliant_skills

Gets skills for an employee in a company. Returns: id, code, description, date, proficiency, notes. Required: company_id, employee_id.

create_a_proliant_skill

Creates Skill for an employee in a company. Required: company_id, employee_id, code.

update_a_proliant_skill_by_id

Updates Skill for an employee in a company. Required: id, company_id, employee_id, code.

delete_a_proliant_skill_by_id

Deletes a skill for an employee in a company. Required: id, company_id, employee_id.

list_all_proliant_employee_reviews

Gets Reviews for an employee in a company. Returns: date, effectiveDate, employeesNotes, id, newPayAmount, newPayPer, newPosition, nextReviewDate. Required: company_id, employee_id.

get_single_proliant_employee_review_by_id

Gets Reviews for an employee in a company. Returns: date, effectiveDate, employeesNotes, id, newPayAmount, newPayPer, newPosition, nextReviewDate. Required: id, company_id, employee_id.

list_all_proliant_company_reviews

Gets Reviews for an employee in a company. Returns: employeeId, date, effectiveDate, id, newPayAmount, newPayPer, raiseAmount. Required: company_id.

create_a_proliant_payroll

Creates a payroll calendar. Required: company_id, checkDate, periodBegin, periodEnd, payrollType, scheduledProcessDate.

proliant_payrolls_start

Starts a scheduled payroll. Required: company_id, calendar_guid.

proliant_payrolls_verify

Runs payroll verification tests and returns the results. Returns: id, description, result, approved, approvedByUser, details. Required: company_id, calendar_guid.

create_a_proliant_payroll_restart

Restarts an open payroll. Required: company_id, calendar_guid, batch.

list_all_proliant_payroll_preproceses

Pre-calculates the payroll to identify any issues and returns a preview of all checks in the payroll. Returns: paychecks, message, taxSetup. Required: company_id, calendar_guid.

create_a_proliant_payroll_preprocese

Pre-calculates the payroll to identify any issues. Returns: paychecks, message, taxSetup. Required: company_id, calendar_guid.

create_a_proliant_payroll_approve

Approves all batches in the calendar. Required: company_id, calendar_guid, batch.

create_a_proliant_payroll_verify

Approves a verification test. Required: company_id, calendar_guid, verification_id.

create_a_proliant_payroll_verify_all

Approves all verification tests. Required: company_id, calendar_guid.

create_a_proliant_payroll_submit

Submits an approved payroll. Required: company_id, calendar_guid.

create_a_proliant_earning

Adds earnings to one or more employee check(s) in the regular batch. Returns: paychecks, message, taxSetup. Required: company_id, earnings.

list_all_proliant_earnings

Gets earnings details by calendar and batch, optionally filtered by a list of employee ids. Returns: paychecks, message, taxSetup. Required: company_id, calendar_id, batch.

list_all_proliant_earnings_calendars

List Proliant earnings calendars for a company, using today as the transaction date. Returns: co, checkDate, periodBegin, periodEnd, calendarId, status, periodBegunUserId, scheduledProcessDate, actualProcessDate, payrollNotes, sequence, eDirDepAuditReportApprovedBy, eDirDepAuditReportApprovedDate. Required: company_id.

list_all_proliant_earnings_calendars_by_date

List earnings calendars for a Proliant company filtered by a specific transaction date. Returns a list of calendar records including id and calendarId. Required: company_id, date.

list_all_proliant_search_earnings_calendars

Search Proliant earnings calendars for a company within a specified date range. Returns: co, checkDate, periodBegin, periodEnd, calendarId, status, periodBegunUserId, scheduledProcessDate, actualProcessDate, payrollNotes, sequence, eDirDepAuditReportApprovedBy, eDirDepAuditReportApprovedDate. If omitted, startDate defaults to 1980-01-01 and endDate defaults to 2100-12-31. Required: company_id.

create_a_proliant_daily_pay_earning

Add earnings to one or more employee checks in the Proliant daily pay batch. Returns a success message string. Required: company_id, earnings.

list_all_proliant_daily_pay_earnings

Get earnings details by calendar for the Proliant daily pay batch, optionally filtered by a list of employee ids. Returns the earnings response object including its attributes. Required: company_id, calendar_id.

list_all_proliant_daily_pay_calendars

List current active Daily Pay calendars for a company in Proliant. Returns: co, checkDate, periodBegin, periodEnd, calendarId, status, periodBegunUserId, scheduledProcessDate, actualProcessDate, payrollNotes, sequence, eDirDepAuditReportApprovedBy, eDirDepAuditReportApprovedDate. Required: company_id.

list_all_proliant_daily_pay_calendars_by_date

List active Daily Pay calendars for a Proliant company as of a specific date. Returns each calendar record with its calendarId and additional calendar attributes from the CompanyCalendarViewModel. Required: company_id, date.

list_all_proliant_pay_histories

List pay history records for a Proliant company within a date range, optionally filtered by cost centers, job code, shift code, workers comp code, and calendar id. Returns: co, id, type, checkDate, totalHours, totalAmount, transId, calendarId, gross, net. Required: company_id, start_date, end_date.

list_all_proliant_pay_history_tax_forms

List Proliant pay history tax form data for a company and tax year, retrieving raw values for tax form totals. Returns: companyId, employeeId, taxYear, calculationDate, releaseDate, formData, formType, isCorrection, id. Required: company_id, tax_year.

list_all_proliant_pay_history_details

List pay history details for employees in a Proliant company within a date range, including paycheck details. Returns: co, id, checkDate, transType, det, detCode, hours, rate, amount, rateCode, tcode1, tcode2, tcode3, tcode4, beginDate, endDate, shift, wcc, cc1, cc2, cc3, cc4, cc5, jobCode, gl1, gl2, gl3, gl4, gl5, gl6, cd, xgl1, xgl2, xgl3, xgl4, xgl5, xgl6, comment, trans, calendarId. Required: company_id, start_date, end_date.

get_single_proliant_pay_stub_by_id

Get a specific pay stub for a Proliant employee by transaction id. Returns the pay stub record including its id and paycheck detail attributes. Required: id, company_id, employee_id.

list_all_proliant_pay_history_tax_docs

Get latest year end tax document for an employee by tax year that is in a released state. Required: company_id, employee_id, tax_year.

list_all_proliant_journal_entries

Gets all pto requests within a date range for a company. Returns: amount, calendarId, transType, det, detCode, entryDate, gl1, gl2. Required: company_id.

list_all_proliant_reports

Gets a list of reports available for run. Returns: title, description, id, format, category, options. Required: company_id.

get_single_proliant_report_by_id

Runs and returns content for the report. Required: id, company_id.

create_a_proliant_report

Runs and returns content for the report. Required: company_id, report_id.

list_all_proliant_report_all_reports

Gets a list of reports available for run. Returns: title, description, id, format, category, options. Required: company_id.

list_all_proliant_report_parameters

List valid parameter options for running a specific Proliant report within a company. Returns the report's parameter definitions as an attributes object whose shape is report-specific, describing the valid options for report execution. Required: company_id, report_id.

list_all_proliant_timecards

List Proliant timecards for an employee within a specified date range. Returns: globalId, companyGlobalId, employeeGlobalId, timecardHeaderGlobalId, employeeBadgeNumber, isIdnegative, periodStart, periodEnd, weekStart, weekEnd, workDate, punchDate, punchDateTimeZone, status, calcPending, inPunchTimeLocal, inTimeZone, inModifier, outPunchTimeLocal, outTimeZone, outModifier, inPunchType,…. Required: company_id, employee_id, start_date, end_date.

update_a_proliant_timecard_by_id

Update a specific Proliant employee timecard by id. Returns a string confirmation response. Required: id, company_id, employee_id.

delete_a_proliant_timecard_by_id

Delete a Proliant timecard by id. Returns a boolean indicating whether the deletion was successful. Required: id, company_id.

proliant_timecard_approves_bulk_update

Approve a Proliant timecard by its timecard header guid. Returns a string result extracted from the response data field confirming the approval. Required: company_id, timecard_header_guid.

list_all_proliant_time_imports

Get the results of an existing time import by calendar and service provider in Proliant. Returns: importsByProvider, error. Required: company_id, calendar_id.

create_a_proliant_time_import

Start time import(s) for a calendar in Proliant, triggering imports from configured service providers. Returns: error. Required: company_id, calendar_id.

create_a_proliant_punch

Create a time clock punch for a specific employee in Proliant. Returns the received punch request data confirming the punch was processed. Required: company_id, employee_id, punchTimeLocal.

create_a_proliant_tip_sale

Process employee tip sales lines for a Proliant company by submitting a sales line payload. Returns a confirmation string indicating the sales lines have been processed. Required: company_id, salesTickets.

create_a_proliant_employee_tip

Process daily hours and tips data for employees in a Proliant company. Returns a string confirmation that hours and tips data have been processed. Required: company_id, DailyHoursAndTips.

create_a_proliant_tip_punch

Create daily tip punch records for employees in a Proliant company. Returns a success message string confirming that punch records have been processed. Required: company_id, DailyPunches.

create_a_proliant_manual_check

Create manual checks in Proliant by adding earnings to one or more employee checks in the manual batch. Returns an earnings response object whose field-level details are not enumerated in the available API specification. Required: company_id.

create_a_proliant_onboarding

Create an onboarding employee record for a company in Proliant. Returns a string value (e.g., the created employee identifier or a success message) on success. Required: company_id, firstName, lastName, startDate, hireDate, workState, empType, payFrequency, defaultHours.

list_all_proliant_onboarding_settings

Get Proliant onboarding settings for a company, including configured RPO values that external systems can map to new hire data. Returns the onboarding settings object with fields defined upstream in Proliant's OnboardingSettingsViewModel schema. Required: company_id.

list_all_proliant_org_charts

List the full organization chart for a Proliant company. Returns a collection of org chart nodes with id and upstream-defined attributes. Required: company_id.

list_all_proliant_trainings

List training records for an employee in a Proliant company. Returns: id, code, description, level, status, startDate, endDate, companyPaid, employeePaid, reimbursed, notes, scheduledDate, expirationDate, renewalFrequency, instructor, certificate, hours, score, category. Required: company_id, employee_id.

create_a_proliant_training

Create a training record for an employee in a Proliant company. Returns a string result indicating the operation outcome. Required: company_id, employee_id, code, category.

update_a_proliant_training_by_id

Update a training record for an employee in a Proliant company. Returns a string result indicating the operation outcome. Required: id, company_id, employee_id, code, category.

delete_a_proliant_training_by_id

Delete a training record for an employee in a Proliant company. Returns an empty 202 response on success. Required: id, company_id, employee_id.

list_all_proliant_workers_comp_codes

List all workers' compensation code records for a company in Proliant. Returns: description, id, isSecondaryCode, secondaryCode, thresholdRate, code. Required: company_id.

list_all_proliant_workers_comp_code_rates

List all workers comp code rate records for a Proliant company. Returns: id, startDate, state, code, codeGroup, defaultIfNoSUI, employeeRateCode, employeeOverrideRate, endDate, employerCode, experienceRate, factor3, factor3description, factor4, factor4description, factor5, factor5description, factor6, factor6description, factor7, factor7description, fiscalStart, isHourly, impound, limit,…. Required: company_id.

create_a_proliant_workers_comp_code_rate

Create a new workers comp code rate record for a Proliant company. Returns a workers comp rate record including its id. Required: company_id, startDate, state, code, isHourly, impound, overtimeSubject, usePeriodEnd.

get_single_proliant_workers_comp_code_rate_by_id

Get a specific workers comp code rate in Proliant by code, state, and id. Returns: id, startDate, state, code, codeGroup, defaultIfNoSUI, employeeRateCode, employeeOverrideRate, endDate, employerCode, experienceRate, factor3, factor3description, factor4, factor4description, factor5, factor5description, factor6, factor6description, factor7, factor7description, fiscalStart, isHourly, impound,…. Required: id, company_id, code, state.

update_a_proliant_workers_comp_code_rate_by_id

Update a workers comp code rate record in Proliant by company, code, state, and id. Returns the updated rate record including its id. Required: id, company_id, code, state, isHourly, impound, overtimeSubject, usePeriodEnd.

list_all_proliant_tax_states

Gets all Company Tax records associated for the provided company and state. Returns: taxCode, description, startDate, endDate, taxType. Required: company_id, state.

list_all_proliant_tax_locals

List all local ProLiant company tax records for a given company and state. Returns: taxCode, description, startDate, endDate, taxType. Required: company_id, state.

list_all_proliant_tax_locals_all

List all local tax records associated with a company in Proliant. Returns each local tax record with its id and tax configuration attributes. Required: company_id.

list_all_proliant_utility_versions

Get the current Proliant API version. Returns: version.

list_all_proliant_utility_healths

Get the Proliant API health status. Returns an object containing the API up status, database access status, and current API version.

list_all_proliant_utility_allowed_paths

List the allowed API paths for the current Proliant user. Returns a collection of path strings representing the endpoints the authenticated user is permitted to access. No required parameters.

create_a_proliant_utility_client_secret

Create (reset) a new client secret for the authenticated Proliant API user. Returns the newly generated client secret string. No request parameters or body are required.

list_all_proliant_lookup_genders

List all gender code options in Proliant. Returns: value, description.

list_all_proliant_lookup_marital_statuses

List all marital status options in Proliant. Returns: value, description.

list_all_proliant_lookup_tax_forms

List all available tax form options in Proliant. Returns: value, description.

list_all_proliant_lookup_auto_pays

List base auto pay options in Proliant. Returns: value, description. No required parameters.

list_all_proliant_lookup_visa_types

List visa type options available in Proliant. Returns: value, description.

list_all_proliant_lookup_rate_pers

List rate per options in Proliant. Returns: value, description.

list_all_proliant_lookup_tax_options

Gets list of TaxOption values. Returns: value, description.

list_all_proliant_lookup_pay_grades

Gets all pay grade options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_pay_groups

Gets all pay group options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_positions

List all position options for a Proliant company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_unions

Gets all union options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_employee_statuses

Gets all employee status options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_employee_types

Gets all employee type options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_benefit_classes

Gets all benefit class options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_time_clock_groups

Gets all time clock group options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_time_clock_pay_classes

Gets all time clock pay class options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_access_groups

Gets all time clock Access Groups. Returns: value, description. Required: company_id.

list_all_proliant_lookup_time_clock_schedule_patterns

Gets all time clock schedule pattern options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_workers_comp_codes

Gets all workers comp code options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_workers_comp_rates

Gets all workers comp code options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_eeo_classes

Gets all workers comp code options. Returns: value, description. Required: company_id.

list_all_proliant_lookup_earning_codes

Gets all Earning code records associated for the provided company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_deduction_codes

Gets all Deduction code records associated for the provided company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_pay_frequencies

Gets all Pay Frequency records associated for the provided company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_termination_reasons

Gets all Termination reasons records associated for the provided company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_job_codes

Gets all Job code records associated for the provided company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_cost_center_1_s

Gets all Cost Center 1 records associated for the provided company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_cost_center_2_s

Gets all Cost Center 2 records associated for the provided company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_cost_center_3_s

Gets all Cost Center 3 records associated for the provided company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_cost_center_4_s

Gets all Cost Center 4 records associated for the provided company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_cost_center_5_s

Gets all Cost Center 5 records associated for the provided company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_shift_codes

List all shift code lookup records for a Proliant company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_taxes

List all company tax lookup records in Proliant for the specified company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_accruals

List all accrual lookup code records associated with a company in Proliant. Returns: value, description. Required: company_id.

list_all_proliant_lookup_onboarding_flows

List all onboarding flow lookup records associated with a company in Proliant. Returns: scope, value, description. Required: company_id.

list_all_proliant_lookup_hiring_managers

List all hiring manager lookup codes for a specific company in Proliant. Returns: scope, value, description. Required: company_id.

list_all_proliant_lookup_batches

List all valid payroll batch names for the current calendar period in a Proliant company. Returns: extendedProperties, value, description. Required: company_id.

list_all_proliant_lookup_raise_reasons

List all valid rate change (raise) reasons for a Proliant company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_ethnicities

List all ethnicity lookup code options for a Proliant company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_rates

List all rate lookup codes for a specific Proliant company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_code_groups

List all Proliant lookup code groups for a company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_check_attributes

List all check attribute lookup codes for a Proliant company. Returns: value, description. Required: company_id.

list_all_proliant_lookup_user_defined_fields

List user-defined field lookup options for a Proliant company. Returns: options, name, description, valueType. Required: company_id.

list_all_proliant_payroll_verifications

List payroll verification results for a specific payroll calendar in Proliant. Retrieves the verification test results that were produced by a prior verify POST request for the given calendar. Returns: id, description, result, approved, approvedByUser, details. Required: company_id, calendar_guid.

list_all_proliant_lookup_tax_states

List Proliant state tax lookup records for a specific company and state. Returns: value, description. Required: company_id, state.

list_all_proliant_lookup_tax_locals

Gets all local Company Tax records associated for the provided company and state. Returns: value, description. Required: company_id, state.

list_all_proliant_lookup_tax_locals_all

List all local tax lookup records associated with a company in Proliant. Returns: value, description. Required: company_id.

list_all_proliant_lookup_batches_by_calendar

List all valid payroll batch names for a specified calendar in Proliant. Returns: scope, value, description. Required: company_id, calendar_id.