addPayrollLineItemTaxAdjustments

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#addPayrollLineItemTaxAdjustments' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addPayrollLineItemTaxAdjustments",
  "companyId": "3A08507F-E78B-4ABF-98D8-87D382E7CE14",
  "payPeriodId": "3C068DE4-038F-4874-B99B-4AFD7CB39351",
  "employeeId": "BA445FB2-A3CA-43B7-BB8A-399BDE85486C",
  "taxAdjustments": [
    {
      "taxName": "Federal Withholding Tax",
      "amount": 45
    }
  ]
}
'

{
  "success": true,
  "message": "Tax adjustment added successfully"
}

Payroll

addPayrollLineItemTaxAdjustments

The addPayrollLineItemTaxAdjustments API is used to add tax adjustments when the calculated taxes are incorrect.

What it does:

Overwrites the existing tax with the specified amount

When to use:

For complex cases where the generic tax calculations do not produce an an accurate withholding amount
When the employee has previosuly over or under-withheld specific taxes

Notes:

Use the getAllowedTaxAdjustmentsList API to retrieve the allowed taxNames
Employees must be active within the pay period sent in the request to have tax adjustments added
Allowed tax adjustments vary from employee to employee

POST

payroll#addPayrollLineItemTaxAdjustments

addPayrollLineItemTaxAdjustments

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/payroll#addPayrollLineItemTaxAdjustments' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addPayrollLineItemTaxAdjustments",
  "companyId": "3A08507F-E78B-4ABF-98D8-87D382E7CE14",
  "payPeriodId": "3C068DE4-038F-4874-B99B-4AFD7CB39351",
  "employeeId": "BA445FB2-A3CA-43B7-BB8A-399BDE85486C",
  "taxAdjustments": [
    {
      "taxName": "Federal Withholding Tax",
      "amount": 45
    }
  ]
}
'

{
  "success": true,
  "message": "Tax adjustment added successfully"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method

string

required

companyId

string

required

payPeriodId

string

required

employeeId

string

required

taxAdjustments

object[]

required

Show child attributes

Response

success

boolean

required

message

string

required

updatePayrollTaxExemption updatePayrollLineItemTaxAdjustment