0

Update Billing Code Status

by
Published Oct 17, 2025

> 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement.

Script paylocity Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Paylocity = {
3
	clientId: string
4
	clientSecret: string
5
}
6
/**
7
 * Update Billing Code Status
8
 * > 🚧 Partner Restricted
9
> All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement.
10
 */
11
export async function main(
12
	auth: Paylocity,
13
	companyId: string,
14
	billingCode: string | undefined,
15
	body: { isActive?: false | true },
16
	testMode?: string
17
) {
18
	const url = new URL(
19
		`https://dc1prodgwext.paylocity.com/compliance/v2/companies/${companyId}/clientOnboarding/billingCode`
20
	)
21
	for (const [k, v] of [['billingCode', billingCode]]) {
22
		if (v !== undefined && v !== '' && k !== undefined) {
23
			url.searchParams.append(k, v)
24
		}
25
	}
26
	const response = await fetch(url, {
27
		method: 'PATCH',
28
		headers: {
29
			...(testMode ? { testMode: testMode } : {}),
30
			'Content-Type': 'application/json',
31
			Authorization:
32
				'Bearer ' +
33
				(await getOAuthToken(auth, 'https://dc1prodgwext.paylocity.com/public/security/v1/token'))
34
		},
35
		body: JSON.stringify(body)
36
	})
37
	if (!response.ok) {
38
		const text = await response.text()
39
		throw new Error(`${response.status} ${text}`)
40
	}
41
	return await response.text()
42
}
43

44
async function getOAuthToken(auth: Paylocity, tokenUrl: string): Promise<string> {
45
	const params = new URLSearchParams({
46
		grant_type: 'client_credentials',
47
		client_id: auth.clientId,
48
		client_secret: auth.clientSecret
49
	})
50

51
	const response = await fetch(tokenUrl, {
52
		method: 'POST',
53
		headers: {
54
			Authorization: 'Basic ' + btoa(`${auth.clientId}:${auth.clientSecret}`),
55
			'Content-Type': 'application/x-www-form-urlencoded'
56
		},
57
		body: params.toString()
58
	})
59

60
	if (!response.ok) {
61
		const text = await response.text()
62
		throw new Error(`OAuth token request failed: ${response.status} ${text}`)
63
	}
64

65
	const data = await response.json()
66
	return data.access_token
67
}
68