POST {version}/GetTransactionBatches
Get Batches
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
QueryName | Description | Type | Additional information |
---|---|---|---|
ActiveOnly | boolean |
None. |
|
Ids | Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "ActiveOnly": true, "Ids": [ "21fe80e9-04c9-432a-afdf-a94858054652", "43411973-a228-4da1-a4ca-81cf66060356" ] }
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>21fe80e9-04c9-432a-afdf-a94858054652</d2p1:guid> <d2p1:guid>43411973-a228-4da1-a4ca-81cf66060356</d2p1:guid> </Ids> </Query>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
List of Batches
Collection of BatchName | Description | 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": "182b8747-3f1a-4056-862c-43c9d7a8880c", "Id": 2, "Name": "sample string 3", "BatchId": 4, "BatchName": "sample string 5", "Date": "10/16/2024", "DisplayDate": "10/16/2024", "Display": "2-sample string 3 (10/16/2024)", "Cont_Amount": 1.0, "Disb_Amount": 1.0, "Close_Date": "10/16/2024", "Default": true, "Deleted": true, "CreatedOn": "10/16/2024", "CreatedBy": "77d5d4f1-17fd-4752-8860-f7c17855b7be", "UpdatedOn": "10/16/2024", "UpdatedBy": "48781ae2-ce4f-4606-8e97-05629f8aadee", "DeletedOn": "10/16/2024", "DeletedBy": "9d217c4a-039e-477f-a0e3-63d2ae30aa78", "Deposit_Post_Date": "10/16/2024", "HasFinancialTransactions": true, "dep_GUID": "b1ec3709-b11d-4e16-9c2a-b7fb5005bfd3" }, { "GUID": "182b8747-3f1a-4056-862c-43c9d7a8880c", "Id": 2, "Name": "sample string 3", "BatchId": 4, "BatchName": "sample string 5", "Date": "10/16/2024", "DisplayDate": "10/16/2024", "Display": "2-sample string 3 (10/16/2024)", "Cont_Amount": 1.0, "Disb_Amount": 1.0, "Close_Date": "10/16/2024", "Default": true, "Deleted": true, "CreatedOn": "10/16/2024", "CreatedBy": "77d5d4f1-17fd-4752-8860-f7c17855b7be", "UpdatedOn": "10/16/2024", "UpdatedBy": "48781ae2-ce4f-4606-8e97-05629f8aadee", "DeletedOn": "10/16/2024", "DeletedBy": "9d217c4a-039e-477f-a0e3-63d2ae30aa78", "Deposit_Post_Date": "10/16/2024", "HasFinancialTransactions": true, "dep_GUID": "b1ec3709-b11d-4e16-9c2a-b7fb5005bfd3" } ]
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>2024-10-16T12:24:14.002287-04:00</Close_Date> <Cont_Amount>1</Cont_Amount> <CreatedBy>77d5d4f1-17fd-4752-8860-f7c17855b7be</CreatedBy> <CreatedOn>2024-10-16T12:24:14.002287-04:00</CreatedOn> <Date>2024-10-16T12:24:14.002287-04:00</Date> <Default>true</Default> <Deleted>true</Deleted> <DeletedBy>9d217c4a-039e-477f-a0e3-63d2ae30aa78</DeletedBy> <DeletedOn>2024-10-16T12:24:14.002287-04:00</DeletedOn> <Deposit_Post_Date>2024-10-16T12:24:14.002287-04:00</Deposit_Post_Date> <Disb_Amount>1</Disb_Amount> <GUID>182b8747-3f1a-4056-862c-43c9d7a8880c</GUID> <HasFinancialTransactions>true</HasFinancialTransactions> <Id>2</Id> <Name>sample string 3</Name> <UpdatedBy>48781ae2-ce4f-4606-8e97-05629f8aadee</UpdatedBy> <UpdatedOn>2024-10-16T12:24:14.002287-04:00</UpdatedOn> <dep_GUID>b1ec3709-b11d-4e16-9c2a-b7fb5005bfd3</dep_GUID> </Batch> <Batch> <BatchId>4</BatchId> <BatchName>sample string 5</BatchName> <Close_Date>2024-10-16T12:24:14.002287-04:00</Close_Date> <Cont_Amount>1</Cont_Amount> <CreatedBy>77d5d4f1-17fd-4752-8860-f7c17855b7be</CreatedBy> <CreatedOn>2024-10-16T12:24:14.002287-04:00</CreatedOn> <Date>2024-10-16T12:24:14.002287-04:00</Date> <Default>true</Default> <Deleted>true</Deleted> <DeletedBy>9d217c4a-039e-477f-a0e3-63d2ae30aa78</DeletedBy> <DeletedOn>2024-10-16T12:24:14.002287-04:00</DeletedOn> <Deposit_Post_Date>2024-10-16T12:24:14.002287-04:00</Deposit_Post_Date> <Disb_Amount>1</Disb_Amount> <GUID>182b8747-3f1a-4056-862c-43c9d7a8880c</GUID> <HasFinancialTransactions>true</HasFinancialTransactions> <Id>2</Id> <Name>sample string 3</Name> <UpdatedBy>48781ae2-ce4f-4606-8e97-05629f8aadee</UpdatedBy> <UpdatedOn>2024-10-16T12:24:14.002287-04:00</UpdatedOn> <dep_GUID>b1ec3709-b11d-4e16-9c2a-b7fb5005bfd3</dep_GUID> </Batch> </ArrayOfBatch>