POST v1/imports/check-history?action={action}&allowSameFile={allowSameFile}

Import Historical Checks

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 CheckHistoryImportDTO

Name	Type	Additional information
RecordType	PayEntryRecordType	Required
Amount	decimal number	None.
Rate	decimal number	None.
ExemptWages	decimal number	None.
GrossWages	decimal number	None.
SubjectWages	decimal number	None.
TaxableWages	decimal number	None.
Code	string	Required
Hours	decimal number	None.
In1	FixedDateTime	None.
In2	FixedDateTime	None.
Out1	FixedDateTime	None.
Out2	FixedDateTime	None.
ChargeDate	date	None.
Memo	string	None.
InternalMemo	string	None.
EarningShiftCode	string	None.
EarningCostCenter1Code	string	None.
EarningCostCenter2Code	string	None.
EarningCostCenter3Code	string	None.
EarningCostCenter4Code	string	None.
EarningCostCenter5Code	string	None.
EarningJobCode	string	None.
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
CheckPeriodBegin	date	None.
CheckPeriodEnd	date	None.
PayNumber	integer	None.
CheckNumber	integer	None.
VoucherNumber	integer	None.
StubMessage	string	None.
PayrollPeriodBegin	date	None.
PayrollPeriodEnd	date	None.
SerializablePayrollKey	globally unique identifier	None.
CheckDate	date	None.
RunNumber	integer	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "recordType": "E",
    "amount": 1.0,
    "rate": 2.0,
    "exemptWages": 3.0,
    "grossWages": 4.0,
    "subjectWages": 5.0,
    "taxableWages": 6.0,
    "code": "sample string 7",
    "hours": 8.0,
    "in1": "0001-02-03T09:05:06.007Z",
    "in2": "0001-02-03T09:05:06.007Z",
    "out1": "0001-02-03T09:05:06.007Z",
    "out2": "0001-02-03T09:05:06.007Z",
    "chargeDate": "0001-02-03",
    "memo": "sample string 9",
    "internalMemo": "sample string 10",
    "earningShiftCode": "sample string 11",
    "earningCostCenter1Code": "sample string 12",
    "earningCostCenter2Code": "sample string 13",
    "earningCostCenter3Code": "sample string 14",
    "earningCostCenter4Code": "sample string 15",
    "earningCostCenter5Code": "sample string 16",
    "earningJobCode": "sample string 17",
    "employeeNumber": "sample string 18",
    "employeePersonalId": 1,
    "checkPeriodBegin": "0001-02-03",
    "checkPeriodEnd": "0001-02-03",
    "payNumber": 19,
    "checkNumber": 20,
    "voucherNumber": 1,
    "stubMessage": "sample string 21",
    "payrollPeriodBegin": "0001-02-03",
    "payrollPeriodEnd": "0001-02-03",
    "serializablePayrollKey": "a5c3e525-1195-459b-9807-85f76fdb7d79",
    "payrollKey": "a5c3e525-1195-459b-9807-85f76fdb7d79",
    "checkDate": "0001-02-03",
    "runNumber": 1,
    "divisionCode": "sample string 22",
    "companyCode": "sample string 23"
  },
  {
    "recordType": "E",
    "amount": 1.0,
    "rate": 2.0,
    "exemptWages": 3.0,
    "grossWages": 4.0,
    "subjectWages": 5.0,
    "taxableWages": 6.0,
    "code": "sample string 7",
    "hours": 8.0,
    "in1": "0001-02-03T09:05:06.007Z",
    "in2": "0001-02-03T09:05:06.007Z",
    "out1": "0001-02-03T09:05:06.007Z",
    "out2": "0001-02-03T09:05:06.007Z",
    "chargeDate": "0001-02-03",
    "memo": "sample string 9",
    "internalMemo": "sample string 10",
    "earningShiftCode": "sample string 11",
    "earningCostCenter1Code": "sample string 12",
    "earningCostCenter2Code": "sample string 13",
    "earningCostCenter3Code": "sample string 14",
    "earningCostCenter4Code": "sample string 15",
    "earningCostCenter5Code": "sample string 16",
    "earningJobCode": "sample string 17",
    "employeeNumber": "sample string 18",
    "employeePersonalId": 1,
    "checkPeriodBegin": "0001-02-03",
    "checkPeriodEnd": "0001-02-03",
    "payNumber": 19,
    "checkNumber": 20,
    "voucherNumber": 1,
    "stubMessage": "sample string 21",
    "payrollPeriodBegin": "0001-02-03",
    "payrollPeriodEnd": "0001-02-03",
    "serializablePayrollKey": "a5c3e525-1195-459b-9807-85f76fdb7d79",
    "payrollKey": "a5c3e525-1195-459b-9807-85f76fdb7d79",
    "checkDate": "0001-02-03",
    "runNumber": 1,
    "divisionCode": "sample string 22",
    "companyCode": "sample string 23"
  }
]

text/xml

Sample:

<ArrayOfCheckHistoryImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <CheckHistoryImportDTO>
    <CompanyCode>sample string 23</CompanyCode>
    <DivisionCode>sample string 22</DivisionCode>
    <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>
    <PayrollKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>true</d3p1:_hasValue>
        <d3p1:_value>a5c3e525-1195-459b-9807-85f76fdb7d79</d3p1:_value>
      </d3p1:_entityKey>
    </PayrollKey>
    <RunNumber>1</RunNumber>
    <SerializablePayrollKey>a5c3e525-1195-459b-9807-85f76fdb7d79</SerializablePayrollKey>
    <PayrollPeriodBegin 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>
    </PayrollPeriodBegin>
    <PayrollPeriodEnd 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>
    </PayrollPeriodEnd>
    <CheckNumber>20</CheckNumber>
    <CheckPeriodBegin 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>
    </CheckPeriodBegin>
    <CheckPeriodEnd 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>
    </CheckPeriodEnd>
    <EmployeeNumber>sample string 18</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <PayNumber>19</PayNumber>
    <StubMessage>sample string 21</StubMessage>
    <VoucherNumber>1</VoucherNumber>
    <ChargeDate 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>
    </ChargeDate>
    <Code>sample string 7</Code>
    <EarningCostCenter1Code>sample string 12</EarningCostCenter1Code>
    <EarningCostCenter2Code>sample string 13</EarningCostCenter2Code>
    <EarningCostCenter3Code>sample string 14</EarningCostCenter3Code>
    <EarningCostCenter4Code>sample string 15</EarningCostCenter4Code>
    <EarningCostCenter5Code>sample string 16</EarningCostCenter5Code>
    <EarningJobCode>sample string 17</EarningJobCode>
    <EarningShiftCode>sample string 11</EarningShiftCode>
    <Hours>8</Hours>
    <In1 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>
      <d3p1:Hour>4</d3p1:Hour>
      <d3p1:Minute>5</d3p1:Minute>
      <d3p1:Second>6</d3p1:Second>
      <d3p1:Milisecond>7</d3p1:Milisecond>
    </In1>
    <In2 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>
      <d3p1:Hour>4</d3p1:Hour>
      <d3p1:Minute>5</d3p1:Minute>
      <d3p1:Second>6</d3p1:Second>
      <d3p1:Milisecond>7</d3p1:Milisecond>
    </In2>
    <InternalMemo>sample string 10</InternalMemo>
    <Memo>sample string 9</Memo>
    <Out1 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>
      <d3p1:Hour>4</d3p1:Hour>
      <d3p1:Minute>5</d3p1:Minute>
      <d3p1:Second>6</d3p1:Second>
      <d3p1:Milisecond>7</d3p1:Milisecond>
    </Out1>
    <Out2 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>
      <d3p1:Hour>4</d3p1:Hour>
      <d3p1:Minute>5</d3p1:Minute>
      <d3p1:Second>6</d3p1:Second>
      <d3p1:Milisecond>7</d3p1:Milisecond>
    </Out2>
    <Amount>1</Amount>
    <ExemptWages>3</ExemptWages>
    <GrossWages>4</GrossWages>
    <Rate>2</Rate>
    <RecordType>E</RecordType>
    <SubjectWages>5</SubjectWages>
    <TaxableWages>6</TaxableWages>
  </CheckHistoryImportDTO>
  <CheckHistoryImportDTO>
    <CompanyCode>sample string 23</CompanyCode>
    <DivisionCode>sample string 22</DivisionCode>
    <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>
    <PayrollKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>true</d3p1:_hasValue>
        <d3p1:_value>a5c3e525-1195-459b-9807-85f76fdb7d79</d3p1:_value>
      </d3p1:_entityKey>
    </PayrollKey>
    <RunNumber>1</RunNumber>
    <SerializablePayrollKey>a5c3e525-1195-459b-9807-85f76fdb7d79</SerializablePayrollKey>
    <PayrollPeriodBegin 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>
    </PayrollPeriodBegin>
    <PayrollPeriodEnd 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>
    </PayrollPeriodEnd>
    <CheckNumber>20</CheckNumber>
    <CheckPeriodBegin 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>
    </CheckPeriodBegin>
    <CheckPeriodEnd 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>
    </CheckPeriodEnd>
    <EmployeeNumber>sample string 18</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <PayNumber>19</PayNumber>
    <StubMessage>sample string 21</StubMessage>
    <VoucherNumber>1</VoucherNumber>
    <ChargeDate 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>
    </ChargeDate>
    <Code>sample string 7</Code>
    <EarningCostCenter1Code>sample string 12</EarningCostCenter1Code>
    <EarningCostCenter2Code>sample string 13</EarningCostCenter2Code>
    <EarningCostCenter3Code>sample string 14</EarningCostCenter3Code>
    <EarningCostCenter4Code>sample string 15</EarningCostCenter4Code>
    <EarningCostCenter5Code>sample string 16</EarningCostCenter5Code>
    <EarningJobCode>sample string 17</EarningJobCode>
    <EarningShiftCode>sample string 11</EarningShiftCode>
    <Hours>8</Hours>
    <In1 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>
      <d3p1:Hour>4</d3p1:Hour>
      <d3p1:Minute>5</d3p1:Minute>
      <d3p1:Second>6</d3p1:Second>
      <d3p1:Milisecond>7</d3p1:Milisecond>
    </In1>
    <In2 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>
      <d3p1:Hour>4</d3p1:Hour>
      <d3p1:Minute>5</d3p1:Minute>
      <d3p1:Second>6</d3p1:Second>
      <d3p1:Milisecond>7</d3p1:Milisecond>
    </In2>
    <InternalMemo>sample string 10</InternalMemo>
    <Memo>sample string 9</Memo>
    <Out1 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>
      <d3p1:Hour>4</d3p1:Hour>
      <d3p1:Minute>5</d3p1:Minute>
      <d3p1:Second>6</d3p1:Second>
      <d3p1:Milisecond>7</d3p1:Milisecond>
    </Out1>
    <Out2 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>
      <d3p1:Hour>4</d3p1:Hour>
      <d3p1:Minute>5</d3p1:Minute>
      <d3p1:Second>6</d3p1:Second>
      <d3p1:Milisecond>7</d3p1:Milisecond>
    </Out2>
    <Amount>1</Amount>
    <ExemptWages>3</ExemptWages>
    <GrossWages>4</GrossWages>
    <Rate>2</Rate>
    <RecordType>E</RecordType>
    <SubjectWages>5</SubjectWages>
    <TaxableWages>6</TaxableWages>
  </CheckHistoryImportDTO>
</ArrayOfCheckHistoryImportDTO>

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.