POST {version}/GetRegisterTransactions

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

TransactionListParams

Name	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": "124079b5-715b-4650-bdac-3d1ea4eb3d1a",
  "PeriodId": "6ae33dab-c79f-459d-a00f-9a9b7cd61f95",
  "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>124079b5-715b-4650-bdac-3d1ea4eb3d1a</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:22:15.9287388-04:00</MaxDate>
  <MinDate>2024-10-16T12:22:15.9287388-04:00</MinDate>
  <PageLength>2</PageLength>
  <PageNum>1</PageNum>
  <PeriodId>6ae33dab-c79f-459d-a00f-9a9b7cd61f95</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

RegisterTransactions

Name	Description	Type	Additional information
Transactions		Collection of RegisterTransactionRecord	None.
TotalTransactions		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Transactions": [
    {
      "EntityId": "sample string 1",
      "Transaction": "sample string 2",
      "EntityType": "sample string 3",
      "Id": "sample string 4",
      "AmountLS": "sample string 5",
      "DateLS": "sample string 6",
      "CheckNumber": "sample string 7",
      "DepositNumber": 1,
      "PaymentMethod": "sample string 8",
      "Period": "sample string 9",
      "TransactionType": "sample string 10",
      "Type": {
        "Id": "a11712f8-e44d-4b86-aba9-b3e5b1a7b057",
        "IsMonetary": true,
        "Text": "sample string 3",
        "IsReceiptType": true
      },
      "RunningBalanceLS": "sample string 11",
      "IsReceipt": true,
      "IsDisbursement": true,
      "IsDeposit": true,
      "IsReversal": true,
      "Category": "sample string 15"
    },
    {
      "EntityId": "sample string 1",
      "Transaction": "sample string 2",
      "EntityType": "sample string 3",
      "Id": "sample string 4",
      "AmountLS": "sample string 5",
      "DateLS": "sample string 6",
      "CheckNumber": "sample string 7",
      "DepositNumber": 1,
      "PaymentMethod": "sample string 8",
      "Period": "sample string 9",
      "TransactionType": "sample string 10",
      "Type": {
        "Id": "a11712f8-e44d-4b86-aba9-b3e5b1a7b057",
        "IsMonetary": true,
        "Text": "sample string 3",
        "IsReceiptType": true
      },
      "RunningBalanceLS": "sample string 11",
      "IsReceipt": true,
      "IsDisbursement": true,
      "IsDeposit": true,
      "IsReversal": true,
      "Category": "sample string 15"
    }
  ],
  "TotalTransactions": 1
}

application/xml, text/xml

Sample:

<RegisterTransactions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <TotalTransactions>1</TotalTransactions>
  <Transactions>
    <RegisterTransactionRecord>
      <AmountLS>sample string 5</AmountLS>
      <Category>sample string 15</Category>
      <CheckNumber>sample string 7</CheckNumber>
      <DateLS>sample string 6</DateLS>
      <DepositNumber>1</DepositNumber>
      <EntityId>sample string 1</EntityId>
      <EntityType>sample string 3</EntityType>
      <Id>sample string 4</Id>
      <IsDeposit>true</IsDeposit>
      <IsDisbursement>true</IsDisbursement>
      <IsReceipt>true</IsReceipt>
      <IsReversal>true</IsReversal>
      <PaymentMethod>sample string 8</PaymentMethod>
      <Period>sample string 9</Period>
      <RunningBalanceLS>sample string 11</RunningBalanceLS>
      <Transaction>sample string 2</Transaction>
      <TransactionType>sample string 10</TransactionType>
      <Type>
        <Id>a11712f8-e44d-4b86-aba9-b3e5b1a7b057</Id>
        <IsMonetary>true</IsMonetary>
        <IsReceiptType>true</IsReceiptType>
        <Text>sample string 3</Text>
      </Type>
    </RegisterTransactionRecord>
    <RegisterTransactionRecord>
      <AmountLS>sample string 5</AmountLS>
      <Category>sample string 15</Category>
      <CheckNumber>sample string 7</CheckNumber>
      <DateLS>sample string 6</DateLS>
      <DepositNumber>1</DepositNumber>
      <EntityId>sample string 1</EntityId>
      <EntityType>sample string 3</EntityType>
      <Id>sample string 4</Id>
      <IsDeposit>true</IsDeposit>
      <IsDisbursement>true</IsDisbursement>
      <IsReceipt>true</IsReceipt>
      <IsReversal>true</IsReversal>
      <PaymentMethod>sample string 8</PaymentMethod>
      <Period>sample string 9</Period>
      <RunningBalanceLS>sample string 11</RunningBalanceLS>
      <Transaction>sample string 2</Transaction>
      <TransactionType>sample string 10</TransactionType>
      <Type>
        <Id>a11712f8-e44d-4b86-aba9-b3e5b1a7b057</Id>
        <IsMonetary>true</IsMonetary>
        <IsReceiptType>true</IsReceiptType>
        <Text>sample string 3</Text>
      </Type>
    </RegisterTransactionRecord>
  </Transactions>
</RegisterTransactions>