POST {version}/GetRegisterTotals
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
TransactionListParamsName | Description | Type | Additional information |
---|---|---|---|
PageNum | integer |
None. |
|
PageLength | integer |
None. |
|
SkipPagination | boolean |
None. |
|
SortCol | string |
None. |
|
SortDir | string |
None. |
|
Filter | string |
None. |
|
CreatorFilter | string |
None. |
|
UpdaterFilter | string |
None. |
|
TypeFilter | string |
None. |
|
DepositMode | string |
None. |
|
HideUndeposited | boolean |
None. |
|
AccountId | globally unique identifier |
None. |
|
PeriodId | globally unique identifier |
None. |
|
MinDate | date |
None. |
|
MaxDate | date |
None. |
|
CheckNumber | string |
None. |
|
DepositNumber | string |
None. |
|
ReconciledStatus | string |
None. |
|
Reconciled | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "PageNum": 1, "PageLength": 2, "SkipPagination": true, "SortCol": "sample string 3", "SortDir": "sample string 4", "Filter": "sample string 5", "CreatorFilter": "sample string 6", "UpdaterFilter": "sample string 7", "TypeFilter": "sample string 8", "DepositMode": "sample string 9", "HideUndeposited": true, "AccountId": "4caacea3-a377-4193-b438-2dcb9e5152f9", "PeriodId": "202465be-f236-4d0b-b6bf-1b5c584ffd11", "MinDate": "10/16/2024", "MaxDate": "10/16/2024", "CheckNumber": "sample string 11", "DepositNumber": "sample string 12", "ReconciledStatus": "sample string 13", "Reconciled": null }
application/xml, text/xml
Sample:
<TransactionListParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model"> <AccountId>4caacea3-a377-4193-b438-2dcb9e5152f9</AccountId> <CheckNumber>sample string 11</CheckNumber> <CreatorFilter>sample string 6</CreatorFilter> <DepositMode>sample string 9</DepositMode> <DepositNumber>sample string 12</DepositNumber> <Filter>sample string 5</Filter> <HideUndeposited>true</HideUndeposited> <MaxDate>2024-10-16T12:25:29.0532738-04:00</MaxDate> <MinDate>2024-10-16T12:25:29.0532738-04:00</MinDate> <PageLength>2</PageLength> <PageNum>1</PageNum> <PeriodId>202465be-f236-4d0b-b6bf-1b5c584ffd11</PeriodId> <ReconciledStatus>sample string 13</ReconciledStatus> <SkipPagination>true</SkipPagination> <SortCol>sample string 3</SortCol> <SortDir>sample string 4</SortDir> <TypeFilter>sample string 8</TypeFilter> <UpdaterFilter>sample string 7</UpdaterFilter> </TransactionListParams>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
RegisterTotalsName | Description | Type | Additional information |
---|---|---|---|
BalanceString | string |
None. |
|
OutstandingString | string |
None. |
|
UndepositedString | string |
None. |
|
UnpaidString | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "BalanceString": "sample string 1", "OutstandingString": "sample string 2", "UndepositedString": "sample string 3", "UnpaidString": "sample string 4" }
application/xml, text/xml
Sample:
<RegisterTotals xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model"> <BalanceString>sample string 1</BalanceString> <OutstandingString>sample string 2</OutstandingString> <UndepositedString>sample string 3</UndepositedString> <UnpaidString>sample string 4</UnpaidString> </RegisterTotals>