POST api/checks/inquiry/export

Get the inquiry result on a csv file in byte Array format

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

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.