Get All Account Types API

Description

Get a list of all account types in the system

Security

Logged in user has account type API permissions

URL

GET http://exampleserver.com/api/ accountTypes? accountTypeCode={accountTypeCode}&description={description}&activeOnly={false}

Parameters        

1. accountTypeCode: [string, optional] search for account type by code
2. description: [string, optional] search for account type by code
3. activeOnly: [optional] restrict list to active account type

Response

Field	Type	Description
accountTypes	Array[AccountTypesOverviewDto]	The list of results if successful, null otherwise

AccountTypesOverviewDto

Field	Type	Description
id	Integer	The account type ID
code	String	The account type code
active	Boolean	True if the account type is active
accountTypeDetailsLink	Link	URL for the account type details

Example

{                                                                                                                                         

“description” : “string”,

"id": 0,

"code": "string",

"active": true,

"accountTypeDetailsLink": {

      "description": "string",

      "url": "string"

      }

} 

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)
503	Service Unavailable (due to maintenance)

Online Documentation

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

• Related Articles

• 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 ...

• Get Account Transactions API

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

• Get Interest Profile API

  Description Get details for a specific interest profile Security Logged in user has interest profile API permissions URL GET http://exampleserver.com/api/ interestProfiles/{ interestProfileId} Parameters interestProfileId: [Required, part of URL] ...

• 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 ...