GET api/account/cashtransactions?clientID={clientID}&adviserID={adviserID}&personID={personID}&startDate={startDate}&endDate={endDate}

Get cash transactions. Transaction data is limited to a 180 day range.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID	Client ID to filter on.	integer	None.
adviserID	Adviser ID to filter on.	integer	None.
personID	Person ID to filter on.	integer	None.
startDate	Start date range (UTC).	date	None.
endDate	End date range (UTC).	date	None.

Body Parameters

None.

Response Information

Resource Description

Cash transactions grouped by client account.

Collection of ClientCashTransaction

Name	Description	Type	Additional information
ClientID	Unique client identifier.	integer	None.
Account	Cash accounts.	CashAccount	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 1234,
    "Account": {
      "AccountID": 123456,
      "Balance": 3000.5,
      "Transactions": [
        {
          "TransactionID": 1000,
          "TransactionTimestamp": "2024-09-29T14:49:38.6299315+10:00",
          "CreatedDate": "2024-09-29",
          "TransactionType": 4,
          "Description": "Credit note.",
          "Value": 2000.0,
          "DrCr": "Credit"
        },
        {
          "TransactionID": 1000,
          "TransactionTimestamp": "2024-09-29T14:49:38.6299315+10:00",
          "CreatedDate": "2024-09-29",
          "TransactionType": 1,
          "Description": "Receipt.",
          "Value": 1500.0,
          "DrCr": "Debit"
        }
      ]
    }
  },
  {
    "ClientID": 5678,
    "Account": {
      "AccountID": 567890,
      "Balance": 1234.15,
      "Transactions": [
        {
          "TransactionID": 1000,
          "TransactionTimestamp": "2024-09-29T14:49:38.6299315+10:00",
          "CreatedDate": "2024-09-29",
          "TransactionType": 4,
          "Description": "Credit note.",
          "Value": 2000.0,
          "DrCr": "Credit"
        },
        {
          "TransactionID": 1000,
          "TransactionTimestamp": "2024-09-29T14:49:38.6299315+10:00",
          "CreatedDate": "2024-09-29",
          "TransactionType": 1,
          "Description": "Receipt.",
          "Value": 1500.0,
          "DrCr": "Debit"
        }
      ]
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientCashTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Cash">
  <ClientCashTransaction>
    <Account>
      <AccountID>123456</AccountID>
      <Balance>3000.50</Balance>
      <Transactions>
        <TransactionEntry>
          <CreatedDate>2024-09-29T14:49:38.6299315+10:00</CreatedDate>
          <Description>Credit note.</Description>
          <DrCr>Credit</DrCr>
          <TransactionID>1000</TransactionID>
          <TransactionTimestamp>2024-09-29T14:49:38.6299315+10:00</TransactionTimestamp>
          <TransactionType>CreditNote</TransactionType>
          <Value>2000.00</Value>
        </TransactionEntry>
        <TransactionEntry>
          <CreatedDate>2024-09-29T14:49:38.6299315+10:00</CreatedDate>
          <Description>Receipt.</Description>
          <DrCr>Debit</DrCr>
          <TransactionID>1000</TransactionID>
          <TransactionTimestamp>2024-09-29T14:49:38.6299315+10:00</TransactionTimestamp>
          <TransactionType>Receipt</TransactionType>
          <Value>1500.00</Value>
        </TransactionEntry>
      </Transactions>
    </Account>
    <ClientID>1234</ClientID>
  </ClientCashTransaction>
  <ClientCashTransaction>
    <Account>
      <AccountID>567890</AccountID>
      <Balance>1234.15</Balance>
      <Transactions>
        <TransactionEntry>
          <CreatedDate>2024-09-29T14:49:38.6299315+10:00</CreatedDate>
          <Description>Credit note.</Description>
          <DrCr>Credit</DrCr>
          <TransactionID>1000</TransactionID>
          <TransactionTimestamp>2024-09-29T14:49:38.6299315+10:00</TransactionTimestamp>
          <TransactionType>CreditNote</TransactionType>
          <Value>2000.00</Value>
        </TransactionEntry>
        <TransactionEntry>
          <CreatedDate>2024-09-29T14:49:38.6299315+10:00</CreatedDate>
          <Description>Receipt.</Description>
          <DrCr>Debit</DrCr>
          <TransactionID>1000</TransactionID>
          <TransactionTimestamp>2024-09-29T14:49:38.6299315+10:00</TransactionTimestamp>
          <TransactionType>Receipt</TransactionType>
          <Value>1500.00</Value>
        </TransactionEntry>
      </Transactions>
    </Account>
    <ClientID>5678</ClientID>
  </ClientCashTransaction>
</ArrayOfClientCashTransaction>

Error Response Information

Resource Description

Cash transactions grouped by client account.

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>