POST api/batches/cash-inquiry/export

exports to csv

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EntityIds	Collection of integer	None.
ManagementCompanyIds	Collection of integer	None.
BankCodeIds	Collection of integer	None.
BatchTypeIds	Collection of integer	None.
BatchStatusIds	Collection of integer	None.
JournalEntryIdFrom	integer	None.
JournalEntryIdTo	integer	None.
BatchIdFrom	integer	None.
BatchIdTo	integer	None.
BatchDateFrom	date	None.
BatchDateTo	date	None.
BatchTotalFrom	decimal number	None.
BatchTotalTo	decimal number	None.
PageSize	integer	None.
PageNumber	integer	None.
SortInformation	SortInformationViewModel	Required

Request Formats

application/json, text/json

Sample:

{
  "entityIds": [
    1,
    2
  ],
  "managementCompanyIds": [
    1,
    2
  ],
  "bankCodeIds": [
    1,
    2
  ],
  "batchTypeIds": [
    1,
    2
  ],
  "batchStatusIds": [
    1,
    2
  ],
  "journalEntryIdFrom": 1,
  "journalEntryIdTo": 1,
  "batchIdFrom": 1,
  "batchIdTo": 1,
  "batchDateFrom": "2024-10-13T16:19:04.4537694-04:00",
  "batchDateTo": "2024-10-13T16:19:04.4537694-04:00",
  "batchTotalFrom": 1.0,
  "batchTotalTo": 1.0,
  "pageSize": 1,
  "pageNumber": 2,
  "sortInformation": {
    "sortBy": "sample string 1",
    "isSortAscending": true
  }
}

application/xml, text/xml

Sample:

<CashBatchInquiryFilterViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.ArReceipts">
  <PageNumber xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">2</PageNumber>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">1</PageSize>
  <SortInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.SortInformation" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
    <d2p1:IsSortAscending>true</d2p1:IsSortAscending>
    <d2p1:SortBy>sample string 1</d2p1:SortBy>
  </SortInformation>
  <BankCodeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BankCodeIds>
  <BatchDateFrom>2024-10-13T16:19:04.4537694-04:00</BatchDateFrom>
  <BatchDateTo>2024-10-13T16:19:04.4537694-04:00</BatchDateTo>
  <BatchIdFrom>1</BatchIdFrom>
  <BatchIdTo>1</BatchIdTo>
  <BatchStatusIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BatchStatusIds>
  <BatchTotalFrom>1</BatchTotalFrom>
  <BatchTotalTo>1</BatchTotalTo>
  <BatchTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BatchTypeIds>
  <EntityIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EntityIds>
  <JournalEntryIdFrom>1</JournalEntryIdFrom>
  <JournalEntryIdTo>1</JournalEntryIdTo>
  <ManagementCompanyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ManagementCompanyIds>
</CashBatchInquiryFilterViewModel>

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 'CashBatchInquiryFilterViewModel'.

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.