GET v1/omni/export/checks?minStatusDate={minStatusDate}&clearedStatus={clearedStatus}

Request Information

URI Parameters

Name	Description	Type	Additional information
minStatusDate		date	Required
clearedStatus		ClearedStatus	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportOmniCheckDTO

Name	Type	Additional information
CheckHeaderKey	EntityKeyOfICheckHeaderAndInt32	None.
CheckNumber	integer	None.
Amount	decimal number	None.
CheckDate	date	None.
PayeeName	string	None.
ClearedStatus	ClearedStatus	None.
ClearedDate	date	None.
StopPaymentRequestDate	date	None.
StopPaymentApprovedDate	date	None.
CompanyCode	string	Required
DivisionCode	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "checkHeaderKey": "<empty>",
    "checkNumber": 1,
    "amount": 2.0,
    "checkDate": "0001-02-03",
    "payeeName": "sample string 3",
    "clearedStatus": "None",
    "clearedDate": "2026-09-13T21:32:35.8500834Z",
    "stopPaymentRequestDate": "2026-09-13T21:32:35.8500834Z",
    "stopPaymentApprovedDate": "2026-09-13T21:32:35.8500834Z",
    "companyCode": "sample string 4",
    "divisionCode": "sample string 5"
  },
  {
    "checkHeaderKey": "<empty>",
    "checkNumber": 1,
    "amount": 2.0,
    "checkDate": "0001-02-03",
    "payeeName": "sample string 3",
    "clearedStatus": "None",
    "clearedDate": "2026-09-13T21:32:35.8500834Z",
    "stopPaymentRequestDate": "2026-09-13T21:32:35.8500834Z",
    "stopPaymentApprovedDate": "2026-09-13T21:32:35.8500834Z",
    "companyCode": "sample string 4",
    "divisionCode": "sample string 5"
  }
]

text/xml

Sample:

<ArrayOfExportOmniCheckDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportOmniCheckDTO>
    <CompanyCode xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 4</CompanyCode>
    <DivisionCode xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 5</DivisionCode>
    <Amount>2</Amount>
    <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>
    <CheckHeaderKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </CheckHeaderKey>
    <CheckNumber>1</CheckNumber>
    <ClearedDate>2026-09-13T17:32:35.8500834-04:00</ClearedDate>
    <ClearedStatus>None</ClearedStatus>
    <PayeeName>sample string 3</PayeeName>
    <StopPaymentApprovedDate>2026-09-13T17:32:35.8500834-04:00</StopPaymentApprovedDate>
    <StopPaymentRequestDate>2026-09-13T17:32:35.8500834-04:00</StopPaymentRequestDate>
  </ExportOmniCheckDTO>
  <ExportOmniCheckDTO>
    <CompanyCode xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 4</CompanyCode>
    <DivisionCode xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">sample string 5</DivisionCode>
    <Amount>2</Amount>
    <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>
    <CheckHeaderKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </CheckHeaderKey>
    <CheckNumber>1</CheckNumber>
    <ClearedDate>2026-09-13T17:32:35.8500834-04:00</ClearedDate>
    <ClearedStatus>None</ClearedStatus>
    <PayeeName>sample string 3</PayeeName>
    <StopPaymentApprovedDate>2026-09-13T17:32:35.8500834-04:00</StopPaymentApprovedDate>
    <StopPaymentRequestDate>2026-09-13T17:32:35.8500834-04:00</StopPaymentRequestDate>
  </ExportOmniCheckDTO>
</ArrayOfExportOmniCheckDTO>