GET v1/on-demand-pay/export/payrolls?companyCode={companyCode}&divisionCode={divisionCode}&modifiedSince={modifiedSince}&optionalEmployeeNumber={optionalEmployeeNumber}

Retrieve Modified OnDemandPay Payrolls

Request Information

URI Parameters

Name	Type	Additional information
companyCode	string	Required
divisionCode	string	Required
modifiedSince	date	Required
optionalEmployeeNumber	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of OnDemandPayPayrollDTO

Name	Type	Additional information
PayrollKey	GlobalEntityKeyOfIDivisionPayCalendar	None.
CheckDate	date	None.
ProcessedDate	date	None.
PeriodBeginDate	date	None.
PeriodEndDate	date	None.
Checks	Collection of OnDemandPayPayCheckDTO	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "payrollKey": "<empty>",
    "checkDate": "0001-02-03",
    "processedDate": "2025-04-11T17:36:30.6312564Z",
    "periodBeginDate": "0001-02-03",
    "periodEndDate": "0001-02-03",
    "checks": [
      {
        "net": 1.0,
        "gross": 2.0,
        "netCheckAmount": 3.0,
        "netDirectDepositAmount": 4.0,
        "employeeNumber": "sample string 5",
        "employeeKey": "<empty>",
        "checkKey": "<empty>",
        "directDeposits": [
          {
            "accountNumberLast4Digits": "sample string 1",
            "accountType": "sample string 2",
            "amount": 3.0,
            "isInternal": true
          },
          {
            "accountNumberLast4Digits": "sample string 1",
            "accountType": "sample string 2",
            "amount": 3.0,
            "isInternal": true
          }
        ],
        "deductions": [
          {
            "deductionCode": "sample string 1",
            "amount": 2.0
          },
          {
            "deductionCode": "sample string 1",
            "amount": 2.0
          }
        ],
        "onDemandPayDeductionsTotal": 6.0,
        "deductionsTotal": 7.0
      },
      {
        "net": 1.0,
        "gross": 2.0,
        "netCheckAmount": 3.0,
        "netDirectDepositAmount": 4.0,
        "employeeNumber": "sample string 5",
        "employeeKey": "<empty>",
        "checkKey": "<empty>",
        "directDeposits": [
          {
            "accountNumberLast4Digits": "sample string 1",
            "accountType": "sample string 2",
            "amount": 3.0,
            "isInternal": true
          },
          {
            "accountNumberLast4Digits": "sample string 1",
            "accountType": "sample string 2",
            "amount": 3.0,
            "isInternal": true
          }
        ],
        "deductions": [
          {
            "deductionCode": "sample string 1",
            "amount": 2.0
          },
          {
            "deductionCode": "sample string 1",
            "amount": 2.0
          }
        ],
        "onDemandPayDeductionsTotal": 6.0,
        "deductionsTotal": 7.0
      }
    ]
  },
  {
    "payrollKey": "<empty>",
    "checkDate": "0001-02-03",
    "processedDate": "2025-04-11T17:36:30.6312564Z",
    "periodBeginDate": "0001-02-03",
    "periodEndDate": "0001-02-03",
    "checks": [
      {
        "net": 1.0,
        "gross": 2.0,
        "netCheckAmount": 3.0,
        "netDirectDepositAmount": 4.0,
        "employeeNumber": "sample string 5",
        "employeeKey": "<empty>",
        "checkKey": "<empty>",
        "directDeposits": [
          {
            "accountNumberLast4Digits": "sample string 1",
            "accountType": "sample string 2",
            "amount": 3.0,
            "isInternal": true
          },
          {
            "accountNumberLast4Digits": "sample string 1",
            "accountType": "sample string 2",
            "amount": 3.0,
            "isInternal": true
          }
        ],
        "deductions": [
          {
            "deductionCode": "sample string 1",
            "amount": 2.0
          },
          {
            "deductionCode": "sample string 1",
            "amount": 2.0
          }
        ],
        "onDemandPayDeductionsTotal": 6.0,
        "deductionsTotal": 7.0
      },
      {
        "net": 1.0,
        "gross": 2.0,
        "netCheckAmount": 3.0,
        "netDirectDepositAmount": 4.0,
        "employeeNumber": "sample string 5",
        "employeeKey": "<empty>",
        "checkKey": "<empty>",
        "directDeposits": [
          {
            "accountNumberLast4Digits": "sample string 1",
            "accountType": "sample string 2",
            "amount": 3.0,
            "isInternal": true
          },
          {
            "accountNumberLast4Digits": "sample string 1",
            "accountType": "sample string 2",
            "amount": 3.0,
            "isInternal": true
          }
        ],
        "deductions": [
          {
            "deductionCode": "sample string 1",
            "amount": 2.0
          },
          {
            "deductionCode": "sample string 1",
            "amount": 2.0
          }
        ],
        "onDemandPayDeductionsTotal": 6.0,
        "deductionsTotal": 7.0
      }
    ]
  }
]

text/xml

Sample:

<ArrayOfOnDemandPayPayrollDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <OnDemandPayPayrollDTO>
    <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>
    <Checks>
      <OnDemandPayPayCheckDTO>
        <CheckKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_hasValue>false</d5p1:_hasValue>
          <d5p1:_value>0</d5p1:_value>
        </CheckKey>
        <Deductions>
          <OnDemandPayPayCheckDeductionDTO>
            <Amount>2</Amount>
            <DeductionCode>sample string 1</DeductionCode>
          </OnDemandPayPayCheckDeductionDTO>
          <OnDemandPayPayCheckDeductionDTO>
            <Amount>2</Amount>
            <DeductionCode>sample string 1</DeductionCode>
          </OnDemandPayPayCheckDeductionDTO>
        </Deductions>
        <DeductionsTotal>7</DeductionsTotal>
        <DirectDeposits>
          <OnDemandPayCheckDirectDepositDTO>
            <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
            <AccountType>sample string 2</AccountType>
            <Amount>3</Amount>
            <IsInternal>true</IsInternal>
          </OnDemandPayCheckDirectDepositDTO>
          <OnDemandPayCheckDirectDepositDTO>
            <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
            <AccountType>sample string 2</AccountType>
            <Amount>3</Amount>
            <IsInternal>true</IsInternal>
          </OnDemandPayCheckDirectDepositDTO>
        </DirectDeposits>
        <EmployeeKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </EmployeeKey>
        <EmployeeNumber>sample string 5</EmployeeNumber>
        <Gross>2</Gross>
        <Net>1</Net>
        <NetCheckAmount>3</NetCheckAmount>
        <NetDirectDepositAmount>4</NetDirectDepositAmount>
        <OnDemandPayDeductionsTotal>6</OnDemandPayDeductionsTotal>
      </OnDemandPayPayCheckDTO>
      <OnDemandPayPayCheckDTO>
        <CheckKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_hasValue>false</d5p1:_hasValue>
          <d5p1:_value>0</d5p1:_value>
        </CheckKey>
        <Deductions>
          <OnDemandPayPayCheckDeductionDTO>
            <Amount>2</Amount>
            <DeductionCode>sample string 1</DeductionCode>
          </OnDemandPayPayCheckDeductionDTO>
          <OnDemandPayPayCheckDeductionDTO>
            <Amount>2</Amount>
            <DeductionCode>sample string 1</DeductionCode>
          </OnDemandPayPayCheckDeductionDTO>
        </Deductions>
        <DeductionsTotal>7</DeductionsTotal>
        <DirectDeposits>
          <OnDemandPayCheckDirectDepositDTO>
            <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
            <AccountType>sample string 2</AccountType>
            <Amount>3</Amount>
            <IsInternal>true</IsInternal>
          </OnDemandPayCheckDirectDepositDTO>
          <OnDemandPayCheckDirectDepositDTO>
            <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
            <AccountType>sample string 2</AccountType>
            <Amount>3</Amount>
            <IsInternal>true</IsInternal>
          </OnDemandPayCheckDirectDepositDTO>
        </DirectDeposits>
        <EmployeeKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </EmployeeKey>
        <EmployeeNumber>sample string 5</EmployeeNumber>
        <Gross>2</Gross>
        <Net>1</Net>
        <NetCheckAmount>3</NetCheckAmount>
        <NetDirectDepositAmount>4</NetDirectDepositAmount>
        <OnDemandPayDeductionsTotal>6</OnDemandPayDeductionsTotal>
      </OnDemandPayPayCheckDTO>
    </Checks>
    <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>
    <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>2025-04-11T13:36:30.6312564-04:00</ProcessedDate>
  </OnDemandPayPayrollDTO>
  <OnDemandPayPayrollDTO>
    <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>
    <Checks>
      <OnDemandPayPayCheckDTO>
        <CheckKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_hasValue>false</d5p1:_hasValue>
          <d5p1:_value>0</d5p1:_value>
        </CheckKey>
        <Deductions>
          <OnDemandPayPayCheckDeductionDTO>
            <Amount>2</Amount>
            <DeductionCode>sample string 1</DeductionCode>
          </OnDemandPayPayCheckDeductionDTO>
          <OnDemandPayPayCheckDeductionDTO>
            <Amount>2</Amount>
            <DeductionCode>sample string 1</DeductionCode>
          </OnDemandPayPayCheckDeductionDTO>
        </Deductions>
        <DeductionsTotal>7</DeductionsTotal>
        <DirectDeposits>
          <OnDemandPayCheckDirectDepositDTO>
            <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
            <AccountType>sample string 2</AccountType>
            <Amount>3</Amount>
            <IsInternal>true</IsInternal>
          </OnDemandPayCheckDirectDepositDTO>
          <OnDemandPayCheckDirectDepositDTO>
            <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
            <AccountType>sample string 2</AccountType>
            <Amount>3</Amount>
            <IsInternal>true</IsInternal>
          </OnDemandPayCheckDirectDepositDTO>
        </DirectDeposits>
        <EmployeeKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </EmployeeKey>
        <EmployeeNumber>sample string 5</EmployeeNumber>
        <Gross>2</Gross>
        <Net>1</Net>
        <NetCheckAmount>3</NetCheckAmount>
        <NetDirectDepositAmount>4</NetDirectDepositAmount>
        <OnDemandPayDeductionsTotal>6</OnDemandPayDeductionsTotal>
      </OnDemandPayPayCheckDTO>
      <OnDemandPayPayCheckDTO>
        <CheckKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_hasValue>false</d5p1:_hasValue>
          <d5p1:_value>0</d5p1:_value>
        </CheckKey>
        <Deductions>
          <OnDemandPayPayCheckDeductionDTO>
            <Amount>2</Amount>
            <DeductionCode>sample string 1</DeductionCode>
          </OnDemandPayPayCheckDeductionDTO>
          <OnDemandPayPayCheckDeductionDTO>
            <Amount>2</Amount>
            <DeductionCode>sample string 1</DeductionCode>
          </OnDemandPayPayCheckDeductionDTO>
        </Deductions>
        <DeductionsTotal>7</DeductionsTotal>
        <DirectDeposits>
          <OnDemandPayCheckDirectDepositDTO>
            <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
            <AccountType>sample string 2</AccountType>
            <Amount>3</Amount>
            <IsInternal>true</IsInternal>
          </OnDemandPayCheckDirectDepositDTO>
          <OnDemandPayCheckDirectDepositDTO>
            <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
            <AccountType>sample string 2</AccountType>
            <Amount>3</Amount>
            <IsInternal>true</IsInternal>
          </OnDemandPayCheckDirectDepositDTO>
        </DirectDeposits>
        <EmployeeKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
          <d5p1:_entityKey>
            <d5p1:_hasValue>false</d5p1:_hasValue>
            <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value>
          </d5p1:_entityKey>
        </EmployeeKey>
        <EmployeeNumber>sample string 5</EmployeeNumber>
        <Gross>2</Gross>
        <Net>1</Net>
        <NetCheckAmount>3</NetCheckAmount>
        <NetDirectDepositAmount>4</NetDirectDepositAmount>
        <OnDemandPayDeductionsTotal>6</OnDemandPayDeductionsTotal>
      </OnDemandPayPayCheckDTO>
    </Checks>
    <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>
    <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>2025-04-11T13:36:30.6312564-04:00</ProcessedDate>
  </OnDemandPayPayrollDTO>
</ArrayOfOnDemandPayPayrollDTO>