Create a withholding or clearance tax adjustment

Adds a withholding or clearance tax adjustment to the specified pay run.

Request

POST https://apisg.yourpayroll.io/api/v2/business/{businessId}/payrun/{payRunId}/taxadjustments

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

The request body takes a complete SubmitPayRunForeignTaxAdjustmentRequest resource, containing the following writable properties:

{
    "employeeIdType": "string",
    "payRunId": "int32",
    "replaceExisting": "boolean",
    "suppressCalculations": "boolean",
    "taxAdjustments": {
        "<key>": "array"
    }
}

Properties

Name Type Description
employeeIdType string IdType

Possible values are:

  • Standard
  • External
payRunId int32 Int32
replaceExisting boolean Boolean
suppressCalculations boolean Boolean
taxAdjustments object Dictionary
taxAdjustments.<key> map of array List
taxAdjustments.<key>.amount double Decimal
taxAdjustments.<key>.employeeExternalId string String
taxAdjustments.<key>.employeeId string String
taxAdjustments.<key>.employeeName string String
taxAdjustments.<key>.externalId string String
taxAdjustments.<key>.id int32 Int32
taxAdjustments.<key>.locationId string String
taxAdjustments.<key>.locationName string String
taxAdjustments.<key>.notes string String
taxAdjustments.<key>.taxType string String

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK