Create new Recurring Employee Deduction

//native

type Paylocity = {

	clientId: string

	clientSecret: string

}

/**

 * Create new Recurring Employee Deduction

 * **Summary Description**

 This function will allow the API user to create a new deduction on the employee record.

Garnishments cannot be created using the Deduction endpoints.

 */

export async function main(

	auth: Paylocity,

	companyId: string,

	employeeId: string,

	body: {

		effectiveFrom?: string

		effectiveTo?: string

		calculationCode?: string

		rate?: number

		frequency?: string

		agency?: string

		arrear?: number

		miscellaneousInfo?: string

		note?: string

		selfInsured?: false | true

		priority?: number

		loan401K?: {

			loanNumber?: string

			issueDate?: string

			firstPaymentDate?: string

		}

		costCenters?: { level?: number; code?: string }[]

		limits?: {

			goal?: number

			paidToDate?: number

			payPeriodMinimum?: number

			payPeriodMaximum?: number

			annualMaximum?: number

		}

		code?: string

	}

) {

	const url = new URL(

		`https://dc1prodgwext.paylocity.com/apiHub/payroll/v1/companies/${companyId}/employees/${employeeId}/deductions`

	)

	const response = await fetch(url, {

		method: 'POST',

		headers: {

			'Content-Type': 'application/json',

			Authorization:

				'Bearer ' +

				(await getOAuthToken(auth, 'https://dc1prodgwext.paylocity.com/public/security/v1/token'))

		},

		body: JSON.stringify(body)

	})

	if (!response.ok) {

		const text = await response.text()

		throw new Error(`${response.status} ${text}`)

	}

	return await response.text()

}

async function getOAuthToken(auth: Paylocity, tokenUrl: string): Promise<string> {

	const params = new URLSearchParams({

		grant_type: 'client_credentials',

		client_id: auth.clientId,

		client_secret: auth.clientSecret

	})

	const response = await fetch(tokenUrl, {

		method: 'POST',

		headers: {

			Authorization: 'Basic ' + btoa(`${auth.clientId}:${auth.clientSecret}`),

			'Content-Type': 'application/x-www-form-urlencoded'

		},

		body: params.toString()

	})

	if (!response.ok) {

		const text = await response.text()

		throw new Error(`OAuth token request failed: ${response.status} ${text}`)

	}

	const data = await response.json()

	return data.access_token

}