POST v1/income-verification/export/clients/{clientCode}/check-summary?asOf={asOf}

Retrieve Check Summaries by SSN by Client

Request Information

URI Parameters

Name	Description	Type	Additional information
clientCode		string	Required
asOf		date	None.

Body Parameters

string

Request Formats

application/json, text/json

Sample:

"sample string 1"

text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of IncomeVerificationCheckSummaryDTO

Name	Type	Additional information
ClientCode	string	None.
CompanyCode	string	None.
DivisionCode	string	None.
SSN	string	None.
EmployeeNumber	string	None.
LastName	string	None.
FirstName	string	None.
EmployeeStatus	EmployeeStatus	None.
EmployeeStatusCode	string	None.
EmployeeStatusDescription	string	None.
TotalGrossCurrentCalendarYear	decimal number	None.
TotalGrossPreviousCalendarYear	decimal number	None.
TotalGrossSecondPreviousCalendarYear	decimal number	None.
LastCheckDate	date	None.
LastCheckDateGrossAmount	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "clientCode": "sample string 1",
    "companyCode": "sample string 2",
    "divisionCode": "sample string 3",
    "ssn": "sample string 4",
    "employeeNumber": "sample string 5",
    "lastName": "sample string 6",
    "firstName": "sample string 7",
    "employeeStatus": "Active",
    "employeeStatusCode": "sample string 8",
    "employeeStatusDescription": "sample string 9",
    "totalGrossCurrentCalendarYear": 10.0,
    "totalGrossPreviousCalendarYear": 11.0,
    "totalGrossSecondPreviousCalendarYear": 12.0,
    "lastCheckDate": "0001-02-03",
    "lastCheckDateGrossAmount": 13.0
  },
  {
    "clientCode": "sample string 1",
    "companyCode": "sample string 2",
    "divisionCode": "sample string 3",
    "ssn": "sample string 4",
    "employeeNumber": "sample string 5",
    "lastName": "sample string 6",
    "firstName": "sample string 7",
    "employeeStatus": "Active",
    "employeeStatusCode": "sample string 8",
    "employeeStatusDescription": "sample string 9",
    "totalGrossCurrentCalendarYear": 10.0,
    "totalGrossPreviousCalendarYear": 11.0,
    "totalGrossSecondPreviousCalendarYear": 12.0,
    "lastCheckDate": "0001-02-03",
    "lastCheckDateGrossAmount": 13.0
  }
]

text/xml

Sample:

<ArrayOfIncomeVerificationCheckSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <IncomeVerificationCheckSummaryDTO>
    <ClientCode>sample string 1</ClientCode>
    <CompanyCode>sample string 2</CompanyCode>
    <DivisionCode>sample string 3</DivisionCode>
    <EmployeeNumber>sample string 5</EmployeeNumber>
    <EmployeeStatus>Active</EmployeeStatus>
    <EmployeeStatusCode>sample string 8</EmployeeStatusCode>
    <EmployeeStatusDescription>sample string 9</EmployeeStatusDescription>
    <FirstName>sample string 7</FirstName>
    <LastCheckDate 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>
    </LastCheckDate>
    <LastCheckDateGrossAmount>13</LastCheckDateGrossAmount>
    <LastName>sample string 6</LastName>
    <SSN>sample string 4</SSN>
    <TotalGrossCurrentCalendarYear>10</TotalGrossCurrentCalendarYear>
    <TotalGrossPreviousCalendarYear>11</TotalGrossPreviousCalendarYear>
    <TotalGrossSecondPreviousCalendarYear>12</TotalGrossSecondPreviousCalendarYear>
  </IncomeVerificationCheckSummaryDTO>
  <IncomeVerificationCheckSummaryDTO>
    <ClientCode>sample string 1</ClientCode>
    <CompanyCode>sample string 2</CompanyCode>
    <DivisionCode>sample string 3</DivisionCode>
    <EmployeeNumber>sample string 5</EmployeeNumber>
    <EmployeeStatus>Active</EmployeeStatus>
    <EmployeeStatusCode>sample string 8</EmployeeStatusCode>
    <EmployeeStatusDescription>sample string 9</EmployeeStatusDescription>
    <FirstName>sample string 7</FirstName>
    <LastCheckDate 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>
    </LastCheckDate>
    <LastCheckDateGrossAmount>13</LastCheckDateGrossAmount>
    <LastName>sample string 6</LastName>
    <SSN>sample string 4</SSN>
    <TotalGrossCurrentCalendarYear>10</TotalGrossCurrentCalendarYear>
    <TotalGrossPreviousCalendarYear>11</TotalGrossPreviousCalendarYear>
    <TotalGrossSecondPreviousCalendarYear>12</TotalGrossSecondPreviousCalendarYear>
  </IncomeVerificationCheckSummaryDTO>
</ArrayOfIncomeVerificationCheckSummaryDTO>