Primary State Tax

Add/update primary state tax

Sends new or updated employee primary state tax information directly to Web Pay.

put/v2/companies/{companyId}/employees/{employeeId}/primaryStateTax

Request

  • Base URL
    https://api.paylocity.com/api
  • URL
    https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/primaryStateTax
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.paylocity.com/IdentityServer/connect/token scopes: WebLinkAPI

Path parameters

companyIdstring required

Company Id

employeeIdstring required

Employee Id

Request body

amountnumber nullable

State tax code.<br /> Max length: 50

deductionsAmountnumber

Box 4(b) on form W4 (year 2020 or later): Deductions amount. <br />Decimal (12,2)

dependentsAmountnumber

Box 3 on form W4 (year 2020 or later): Total dependents amount. <br />Decimal (12,2)

exemptionsnumber nullable

State tax exemptions value.<br />Decimal (12,2)

exemptions2number nullable

State tax exemptions 2 value.<br />Decimal (12,2)

filingStatusstring nullable

Employee state tax filing status. Common values are S (Single), M (Married).<br />Max length: 50

higherRateboolean

Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. <br />Boolean

otherIncomeAmountnumber

Box 4(a) on form W4 (year 2020 or later): Other income amount. <br />Decimal (12,2)

percentagenumber nullable

State Tax percentage. <br />Decimal (12,2)

specialCheckCalcstring nullable

Supplemental check calculation code. Common values are Blocked (Taxes blocked on Supplemental checks), Supp (Use supplemental Tax Rate-Code). <br />Max length: 10

taxCalculationCodestring nullable

Tax calculation code. Common values are F (Flat), P (Percentage), FDFP (Flat Dollar Amount plus Fixed Percentage). <br />Max length: 10

taxCodestring nullable

State tax code.<br /> Max length: 50

w4FormYearinteger

The state W4 form year <br />Integer

Response

Successfully added or updated

Changes

No recorded changes to this operation across all 4 revisions of this API.