POST {version}/GetPaginatedTransactionsForEntity

Get Paginated Transactions For an Entity

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

PaginatedTransactionCriteria

Name	Type	Additional information
Id	globally unique identifier	None.
EntityName	string	None.
ElectionPeriodFilter	globally unique identifier	None.
TransactionTypeFilter	globally unique identifier	None.
IncludeSoftAllocations	boolean	None.
PageNum	integer	None.
PageSize	integer	None.
OrderBy_Field	string	None.
IsAscending	boolean	None.
EntityType	string	None.
Columns	Collection of string	None.
UiToDbColMap	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "8a497d2f-a3bc-4841-9bea-aa99ea5a3212",
  "EntityName": "sample string 1",
  "ElectionPeriodFilter": "5b537e1f-c519-4516-80f0-322653cb4179",
  "TransactionTypeFilter": "ef298d95-0ddb-40ee-b8c7-e3f9015aae4d",
  "IncludeSoftAllocations": true,
  "PageNum": 1,
  "PageSize": 1,
  "OrderBy_Field": "sample string 2",
  "IsAscending": true,
  "EntityType": "sample string 3",
  "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:

<PaginatedTransactionCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <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>
  <ElectionPeriodFilter>5b537e1f-c519-4516-80f0-322653cb4179</ElectionPeriodFilter>
  <EntityName>sample string 1</EntityName>
  <EntityType>sample string 3</EntityType>
  <Id>8a497d2f-a3bc-4841-9bea-aa99ea5a3212</Id>
  <IncludeSoftAllocations>true</IncludeSoftAllocations>
  <IsAscending>true</IsAscending>
  <OrderBy_Field>sample string 2</OrderBy_Field>
  <PageNum>1</PageNum>
  <PageSize>1</PageSize>
  <TransactionTypeFilter>ef298d95-0ddb-40ee-b8c7-e3f9015aae4d</TransactionTypeFilter>
  <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>
</PaginatedTransactionCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of Paginated Transactions

TransactionSearch

Name	Description	Type	Additional information
Results		Collection of PaginatedTransaction	None.
TotalRecords		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Results": [
    {
      "RowNum": 1,
      "TransactionGuid": "df8b5aee-71c7-4109-91ed-8af7d971677e",
      "TransactionDate": "sample string 2",
      "PaymentAmount": 3.0,
      "CheckNumber": "sample string 4",
      "BankNumber": "sample string 5",
      "TransactionType": "sample string 6",
      "ElectionPeriod": "sample string 7",
      "Thanked": "sample string 8",
      "TransactionMode": "sample string 9",
      "AccountName": "sample string 10",
      "Category": "sample string 11",
      "Reconciled": "sample string 12",
      "PaymentMethod": "sample string 13",
      "FromClearedDate": "sample string 14",
      "ToClearedDate": "sample string 15",
      "Memo": "sample string 16",
      "DueDate": "sample string 17",
      "Rate": 18.0,
      "SupportOpposeName": "sample string 19",
      "ReportingDescription": "sample string 20",
      "IsReversal": true,
      "Event": "sample string 21",
      "Batch": "sample string 22",
      "ReportingCode": "sample string 23"
    },
    {
      "RowNum": 1,
      "TransactionGuid": "df8b5aee-71c7-4109-91ed-8af7d971677e",
      "TransactionDate": "sample string 2",
      "PaymentAmount": 3.0,
      "CheckNumber": "sample string 4",
      "BankNumber": "sample string 5",
      "TransactionType": "sample string 6",
      "ElectionPeriod": "sample string 7",
      "Thanked": "sample string 8",
      "TransactionMode": "sample string 9",
      "AccountName": "sample string 10",
      "Category": "sample string 11",
      "Reconciled": "sample string 12",
      "PaymentMethod": "sample string 13",
      "FromClearedDate": "sample string 14",
      "ToClearedDate": "sample string 15",
      "Memo": "sample string 16",
      "DueDate": "sample string 17",
      "Rate": 18.0,
      "SupportOpposeName": "sample string 19",
      "ReportingDescription": "sample string 20",
      "IsReversal": true,
      "Event": "sample string 21",
      "Batch": "sample string 22",
      "ReportingCode": "sample string 23"
    }
  ],
  "TotalRecords": 1
}

application/xml, text/xml

Sample:

<TransactionSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <Results>
    <PaginatedTransaction>
      <AccountName>sample string 10</AccountName>
      <BankNumber>sample string 5</BankNumber>
      <Batch>sample string 22</Batch>
      <Category>sample string 11</Category>
      <CheckNumber>sample string 4</CheckNumber>
      <DueDate>sample string 17</DueDate>
      <ElectionPeriod>sample string 7</ElectionPeriod>
      <Event>sample string 21</Event>
      <FromClearedDate>sample string 14</FromClearedDate>
      <IsReversal>true</IsReversal>
      <Memo>sample string 16</Memo>
      <PaymentAmount>3</PaymentAmount>
      <PaymentMethod>sample string 13</PaymentMethod>
      <Rate>18</Rate>
      <Reconciled>sample string 12</Reconciled>
      <ReportingCode>sample string 23</ReportingCode>
      <ReportingDescription>sample string 20</ReportingDescription>
      <RowNum>1</RowNum>
      <SupportOpposeName>sample string 19</SupportOpposeName>
      <Thanked>sample string 8</Thanked>
      <ToClearedDate>sample string 15</ToClearedDate>
      <TransactionDate>sample string 2</TransactionDate>
      <TransactionGuid>df8b5aee-71c7-4109-91ed-8af7d971677e</TransactionGuid>
      <TransactionMode>sample string 9</TransactionMode>
      <TransactionType>sample string 6</TransactionType>
    </PaginatedTransaction>
    <PaginatedTransaction>
      <AccountName>sample string 10</AccountName>
      <BankNumber>sample string 5</BankNumber>
      <Batch>sample string 22</Batch>
      <Category>sample string 11</Category>
      <CheckNumber>sample string 4</CheckNumber>
      <DueDate>sample string 17</DueDate>
      <ElectionPeriod>sample string 7</ElectionPeriod>
      <Event>sample string 21</Event>
      <FromClearedDate>sample string 14</FromClearedDate>
      <IsReversal>true</IsReversal>
      <Memo>sample string 16</Memo>
      <PaymentAmount>3</PaymentAmount>
      <PaymentMethod>sample string 13</PaymentMethod>
      <Rate>18</Rate>
      <Reconciled>sample string 12</Reconciled>
      <ReportingCode>sample string 23</ReportingCode>
      <ReportingDescription>sample string 20</ReportingDescription>
      <RowNum>1</RowNum>
      <SupportOpposeName>sample string 19</SupportOpposeName>
      <Thanked>sample string 8</Thanked>
      <ToClearedDate>sample string 15</ToClearedDate>
      <TransactionDate>sample string 2</TransactionDate>
      <TransactionGuid>df8b5aee-71c7-4109-91ed-8af7d971677e</TransactionGuid>
      <TransactionMode>sample string 9</TransactionMode>
      <TransactionType>sample string 6</TransactionType>
    </PaginatedTransaction>
  </Results>
  <TotalRecords>1</TotalRecords>
</TransactionSearch>