POST v1/employee-navigator/companies/{companyCode}/employees/{employeeKey}/deduction

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode		string	Required
employeeKey		globally unique identifier	Required

Body Parameters

EmployeeNavigatorDeductionDTO

Name	Type	Additional information
CompanyId	string	None.
EmployeeIdentifier	string	None.
DeductionCode	string	None.
EmployeePerPayAmount	decimal number	None.
DeductionStartDate	FixedDateTime	None.
EnrollmentEndDate	FixedDateTime	None.

Request Formats

application/json, text/json

Sample:

{
  "companyId": "sample string 1",
  "employeeIdentifier": "sample string 2",
  "deductionCode": "sample string 3",
  "employeePerPayAmount": 4.0,
  "deductionStartDate": "0001-02-03T09:05:06.007Z",
  "enrollmentEndDate": "0001-02-03T09:05:06.007Z"
}

text/xml

Sample:

<EmployeeNavigatorDeductionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.EmployeeNavigator.ServiceContracts.Data.Models">
  <CompanyId>sample string 1</CompanyId>
  <DeductionCode>sample string 3</DeductionCode>
  <DeductionStartDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
    <d2p1:Year>1</d2p1:Year>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Day>3</d2p1:Day>
    <d2p1:Hour>4</d2p1:Hour>
    <d2p1:Minute>5</d2p1:Minute>
    <d2p1:Second>6</d2p1:Second>
    <d2p1:Milisecond>7</d2p1:Milisecond>
  </DeductionStartDate>
  <EmployeeIdentifier>sample string 2</EmployeeIdentifier>
  <EmployeePerPayAmount>4</EmployeePerPayAmount>
  <EnrollmentEndDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
    <d2p1:Year>1</d2p1:Year>
    <d2p1:Month>2</d2p1:Month>
    <d2p1:Day>3</d2p1:Day>
    <d2p1:Hour>4</d2p1:Hour>
    <d2p1:Minute>5</d2p1:Minute>
    <d2p1:Second>6</d2p1:Second>
    <d2p1:Milisecond>7</d2p1:Milisecond>
  </EnrollmentEndDate>
</EmployeeNavigatorDeductionDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EmployeeNavigatorResponseDTO

Name	Description	Type	Additional information
Messages		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "messages": [
    "sample string 1",
    "sample string 2"
  ]
}

text/xml

Sample:

<EmployeeNavigatorResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.EmployeeNavigator.ServiceContracts.Data.Models">
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
</EmployeeNavigatorResponseDTO>