Get Account Transactions API

Description

Retrieve the transactions for an account

Security

Logged in user has account API permissions

URL

GET http://exampleserver.com/api/{system}/{accountId}/transactions?inputDateFrom={date}&inputDateTo={date}&valueDateFrom={date}&valueDateTo={date}&ledger={ledger}

Parameters        

1. system: [Required, part of URL] One of (case insensitive):
1. FixedLoan
   
2. Dealer
   
3. CallSaving
   
4. VariableLoan
   
5. Deposit
   
6. Insurer
   
7. Lease
   
8. UnitFund
   
2. accountId: [Required, part of URL] account to retrieve
   
3. inputDateFrom: [DateTime, optional] the start period for the transaction input date (inclusive)
   
4. inputDateTo: [DateTime, optional] the end period for the transaction input date (inclusive)
5. valueDateFrom: [DateTime, optional] the start period for the transaction value date (inclusive)
6. valueDateTo:  [DateTime, optional] the end period for the transaction value date (inclusive)
7. ledger: [String], optional] restrict transactions to a specific ledger. If omitted, both ledgers are returned. One of (case insensitive): 
1. current
   
2. future

Response

AccountOverviewDto

Field	Type	Description
accountDetailsLink	Link	URL for the account details
primaryClientLink	Link	URL for the primary client details
id	Integer	The transaction ID
description	String	The transaction description
inputDate	DateTime	The input date for the transaction
valueDate	DateTime	The value date for the transaction
transactionType	String	The transaction type
reference	String	The transaction type
ledger	String	The ledger the transaction belongs to
amount	Number	The transaction amount
accountBalance	String	Running account balance

Example

{                                                                                                                                         

"accountDetailsLink": {

      "description": "string",

      "url": "string"

      },

"primaryClientLink": {

      "description": "string",

      "url": "string"

      },

"transactions": [

            {

            "id": 0,

            "description": "string",

            "inputDate": "2018-07-04T20:13:49.162Z",

            "valueDate": "2018-07-04T20:13:49.162Z",

            "transactionType": "string",

            "reference": "string",

            "amount": 0,

            "accountBalance": 0

            }

      ]

} 

Error Codes

HTTP Status Code	Type
200	OK (Success)
204	No Content (no records match the search)
401	Unauthorised (not Authenticated)
403	Forbidden (invalid Authorisation)
404	Account not found
503	Service Unavailable (due to maintenance)

Online Documentation

https://api.argos.co.nz/WebApi/swagger/ui/index#!/Accounts/Accounts

• Related Articles

• Search Accounts API

  Description Search for accounts matching criteria Security Logged in user has account API permissions URL GET http://exampleserver.com/api/accounts?code={code}&activeOnly={false}&clientId={clientId}&system={system}&openOnly={false} Parameters code: ...

• Get Client API

  Description Get details for a specific client Security Logged in user has client API permissions URL GET http://exampleserver.com/api/v6/clients/{clientId} Parameters clientId: [Required, part of URL] client to retrieve Response ClientDto Field Type ...

• Get Account Details API

  Description Retrieve the system specific details for an account Security Logged in user has account API permissions URL GET http://exampleserver.com/api/{system}/{accountId}?calculationDate=date Parameters system: [Required, part of URL] One of (case ...

• Get Account Type API

  Description Get details for a specific account type Security Get details for a specific account type URL GET http://exampleserver.com/api/ accountTypes/{ accountTypeId} Parameters accountTypeId: [Required, part of URL] accountType to retrieve ...

• Argos Vault Release Notes V5.146

  Release Completion Date: 30 August 2024 Please disregard the release notes for the modules you do not use. Unless otherwise indicated, more detail about any change will be included in the relevant dialog [Help] button. Other documents referred to in ...