POST v1/imports/payrolls?action={action}&allowSameFile={allowSameFile}

Import Pay Calendars

Request Information

URI Parameters

Name	Description	Type	Additional information
action	The import action.	ImportAction	Default value is Insert
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 DivisionPayCalendarImportDTO

Name	Type	Additional information
CheckDate	date	Required
PeriodBegin	date	None.
PeriodEnd	date	None.
ScheduledDate	date	None.
RunNumber	integer	None.
OffCycle	boolean	None.
BlockACH	boolean	None.
BlockBilling	boolean	None.
BlockProduction	boolean	None.
BlockPTORollover	boolean	None.
BlockPTOAccrual	boolean	None.
BlockPTOTaken	boolean	None.
BlockAllDeductions	boolean	None.
BlockTaxFiling	boolean	None.
BlockThirdPartyChecks	boolean	None.
DoNotTakeArrears	boolean	None.
DoNotAccumulateArrears	boolean	None.
StartPayroll	boolean	None.
PayrollType	PayrollType	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "checkDate": "0001-02-03",
    "periodBegin": "0001-02-03",
    "periodEnd": "0001-02-03",
    "scheduledDate": "0001-02-03",
    "runNumber": 1,
    "offCycle": true,
    "blockACH": true,
    "blockBilling": true,
    "blockProduction": true,
    "blockPTORollover": true,
    "blockPTOAccrual": true,
    "blockPTOTaken": true,
    "blockAllDeductions": true,
    "blockTaxFiling": true,
    "blockThirdPartyChecks": true,
    "doNotTakeArrears": true,
    "doNotAccumulateArrears": true,
    "startPayroll": true,
    "payrollType": "Standard",
    "divisionCode": "sample string 14",
    "companyCode": "sample string 15"
  },
  {
    "checkDate": "0001-02-03",
    "periodBegin": "0001-02-03",
    "periodEnd": "0001-02-03",
    "scheduledDate": "0001-02-03",
    "runNumber": 1,
    "offCycle": true,
    "blockACH": true,
    "blockBilling": true,
    "blockProduction": true,
    "blockPTORollover": true,
    "blockPTOAccrual": true,
    "blockPTOTaken": true,
    "blockAllDeductions": true,
    "blockTaxFiling": true,
    "blockThirdPartyChecks": true,
    "doNotTakeArrears": true,
    "doNotAccumulateArrears": true,
    "startPayroll": true,
    "payrollType": "Standard",
    "divisionCode": "sample string 14",
    "companyCode": "sample string 15"
  }
]

text/xml

Sample:

<ArrayOfDivisionPayCalendarImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <DivisionPayCalendarImportDTO>
    <CompanyCode>sample string 15</CompanyCode>
    <DivisionCode>sample string 14</DivisionCode>
    <BlockACH>true</BlockACH>
    <BlockAllDeductions>true</BlockAllDeductions>
    <BlockBilling>true</BlockBilling>
    <BlockPTOAccrual>true</BlockPTOAccrual>
    <BlockPTORollover>true</BlockPTORollover>
    <BlockPTOTaken>true</BlockPTOTaken>
    <BlockProduction>true</BlockProduction>
    <BlockTaxFiling>true</BlockTaxFiling>
    <BlockThirdPartyChecks>true</BlockThirdPartyChecks>
    <CheckDate 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>
    </CheckDate>
    <DoNotAccumulateArrears>true</DoNotAccumulateArrears>
    <DoNotTakeArrears>true</DoNotTakeArrears>
    <OffCycle>true</OffCycle>
    <PayrollType>Standard</PayrollType>
    <PeriodBegin 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>
    </PeriodBegin>
    <PeriodEnd 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>
    </PeriodEnd>
    <RunNumber>1</RunNumber>
    <ScheduledDate 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>
    </ScheduledDate>
    <StartPayroll>true</StartPayroll>
  </DivisionPayCalendarImportDTO>
  <DivisionPayCalendarImportDTO>
    <CompanyCode>sample string 15</CompanyCode>
    <DivisionCode>sample string 14</DivisionCode>
    <BlockACH>true</BlockACH>
    <BlockAllDeductions>true</BlockAllDeductions>
    <BlockBilling>true</BlockBilling>
    <BlockPTOAccrual>true</BlockPTOAccrual>
    <BlockPTORollover>true</BlockPTORollover>
    <BlockPTOTaken>true</BlockPTOTaken>
    <BlockProduction>true</BlockProduction>
    <BlockTaxFiling>true</BlockTaxFiling>
    <BlockThirdPartyChecks>true</BlockThirdPartyChecks>
    <CheckDate 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>
    </CheckDate>
    <DoNotAccumulateArrears>true</DoNotAccumulateArrears>
    <DoNotTakeArrears>true</DoNotTakeArrears>
    <OffCycle>true</OffCycle>
    <PayrollType>Standard</PayrollType>
    <PeriodBegin 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>
    </PeriodBegin>
    <PeriodEnd 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>
    </PeriodEnd>
    <RunNumber>1</RunNumber>
    <ScheduledDate 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>
    </ScheduledDate>
    <StartPayroll>true</StartPayroll>
  </DivisionPayCalendarImportDTO>
</ArrayOfDivisionPayCalendarImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The result 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.