GET v1/supplemental-benefits/export/companies/{companyCode}/divisions/{divisionCode}/pay-calendars?payrollStatus={payrollStatus}&beginDate={beginDate}&endDate={endDate}

Retrieve Supplemental Benefits Pay Calendars by Division

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	The company code	string	Required
divisionCode	The division code	string	Required
payrollStatus	Optional PayrollStatus to filter results	PayrollStatus	None.
beginDate		date	None.
endDate		date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of SupplementalBenefitsPayrollCalendarDTO

Name	Type	Additional information
PayrollKey	GlobalEntityKeyOfIDivisionPayCalendar	None.
ClientCode	string	None.
CompanyCode	string	None.
DivisionCode	string	None.
RunNumber	integer	None.
CheckDate	date	None.
PeriodBeginDate	date	None.
PeriodEndDate	date	None.
ScheduledDate	date	None.
OriginalCheckDate	date	None.
OriginalPeriodBeginDate	date	None.
OriginalPeriodEndDate	date	None.
PayrollStatus	PayrollStatus	None.
ProcessedDate	date	None.
OffCyclePayroll	boolean	None.
SubmittedOn	date	None.
PayrollType	PayrollType	None.
PayBatches	Collection of SupplementalBenefitsPayBatchDTO	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "payrollKey": "<empty>",
    "clientCode": "sample string 1",
    "companyCode": "sample string 2",
    "divisionCode": "sample string 3",
    "runNumber": 4,
    "checkDate": "0001-02-03",
    "periodBeginDate": "0001-02-03",
    "periodEndDate": "0001-02-03",
    "scheduledDate": "0001-02-03",
    "originalCheckDate": "0001-02-03",
    "originalPeriodBeginDate": "0001-02-03",
    "originalPeriodEndDate": "0001-02-03",
    "payrollStatus": "Scheduled",
    "processedDate": "2026-03-17T22:31:38.3275303Z",
    "offCyclePayroll": true,
    "submittedOn": "2026-03-17T22:31:38.3275303Z",
    "payrollType": "Standard",
    "payBatches": [
      {
        "periodBeginDate": "0001-02-03",
        "periodEndDate": "0001-02-03",
        "key": 1,
        "code": "sample string 2",
        "description": "sample string 3"
      },
      {
        "periodBeginDate": "0001-02-03",
        "periodEndDate": "0001-02-03",
        "key": 1,
        "code": "sample string 2",
        "description": "sample string 3"
      }
    ]
  },
  {
    "payrollKey": "<empty>",
    "clientCode": "sample string 1",
    "companyCode": "sample string 2",
    "divisionCode": "sample string 3",
    "runNumber": 4,
    "checkDate": "0001-02-03",
    "periodBeginDate": "0001-02-03",
    "periodEndDate": "0001-02-03",
    "scheduledDate": "0001-02-03",
    "originalCheckDate": "0001-02-03",
    "originalPeriodBeginDate": "0001-02-03",
    "originalPeriodEndDate": "0001-02-03",
    "payrollStatus": "Scheduled",
    "processedDate": "2026-03-17T22:31:38.3275303Z",
    "offCyclePayroll": true,
    "submittedOn": "2026-03-17T22:31:38.3275303Z",
    "payrollType": "Standard",
    "payBatches": [
      {
        "periodBeginDate": "0001-02-03",
        "periodEndDate": "0001-02-03",
        "key": 1,
        "code": "sample string 2",
        "description": "sample string 3"
      },
      {
        "periodBeginDate": "0001-02-03",
        "periodEndDate": "0001-02-03",
        "key": 1,
        "code": "sample string 2",
        "description": "sample string 3"
      }
    ]
  }
]

text/xml

Sample:

<ArrayOfSupplementalBenefitsPayrollCalendarDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <SupplementalBenefitsPayrollCalendarDTO>
    <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>
    <ClientCode>sample string 1</ClientCode>
    <CompanyCode>sample string 2</CompanyCode>
    <DivisionCode>sample string 3</DivisionCode>
    <OffCyclePayroll>true</OffCyclePayroll>
    <OriginalCheckDate 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>
    </OriginalCheckDate>
    <OriginalPeriodBeginDate 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>
    </OriginalPeriodBeginDate>
    <OriginalPeriodEndDate 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>
    </OriginalPeriodEndDate>
    <PayBatches>
      <SupplementalBenefitsPayBatchDTO>
        <Code xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 2</Code>
        <Description xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 3</Description>
        <Key xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">1</Key>
        <PeriodBeginDate 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>
        </PeriodBeginDate>
        <PeriodEndDate 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>
        </PeriodEndDate>
      </SupplementalBenefitsPayBatchDTO>
      <SupplementalBenefitsPayBatchDTO>
        <Code xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 2</Code>
        <Description xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 3</Description>
        <Key xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">1</Key>
        <PeriodBeginDate 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>
        </PeriodBeginDate>
        <PeriodEndDate 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>
        </PeriodEndDate>
      </SupplementalBenefitsPayBatchDTO>
    </PayBatches>
    <PayrollKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </PayrollKey>
    <PayrollStatus>Scheduled</PayrollStatus>
    <PayrollType>Standard</PayrollType>
    <PeriodBeginDate 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>
    </PeriodBeginDate>
    <PeriodEndDate 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>
    </PeriodEndDate>
    <ProcessedDate>2026-03-17T18:31:38.3275303-04:00</ProcessedDate>
    <RunNumber>4</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>
    <SubmittedOn>2026-03-17T18:31:38.3275303-04:00</SubmittedOn>
  </SupplementalBenefitsPayrollCalendarDTO>
  <SupplementalBenefitsPayrollCalendarDTO>
    <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>
    <ClientCode>sample string 1</ClientCode>
    <CompanyCode>sample string 2</CompanyCode>
    <DivisionCode>sample string 3</DivisionCode>
    <OffCyclePayroll>true</OffCyclePayroll>
    <OriginalCheckDate 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>
    </OriginalCheckDate>
    <OriginalPeriodBeginDate 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>
    </OriginalPeriodBeginDate>
    <OriginalPeriodEndDate 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>
    </OriginalPeriodEndDate>
    <PayBatches>
      <SupplementalBenefitsPayBatchDTO>
        <Code xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 2</Code>
        <Description xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 3</Description>
        <Key xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">1</Key>
        <PeriodBeginDate 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>
        </PeriodBeginDate>
        <PeriodEndDate 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>
        </PeriodEndDate>
      </SupplementalBenefitsPayBatchDTO>
      <SupplementalBenefitsPayBatchDTO>
        <Code xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 2</Code>
        <Description xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 3</Description>
        <Key xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">1</Key>
        <PeriodBeginDate 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>
        </PeriodBeginDate>
        <PeriodEndDate 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>
        </PeriodEndDate>
      </SupplementalBenefitsPayBatchDTO>
    </PayBatches>
    <PayrollKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </PayrollKey>
    <PayrollStatus>Scheduled</PayrollStatus>
    <PayrollType>Standard</PayrollType>
    <PeriodBeginDate 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>
    </PeriodBeginDate>
    <PeriodEndDate 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>
    </PeriodEndDate>
    <ProcessedDate>2026-03-17T18:31:38.3275303-04:00</ProcessedDate>
    <RunNumber>4</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>
    <SubmittedOn>2026-03-17T18:31:38.3275303-04:00</SubmittedOn>
  </SupplementalBenefitsPayrollCalendarDTO>
</ArrayOfSupplementalBenefitsPayrollCalendarDTO>