GET v1/supplemental-benefits/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/checks?startDate={startDate}&endDate={endDate}

Retrieve Supplemental Benefits Checks by Employee

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	The company code	string	Required
divisionCode	The division code	string	Required
employeeNumber	Employee number filter	string	Required
startDate		date	Required
endDate		date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of SupplementalBenefitsCheckDTO

Name	Type	Additional information
CheckDate	date	None.
RunNumber	integer	None.
PeriodBeginDate	date	None.
PeriodEndDate	date	None.
CheckNumber	integer	None.
VoucherNumber	integer	None.
Net	decimal number	None.
Gross	decimal number	None.
TotalDeductions	decimal number	None.
Deductions	Collection of SupplementalBenefitsCheckDeductionDTO	None.
CheckKey	EntityKeyOfICheckHeaderAndInt32	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "checkDate": "0001-02-03",
    "runNumber": 1,
    "periodBeginDate": "0001-02-03",
    "periodEndDate": "0001-02-03",
    "checkNumber": 2,
    "voucherNumber": 1,
    "net": 3.0,
    "gross": 4.0,
    "totalDeductions": 5.0,
    "deductions": [
      {
        "deductionCode": "sample string 1",
        "amount": 2.0
      },
      {
        "deductionCode": "sample string 1",
        "amount": 2.0
      }
    ],
    "checkKey": "<empty>",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 6"
  },
  {
    "checkDate": "0001-02-03",
    "runNumber": 1,
    "periodBeginDate": "0001-02-03",
    "periodEndDate": "0001-02-03",
    "checkNumber": 2,
    "voucherNumber": 1,
    "net": 3.0,
    "gross": 4.0,
    "totalDeductions": 5.0,
    "deductions": [
      {
        "deductionCode": "sample string 1",
        "amount": 2.0
      },
      {
        "deductionCode": "sample string 1",
        "amount": 2.0
      }
    ],
    "checkKey": "<empty>",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 6"
  }
]

text/xml

Sample:

<ArrayOfSupplementalBenefitsCheckDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <SupplementalBenefitsCheckDTO>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode>
    </DivisionKey>
    <EmployeeKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </EmployeeKey>
    <EmployeeNumber>sample string 6</EmployeeNumber>
    <CheckDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </CheckDate>
    <CheckKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </CheckKey>
    <CheckNumber>2</CheckNumber>
    <Deductions>
      <SupplementalBenefitsCheckDeductionDTO>
        <Amount>2</Amount>
        <DeductionCode>sample string 1</DeductionCode>
      </SupplementalBenefitsCheckDeductionDTO>
      <SupplementalBenefitsCheckDeductionDTO>
        <Amount>2</Amount>
        <DeductionCode>sample string 1</DeductionCode>
      </SupplementalBenefitsCheckDeductionDTO>
    </Deductions>
    <Gross>4</Gross>
    <Net>3</Net>
    <PeriodBeginDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </PeriodBeginDate>
    <PeriodEndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </PeriodEndDate>
    <RunNumber>1</RunNumber>
    <TotalDeductions>5</TotalDeductions>
    <VoucherNumber>1</VoucherNumber>
  </SupplementalBenefitsCheckDTO>
  <SupplementalBenefitsCheckDTO>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode>
    </DivisionKey>
    <EmployeeKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </EmployeeKey>
    <EmployeeNumber>sample string 6</EmployeeNumber>
    <CheckDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </CheckDate>
    <CheckKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </CheckKey>
    <CheckNumber>2</CheckNumber>
    <Deductions>
      <SupplementalBenefitsCheckDeductionDTO>
        <Amount>2</Amount>
        <DeductionCode>sample string 1</DeductionCode>
      </SupplementalBenefitsCheckDeductionDTO>
      <SupplementalBenefitsCheckDeductionDTO>
        <Amount>2</Amount>
        <DeductionCode>sample string 1</DeductionCode>
      </SupplementalBenefitsCheckDeductionDTO>
    </Deductions>
    <Gross>4</Gross>
    <Net>3</Net>
    <PeriodBeginDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </PeriodBeginDate>
    <PeriodEndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </PeriodEndDate>
    <RunNumber>1</RunNumber>
    <TotalDeductions>5</TotalDeductions>
    <VoucherNumber>1</VoucherNumber>
  </SupplementalBenefitsCheckDTO>
</ArrayOfSupplementalBenefitsCheckDTO>