GET v1/export/clients/{clientCode}/employee-pto-accruals?effectiveDate={effectiveDate}&includeInactive={includeInactive}

Retrieve PTO Accruals by Client

Request Information

URI Parameters

Name	Type	Additional information
clientCode	string	Required
effectiveDate	date	None.
includeInactive	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of ExportEmployeePTOAccrualDTO

Name	Type	Additional information
Code	string	None.
Description	string	None.
StartDate	date	None.
EndDate	date	None.
AllowedAmount	decimal number	None.
TakenAmount	decimal number	None.
PendingAmount	decimal number	None.
LastAccrualDate	date	None.
LastTakenDate	date	None.
IsActive	boolean	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "code": "sample string 1",
    "description": "sample string 2",
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "allowedAmount": 3.0,
    "takenAmount": 4.0,
    "pendingAmount": 5.0,
    "lastAccrualDate": "0001-02-03",
    "lastTakenDate": "0001-02-03",
    "isActive": true,
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 7"
  },
  {
    "code": "sample string 1",
    "description": "sample string 2",
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "allowedAmount": 3.0,
    "takenAmount": 4.0,
    "pendingAmount": 5.0,
    "lastAccrualDate": "0001-02-03",
    "lastTakenDate": "0001-02-03",
    "isActive": true,
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 7"
  }
]

text/xml

Sample:

<ArrayOfExportEmployeePTOAccrualDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportEmployeePTOAccrualDTO>
    <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 7</EmployeeNumber>
    <AllowedAmount>3</AllowedAmount>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <EndDate 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>
    </EndDate>
    <IsActive>true</IsActive>
    <LastAccrualDate 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>
    </LastAccrualDate>
    <LastTakenDate 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>
    </LastTakenDate>
    <PendingAmount>5</PendingAmount>
    <StartDate 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>
    </StartDate>
    <TakenAmount>4</TakenAmount>
  </ExportEmployeePTOAccrualDTO>
  <ExportEmployeePTOAccrualDTO>
    <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 7</EmployeeNumber>
    <AllowedAmount>3</AllowedAmount>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <EndDate 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>
    </EndDate>
    <IsActive>true</IsActive>
    <LastAccrualDate 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>
    </LastAccrualDate>
    <LastTakenDate 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>
    </LastTakenDate>
    <PendingAmount>5</PendingAmount>
    <StartDate 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>
    </StartDate>
    <TakenAmount>4</TakenAmount>
  </ExportEmployeePTOAccrualDTO>
</ArrayOfExportEmployeePTOAccrualDTO>