POST {version}/GetTransactionBatches

Get Batches

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

Query

Name	Description	Type	Additional information
ActiveOnly		boolean	None.
Ids		Collection of globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "ActiveOnly": true,
  "Ids": [
    "d153321e-5a9f-4a6a-a48f-c8a27ca0dcfa",
    "1bf7ca98-3567-4e2b-86ca-fa5846beadce"
  ]
}

application/xml, text/xml

Sample:

<Query xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <ActiveOnly>true</ActiveOnly>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>d153321e-5a9f-4a6a-a48f-c8a27ca0dcfa</d2p1:guid>
    <d2p1:guid>1bf7ca98-3567-4e2b-86ca-fa5846beadce</d2p1:guid>
  </Ids>
</Query>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of Batches

Collection of Batch

Name	Type	Additional information
GUID	globally unique identifier	None.
Id	integer	None.
Name	string	None.
BatchId	integer	None.
BatchName	string	None.
Date	date	None.
DisplayDate	string	None.
Display	string	None.
Cont_Amount	decimal number	None.
Disb_Amount	decimal number	None.
Close_Date	date	None.
Default	boolean	None.
Deleted	boolean	None.
CreatedOn	date	None.
CreatedBy	globally unique identifier	None.
UpdatedOn	date	None.
UpdatedBy	globally unique identifier	None.
DeletedOn	date	None.
DeletedBy	globally unique identifier	None.
Deposit_Post_Date	date	None.
HasFinancialTransactions	boolean	None.
dep_GUID	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "GUID": "ff7a6803-7476-48a3-93f5-59dfd93dafbe",
    "Id": 2,
    "Name": "sample string 3",
    "BatchId": 4,
    "BatchName": "sample string 5",
    "Date": "03/15/2026",
    "DisplayDate": "3/15/2026",
    "Display": "2-sample string 3 (3/15/2026)",
    "Cont_Amount": 1.0,
    "Disb_Amount": 1.0,
    "Close_Date": "03/15/2026",
    "Default": true,
    "Deleted": true,
    "CreatedOn": "03/15/2026",
    "CreatedBy": "e1083683-4ab2-406d-b369-94b6d87ab5ff",
    "UpdatedOn": "03/15/2026",
    "UpdatedBy": "4ac9f109-0f00-4c47-b0a2-6c0a90943eb5",
    "DeletedOn": "03/15/2026",
    "DeletedBy": "357a1da6-851a-455d-b98d-683bb635587f",
    "Deposit_Post_Date": "03/15/2026",
    "HasFinancialTransactions": true,
    "dep_GUID": "75f5e579-b9c0-448a-906a-38eb036b7b43"
  },
  {
    "GUID": "ff7a6803-7476-48a3-93f5-59dfd93dafbe",
    "Id": 2,
    "Name": "sample string 3",
    "BatchId": 4,
    "BatchName": "sample string 5",
    "Date": "03/15/2026",
    "DisplayDate": "3/15/2026",
    "Display": "2-sample string 3 (3/15/2026)",
    "Cont_Amount": 1.0,
    "Disb_Amount": 1.0,
    "Close_Date": "03/15/2026",
    "Default": true,
    "Deleted": true,
    "CreatedOn": "03/15/2026",
    "CreatedBy": "e1083683-4ab2-406d-b369-94b6d87ab5ff",
    "UpdatedOn": "03/15/2026",
    "UpdatedBy": "4ac9f109-0f00-4c47-b0a2-6c0a90943eb5",
    "DeletedOn": "03/15/2026",
    "DeletedBy": "357a1da6-851a-455d-b98d-683bb635587f",
    "Deposit_Post_Date": "03/15/2026",
    "HasFinancialTransactions": true,
    "dep_GUID": "75f5e579-b9c0-448a-906a-38eb036b7b43"
  }
]

application/xml, text/xml

Sample:

<ArrayOfBatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <Batch>
    <BatchId>4</BatchId>
    <BatchName>sample string 5</BatchName>
    <Close_Date>2026-03-15T15:03:16.032125-04:00</Close_Date>
    <Cont_Amount>1</Cont_Amount>
    <CreatedBy>e1083683-4ab2-406d-b369-94b6d87ab5ff</CreatedBy>
    <CreatedOn>2026-03-15T15:03:16.032125-04:00</CreatedOn>
    <Date>2026-03-15T15:03:16.032125-04:00</Date>
    <Default>true</Default>
    <Deleted>true</Deleted>
    <DeletedBy>357a1da6-851a-455d-b98d-683bb635587f</DeletedBy>
    <DeletedOn>2026-03-15T15:03:16.032125-04:00</DeletedOn>
    <Deposit_Post_Date>2026-03-15T15:03:16.032125-04:00</Deposit_Post_Date>
    <Disb_Amount>1</Disb_Amount>
    <GUID>ff7a6803-7476-48a3-93f5-59dfd93dafbe</GUID>
    <HasFinancialTransactions>true</HasFinancialTransactions>
    <Id>2</Id>
    <Name>sample string 3</Name>
    <UpdatedBy>4ac9f109-0f00-4c47-b0a2-6c0a90943eb5</UpdatedBy>
    <UpdatedOn>2026-03-15T15:03:16.032125-04:00</UpdatedOn>
    <dep_GUID>75f5e579-b9c0-448a-906a-38eb036b7b43</dep_GUID>
  </Batch>
  <Batch>
    <BatchId>4</BatchId>
    <BatchName>sample string 5</BatchName>
    <Close_Date>2026-03-15T15:03:16.032125-04:00</Close_Date>
    <Cont_Amount>1</Cont_Amount>
    <CreatedBy>e1083683-4ab2-406d-b369-94b6d87ab5ff</CreatedBy>
    <CreatedOn>2026-03-15T15:03:16.032125-04:00</CreatedOn>
    <Date>2026-03-15T15:03:16.032125-04:00</Date>
    <Default>true</Default>
    <Deleted>true</Deleted>
    <DeletedBy>357a1da6-851a-455d-b98d-683bb635587f</DeletedBy>
    <DeletedOn>2026-03-15T15:03:16.032125-04:00</DeletedOn>
    <Deposit_Post_Date>2026-03-15T15:03:16.032125-04:00</Deposit_Post_Date>
    <Disb_Amount>1</Disb_Amount>
    <GUID>ff7a6803-7476-48a3-93f5-59dfd93dafbe</GUID>
    <HasFinancialTransactions>true</HasFinancialTransactions>
    <Id>2</Id>
    <Name>sample string 3</Name>
    <UpdatedBy>4ac9f109-0f00-4c47-b0a2-6c0a90943eb5</UpdatedBy>
    <UpdatedOn>2026-03-15T15:03:16.032125-04:00</UpdatedOn>
    <dep_GUID>75f5e579-b9c0-448a-906a-38eb036b7b43</dep_GUID>
  </Batch>
</ArrayOfBatch>