POST {version}/GetBatchableTransactions

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": "04/03/2025",
  "MinDate": "04/03/2025",
  "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": "a9831baa-3504-4ffa-bdee-4266c057c16d",
  "EventId": "fb9f798b-93eb-4bd3-8136-3230815ecb05",
  "CategoryId": "8e6cc01e-d66d-4473-bc03-ad7cbce0b2e2",
  "AccountId": "33c7063c-078f-4a46-9551-e8a6548a1201",
  "DepositNumber": 1,
  "DepositId": "c4eb83b5-18bb-4e99-9808-0562679a81c5",
  "BatchNumber": 1,
  "BatchId": "8262d031-4a5a-4eb2-a009-a157f9596cfc",
  "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>33c7063c-078f-4a46-9551-e8a6548a1201</AccountId>
  <BatchId>8262d031-4a5a-4eb2-a009-a157f9596cfc</BatchId>
  <BatchNumber>1</BatchNumber>
  <CategoryId>8e6cc01e-d66d-4473-bc03-ad7cbce0b2e2</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>c4eb83b5-18bb-4e99-9808-0562679a81c5</DepositId>
  <DepositNumber>1</DepositNumber>
  <EntityTypeFilter>sample string 11</EntityTypeFilter>
  <EventId>fb9f798b-93eb-4bd3-8136-3230815ecb05</EventId>
  <IncludeJfc>true</IncludeJfc>
  <MaxAmount>sample string 6</MaxAmount>
  <MaxDate>2025-04-03T05:10:51.9389961-04:00</MaxDate>
  <MinAmount>sample string 7</MinAmount>
  <MinDate>2025-04-03T05:10:51.9389961-04:00</MinDate>
  <Name>sample string 8</Name>
  <PageNum>10</PageNum>
  <PageSize>1</PageSize>
  <QueryId>a9831baa-3504-4ffa-bdee-4266c057c16d</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

BatchOrDepositTransactionsWrapper

Name	Type	Additional information
Transactions	Collection of BatchOrDepositTransaction	None.
TransactionCount	integer	None.
IsJFC3Batch	boolean	None.
Batch	BatchByBatchId	None.
Deposit	DepositByDepositId	None.

Response Formats

application/json, text/json

Sample:

{
  "Transactions": [
    {
      "Transaction": "sample string 15",
      "EntityType": "sample string 17",
      "EntityId": "129df8f9-97d3-43da-a732-133e10783bb4",
      "GeneralTypeString": "sample string 18",
      "Date": "04/03/2025",
      "DateLS": "sample string 1",
      "Amount": 1.0,
      "AmountLS": "sample string 2",
      "TypeString": "sample string 3",
      "BatchName": "sample string 4",
      "AccountName": "sample string 5",
      "InternalMemo": "sample string 6",
      "EventName": "sample string 7",
      "PaymentMethod": "sample string 8",
      "SupportOppose": "sample string 9",
      "ElectionPeriod": "sample string 10",
      "CategoryName": "sample string 11",
      "ReportingDescription": "sample string 12",
      "ReportingCode": "sample string 13",
      "Id": "sample string 14",
      "Deposited": "04/03/2025",
      "Name": "sample string 15",
      "OwnerId": "129df8f9-97d3-43da-a732-133e10783bb4",
      "OwnerType": "sample string 17",
      "TransactionType": "sample string 18",
      "SpecificType": "sample string 19",
      "Reversal": true,
      "RowNum": 20
    },
    {
      "Transaction": "sample string 15",
      "EntityType": "sample string 17",
      "EntityId": "129df8f9-97d3-43da-a732-133e10783bb4",
      "GeneralTypeString": "sample string 18",
      "Date": "04/03/2025",
      "DateLS": "sample string 1",
      "Amount": 1.0,
      "AmountLS": "sample string 2",
      "TypeString": "sample string 3",
      "BatchName": "sample string 4",
      "AccountName": "sample string 5",
      "InternalMemo": "sample string 6",
      "EventName": "sample string 7",
      "PaymentMethod": "sample string 8",
      "SupportOppose": "sample string 9",
      "ElectionPeriod": "sample string 10",
      "CategoryName": "sample string 11",
      "ReportingDescription": "sample string 12",
      "ReportingCode": "sample string 13",
      "Id": "sample string 14",
      "Deposited": "04/03/2025",
      "Name": "sample string 15",
      "OwnerId": "129df8f9-97d3-43da-a732-133e10783bb4",
      "OwnerType": "sample string 17",
      "TransactionType": "sample string 18",
      "SpecificType": "sample string 19",
      "Reversal": true,
      "RowNum": 20
    }
  ],
  "TransactionCount": 1,
  "IsJFC3Batch": true,
  "Batch": {
    "Id": "sample string 1",
    "BatchId": "sample string 2",
    "Name": "sample string 3",
    "Date": "04/03/2025",
    "DateLS": "sample string 4",
    "CloseDate": "04/03/2025",
    "CloseDateString": "sample string 5",
    "ContributionAmount": 1.0,
    "ContributionAmountLS": "sample string 6",
    "DisbursementAmount": 1.0,
    "DisbursementAmountLS": "sample string 7",
    "DisbursementSum": 1.0,
    "DisbursementSumString": "sample string 8",
    "ReceiptSum": 1.0,
    "ReceiptSumString": "sample string 9"
  },
  "Deposit": {
    "Id": "sample string 1",
    "DepositId": "sample string 2",
    "Name": "sample string 3",
    "Date": "04/03/2025",
    "DateLS": "sample string 4",
    "AccountId": "sample string 5",
    "AmountReconciled": 1.0,
    "IsLocked": true,
    "ForcedDeposit": true,
    "DisbursementSum": 1.0,
    "DisbursementSumString": "sample string 6",
    "ReceiptSum": 1.0,
    "ReceiptSumString": "sample string 7"
  }
}

application/xml, text/xml

Sample:

<BatchOrDepositTransactionsWrapper xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <Batch>
    <BatchId>sample string 2</BatchId>
    <CloseDate>2025-04-03T05:10:51.9389961-04:00</CloseDate>
    <CloseDateString>sample string 5</CloseDateString>
    <ContributionAmount>1</ContributionAmount>
    <ContributionAmountLS>sample string 6</ContributionAmountLS>
    <Date>2025-04-03T05:10:51.9389961-04:00</Date>
    <DateLS>sample string 4</DateLS>
    <DisbursementAmount>1</DisbursementAmount>
    <DisbursementAmountLS>sample string 7</DisbursementAmountLS>
    <DisbursementSum>1</DisbursementSum>
    <DisbursementSumString>sample string 8</DisbursementSumString>
    <Id>sample string 1</Id>
    <Name>sample string 3</Name>
    <ReceiptSum>1</ReceiptSum>
    <ReceiptSumString>sample string 9</ReceiptSumString>
  </Batch>
  <Deposit>
    <AccountId>sample string 5</AccountId>
    <AmountReconciled>1</AmountReconciled>
    <Date>2025-04-03T05:10:51.9389961-04:00</Date>
    <DateLS>sample string 4</DateLS>
    <DepositId>sample string 2</DepositId>
    <DisbursementSum>1</DisbursementSum>
    <DisbursementSumString>sample string 6</DisbursementSumString>
    <ForcedDeposit>true</ForcedDeposit>
    <Id>sample string 1</Id>
    <IsLocked>true</IsLocked>
    <Name>sample string 3</Name>
    <ReceiptSum>1</ReceiptSum>
    <ReceiptSumString>sample string 7</ReceiptSumString>
  </Deposit>
  <IsJFC3Batch>true</IsJFC3Batch>
  <TransactionCount>1</TransactionCount>
  <Transactions>
    <BatchOrDepositTransaction>
      <AccountName>sample string 5</AccountName>
      <Amount>1</Amount>
      <AmountLS>sample string 2</AmountLS>
      <BatchName>sample string 4</BatchName>
      <CategoryName>sample string 11</CategoryName>
      <Date>2025-04-03T05:10:51.9389961-04:00</Date>
      <DateLS>sample string 1</DateLS>
      <Deposited>2025-04-03T05:10:51.9389961-04:00</Deposited>
      <ElectionPeriod>sample string 10</ElectionPeriod>
      <EventName>sample string 7</EventName>
      <Id>sample string 14</Id>
      <InternalMemo>sample string 6</InternalMemo>
      <Name>sample string 15</Name>
      <OwnerId>129df8f9-97d3-43da-a732-133e10783bb4</OwnerId>
      <OwnerType>sample string 17</OwnerType>
      <PaymentMethod>sample string 8</PaymentMethod>
      <ReportingCode>sample string 13</ReportingCode>
      <ReportingDescription>sample string 12</ReportingDescription>
      <Reversal>true</Reversal>
      <RowNum>20</RowNum>
      <SpecificType>sample string 19</SpecificType>
      <SupportOppose>sample string 9</SupportOppose>
      <TransactionType>sample string 18</TransactionType>
      <TypeString>sample string 3</TypeString>
    </BatchOrDepositTransaction>
    <BatchOrDepositTransaction>
      <AccountName>sample string 5</AccountName>
      <Amount>1</Amount>
      <AmountLS>sample string 2</AmountLS>
      <BatchName>sample string 4</BatchName>
      <CategoryName>sample string 11</CategoryName>
      <Date>2025-04-03T05:10:51.9389961-04:00</Date>
      <DateLS>sample string 1</DateLS>
      <Deposited>2025-04-03T05:10:51.9389961-04:00</Deposited>
      <ElectionPeriod>sample string 10</ElectionPeriod>
      <EventName>sample string 7</EventName>
      <Id>sample string 14</Id>
      <InternalMemo>sample string 6</InternalMemo>
      <Name>sample string 15</Name>
      <OwnerId>129df8f9-97d3-43da-a732-133e10783bb4</OwnerId>
      <OwnerType>sample string 17</OwnerType>
      <PaymentMethod>sample string 8</PaymentMethod>
      <ReportingCode>sample string 13</ReportingCode>
      <ReportingDescription>sample string 12</ReportingDescription>
      <Reversal>true</Reversal>
      <RowNum>20</RowNum>
      <SpecificType>sample string 19</SpecificType>
      <SupportOppose>sample string 9</SupportOppose>
      <TransactionType>sample string 18</TransactionType>
      <TypeString>sample string 3</TypeString>
    </BatchOrDepositTransaction>
  </Transactions>
</BatchOrDepositTransactionsWrapper>