POST v1/imports/pto-accruals?importAction={importAction}&allowSameFile={allowSameFile}

Import PTO Accruals

Request Information

URI Parameters

Name	Description	Type	Additional information
importAction	The import action.	ImportAction	Default value is Override
allowSameFile	Determines if the import allows the content to be imported multiple times	boolean	Default value is True

Body Parameters

The items to import.

Collection of EmployeePTOAccrualImportDTO

Name	Type	Additional information
PTOCode	string	None.
Allowed	decimal number	None.
Taken	decimal number	None.
Pending	decimal number	None.
LOSDateToUse	date	None.
StartDate	date	None.
EndDate	date	None.
LastRollover	date	None.
AccrualToDate	decimal number	None.
UseEmployeeRate	boolean	None.
EmployeeRate	decimal number	None.
UseEmployeeHours	boolean	None.
EmployeeHours	decimal number	None.
UseEmployeeAmount	boolean	None.
EmployeeAmount	decimal number	None.
MaximumAccrual	decimal number	None.
MaximumBalance	decimal number	None.
MaximumCarryOver	decimal number	None.
MaximumPerPeriod	decimal number	None.
LastPendingMoved	date	None.
LastAmountCarriedOver	decimal number	None.
LastAmountNotCarriedOver	decimal number	None.
CarryOverEligibleMinimum	decimal number	None.
MaximumAllowed	decimal number	None.
CarryOverRate	decimal number	None.
LastAccrualDate	date	None.
LastTakenDate	date	None.
IsActive	boolean	None.
PTOHistories	Collection of EmployeePTOHistorySubImportDTO	None.
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "ptoCode": "sample string 1",
    "allowed": 1.0,
    "taken": 1.0,
    "pending": 1.0,
    "losDateToUse": "0001-02-03",
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "lastRollover": "0001-02-03",
    "accrualToDate": 1.0,
    "useEmployeeRate": true,
    "employeeRate": 1.0,
    "useEmployeeHours": true,
    "employeeHours": 1.0,
    "useEmployeeAmount": true,
    "employeeAmount": 1.0,
    "maximumAccrual": 1.0,
    "maximumBalance": 1.0,
    "maximumCarryOver": 1.0,
    "maximumPerPeriod": 1.0,
    "lastPendingMoved": "0001-02-03",
    "lastAmountCarriedOver": 1.0,
    "lastAmountNotCarriedOver": 1.0,
    "carryOverEligibleMinimum": 1.0,
    "maximumAllowed": 1.0,
    "carryOverRate": 1.0,
    "lastAccrualDate": "0001-02-03",
    "lastTakenDate": "0001-02-03",
    "isActive": true,
    "ptoHistories": [
      {
        "checkDate": "0001-02-03",
        "runNumber": 1,
        "takenThisPeriod": 2.0,
        "accruedThisPeriod": 3.0,
        "pendingThisPeriod": 4.0,
        "allowed": 5.0,
        "taken": 6.0,
        "pending": 7.0,
        "accrualToDate": 8.0
      },
      {
        "checkDate": "0001-02-03",
        "runNumber": 1,
        "takenThisPeriod": 2.0,
        "accruedThisPeriod": 3.0,
        "pendingThisPeriod": 4.0,
        "allowed": 5.0,
        "taken": 6.0,
        "pending": 7.0,
        "accrualToDate": 8.0
      }
    ],
    "employeeNumber": "sample string 2",
    "employeePersonalId": 1,
    "divisionCode": "sample string 3",
    "companyCode": "sample string 4"
  },
  {
    "ptoCode": "sample string 1",
    "allowed": 1.0,
    "taken": 1.0,
    "pending": 1.0,
    "losDateToUse": "0001-02-03",
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "lastRollover": "0001-02-03",
    "accrualToDate": 1.0,
    "useEmployeeRate": true,
    "employeeRate": 1.0,
    "useEmployeeHours": true,
    "employeeHours": 1.0,
    "useEmployeeAmount": true,
    "employeeAmount": 1.0,
    "maximumAccrual": 1.0,
    "maximumBalance": 1.0,
    "maximumCarryOver": 1.0,
    "maximumPerPeriod": 1.0,
    "lastPendingMoved": "0001-02-03",
    "lastAmountCarriedOver": 1.0,
    "lastAmountNotCarriedOver": 1.0,
    "carryOverEligibleMinimum": 1.0,
    "maximumAllowed": 1.0,
    "carryOverRate": 1.0,
    "lastAccrualDate": "0001-02-03",
    "lastTakenDate": "0001-02-03",
    "isActive": true,
    "ptoHistories": [
      {
        "checkDate": "0001-02-03",
        "runNumber": 1,
        "takenThisPeriod": 2.0,
        "accruedThisPeriod": 3.0,
        "pendingThisPeriod": 4.0,
        "allowed": 5.0,
        "taken": 6.0,
        "pending": 7.0,
        "accrualToDate": 8.0
      },
      {
        "checkDate": "0001-02-03",
        "runNumber": 1,
        "takenThisPeriod": 2.0,
        "accruedThisPeriod": 3.0,
        "pendingThisPeriod": 4.0,
        "allowed": 5.0,
        "taken": 6.0,
        "pending": 7.0,
        "accrualToDate": 8.0
      }
    ],
    "employeeNumber": "sample string 2",
    "employeePersonalId": 1,
    "divisionCode": "sample string 3",
    "companyCode": "sample string 4"
  }
]

text/xml

Sample:

<ArrayOfEmployeePTOAccrualImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <EmployeePTOAccrualImportDTO>
    <CompanyCode>sample string 4</CompanyCode>
    <DivisionCode>sample string 3</DivisionCode>
    <EmployeeNumber>sample string 2</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <AccrualToDate>1</AccrualToDate>
    <Allowed>1</Allowed>
    <CarryOverEligibleMinimum>1</CarryOverEligibleMinimum>
    <CarryOverRate>1</CarryOverRate>
    <EmployeeAmount>1</EmployeeAmount>
    <EmployeeHours>1</EmployeeHours>
    <EmployeeRate>1</EmployeeRate>
    <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>
    <LOSDateToUse 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>
    </LOSDateToUse>
    <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>
    <LastAmountCarriedOver>1</LastAmountCarriedOver>
    <LastAmountNotCarriedOver>1</LastAmountNotCarriedOver>
    <LastPendingMoved 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>
    </LastPendingMoved>
    <LastRollover 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>
    </LastRollover>
    <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>
    <MaximumAccrual>1</MaximumAccrual>
    <MaximumAllowed>1</MaximumAllowed>
    <MaximumBalance>1</MaximumBalance>
    <MaximumCarryOver>1</MaximumCarryOver>
    <MaximumPerPeriod>1</MaximumPerPeriod>
    <PTOCode>sample string 1</PTOCode>
    <PTOHistories>
      <EmployeePTOHistorySubImportDTO>
        <AccrualToDate>8</AccrualToDate>
        <AccruedThisPeriod>3</AccruedThisPeriod>
        <Allowed>5</Allowed>
        <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>
        <Pending>7</Pending>
        <PendingThisPeriod>4</PendingThisPeriod>
        <RunNumber>1</RunNumber>
        <Taken>6</Taken>
        <TakenThisPeriod>2</TakenThisPeriod>
      </EmployeePTOHistorySubImportDTO>
      <EmployeePTOHistorySubImportDTO>
        <AccrualToDate>8</AccrualToDate>
        <AccruedThisPeriod>3</AccruedThisPeriod>
        <Allowed>5</Allowed>
        <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>
        <Pending>7</Pending>
        <PendingThisPeriod>4</PendingThisPeriod>
        <RunNumber>1</RunNumber>
        <Taken>6</Taken>
        <TakenThisPeriod>2</TakenThisPeriod>
      </EmployeePTOHistorySubImportDTO>
    </PTOHistories>
    <Pending>1</Pending>
    <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>
    <Taken>1</Taken>
    <UseEmployeeAmount>true</UseEmployeeAmount>
    <UseEmployeeHours>true</UseEmployeeHours>
    <UseEmployeeRate>true</UseEmployeeRate>
  </EmployeePTOAccrualImportDTO>
  <EmployeePTOAccrualImportDTO>
    <CompanyCode>sample string 4</CompanyCode>
    <DivisionCode>sample string 3</DivisionCode>
    <EmployeeNumber>sample string 2</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <AccrualToDate>1</AccrualToDate>
    <Allowed>1</Allowed>
    <CarryOverEligibleMinimum>1</CarryOverEligibleMinimum>
    <CarryOverRate>1</CarryOverRate>
    <EmployeeAmount>1</EmployeeAmount>
    <EmployeeHours>1</EmployeeHours>
    <EmployeeRate>1</EmployeeRate>
    <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>
    <LOSDateToUse 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>
    </LOSDateToUse>
    <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>
    <LastAmountCarriedOver>1</LastAmountCarriedOver>
    <LastAmountNotCarriedOver>1</LastAmountNotCarriedOver>
    <LastPendingMoved 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>
    </LastPendingMoved>
    <LastRollover 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>
    </LastRollover>
    <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>
    <MaximumAccrual>1</MaximumAccrual>
    <MaximumAllowed>1</MaximumAllowed>
    <MaximumBalance>1</MaximumBalance>
    <MaximumCarryOver>1</MaximumCarryOver>
    <MaximumPerPeriod>1</MaximumPerPeriod>
    <PTOCode>sample string 1</PTOCode>
    <PTOHistories>
      <EmployeePTOHistorySubImportDTO>
        <AccrualToDate>8</AccrualToDate>
        <AccruedThisPeriod>3</AccruedThisPeriod>
        <Allowed>5</Allowed>
        <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>
        <Pending>7</Pending>
        <PendingThisPeriod>4</PendingThisPeriod>
        <RunNumber>1</RunNumber>
        <Taken>6</Taken>
        <TakenThisPeriod>2</TakenThisPeriod>
      </EmployeePTOHistorySubImportDTO>
      <EmployeePTOHistorySubImportDTO>
        <AccrualToDate>8</AccrualToDate>
        <AccruedThisPeriod>3</AccruedThisPeriod>
        <Allowed>5</Allowed>
        <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>
        <Pending>7</Pending>
        <PendingThisPeriod>4</PendingThisPeriod>
        <RunNumber>1</RunNumber>
        <Taken>6</Taken>
        <TakenThisPeriod>2</TakenThisPeriod>
      </EmployeePTOHistorySubImportDTO>
    </PTOHistories>
    <Pending>1</Pending>
    <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>
    <Taken>1</Taken>
    <UseEmployeeAmount>true</UseEmployeeAmount>
    <UseEmployeeHours>true</UseEmployeeHours>
    <UseEmployeeRate>true</UseEmployeeRate>
  </EmployeePTOAccrualImportDTO>
</ArrayOfEmployeePTOAccrualImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results of the import.

ImportResultDTO

Name	Type	Additional information
NewRecords	integer	None.
UpdatedRecords	integer	None.
Errors	Collection of ImportErrorDTO	None.
NewRecordKeys	Collection of ImportKeyDTO	None.
UpdatedRecordKeys	Collection of ImportKeyDTO	None.
ImportKey	GlobalEntityKeyOfIImportSubmission	None.

Response Formats

application/json, text/json, text/xml

Sample:

Sample not available.