POST api/checks/search

Search checks based on query parameters, this route is POST because of the length restriction on the GET verb

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ManagementCompanyIds	Collection of integer	None.
EntityId	integer	None.
Payee	string	None.
BankCodeId	integer	None.
CheckNumberFrom	string	None.
CheckNumberTo	string	None.
CheckStartDate	string	None.
CheckEndDate	string	None.
CheckAmountMin	decimal number	None.
CheckAmountMax	decimal number	None.
ConfirmationNumber	string	None.
CheckIds	Collection of integer	None.
CheckStatus	CheckInquiryStatusParametersViewModel	None.
PageSize	integer	None.
PageNumber	integer	None.
SortInformation	SortInformationViewModel	Required

Request Formats

application/json, text/json

Sample:

{
  "managementCompanyIds": [
    1,
    2
  ],
  "entityId": 1,
  "payee": "sample string 1",
  "bankCodeId": 1,
  "checkNumberFrom": "sample string 2",
  "checkNumberTo": "sample string 3",
  "checkStartDate": "sample string 4",
  "checkEndDate": "sample string 5",
  "checkAmountMin": 1.0,
  "checkAmountMax": 1.0,
  "confirmationNumber": "sample string 6",
  "checkIds": [
    1,
    2
  ],
  "checkStatus": {
    "created": true,
    "exported": true,
    "printed": true,
    "reconciled": true,
    "voided": true
  },
  "pageSize": 7,
  "pageNumber": 8,
  "sortInformation": {
    "sortBy": "sample string 1",
    "isSortAscending": true
  }
}

application/xml, text/xml

Sample:

<CheckInquiryParametersViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <PageNumber>8</PageNumber>
  <PageSize>7</PageSize>
  <SortInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.SortInformation">
    <d2p1:IsSortAscending>true</d2p1:IsSortAscending>
    <d2p1:SortBy>sample string 1</d2p1:SortBy>
  </SortInformation>
  <BankCodeId>1</BankCodeId>
  <CheckAmountMax>1</CheckAmountMax>
  <CheckAmountMin>1</CheckAmountMin>
  <CheckEndDate>sample string 5</CheckEndDate>
  <CheckIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CheckIds>
  <CheckNumberFrom>sample string 2</CheckNumberFrom>
  <CheckNumberTo>sample string 3</CheckNumberTo>
  <CheckStartDate>sample string 4</CheckStartDate>
  <CheckStatus>
    <Created>true</Created>
    <Exported>true</Exported>
    <Printed>true</Printed>
    <Reconciled>true</Reconciled>
    <Voided>true</Voided>
  </CheckStatus>
  <ConfirmationNumber>sample string 6</ConfirmationNumber>
  <EntityId>1</EntityId>
  <ManagementCompanyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ManagementCompanyIds>
  <Payee>sample string 1</Payee>
</CheckInquiryParametersViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CheckInquiryParametersViewModel'.

Response Information

Resource Description

CheckInquiryResultViewModel

Name	Type	Additional information
ShowWorkflowStatus	boolean	None.
Items	Collection of CheckInquiryResultItemViewModel	None.
TotalCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "showWorkflowStatus": true,
  "items": [
    {
      "id": 1,
      "checkNumber": "sample string 2",
      "bankCode": "sample string 3",
      "payeeNameLine1": "sample string 4",
      "payeeNameLine2": "sample string 5",
      "entity": "sample string 6",
      "managementCompanyName": "sample string 7",
      "checkDate": "2024-10-14T08:25:53.7560629-04:00",
      "amount": 9.0,
      "status": "sample string 10",
      "confirmationNumber": "sample string 11",
      "voidedDate": "2024-10-14T08:25:53.7560629-04:00",
      "voidNotes": "sample string 12",
      "workflowStatus": "sample string 13",
      "invoices": [
        {
          "id": 1,
          "glDate": "2024-10-14T08:25:53.7560629-04:00",
          "invoiceNumber": "sample string 3",
          "invoiceDescription": "sample string 4"
        },
        {
          "id": 1,
          "glDate": "2024-10-14T08:25:53.7560629-04:00",
          "invoiceNumber": "sample string 3",
          "invoiceDescription": "sample string 4"
        }
      ],
      "checkNotes": [
        {
          "id": 1,
          "checkStatus": "sample string 2",
          "note": "sample string 3",
          "user": "sample string 4",
          "date": "2024-10-14T08:25:53.7560629-04:00"
        },
        {
          "id": 1,
          "checkStatus": "sample string 2",
          "note": "sample string 3",
          "user": "sample string 4",
          "date": "2024-10-14T08:25:53.7560629-04:00"
        }
      ],
      "journalEntries": [
        {
          "journalEntryId": 1,
          "journalEntryType": "sample string 2",
          "glDate": "2024-10-14T08:25:53.7560629-04:00",
          "journalEntryTypeDescription": "sample string 4"
        },
        {
          "journalEntryId": 1,
          "journalEntryType": "sample string 2",
          "glDate": "2024-10-14T08:25:53.7560629-04:00",
          "journalEntryTypeDescription": "sample string 4"
        }
      ]
    },
    {
      "id": 1,
      "checkNumber": "sample string 2",
      "bankCode": "sample string 3",
      "payeeNameLine1": "sample string 4",
      "payeeNameLine2": "sample string 5",
      "entity": "sample string 6",
      "managementCompanyName": "sample string 7",
      "checkDate": "2024-10-14T08:25:53.7560629-04:00",
      "amount": 9.0,
      "status": "sample string 10",
      "confirmationNumber": "sample string 11",
      "voidedDate": "2024-10-14T08:25:53.7560629-04:00",
      "voidNotes": "sample string 12",
      "workflowStatus": "sample string 13",
      "invoices": [
        {
          "id": 1,
          "glDate": "2024-10-14T08:25:53.7560629-04:00",
          "invoiceNumber": "sample string 3",
          "invoiceDescription": "sample string 4"
        },
        {
          "id": 1,
          "glDate": "2024-10-14T08:25:53.7560629-04:00",
          "invoiceNumber": "sample string 3",
          "invoiceDescription": "sample string 4"
        }
      ],
      "checkNotes": [
        {
          "id": 1,
          "checkStatus": "sample string 2",
          "note": "sample string 3",
          "user": "sample string 4",
          "date": "2024-10-14T08:25:53.7560629-04:00"
        },
        {
          "id": 1,
          "checkStatus": "sample string 2",
          "note": "sample string 3",
          "user": "sample string 4",
          "date": "2024-10-14T08:25:53.7560629-04:00"
        }
      ],
      "journalEntries": [
        {
          "journalEntryId": 1,
          "journalEntryType": "sample string 2",
          "glDate": "2024-10-14T08:25:53.7560629-04:00",
          "journalEntryTypeDescription": "sample string 4"
        },
        {
          "journalEntryId": 1,
          "journalEntryType": "sample string 2",
          "glDate": "2024-10-14T08:25:53.7560629-04:00",
          "journalEntryTypeDescription": "sample string 4"
        }
      ]
    }
  ],
  "totalCount": 1
}

application/xml, text/xml

Sample:

<CheckInquiryResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Items>
    <CheckInquiryResultItemViewModel>
      <Amount>9</Amount>
      <BankCode>sample string 3</BankCode>
      <CheckDate>2024-10-14T08:25:53.7560629-04:00</CheckDate>
      <CheckNotes>
        <CheckInquiryCheckNoteItemViewModel>
          <CheckStatus>sample string 2</CheckStatus>
          <Date>2024-10-14T08:25:53.7560629-04:00</Date>
          <Id>1</Id>
          <Note>sample string 3</Note>
          <User>sample string 4</User>
        </CheckInquiryCheckNoteItemViewModel>
        <CheckInquiryCheckNoteItemViewModel>
          <CheckStatus>sample string 2</CheckStatus>
          <Date>2024-10-14T08:25:53.7560629-04:00</Date>
          <Id>1</Id>
          <Note>sample string 3</Note>
          <User>sample string 4</User>
        </CheckInquiryCheckNoteItemViewModel>
      </CheckNotes>
      <CheckNumber>sample string 2</CheckNumber>
      <ConfirmationNumber>sample string 11</ConfirmationNumber>
      <Entity>sample string 6</Entity>
      <Id>1</Id>
      <Invoices>
        <CheckInquiryInvoiceItemViewModel>
          <GlDate>2024-10-14T08:25:53.7560629-04:00</GlDate>
          <Id>1</Id>
          <InvoiceDescription>sample string 4</InvoiceDescription>
          <InvoiceNumber>sample string 3</InvoiceNumber>
        </CheckInquiryInvoiceItemViewModel>
        <CheckInquiryInvoiceItemViewModel>
          <GlDate>2024-10-14T08:25:53.7560629-04:00</GlDate>
          <Id>1</Id>
          <InvoiceDescription>sample string 4</InvoiceDescription>
          <InvoiceNumber>sample string 3</InvoiceNumber>
        </CheckInquiryInvoiceItemViewModel>
      </Invoices>
      <JournalEntries>
        <CheckInquiryJournalEntryItemViewModel>
          <GlDate>2024-10-14T08:25:53.7560629-04:00</GlDate>
          <JournalEntryId>1</JournalEntryId>
          <JournalEntryType>sample string 2</JournalEntryType>
          <JournalEntryTypeDescription>sample string 4</JournalEntryTypeDescription>
        </CheckInquiryJournalEntryItemViewModel>
        <CheckInquiryJournalEntryItemViewModel>
          <GlDate>2024-10-14T08:25:53.7560629-04:00</GlDate>
          <JournalEntryId>1</JournalEntryId>
          <JournalEntryType>sample string 2</JournalEntryType>
          <JournalEntryTypeDescription>sample string 4</JournalEntryTypeDescription>
        </CheckInquiryJournalEntryItemViewModel>
      </JournalEntries>
      <ManagementCompanyName>sample string 7</ManagementCompanyName>
      <PayeeNameLine1>sample string 4</PayeeNameLine1>
      <PayeeNameLine2>sample string 5</PayeeNameLine2>
      <Status>sample string 10</Status>
      <VoidNotes>sample string 12</VoidNotes>
      <VoidedDate>2024-10-14T08:25:53.7560629-04:00</VoidedDate>
      <WorkflowStatus>sample string 13</WorkflowStatus>
    </CheckInquiryResultItemViewModel>
    <CheckInquiryResultItemViewModel>
      <Amount>9</Amount>
      <BankCode>sample string 3</BankCode>
      <CheckDate>2024-10-14T08:25:53.7560629-04:00</CheckDate>
      <CheckNotes>
        <CheckInquiryCheckNoteItemViewModel>
          <CheckStatus>sample string 2</CheckStatus>
          <Date>2024-10-14T08:25:53.7560629-04:00</Date>
          <Id>1</Id>
          <Note>sample string 3</Note>
          <User>sample string 4</User>
        </CheckInquiryCheckNoteItemViewModel>
        <CheckInquiryCheckNoteItemViewModel>
          <CheckStatus>sample string 2</CheckStatus>
          <Date>2024-10-14T08:25:53.7560629-04:00</Date>
          <Id>1</Id>
          <Note>sample string 3</Note>
          <User>sample string 4</User>
        </CheckInquiryCheckNoteItemViewModel>
      </CheckNotes>
      <CheckNumber>sample string 2</CheckNumber>
      <ConfirmationNumber>sample string 11</ConfirmationNumber>
      <Entity>sample string 6</Entity>
      <Id>1</Id>
      <Invoices>
        <CheckInquiryInvoiceItemViewModel>
          <GlDate>2024-10-14T08:25:53.7560629-04:00</GlDate>
          <Id>1</Id>
          <InvoiceDescription>sample string 4</InvoiceDescription>
          <InvoiceNumber>sample string 3</InvoiceNumber>
        </CheckInquiryInvoiceItemViewModel>
        <CheckInquiryInvoiceItemViewModel>
          <GlDate>2024-10-14T08:25:53.7560629-04:00</GlDate>
          <Id>1</Id>
          <InvoiceDescription>sample string 4</InvoiceDescription>
          <InvoiceNumber>sample string 3</InvoiceNumber>
        </CheckInquiryInvoiceItemViewModel>
      </Invoices>
      <JournalEntries>
        <CheckInquiryJournalEntryItemViewModel>
          <GlDate>2024-10-14T08:25:53.7560629-04:00</GlDate>
          <JournalEntryId>1</JournalEntryId>
          <JournalEntryType>sample string 2</JournalEntryType>
          <JournalEntryTypeDescription>sample string 4</JournalEntryTypeDescription>
        </CheckInquiryJournalEntryItemViewModel>
        <CheckInquiryJournalEntryItemViewModel>
          <GlDate>2024-10-14T08:25:53.7560629-04:00</GlDate>
          <JournalEntryId>1</JournalEntryId>
          <JournalEntryType>sample string 2</JournalEntryType>
          <JournalEntryTypeDescription>sample string 4</JournalEntryTypeDescription>
        </CheckInquiryJournalEntryItemViewModel>
      </JournalEntries>
      <ManagementCompanyName>sample string 7</ManagementCompanyName>
      <PayeeNameLine1>sample string 4</PayeeNameLine1>
      <PayeeNameLine2>sample string 5</PayeeNameLine2>
      <Status>sample string 10</Status>
      <VoidNotes>sample string 12</VoidNotes>
      <VoidedDate>2024-10-14T08:25:53.7560629-04:00</VoidedDate>
      <WorkflowStatus>sample string 13</WorkflowStatus>
    </CheckInquiryResultItemViewModel>
  </Items>
  <TotalCount>1</TotalCount>
  <ShowWorkflowStatus>true</ShowWorkflowStatus>
</CheckInquiryResultViewModel>