v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB

Client Onboarding

Update Billing Code Status

🚧 Partner Restricted All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to our team if you would like to discuss partnership opportunities.

Summary Description

This is used to update an already registered billing code’s status by companyId and specific billing code for a given client

Use Cases

Partner wants to update the status of a specific billing code for a client to either make active or inactive*

V1 endpoint was deprecated to allow for special characters

patch/compliance/v2/companies/{companyId}/clientOnboarding/billingCode

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max

Query parameters

billingCodestring required

Billing code associated with the screening order. This billing code is created on the partner side for a specific company. Required.

Headers

testModeboolean

If true all responses are mocked and generated randomly

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

isActiveboolean

A Boolean value indicating if the package is active. Optional. Allowable Values: true, false

Response

Returns confirmation that billing code has been updated