POST {version}/GetTransactionsByBatchIdDownload

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

BatchDepositTransactionFilter

Name	Type	Additional information
PageSize	integer	None.
SortAsc	boolean	None.
SortBy	string	None.
UpdatedByFilter	string	None.
CreatedByFilter	string	None.
MaxDate	date	None.
MinDate	date	None.
MaxAmountInt	integer	None.
MaxAmount	string	None.
MinAmountInt	integer	None.
MinAmount	string	None.
Name	string	None.
SkipPagination	boolean	None.
SelectAllMode	boolean	None.
PageNum	integer	None.
EntityTypeFilter	string	None.
QueryId	globally unique identifier	None.
EventId	globally unique identifier	None.
CategoryId	globally unique identifier	None.
AccountId	globally unique identifier	None.
DepositNumber	integer	None.
DepositId	globally unique identifier	None.
BatchNumber	integer	None.
BatchId	globally unique identifier	None.
IncludeJfc	boolean	None.
Columns	Collection of string	None.
UiToDbColMap	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "PageSize": 1,
  "SortAsc": true,
  "SortBy": "sample string 3",
  "UpdatedByFilter": "sample string 4",
  "CreatedByFilter": "sample string 5",
  "MaxDate": "01/27/2026",
  "MinDate": "01/27/2026",
  "MaxAmountInt": null,
  "MaxAmount": "sample string 6",
  "MinAmountInt": null,
  "MinAmount": "sample string 7",
  "Name": "sample string 8",
  "SkipPagination": true,
  "SelectAllMode": true,
  "PageNum": 10,
  "EntityTypeFilter": "sample string 11",
  "QueryId": "e3dde065-4f1c-4bdd-b293-531d043376ff",
  "EventId": "9896a758-c838-4f16-bf6a-cd9236818f31",
  "CategoryId": "296b3ff2-2326-4737-b181-eef0943c7fe1",
  "AccountId": "6af90a03-b670-4c87-8b7a-dd686a835be0",
  "DepositNumber": 1,
  "DepositId": "8f529129-47fe-4ad3-a013-8a7da9df0806",
  "BatchNumber": 1,
  "BatchId": "7e4aa2ce-78c6-4a22-97c9-5e923eef7631",
  "IncludeJfc": true,
  "Columns": [
    "sample string 1",
    "sample string 2"
  ],
  "UiToDbColMap": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<BatchDepositTransactionFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <AccountId>6af90a03-b670-4c87-8b7a-dd686a835be0</AccountId>
  <BatchId>7e4aa2ce-78c6-4a22-97c9-5e923eef7631</BatchId>
  <BatchNumber>1</BatchNumber>
  <CategoryId>296b3ff2-2326-4737-b181-eef0943c7fe1</CategoryId>
  <Columns xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Columns>
  <CreatedByFilter>sample string 5</CreatedByFilter>
  <DepositId>8f529129-47fe-4ad3-a013-8a7da9df0806</DepositId>
  <DepositNumber>1</DepositNumber>
  <EntityTypeFilter>sample string 11</EntityTypeFilter>
  <EventId>9896a758-c838-4f16-bf6a-cd9236818f31</EventId>
  <IncludeJfc>true</IncludeJfc>
  <MaxAmount>sample string 6</MaxAmount>
  <MaxDate>2026-01-27T00:26:34.1652711-05:00</MaxDate>
  <MinAmount>sample string 7</MinAmount>
  <MinDate>2026-01-27T00:26:34.1652711-05:00</MinDate>
  <Name>sample string 8</Name>
  <PageNum>10</PageNum>
  <PageSize>1</PageSize>
  <QueryId>e3dde065-4f1c-4bdd-b293-531d043376ff</QueryId>
  <SelectAllMode>true</SelectAllMode>
  <SkipPagination>true</SkipPagination>
  <SortAsc>true</SortAsc>
  <SortBy>sample string 3</SortBy>
  <UiToDbColMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </UiToDbColMap>
  <UpdatedByFilter>sample string 4</UpdatedByFilter>
</BatchDepositTransactionFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

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.