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

Retrieve Checks by Employee Number

Request Information

URI Parameters

Name	Type	Additional information
companyCode	string	Required
divisionCode	string	Required
employeeNumber	string	Required
startDate	date	Required
endDate	date	Required

Body Parameters

None.

Response Information

Resource Description

Collection of IncomeVerificationCheckDTO

Name	Type	Additional information
CheckDate	date	None.
RunNumber	integer	None.
PeriodBeginDate	date	None.
PeriodEndDate	date	None.
PayMethod	EmployeePayMethod	None.
CheckNumber	integer	None.
VoucherNumber	integer	None.
TotalWorkedHours	decimal number	None.
TotalHours	decimal number	None.
TotalGross	decimal number	None.
TotalDeductions	decimal number	None.
TotalTaxes	decimal number	None.
NetCheckAmount	decimal number	None.
NetDirectDepositAmount	decimal number	None.
TotalNet	decimal number	None.
Taxes	Collection of ExportCheckTaxDTO	None.
Earnings	Collection of IncomeVerificationCheckEarningDTO	None.
Deductions	Collection of IncomeVerificationCheckDeductionDTO	None.
DivisionKey	DivisionKeyDTO	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",
    "payMethod": "Check",
    "checkNumber": 2,
    "voucherNumber": 1,
    "totalWorkedHours": 3.0,
    "totalHours": 4.0,
    "totalGross": 5.0,
    "totalDeductions": 6.0,
    "totalTaxes": 7.0,
    "netCheckAmount": 8.0,
    "netDirectDepositAmount": 9.0,
    "totalNet": 10.0,
    "taxes": [
      {
        "taxCode": "sample string 1",
        "grossWages": 2.0,
        "taxableWages": 3.0,
        "taxAmount": 4.0
      },
      {
        "taxCode": "sample string 1",
        "grossWages": 2.0,
        "taxableWages": 3.0,
        "taxAmount": 4.0
      }
    ],
    "earnings": [
      {
        "earningCode": "sample string 1",
        "hours": 2.0,
        "rate": 3.0,
        "amount": 4.0
      },
      {
        "earningCode": "sample string 1",
        "hours": 2.0,
        "rate": 3.0,
        "amount": 4.0
      }
    ],
    "deductions": [
      {
        "deductionCode": "sample string 1",
        "amount": 2.0,
        "memoOnly": true
      },
      {
        "deductionCode": "sample string 1",
        "amount": 2.0,
        "memoOnly": true
      }
    ],
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeNumber": "sample string 11"
  },
  {
    "checkDate": "0001-02-03",
    "runNumber": 1,
    "periodBeginDate": "0001-02-03",
    "periodEndDate": "0001-02-03",
    "payMethod": "Check",
    "checkNumber": 2,
    "voucherNumber": 1,
    "totalWorkedHours": 3.0,
    "totalHours": 4.0,
    "totalGross": 5.0,
    "totalDeductions": 6.0,
    "totalTaxes": 7.0,
    "netCheckAmount": 8.0,
    "netDirectDepositAmount": 9.0,
    "totalNet": 10.0,
    "taxes": [
      {
        "taxCode": "sample string 1",
        "grossWages": 2.0,
        "taxableWages": 3.0,
        "taxAmount": 4.0
      },
      {
        "taxCode": "sample string 1",
        "grossWages": 2.0,
        "taxableWages": 3.0,
        "taxAmount": 4.0
      }
    ],
    "earnings": [
      {
        "earningCode": "sample string 1",
        "hours": 2.0,
        "rate": 3.0,
        "amount": 4.0
      },
      {
        "earningCode": "sample string 1",
        "hours": 2.0,
        "rate": 3.0,
        "amount": 4.0
      }
    ],
    "deductions": [
      {
        "deductionCode": "sample string 1",
        "amount": 2.0,
        "memoOnly": true
      },
      {
        "deductionCode": "sample string 1",
        "amount": 2.0,
        "memoOnly": true
      }
    ],
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeNumber": "sample string 11"
  }
]

text/xml

Sample:

<ArrayOfIncomeVerificationCheckDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <IncomeVerificationCheckDTO>
    <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>
    <CheckNumber>2</CheckNumber>
    <Deductions>
      <IncomeVerificationCheckDeductionDTO>
        <Amount>2</Amount>
        <DeductionCode>sample string 1</DeductionCode>
        <MemoOnly>true</MemoOnly>
      </IncomeVerificationCheckDeductionDTO>
      <IncomeVerificationCheckDeductionDTO>
        <Amount>2</Amount>
        <DeductionCode>sample string 1</DeductionCode>
        <MemoOnly>true</MemoOnly>
      </IncomeVerificationCheckDeductionDTO>
    </Deductions>
    <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>
    <Earnings>
      <IncomeVerificationCheckEarningDTO>
        <Amount>4</Amount>
        <EarningCode>sample string 1</EarningCode>
        <Hours>2</Hours>
        <Rate>3</Rate>
      </IncomeVerificationCheckEarningDTO>
      <IncomeVerificationCheckEarningDTO>
        <Amount>4</Amount>
        <EarningCode>sample string 1</EarningCode>
        <Hours>2</Hours>
        <Rate>3</Rate>
      </IncomeVerificationCheckEarningDTO>
    </Earnings>
    <EmployeeNumber>sample string 11</EmployeeNumber>
    <NetCheckAmount>8</NetCheckAmount>
    <NetDirectDepositAmount>9</NetDirectDepositAmount>
    <PayMethod>Check</PayMethod>
    <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>
    <Taxes>
      <ExportCheckTaxDTO>
        <GrossWages>2</GrossWages>
        <TaxAmount>4</TaxAmount>
        <TaxCode>sample string 1</TaxCode>
        <TaxableWages>3</TaxableWages>
      </ExportCheckTaxDTO>
      <ExportCheckTaxDTO>
        <GrossWages>2</GrossWages>
        <TaxAmount>4</TaxAmount>
        <TaxCode>sample string 1</TaxCode>
        <TaxableWages>3</TaxableWages>
      </ExportCheckTaxDTO>
    </Taxes>
    <TotalDeductions>6</TotalDeductions>
    <TotalGross>5</TotalGross>
    <TotalHours>4</TotalHours>
    <TotalNet>10</TotalNet>
    <TotalTaxes>7</TotalTaxes>
    <TotalWorkedHours>3</TotalWorkedHours>
    <VoucherNumber>1</VoucherNumber>
  </IncomeVerificationCheckDTO>
  <IncomeVerificationCheckDTO>
    <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>
    <CheckNumber>2</CheckNumber>
    <Deductions>
      <IncomeVerificationCheckDeductionDTO>
        <Amount>2</Amount>
        <DeductionCode>sample string 1</DeductionCode>
        <MemoOnly>true</MemoOnly>
      </IncomeVerificationCheckDeductionDTO>
      <IncomeVerificationCheckDeductionDTO>
        <Amount>2</Amount>
        <DeductionCode>sample string 1</DeductionCode>
        <MemoOnly>true</MemoOnly>
      </IncomeVerificationCheckDeductionDTO>
    </Deductions>
    <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>
    <Earnings>
      <IncomeVerificationCheckEarningDTO>
        <Amount>4</Amount>
        <EarningCode>sample string 1</EarningCode>
        <Hours>2</Hours>
        <Rate>3</Rate>
      </IncomeVerificationCheckEarningDTO>
      <IncomeVerificationCheckEarningDTO>
        <Amount>4</Amount>
        <EarningCode>sample string 1</EarningCode>
        <Hours>2</Hours>
        <Rate>3</Rate>
      </IncomeVerificationCheckEarningDTO>
    </Earnings>
    <EmployeeNumber>sample string 11</EmployeeNumber>
    <NetCheckAmount>8</NetCheckAmount>
    <NetDirectDepositAmount>9</NetDirectDepositAmount>
    <PayMethod>Check</PayMethod>
    <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>
    <Taxes>
      <ExportCheckTaxDTO>
        <GrossWages>2</GrossWages>
        <TaxAmount>4</TaxAmount>
        <TaxCode>sample string 1</TaxCode>
        <TaxableWages>3</TaxableWages>
      </ExportCheckTaxDTO>
      <ExportCheckTaxDTO>
        <GrossWages>2</GrossWages>
        <TaxAmount>4</TaxAmount>
        <TaxCode>sample string 1</TaxCode>
        <TaxableWages>3</TaxableWages>
      </ExportCheckTaxDTO>
    </Taxes>
    <TotalDeductions>6</TotalDeductions>
    <TotalGross>5</TotalGross>
    <TotalHours>4</TotalHours>
    <TotalNet>10</TotalNet>
    <TotalTaxes>7</TotalTaxes>
    <TotalWorkedHours>3</TotalWorkedHours>
    <VoucherNumber>1</VoucherNumber>
  </IncomeVerificationCheckDTO>
</ArrayOfIncomeVerificationCheckDTO>