ClientMasterService

This table lists the methods in the clientMaster service of the PrismHR Services API.

Method Description

ClientMasterService.addBillPending

Create one new bill pending record at a time.

ClientMasterService.cloneClient

Duplicate an existing client.
ClientMasterService.createClientMaster Create a new client record
ClientMasterService.createNewMessage Create a new message

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.createNewWorksiteLocation

Create new client worksite location

ClientMasterService.createPositionCode

Create a new position/job code
ClientMasterService.createPrismClientContact Create a new contact for a client managed in PrismHR

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.createProjectCode

Create a new project record for a client. Note that you cannot set the Certified Payroll Details information using the API; those fields must be completed in the PrismHRor HRPyramid product.
ClientMasterService.createSutaRates Create State Tax Bill Rates (SUTA) for the client

ClientMasterService.deleteBillPending

Delete a single bill pending item. Certain restrictions apply if the bill pending item is included in an unfinalized payroll batch.

ClientMasterService.deletePrismMessage

Delete one or more messages for a specified user.

ClientMasterService.flagClientsForEverify

Enable and disable the E-Verify flag for multiple clients. Web service user must have access to the clients.

ClientMasterService.flagLocationEverifyOverride

Enable the Exclude this location from E-Verification option for a specified group of worksite locations.

ClientMasterService.getACALargeEmployer

Retrieve information about ACA Large Employer status for one client or all clients.
ClientMasterService.getAllPrismClientContacts Retrieve contacts for specified client managed in PrismHR

ClientMasterService.getBackupAssignments

Retrieve backup users assigned for the client-level Account Assignments, such as Payroll, Human Resources, and I-9 Approver.
ClientMasterService.getBenefitGroup Retrieve benefit groups for specified client

ClientMasterService.getBillPending

Retrieve data about entries in the client bill pending record.

ClientMasterService.getBundledBillingRule

Retrieve data about bundled billing rules.

ClientMasterService.getClientBillingBankAccount

Retrieve client billing bank account information.
ClientMasterService.getClientCodes Return one or more client-related codes (departments, divisions, pay codes, positions, worksite locations, and so on)

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.getClientContact

Retrieve contacts for specified clients
ClientMasterService.getClientList Retrieve client IDs, names, and statuses
ClientMasterService.getClientLocationDetails Retrieve worksite Location details
ClientMasterService.getClientMaster Retrieve Client Details information

ClientMasterService.getClientOwnership

Retrieve ownership information from the Client Details > Benefits tab.

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.getClientUserDefinedFields

Retrieve information about client user-defined fields.

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.getDepartmentUserDefinedFields

Retrieve user-defined department fields for the specified client.

ClientMasterService.getDocExpirations

Retrieve a list of employee documents with an expiration date on or before the specified numbers of days from the current date

ClientMasterService.getEmployeeListByEntity

Retrieve a list of employees associated with a particular entity, such as a division, project, or worksite location.

ClientMasterService.getEmployeesInPayGroup

Retrieve a list of employees who are assigned to the specified pay group

ClientMasterService.getGLCutbackCheckPost

Retrieve file of third-party/cutback checks

ClientMasterService.getGLData

Retrieve transaction dates, employer IDs, and amounts for journals, invoices, or third-party/cutback checks as specified

ClientMasterService.getGLInvoicePost

Get and save the file as in External Invoice Post, removing it from the system after saving
ClientMasterService.getGLJournalPost Get and save the file as in External Journal Post, removing it from the system after saving
ClientMasterService.getGeoLocations Retrieve Vertex GeoLocations for specified ZIP code; includes city, state, and county

ClientMasterService.getLaborAllocations

Retrieve a list of labor allocation templates. By default, all labor allocation templates for the specified client will be returned

ClientMasterService.getLaborUnionDetails

Retrieve details for a specific labor union configured in PrismHR

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.getLocationUserDefinedFields

 Retrieve user-defined fields for the worksite location
ClientMasterService.getMessageList Retrieve message IDs, senders, dates, and subjects
ClientMasterService.getMessages Retrieve message IDs, senders, dates, subjects, and body of messages; max of 20
ClientMasterService.getOSHA300Astats Retrieve OSHA 300A statistics (data for the Summary of Work-Related Injuries and Illnesses)

ClientMasterService.getPayDayRules

Retrieve pay day rules for the client

ClientMasterService.getPayGroupDetails

Retrieve the details of the specified pay group
ClientMasterService.getPayrollSchedule Retrieve pay group and pay schedule information for specified clients
ClientMasterService.getPrismClientContact Retrieve particular contact at specified client managed in PrismHR

ClientMasterService.getSutaBillingRates

Retrieve SUTA billing rate information for a given state, effective date, and (optional) location.

ClientMasterService.getSutaRates

Retrieve data from the Employer Tax Rates (SUTA) and State Tax Rates (SUTA) forms.

ClientMasterService.getUnbundledBillingRules

Retrieve detailed information about one or more unbundled billing rules for a specific client.

ClientMasterService.getWCAccrualModifiers

Retrieve information about a particular client's Workers' Compensation accrual modifiers.

ClientMasterService.getWCBillingModifiers

Retrieve information about a particular client's Workers' Compensation billing modifiers.
ClientMasterService.removePrismClientContact Delete a contact record from a client managed in PrismHR

ClientMasterService.setACALargeEmployer

Create, update, or delete information in the client ACA Large Employer table for a particular year.

ClientMasterService.setAccountAssignments

Assign users to the account roles listed on the Client Details > Account tab.

Set the custom field names and values in the My Support Team Dashboard, if this feature is enabled.

ClientMasterService.setAlternateEmployers

Update the Alternate Employers grid on the Other tab of Client Details.

ClientMasterService.setBackupAssignments

Update the list of backup users assigned for the client-level Account Assignments, such as Payroll, Human Resources, and I-9 Approver.

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.setBankAccounts

Set financial institution accounts in Client Details Account tab
ClientMasterService.setBenefitGroup Create or update a benefit group for specified client
ClientMasterService.setBillingDetails Set client’s billing information in Client Details Billing tab

ClientMasterService.setBundledBillingRule

Create or update a bundled billing rule.

ClientMasterService.setClientBillingBankAccount

Update client billing bank account information.
ClientMasterService.setClientControl Set processing and employer accounting information in Client Details Control tab

ClientMasterService.setClientEvents

Create or update a specific client event and its associated information.

ClientMasterService.setClientLocationDetails

Create and update client worksite location details.

 

In prismhr-api, this replaces createWorksiteLocation and updateWorksiteLocation.

ClientMasterService.setClientOwnership

Set ownership information on the Client Details > Benefits tab.
ClientMasterService.setClientPayroll Set payroll delivery methods in Client Details Payroll tab
ClientMasterService.setClientTimeSheetPayCode Set the client’s time sheet pay code information and the default hours pay code

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.setClientUserDefinedFields

Create or update user-defined client fields for a specified client.

ClientMasterService.setCodeDescriptionOverride

Create or update (P)ay, (D)eduction, (T)ax, or (B)enefit code description override for the specified client

ClientMasterService.setControlCodes

Set the pay, deduction, arrears, and other code assignments on the Client Details > Control tab.

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.setDepartmentUserDefinedFields

Create or update user-defined department fields for a specified client. Use the checksum value from ClientMasterService.getDepartmentUserDefinedFields.

ClientMasterService.setLaborAllocations

Create or update a labor allocation template

ClientMasterService.setLaborUnionDetails

Update information about client labor unions.

Note:  Can only be used if explicitly listed in the Allowed Methods grid.

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.setLocationUserDefinedFields

 Update user-defined fields for the worksite location
ClientMasterService.setMessageToRead Set flag in message to indicate it was read

ClientMasterService.setPayDayRules

Sets pay day rules for the specified client

ClientMasterService.setPayGroup

Create a new client pay group.

ClientMasterService.setRetirementPlan

Update the retirement plans and TPA plans associated with a client. Note that if you do not specify every existing retirement plan ID in this method, it will delete those plans from the client settings.

ClientMasterService.setWCAccrualModifiers

Set and update the client's W/C accrual modifiers.
ClientMasterService.setWCBillingModifiers Set the client’s W/C Billing Modifiers

ClientMasterService.setWorkersCompPolicy

Set or update a workers' compensation policy, and its associated settings, for a specified client.
ClientMasterService.updateClientAddress Update address for an existing client

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.updateClientContact

Update existing contact information for specified HRPyramid client and contact

ClientMasterService.updateClientMasterFields

Update one or many Client Details fields without the need to provide a checksum.

ClientMasterService.updateClientTaxInfo

Update the fields on the Tax tab of the Client Details form.
ClientMasterService.updatePrismClientContact Update existing contact information for specified PrismHR client and contact

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.updateProjectCode

 Update details for a client’s project (not including certified payroll information)

Note:  Not in prismhr-api. Endpoint was deprecated in API 1.30 or combined with others.

ClientMasterService.updateWorksiteLocation

 Update basic worksite location information

ClientMasterService.updateWorksiteLocationAch

Allow the user to update the ACH data associated with a client worksite location

Parent Topic

Allowed Methods for Web Service Users