POST v1/time-attendance/import/companies/{companyCode}/divisions/{divisionCode}/payrolls/{checkDate}/{runNumber}/pay-batches/{batchCode}

Import Pay Entries

Request Information

URI Parameters

Name	Type	Additional information
companyCode	string	Required
divisionCode	string	Required
checkDate	date	Required
runNumber	integer	Required
batchCode	string	Required

Body Parameters

Collection of TimeAttendancePayEntryImportDTO

Name	Type	Additional information
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
PayNumber	integer	None.
Code	string	None.
Hours	decimal number	None.
Amount	decimal number	None.
Rate	decimal number	None.
ChargeDate	date	None.
In	FixedDateTime	None.
Out	FixedDateTime	None.
In2	FixedDateTime	None.
Out2	FixedDateTime	None.
JobCode	string	None.
Department	string	None.
Memo	string	None.
InternalMemo	string	None.
CostCenter1	string	None.
CostCenter2	string	None.
CostCenter3	string	None.
CostCenter4	string	None.
CostCenter5	string	None.
RateCode	string	None.
TaxLocationCode	string	None.
RecordType	PayEntryRecordType	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "employeeNumber": "sample string 1",
    "employeePersonalId": 1,
    "payNumber": 1,
    "code": "sample string 2",
    "hours": 1.0,
    "amount": 1.0,
    "rate": 1.0,
    "chargeDate": "0001-02-03",
    "in": "0001-02-03T09:05:06.007Z",
    "out": "0001-02-03T09:05:06.007Z",
    "in2": "0001-02-03T09:05:06.007Z",
    "out2": "0001-02-03T09:05:06.007Z",
    "jobCode": "sample string 3",
    "department": "sample string 4",
    "memo": "sample string 5",
    "internalMemo": "sample string 6",
    "costCenter1": "sample string 7",
    "costCenter2": "sample string 8",
    "costCenter3": "sample string 9",
    "costCenter4": "sample string 10",
    "costCenter5": "sample string 11",
    "rateCode": "sample string 12",
    "taxLocationCode": "sample string 13",
    "recordType": "E"
  },
  {
    "employeeNumber": "sample string 1",
    "employeePersonalId": 1,
    "payNumber": 1,
    "code": "sample string 2",
    "hours": 1.0,
    "amount": 1.0,
    "rate": 1.0,
    "chargeDate": "0001-02-03",
    "in": "0001-02-03T09:05:06.007Z",
    "out": "0001-02-03T09:05:06.007Z",
    "in2": "0001-02-03T09:05:06.007Z",
    "out2": "0001-02-03T09:05:06.007Z",
    "jobCode": "sample string 3",
    "department": "sample string 4",
    "memo": "sample string 5",
    "internalMemo": "sample string 6",
    "costCenter1": "sample string 7",
    "costCenter2": "sample string 8",
    "costCenter3": "sample string 9",
    "costCenter4": "sample string 10",
    "costCenter5": "sample string 11",
    "rateCode": "sample string 12",
    "taxLocationCode": "sample string 13",
    "recordType": "E"
  }
]

text/xml

Sample:

<ArrayOfTimeAttendancePayEntryImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <TimeAttendancePayEntryImportDTO>
    <Amount>1</Amount>
    <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 2</Code>
    <CostCenter1>sample string 7</CostCenter1>
    <CostCenter2>sample string 8</CostCenter2>
    <CostCenter3>sample string 9</CostCenter3>
    <CostCenter4>sample string 10</CostCenter4>
    <CostCenter5>sample string 11</CostCenter5>
    <Department>sample string 4</Department>
    <EmployeeNumber>sample string 1</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <Hours>1</Hours>
    <In 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>
    </In>
    <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 6</InternalMemo>
    <JobCode>sample string 3</JobCode>
    <Memo>sample string 5</Memo>
    <Out 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>
    </Out>
    <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>
    <PayNumber>1</PayNumber>
    <Rate>1</Rate>
    <RateCode>sample string 12</RateCode>
    <RecordType>E</RecordType>
    <TaxLocationCode>sample string 13</TaxLocationCode>
  </TimeAttendancePayEntryImportDTO>
  <TimeAttendancePayEntryImportDTO>
    <Amount>1</Amount>
    <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 2</Code>
    <CostCenter1>sample string 7</CostCenter1>
    <CostCenter2>sample string 8</CostCenter2>
    <CostCenter3>sample string 9</CostCenter3>
    <CostCenter4>sample string 10</CostCenter4>
    <CostCenter5>sample string 11</CostCenter5>
    <Department>sample string 4</Department>
    <EmployeeNumber>sample string 1</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <Hours>1</Hours>
    <In 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>
    </In>
    <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 6</InternalMemo>
    <JobCode>sample string 3</JobCode>
    <Memo>sample string 5</Memo>
    <Out 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>
    </Out>
    <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>
    <PayNumber>1</PayNumber>
    <Rate>1</Rate>
    <RateCode>sample string 12</RateCode>
    <RecordType>E</RecordType>
    <TaxLocationCode>sample string 13</TaxLocationCode>
  </TimeAttendancePayEntryImportDTO>
</ArrayOfTimeAttendancePayEntryImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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

Sample:

{
  "newRecords": 1,
  "updatedRecords": 2,
  "errors": [
    {
      "index": 1,
      "details": [
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    },
    {
      "index": 1,
      "details": [
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    }
  ],
  "newRecordKeys": [
    {
      "index": 1,
      "key": "sample string 2"
    },
    {
      "index": 1,
      "key": "sample string 2"
    }
  ],
  "updatedRecordKeys": [
    {
      "index": 1,
      "key": "sample string 2"
    },
    {
      "index": 1,
      "key": "sample string 2"
    }
  ],
  "importKey": "<empty>"
}

text/xml

Sample:

<ImportResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
  <Errors>
    <ImportErrorDTO>
      <Details>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
      </Details>
      <Index>1</Index>
    </ImportErrorDTO>
    <ImportErrorDTO>
      <Details>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
      </Details>
      <Index>1</Index>
    </ImportErrorDTO>
  </Errors>
  <ImportKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
    <d2p1:_entityKey>
      <d2p1:_hasValue>false</d2p1:_hasValue>
      <d2p1:_value>00000000-0000-0000-0000-000000000000</d2p1:_value>
    </d2p1:_entityKey>
  </ImportKey>
  <NewRecordKeys>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
  </NewRecordKeys>
  <NewRecords>1</NewRecords>
  <UpdatedRecordKeys>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
  </UpdatedRecordKeys>
  <UpdatedRecords>2</UpdatedRecords>
</ImportResultDTO>