GET v1/export/clients/{clientCode}/employee-allocations

Retrieve Employee Allocations by Client

Request Information

URI Parameters

Name	Description	Type	Additional information
clientCode		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportEmployeeAllocationDTO

Name	Type	Additional information
Allocations	Collection of ExportAllocationDTO	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "allocations": [
      {
        "costCenters": [
          {
            "level": 1,
            "levelCode": "sample string 2",
            "costCenterCode": "sample string 3",
            "costCenterDescription": "sample string 4",
            "groupCode": "sample string 5"
          },
          {
            "level": 1,
            "levelCode": "sample string 2",
            "costCenterCode": "sample string 3",
            "costCenterDescription": "sample string 4",
            "groupCode": "sample string 5"
          }
        ],
        "jobCode": "sample string 1",
        "percent": 2.0,
        "isDefault": true
      },
      {
        "costCenters": [
          {
            "level": 1,
            "levelCode": "sample string 2",
            "costCenterCode": "sample string 3",
            "costCenterDescription": "sample string 4",
            "groupCode": "sample string 5"
          },
          {
            "level": 1,
            "levelCode": "sample string 2",
            "costCenterCode": "sample string 3",
            "costCenterDescription": "sample string 4",
            "groupCode": "sample string 5"
          }
        ],
        "jobCode": "sample string 1",
        "percent": 2.0,
        "isDefault": true
      }
    ],
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 1"
  },
  {
    "allocations": [
      {
        "costCenters": [
          {
            "level": 1,
            "levelCode": "sample string 2",
            "costCenterCode": "sample string 3",
            "costCenterDescription": "sample string 4",
            "groupCode": "sample string 5"
          },
          {
            "level": 1,
            "levelCode": "sample string 2",
            "costCenterCode": "sample string 3",
            "costCenterDescription": "sample string 4",
            "groupCode": "sample string 5"
          }
        ],
        "jobCode": "sample string 1",
        "percent": 2.0,
        "isDefault": true
      },
      {
        "costCenters": [
          {
            "level": 1,
            "levelCode": "sample string 2",
            "costCenterCode": "sample string 3",
            "costCenterDescription": "sample string 4",
            "groupCode": "sample string 5"
          },
          {
            "level": 1,
            "levelCode": "sample string 2",
            "costCenterCode": "sample string 3",
            "costCenterDescription": "sample string 4",
            "groupCode": "sample string 5"
          }
        ],
        "jobCode": "sample string 1",
        "percent": 2.0,
        "isDefault": true
      }
    ],
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 1"
  }
]

text/xml

Sample:

<ArrayOfExportEmployeeAllocationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportEmployeeAllocationDTO>
    <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 1</EmployeeNumber>
    <Allocations>
      <ExportAllocationDTO>
        <CostCenters>
          <ExportCostCenterHeaderDTO>
            <CostCenterCode>sample string 3</CostCenterCode>
            <CostCenterDescription>sample string 4</CostCenterDescription>
            <GroupCode>sample string 5</GroupCode>
            <Level>1</Level>
            <LevelCode>sample string 2</LevelCode>
          </ExportCostCenterHeaderDTO>
          <ExportCostCenterHeaderDTO>
            <CostCenterCode>sample string 3</CostCenterCode>
            <CostCenterDescription>sample string 4</CostCenterDescription>
            <GroupCode>sample string 5</GroupCode>
            <Level>1</Level>
            <LevelCode>sample string 2</LevelCode>
          </ExportCostCenterHeaderDTO>
        </CostCenters>
        <IsDefault>true</IsDefault>
        <JobCode>sample string 1</JobCode>
        <Percent>2</Percent>
      </ExportAllocationDTO>
      <ExportAllocationDTO>
        <CostCenters>
          <ExportCostCenterHeaderDTO>
            <CostCenterCode>sample string 3</CostCenterCode>
            <CostCenterDescription>sample string 4</CostCenterDescription>
            <GroupCode>sample string 5</GroupCode>
            <Level>1</Level>
            <LevelCode>sample string 2</LevelCode>
          </ExportCostCenterHeaderDTO>
          <ExportCostCenterHeaderDTO>
            <CostCenterCode>sample string 3</CostCenterCode>
            <CostCenterDescription>sample string 4</CostCenterDescription>
            <GroupCode>sample string 5</GroupCode>
            <Level>1</Level>
            <LevelCode>sample string 2</LevelCode>
          </ExportCostCenterHeaderDTO>
        </CostCenters>
        <IsDefault>true</IsDefault>
        <JobCode>sample string 1</JobCode>
        <Percent>2</Percent>
      </ExportAllocationDTO>
    </Allocations>
  </ExportEmployeeAllocationDTO>
  <ExportEmployeeAllocationDTO>
    <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 1</EmployeeNumber>
    <Allocations>
      <ExportAllocationDTO>
        <CostCenters>
          <ExportCostCenterHeaderDTO>
            <CostCenterCode>sample string 3</CostCenterCode>
            <CostCenterDescription>sample string 4</CostCenterDescription>
            <GroupCode>sample string 5</GroupCode>
            <Level>1</Level>
            <LevelCode>sample string 2</LevelCode>
          </ExportCostCenterHeaderDTO>
          <ExportCostCenterHeaderDTO>
            <CostCenterCode>sample string 3</CostCenterCode>
            <CostCenterDescription>sample string 4</CostCenterDescription>
            <GroupCode>sample string 5</GroupCode>
            <Level>1</Level>
            <LevelCode>sample string 2</LevelCode>
          </ExportCostCenterHeaderDTO>
        </CostCenters>
        <IsDefault>true</IsDefault>
        <JobCode>sample string 1</JobCode>
        <Percent>2</Percent>
      </ExportAllocationDTO>
      <ExportAllocationDTO>
        <CostCenters>
          <ExportCostCenterHeaderDTO>
            <CostCenterCode>sample string 3</CostCenterCode>
            <CostCenterDescription>sample string 4</CostCenterDescription>
            <GroupCode>sample string 5</GroupCode>
            <Level>1</Level>
            <LevelCode>sample string 2</LevelCode>
          </ExportCostCenterHeaderDTO>
          <ExportCostCenterHeaderDTO>
            <CostCenterCode>sample string 3</CostCenterCode>
            <CostCenterDescription>sample string 4</CostCenterDescription>
            <GroupCode>sample string 5</GroupCode>
            <Level>1</Level>
            <LevelCode>sample string 2</LevelCode>
          </ExportCostCenterHeaderDTO>
        </CostCenters>
        <IsDefault>true</IsDefault>
        <JobCode>sample string 1</JobCode>
        <Percent>2</Percent>
      </ExportAllocationDTO>
    </Allocations>
  </ExportEmployeeAllocationDTO>
</ArrayOfExportEmployeeAllocationDTO>