POST v1/EmployeeTaxCode/AddTaxCodeToEmployee?employeeNumber={employeeNumber}

Add TaxCodes to Employee. This endpoint is currently available only to approved customers; all other requests will return an error.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
employeeNumber

A Valid employee number is required.

string

Required

Body Parameters

A Valid TaxCodeID is required.

EmployeeTaxCode
NameDescriptionTypeAdditional information
EmployeeTaxCodeID

Gets or sets the unique identifier for the employee tax code (required).

integer

Required

TaxFilingStatusID

Gets or sets the tax filing status ID. This is optional.

integer

None.

Exemptions

Gets or sets the number of exemptions. This is optional.

integer

None.

ExemptBlocked

Gets or sets the number of ExemptBlocked. This is optional.

ExemptBlocked

None.

AdditionalTaxType

Gets or sets the type of additional tax. This is optional.

AdditionalTaxType

None.

AdditionalAmount

Gets or sets the additional tax amount. This is optional.

decimal number

None.

TaxTableStateID

Gets or sets the tax table state ID. This is optional.

integer

None.

TaxCodeID

Gets or sets the tax code ID (required).

integer

Required

DependentCredit

Gets or sets the dependent credit amount. This is optional.

decimal number

None.

OtherIncome

Gets or sets the other income amount. This is optional.

decimal number

None.

Deductions

Gets or sets the deductions amount. This is optional.

decimal number

None.

MultipleJobs

Gets or sets a value indicating whether the employee has multiple jobs. This is optional.

boolean

None.

ResidentPSDCode

Gets or sets the resident PSD code. This is optional.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "EmployeeTaxCodeID": 1,
  "TaxFilingStatusID": 1,
  "Exemptions": 1,
  "ExemptBlocked": 0,
  "AdditionalTaxType": 0,
  "AdditionalAmount": 1.0,
  "TaxTableStateID": 1,
  "TaxCodeID": 2,
  "DependentCredit": 1.0,
  "OtherIncome": 1.0,
  "Deductions": 1.0,
  "MultipleJobs": true,
  "ResidentPSDCode": "sample string 3"
}

application/xml, text/xml

Sample:
<EmployeeTaxCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">
  <AdditionalAmount>1</AdditionalAmount>
  <AdditionalTaxType>None</AdditionalTaxType>
  <Deductions>1</Deductions>
  <DependentCredit>1</DependentCredit>
  <EmployeeTaxCodeID>1</EmployeeTaxCodeID>
  <ExemptBlocked>None</ExemptBlocked>
  <Exemptions>1</Exemptions>
  <MultipleJobs>true</MultipleJobs>
  <OtherIncome>1</OtherIncome>
  <ResidentPSDCode>sample string 3</ResidentPSDCode>
  <TaxCodeID>2</TaxCodeID>
  <TaxFilingStatusID>1</TaxFilingStatusID>
  <TaxTableStateID>1</TaxTableStateID>
</EmployeeTaxCode>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns EmployeeTaxCode object.

EmployeeTaxCode
NameDescriptionTypeAdditional information
EmployeeTaxCodeID

Gets or sets the unique identifier for the employee tax code (required).

integer

Required

TaxFilingStatusID

Gets or sets the tax filing status ID. This is optional.

integer

None.

Exemptions

Gets or sets the number of exemptions. This is optional.

integer

None.

ExemptBlocked

Gets or sets the number of ExemptBlocked. This is optional.

ExemptBlocked

None.

AdditionalTaxType

Gets or sets the type of additional tax. This is optional.

AdditionalTaxType

None.

AdditionalAmount

Gets or sets the additional tax amount. This is optional.

decimal number

None.

TaxTableStateID

Gets or sets the tax table state ID. This is optional.

integer

None.

TaxCodeID

Gets or sets the tax code ID (required).

integer

Required

DependentCredit

Gets or sets the dependent credit amount. This is optional.

decimal number

None.

OtherIncome

Gets or sets the other income amount. This is optional.

decimal number

None.

Deductions

Gets or sets the deductions amount. This is optional.

decimal number

None.

MultipleJobs

Gets or sets a value indicating whether the employee has multiple jobs. This is optional.

boolean

None.

ResidentPSDCode

Gets or sets the resident PSD code. This is optional.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EmployeeTaxCodeID": 1,
  "TaxFilingStatusID": 1,
  "Exemptions": 1,
  "ExemptBlocked": 0,
  "AdditionalTaxType": 0,
  "AdditionalAmount": 1.0,
  "TaxTableStateID": 1,
  "TaxCodeID": 2,
  "DependentCredit": 1.0,
  "OtherIncome": 1.0,
  "Deductions": 1.0,
  "MultipleJobs": true,
  "ResidentPSDCode": "sample string 3"
}

application/xml, text/xml

Sample:
<EmployeeTaxCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">
  <AdditionalAmount>1</AdditionalAmount>
  <AdditionalTaxType>None</AdditionalTaxType>
  <Deductions>1</Deductions>
  <DependentCredit>1</DependentCredit>
  <EmployeeTaxCodeID>1</EmployeeTaxCodeID>
  <ExemptBlocked>None</ExemptBlocked>
  <Exemptions>1</Exemptions>
  <MultipleJobs>true</MultipleJobs>
  <OtherIncome>1</OtherIncome>
  <ResidentPSDCode>sample string 3</ResidentPSDCode>
  <TaxCodeID>2</TaxCodeID>
  <TaxFilingStatusID>1</TaxFilingStatusID>
  <TaxTableStateID>1</TaxTableStateID>
</EmployeeTaxCode>