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        

1. code: [string, optional] search for account by code 
2. activeOnly: [Boolean, optional] restrict list to active accounts; defaults to false
3. clientId: [Integer, optional] search for account by client id
4. system: [String, optional] restrict list to accounts in specified system. One of (case insensitive):
1. FixedLoan
   
2. Dealer
   
3. CallSavings
   
4. VariableLoan
   
5. Deposit
   
6. Insurer
   
7. Lease
   
8. UnitFund
   
5. openOnly: [Boolean, optional] restrict list to open accounts; defaults to false

Response

AccountOverviewDto

Field	Type	Description
id	Integer	The account ID
code	String	The account code
accountDetailsLink	Link	URL for the account details
primaryClientLink	Link	URL for the primary client details
active	Boolean	True if the account is active
currentBalance	Number	The balance of the account current ledger
system	String	The module of the account

Example

{                                                                                                                                         

"id": 0,

"code": "string",

"active": true,

"currentBalance": 0,

"system": "string",

"accountDetailsLink": {

      "description": "string",

      "url": "string"

      },

"primaryClientLink": {

      "description": "string",

      "url": "string"

      }

} 

Error Codes

HTTP Status Code	Type
200	OK (Success)
204	No Content (no records match the search)
400	Bad Request (request format error)
401	Unauthorised (not Authenticated)
403	Forbidden (invalid Authorisation)
503	Service Unavailable (due to maintenance)

Online Documentation

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

• Related Articles

• Update Account API

  Description Update the details of a specific account. Security Logged in user has account API permissions URL PATCH http://exampleserver.com/api/v3/Accounts/{account_id} Parameters Model Field Type Description description String (optional) The ...

• Get Account Transactions API

  Description Retrieve the transactions for an account Security Logged in user has account API permissions URL GET ...

• Dispatch Centre Configuration - Gmail APIs

  Purpose To setup the Gmail API service within the Gmail Admin portal Access https://console.cloud.google.com/ Login to the above website. Create the Project In the search bar enter Projects. Select the Create a Project option. Complete the Project ...

• Argos Vault Release Notes V5.140

  Argos Vault Release Notes V5.140 Release Completion Date: 18 August 2021 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] ...

• Argos Release Notes V5.123.54

  Argos Vault Release Notes V 5.123.54 Release Completion Date: 19 February 2020 Please disregard the release notes for the modules you do not use. Please refer to the Argos Installation Manual in your documents folder for instructions on installing ...