GET v1/supplemental-benefits/export/companies/{companyCode}/divisions/{divisionCode}/ach?achDate={achDate}

Retrieve Supplemental Benefits ACH details by Division

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	The company code	string	Required
divisionCode	The division code	string	Required
achDate		date	Required

Body Parameters

None.

Response Information

Resource Description

Collection of SupplementalBenefitsACHDetailDTO

Name	Type	Additional information
CompanyCode	string	None.
DivisionCode	string	None.
AchDate	date	None.
TotalAmount	decimal number	None.
Deductions	Collection of SupplementalBenefitsEmployeeDeductionDTO	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "companyCode": "sample string 1",
    "divisionCode": "sample string 2",
    "achDate": "0001-02-03",
    "totalAmount": 3.0,
    "deductions": [
      {
        "employeeNumber": "sample string 1",
        "employeeKey": "<empty>",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "deductionCode": "sample string 4",
        "amount": 5.0,
        "checkDate": "0001-02-03",
        "checkKey": "<empty>"
      },
      {
        "employeeNumber": "sample string 1",
        "employeeKey": "<empty>",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "deductionCode": "sample string 4",
        "amount": 5.0,
        "checkDate": "0001-02-03",
        "checkKey": "<empty>"
      }
    ]
  },
  {
    "companyCode": "sample string 1",
    "divisionCode": "sample string 2",
    "achDate": "0001-02-03",
    "totalAmount": 3.0,
    "deductions": [
      {
        "employeeNumber": "sample string 1",
        "employeeKey": "<empty>",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "deductionCode": "sample string 4",
        "amount": 5.0,
        "checkDate": "0001-02-03",
        "checkKey": "<empty>"
      },
      {
        "employeeNumber": "sample string 1",
        "employeeKey": "<empty>",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "deductionCode": "sample string 4",
        "amount": 5.0,
        "checkDate": "0001-02-03",
        "checkKey": "<empty>"
      }
    ]
  }
]

text/xml

Sample:

<ArrayOfSupplementalBenefitsACHDetailDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <SupplementalBenefitsACHDetailDTO>
    <AchDate 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>
    </AchDate>
    <CompanyCode>sample string 1</CompanyCode>
    <Deductions>
      <SupplementalBenefitsEmployeeDeductionDTO>
        <Amount>5</Amount>
        <CheckDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </CheckDate>
        <CheckKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_hasValue>false</d5p1:_hasValue>
          <d5p1:_value>0</d5p1:_value>
        </CheckKey>
        <DeductionCode>sample string 4</DeductionCode>
        <EmployeeKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </EmployeeKey>
        <EmployeeNumber>sample string 1</EmployeeNumber>
        <FirstName>sample string 2</FirstName>
        <LastName>sample string 3</LastName>
      </SupplementalBenefitsEmployeeDeductionDTO>
      <SupplementalBenefitsEmployeeDeductionDTO>
        <Amount>5</Amount>
        <CheckDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </CheckDate>
        <CheckKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_hasValue>false</d5p1:_hasValue>
          <d5p1:_value>0</d5p1:_value>
        </CheckKey>
        <DeductionCode>sample string 4</DeductionCode>
        <EmployeeKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </EmployeeKey>
        <EmployeeNumber>sample string 1</EmployeeNumber>
        <FirstName>sample string 2</FirstName>
        <LastName>sample string 3</LastName>
      </SupplementalBenefitsEmployeeDeductionDTO>
    </Deductions>
    <DivisionCode>sample string 2</DivisionCode>
    <TotalAmount>3</TotalAmount>
  </SupplementalBenefitsACHDetailDTO>
  <SupplementalBenefitsACHDetailDTO>
    <AchDate 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>
    </AchDate>
    <CompanyCode>sample string 1</CompanyCode>
    <Deductions>
      <SupplementalBenefitsEmployeeDeductionDTO>
        <Amount>5</Amount>
        <CheckDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </CheckDate>
        <CheckKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_hasValue>false</d5p1:_hasValue>
          <d5p1:_value>0</d5p1:_value>
        </CheckKey>
        <DeductionCode>sample string 4</DeductionCode>
        <EmployeeKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </EmployeeKey>
        <EmployeeNumber>sample string 1</EmployeeNumber>
        <FirstName>sample string 2</FirstName>
        <LastName>sample string 3</LastName>
      </SupplementalBenefitsEmployeeDeductionDTO>
      <SupplementalBenefitsEmployeeDeductionDTO>
        <Amount>5</Amount>
        <CheckDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </CheckDate>
        <CheckKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_hasValue>false</d5p1:_hasValue>
          <d5p1:_value>0</d5p1:_value>
        </CheckKey>
        <DeductionCode>sample string 4</DeductionCode>
        <EmployeeKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </EmployeeKey>
        <EmployeeNumber>sample string 1</EmployeeNumber>
        <FirstName>sample string 2</FirstName>
        <LastName>sample string 3</LastName>
      </SupplementalBenefitsEmployeeDeductionDTO>
    </Deductions>
    <DivisionCode>sample string 2</DivisionCode>
    <TotalAmount>3</TotalAmount>
  </SupplementalBenefitsACHDetailDTO>
</ArrayOfSupplementalBenefitsACHDetailDTO>