GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/payrolls

Retrieve Payrolls by Division

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyCode

string

Required

divisionCode

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of TimeAttendancePayrollDTO
NameDescriptionTypeAdditional information
CheckDate

date

None.

RunNumber

integer

None.

PeriodBegin

date

None.

PeriodEnd

date

None.

PayBatches

Collection of TimeAttendancePayBatchDTO

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "checkDate": "0001-02-03",
    "runNumber": 1,
    "periodBegin": "0001-02-03",
    "periodEnd": "0001-02-03",
    "payBatches": [
      {
        "code": "sample string 1",
        "description": "sample string 2",
        "periodBegin": "0001-02-03",
        "periodEnd": "0001-02-03"
      },
      {
        "code": "sample string 1",
        "description": "sample string 2",
        "periodBegin": "0001-02-03",
        "periodEnd": "0001-02-03"
      }
    ]
  },
  {
    "checkDate": "0001-02-03",
    "runNumber": 1,
    "periodBegin": "0001-02-03",
    "periodEnd": "0001-02-03",
    "payBatches": [
      {
        "code": "sample string 1",
        "description": "sample string 2",
        "periodBegin": "0001-02-03",
        "periodEnd": "0001-02-03"
      },
      {
        "code": "sample string 1",
        "description": "sample string 2",
        "periodBegin": "0001-02-03",
        "periodEnd": "0001-02-03"
      }
    ]
  }
]

text/xml

Sample:
<ArrayOfTimeAttendancePayrollDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <TimeAttendancePayrollDTO>
    <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>
    <PayBatches>
      <TimeAttendancePayBatchDTO>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <PeriodBegin 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>
        </PeriodBegin>
        <PeriodEnd 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>
        </PeriodEnd>
      </TimeAttendancePayBatchDTO>
      <TimeAttendancePayBatchDTO>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <PeriodBegin 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>
        </PeriodBegin>
        <PeriodEnd 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>
        </PeriodEnd>
      </TimeAttendancePayBatchDTO>
    </PayBatches>
    <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>
  </TimeAttendancePayrollDTO>
  <TimeAttendancePayrollDTO>
    <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>
    <PayBatches>
      <TimeAttendancePayBatchDTO>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <PeriodBegin 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>
        </PeriodBegin>
        <PeriodEnd 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>
        </PeriodEnd>
      </TimeAttendancePayBatchDTO>
      <TimeAttendancePayBatchDTO>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <PeriodBegin 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>
        </PeriodBegin>
        <PeriodEnd 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>
        </PeriodEnd>
      </TimeAttendancePayBatchDTO>
    </PayBatches>
    <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>
  </TimeAttendancePayrollDTO>
</ArrayOfTimeAttendancePayrollDTO>