Get Account Details API

Get Account Details API

Description

Retrieve the system specific details for an account

Security

Logged in user has account API permissions

URL

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. calculationDate: [date, optional] date used for AccruedDate, AccruedInterestCurrent, AccruedWithholdingTaxCurrent, AccruedBalanceCurrent (and if present, AccruedInterestFuture, AccruedWithholdingTaxFuture and AccruedBalanceFuture) calculations.  If not specified the date is set to today

Response

The individual account systems share a common set of details.  Some systems have additional details.

Details for CallSavingsAccountDto, DealerAccountDto, DepositAccountDto, FixedLoanAccountDto, InsurerAccountDto, LeaseAccountDto, UnitFundAccountDto, VariableLoanAccountDto

FieldTypeDescription
idIntegerThe account ID
codeStringThe account code
accountDetailsLinkLinkURL 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
internalReturnRate
Number
The internal return rate
currentLedgerAccruedInterestRate
Number
The current ledger accrued interest rate
accruedInterestCurrent
Number
The accrued interest for the current ledger
accruedBalanceCurrent
Number
The accrued balance for the current ledger
openDate
DateTime
The account open date
nextInterestDate
DateTime (optional)
The next interest date
analysisCodeFirst
String
The account first analysis code
analysisCodeSecond
String
The account second analysis code
notes
String
The account notes
accruedDate
DateTime
The account accrued date
interestAction
String
The account interest action
interestFrequency
String
The interest frequency
defaultInterestProfileLink
Link
Interest profile for the current ledger
futureIntersetProfileLink
Link
Interest profile for the future ledger

Additional DepositAccountDto details

FieldTypeDescription
maturityDateDateTime (optional)The account maturity date
maturityInstructionsStringThe account maturity instructions
maturityActionStringThe account maturity action
accruedWithholdingTaxCurrentNumberThe accrued withholding tax for the current ledger
interestPaymentExternalDetailsStringThe interest payment bank account
maturityExternalAccountStringThe maturity bank account

Example

Notes

{                                                                                                                                         
"maturityDate": "2018-07-15T21:09:21.729Z",
"maturityInstructions": "string",
"maturityAction": "string",
"interestPaymentExternalDetails": "string",
"maturityExternalAccount": "string",
"accruedWithholdingTaxCurrent": 0,
"internalReturnRate": 0,
"currentLedgerAccruedInterestRate": 0,
"accruedInterestCurrent": 0,
"accruedBalanceCurrent": 0,
"openDate": "2018-07-15T21:09:21.729Z",
"nextInterestDate": "2018-07-15T21:09:21.729Z",
"analysisCodeFirst": "string",
"analysisCodeSecond": "string",
"notes": "string",
"accruedDate": "2018-07-15T21:09:21.729Z",
"interestAction": "string",
"interestFrequency": "string",
"id": 0,
"code": "string",
"active": true,
"currentBalance": 0,
"system": "string",
"accountDetailsLink": {
      "description": "string",
      "url": "string"
      },
"primaryClientLink": {
      "description": "string",
      "url": "string"
      }
} 

Additional LeaseAccountDto details

FieldTypeDescription
vendorProgramStringThe account vendor program
futureBalanceIncludingTaxesNumberThe balance of the account future ledger including taxes
lastReceiptDateDateTime (optional)The last receipt date
lastReceiptAmountNumberThe last receipt amount
nextInstalmentDateDateTime (optional)The next instalment date
finalInstalmentDateDateTime (optional)The final instalment date
instalmentFrequency
String
The instalment frequency
secondaryClientLinks
Link
Collections of URLs for the secondary clients
guarantorLinks
Link
Collections of URLs for the guarantor clients

Example

Notes
{                                                                                                                                         
"vendorProgram": "string",
"futureBalanceIncludingTaxes": 0,
"lastReceiptDate": "2018-07-15T21:09:21.657Z",
"lastReceiptAmount": 0,
"nextInstalmentDate": "2018-07-15T21:09:21.657Z",
"finalInstalmentDate": "2018-07-15T21:09:21.657Z",
"instalmentFrequency": "string",
"secondaryClientLinks": [
      {
      "description": "string",
      "url": "string"
      }
],
"guarantorLinks": [
      {
      "description": "string",
      "url": "string"
      }
],
"internalReturnRate": 0,
"currentLedgerAccruedInterestRate": 0,
"accruedInterestCurrent": 0,
"accruedBalanceCurrent": 0,
"openDate": "2018-07-15T21:09:21.658Z",
"nextInterestDate": "2018-07-15T21:09:21.658Z",
"analysisCodeFirst": "string",
"analysisCodeSecond": "string",
"notes": "string",
"accruedDate": "2018-07-15T21:09:21.658Z",
"interestAction": "string",
"interestFrequency": "string",
"id": 0,
"code": "string",
"active": true,
"currentBalance": 0,
"system": "string",
"accountDetailsLink": {
      "description": "string",
      "url": "string"
      },
"primaryClientLink": {
      "description": "string",
      "url": "string"
      }
} 

Additional FixedLoanAccountDto details

FieldTypeDescription
remainingInstalmentsNumberThe remaining instalments for this fixed loan
originalTermNumberThe number of instalments on account creation
amountFinancedNumberThe amount financed for this fixed loan
nextInstalmentDateDateTime (optional)The next instalment date
finalInstalmentDateDateTime (optional)The final instalment date
originalInstalmentFrequency
String
The original instalment frequency
instalmentFrequencyStringThe instalment frequency
vendorProgram
String
The account vendor program
futureBalance
Number
The balance of the account future ledger
lastReceiptDate
DateTime (optional)
The last receipt date
lastReceiptAmount
Number
The last receipt amount
standardInstalmentAmount
Number
The standard instalment amount
payOffAmount
Number
The amount to pay off the account
daysInArrears
Integer
The number of days the account is in arrears
secondaryClientLinksLinkCollections of URLs for the secondary clients
guarantorLinksLinkCollections of URLs for the guarantor clients
collateralItems
Collateral Items
Collection of collateral items for the account

Example

Notes
{                                                                                                                                         
"remainingInstalments": 0,
"originalTerm": 0,
"amountFinanced": 0,
"nextInstalmentDate": "2018-07-15T21:09:21.788Z",
"finalInstalmentDate": "2018-07-15T21:09:21.788Z",
"originalInstalmentFrequency": "string",
"instalmentFrequency": "string",
"vendorProgram": "string",
"futureBalance": 0,
"lastReceiptDate": "2018-07-15T21:09:21.788Z",
"lastReceiptAmount": 0,
"secondaryClientLinks": [
      {
      "description": "string",
      "url": "string"
      }
],
"guarantorLinks": [
      {
      "description": "string",
      "url": "string"
      }
],
"internalReturnRate": 0,
"currentLedgerAccruedInterestRate": 0,
"accruedInterestCurrent": 0,
"accruedBalanceCurrent": 0,
"openDate": "2018-07-15T21:09:21.788Z",
"nextInterestDate": "2018-07-15T21:09:21.788Z",
"analysisCodeFirst": "string",
"analysisCodeSecond": "string",
"notes": "string",
"accruedDate": "2018-07-15T21:09:21.788Z",
"interestAction": "string",
"interestFrequency": "string",
"id": 0,
"standardInstalmentAmount": 0.0,
"payOffAmount": 0.0,
"daysInArrears": 0,
"code": "string",
"active": true,
"currentBalance": 0,
"system": "string",
"accountDetailsLink": {
      "description": "string",
      "url": "string"
      },
"primaryClientLink": {
      "description": "string",
      "url": "string"
      },
"collateralItems": [
      {
      "recordState": "string",
      "type": "string",
      "code": "string",
      "category": "string",
      "itemDescription": "string",
      "make": "string",
      "model": "string",
      "year": 0,
      "newDate": "2018-07-15T21:09:21.812Z",
      "colour": "string",
      "vinhin": "string",
      "chassisSerialNumber": "string",
      "registrationNumber": "string",
      "registrationMark": "string",
      "engineSize": "string",
      "transmissionType": "string",
      "bodyStyle": "string",
      "fuelType": "string",
      "manufactureSerialNumber": "string",
      "aircraftClass": "string",
      "identifyingNumbers": "string",
      "expiryDate": "2018-07-15T21:09:21.812Z",
      "location": "string",
      "owner": "string",
      "externalId": "string",
      "externalCost": 0,
      "notes": "string"
      }
]
}

Additional VariableLoanAccountDto details

FieldTypeDescription
nextInstalmentDateDateTime (optional)The next instalment date
maturityDateDateTime (optional)The account maturity date
instalmentAmountNumberThe instalment amount
daysInArrearsIntegerThe number of days the account is in arrears
accruedInterestFutureNumberThe accrued interest for the future ledger
accruedIBalanceFutureNumberThe accrued balance for the future ledger
futureLedgerAccruedInterestRateNumberThe future ledger accrued interest rate
vendorProgramStringThe account vendor program
futureBalanceNumberThe balance of the account future ledger
lastReceiptDateDateTime (optional)The last receipt date
lastReceiptAmountNumberThe last receipt amount
payOffAmountNumberThe amount to pay off the account
reviewDateDateTime (optional)The review date
instalmentFrequency
String
The instalment frequency
costItem1, costItem2... costItem15
Number
Cost Items 1 ... 15
secondaryClientLinksLinkCollections of URLs for the secondary clients
guarantorLinksLinkCollections of URLs for the guarantor clients
collateralItemsCollateral ItemsCollection of collateral items for the account
overdraftFacilityLimit
Number
Overdraft Facility Limit

Example

Notes
{                                                                                                                                         
"nextInstalmentDate": "2018-07-15T21:09:21.812Z",
"maturityDate": "2018-07-15T21:09:21.812Z",
"instalmentAmount": 0,
"reviewDate": "2018-07-15T21:09:21.812Z",
"instalmentFrequency": "string",
"daysInArrears": 0,
"accruedInterestFuture": 0,
"accruedBalanceFuture": 0,
"futureLedgerAccruedInterestRate": 0,
"vendorProgram": "string",
"futureBalance": 0,
"lastReceiptDate": "2018-07-15T21:09:21.812Z",
"lastReceiptAmount": 0,
"payOffAmount": 0,
"costItem1": 0,
"costItem2": 0,
"costItem3": 0,
"costItem4": 0,
"costItem5": 0,
"costItem6": 0,
"costItem7": 0,
"costItem8": 0,
"costItem9": 0,
"costItem10": 0,
"costItem11": 0,
"costItem12": 0,
"costItem13": 0,
"costItem14": 0,
"costItem15": 0,
"secondaryClientLinks": [
      {
      "description": "string",
      "url": "string"
      }
],
"guarantorLinks": [
      {
      "description": "string",
      "url": "string"      
      }
],
"internalReturnRate": 0,
"currentLedgerAccruedInterestRate": 0,
"accruedInterestCurrent": 0,
"accruedBalanceCurrent": 0,
"openDate": "2018-07-15T21:09:21.812Z",
"nextInterestDate": "2018-07-15T21:09:21.812Z",
"analysisCodeFirst": "string",
"analysisCodeSecond": "string",
"notes": "string",
"accruedDate": "2018-07-15T21:09:21.812Z",
"interestAction": "string",
"interestFrequency": "string",
"id": 0,
"code": "string",
"active": true,
"currentBalance": 0,
"system": "string",
"accountDetailsLink": {     
      "description": "string",
      "url": "string"
      },
"primaryClientLink": {
      "description": "string",
      "url": "string"
      },
"collateralItems": [
      {
      "recordState": "string",
      "type": "string",
      "code": "string",
      "category": "string",
      "itemDescription": "string",
      "make": "string",
      "model": "string",
      "year": 0,
      "newDate": "2018-07-15T21:09:21.812Z",
      "colour": "string",
      "vinhin": "string",
      "chassisSerialNumber": "string",
      "registrationNumber": "string",
      "registrationMark": "string",
      "engineSize": "string",
      "transmissionType": "string",
      "bodyStyle": "string",
      "fuelType": "string",
      "manufactureSerialNumber": "string",
      "aircraftClass": "string",
      "identifyingNumbers": "string",
      "expiryDate": "2018-07-15T21:09:21.812Z",
      "location": "string",
      "owner": "string",
      "externalId": "string",
      "externalCost": 0,
      "notes": "string"
      }
],
"overdraftFacilityLimit": 0
}

Additional V7 VariableLoanAccountDto details

GET http://exampleserver.com/api/v7/{system}/{accountId}?calculationDate=date

FieldTypeDescription
dealerIdIntegerThe dealer Id associated with variable loan

Example

Notes
{                                                                                                                                         
"dealerId": 0,
"nextInstalmentDate": "2025-10-29T22:36:24.856Z",
"maturityDate": "2025-10-29T22:36:24.856Z",
"instalmentAmount": 0,
"reviewDate": "2025-10-29T22:36:24.856Z",
"instalmentFrequency": "string",
"accruedInterestFuture": 0,
"accruedBalanceFuture": 0,
"futureLedgerAccruedInterestRate": 0,
"vendorProgram": "string",
"futureBalance": 0,
"lastReceiptDate": "2025-10-29T22:36:24.856Z",
"lastReceiptAmount": 0,
"costItem1": 0,
"costItem2": 0,
"costItem3": 0,
"costItem4": 0,
"costItem5": 0,
"costItem6": 0,
"costItem7": 0,
"costItem8": 0,
"costItem9": 0,
"costItem10": 0,
"costItem11": 0,
"costItem12": 0,
"costItem13": 0,
"costItem14": 0,
"costItem15": 0,
"daysInArrears": 0,
"payOffAmount": 0,
"secondaryClientLinks": [
      {
      "description": "string",
      "url": "string"
      }
],
"guarantorLinks": [
      {
      "description": "string",
      "url": "string"
      }
],
"collateralItems": [
      {
      "recordState": "string",
      "type": "string",
      "code": "string",
      "category": "string",
      "itemDescription": "string",
      "make": "string",      
      "model": "string",
      "year": 0,
      "newDate": "2025-10-29T22:36:24.856Z",
      "colour": "string",
      "vinhin": "string",
      "chassisSerialNumber": "string",
      "registrationNumber": "string",
      "registrationMark": "string",
      "engineSize": "string",
      "transmissionType": "string",
      "bodyStyle": "string",
      "fuelType": "string",
      "manufactureSerialNumber": "string",
      "aircraftClass": "string",
      "identifyingNumbers": "string",
      "expiryDate": "2025-10-29T22:36:24.856Z",
      "location": "string",
      "owner": "string",
      "externalId": "string",
      "externalCost": 0,
      "notes": "string"
      }
],
"overdraftFacilityLimit": 0,
"internalReturnRate": 0,
"currentLedgerAccruedInterestRate": 0,
"accruedInterestCurrent": 0,
"accruedBalanceCurrent": 0,
"openDate": "2025-10-29T22:36:24.856Z",
"nextInterestDate": "2025-10-29T22:36:24.856Z",
"analysisCodeFirst": "string",
"analysisCodeSecond": "string",
"notes": "string",
"accruedDate": "2025-10-29T22:36:24.856Z",
"interestAction": "string",
"interestFrequency": "string",
"defaultInterestProfileLink": {
      "description": "string",
      "url": "string"
      },
"futureInterestProfileLink": {
      "description": "string",
      "url": "string"
      },
"id": 0,
"code": "string",
"active": true,
"currentBalance": 0,
"system": "string",
"accountDetailsLink": {
      "description": "string",
      "url": "string"
      },
"primaryClientLink": {
      "description": "string",
      "url": "string"
      }
}

Additional DealerAccountDto details


FieldTypeDescription
vendorProgramIntegerThe dealer Id associated with variable loan
futureBalance
Number
The balance of the future ledger
secondaryClientLinks
Link
Collection of URLs for the secondary clients
guarantorLinks
Link
Collection of URLs for the guarantor clients

Example

Notes
{                                                                                                                                         
"futureBalance": 0,
"vendorProgram": "string",
"secondaryClientLinks": [
      {
      "description": "string",
      "url": "string"
      }
],
"guarantorLinks": [
      {
      "description": "string",
      "url": "string"
      }
],
"internalReturnRate": 0,
"currentLedgerAccruedInterestRate": 0,
"accruedInterestCurrent": 0,
"accruedBalanceCurrent": 0,
"openDate": "2018-07-15T21:09:21.712Z",
"nextInterestDate": "2018-07-15T21:09:21.712Z",
"analysisCodeFirst": "string",
"analysisCodeSecond": "string",
"notes": "string",
"accruedDate": "2018-07-15T21:09:21.712Z",
"interestAction": "string",
"interestFrequency": "string",
"id": 0,
"code": "string",
"active": true,
"currentBalance": 0,
"system": "string",
"accountDetailsLink": {
      "description": "string",
      "url": "string"
      },
"primaryClientLink": {
      "description": "string",
      "url": "string"
      }
}

Additional CallSavingAccountDto details


FieldTypeDescription
futureBalanceNumberThe balance of the future ledger
accruedWithholdingTaxCurrentNumberThe accrued withholding tax for the current ledger

Example

Notes
{                                                                                                                                        
"futureBalance": 0,
"accruedWithholdingTaxCurrent": 0,
"internalReturnRate": 0,
"currentLedgerAccruedInterestRate": 0,
"accruedInterestCurrent": 0,
"accruedBalanceCurrent": 0,
"openDate": "2018-07-15T21:09:21.801Z",
"nextInterestDate": "2018-07-15T21:09:21.801Z",
"analysisCodeFirst": "string",
"analysisCodeSecond": "string",
"notes": "string",
"accruedDate": "2018-07-15T21:09:21.802Z",
"interestAction": "string",
"interestFrequency": "string",
"id": 0,
"code": "string",
"active": true,
"currentBalance": 0,
"system": "string",
"accountDetailsLink": {
      "description": "string",
      "url": "string"
      },
"primaryClientLink": {
      "description": "string",
      "url": "string"
      }
}

Additional InsurerAccountDto details


FieldTypeDescription
vendorProgram
String
The account vendor program
futureBalanceNumberThe balance of the future ledger
secondaryClientLinksLinksCollection of URLs for the secondary clients
guarantorClientLinks
Links
Collection of URLs for the guarantor clients

Example

Notes
{                                                                                                                                        
"vendorProgram": "string",
"futureBalance": 0,
"secondaryClientLinks": [
      {
      "description": "string",
      "url": "string"
      }
],
"guarantorLinks": [
      {
      "description": "string",
      "url": "string"
      }
],
"internalReturnRate": 0,
"currentLedgerAccruedInterestRate": 0,
"accruedInterestCurrent": 0,
"accruedBalanceCurrent": 0,
"openDate": "2018-07-15T21:30:32.512Z",
"nextInterestDate": "2018-07-15T21:30:32.512Z",
"analysisCodeFirst": "string",
"analysisCodeSecond": "string",
"notes": "string",
"accruedDate": "2018-07-15T21:30:32.512Z",
"interestAction": "string",
"interestFrequency": "string",
"id": 0,
"code": "string",
"active": true,
"currentBalance": 0,
"system": "string",
"accountDetailsLink": {
      "description": "string",
      "url": "string"
      },
"primaryClientLink": {
      "description": "string",
      "url": "string"
      }
}

Additional UnitFundAccountDto Details

FieldTypeDescription
futureBalanceNumberThe balance of the future ledger
unitBalanceNumberThe number of units
unitValueNumberThe value of each unit

Example

Notes

{                                                                                                                                        
"futureBalance": 0,
"unitBalance": 0,
"unitValue": 0,
"internalReturnRate": 0,
"currentLedgerAccruedInterestRate": 0,
"accruedInterestCurrent": 0,
"accruedBalanceCurrent": 0,
"openDate": "2018-07-15T21:30:32.530Z",
"nextInterestDate": "2018-07-15T21:30:32.530Z",
"analysisCodeFirst": "string",
"analysisCodeSecond": "string",
"notes": "string",
"accruedDate": "2018-07-15T21:30:32.530Z",
"interestAction": "string",
"interestFrequency": "string",
"id": 0,
"code": "string",
"active": true,
"currentBalance": 0,
"system": "string",
"accountDetailsLink": {
      "description": "string",
      "url": "string"
},
"primaryClientLink": {
      "description": "string",
      "url": "string"
      }
}

Error Codes

HTTP Status CodeType
200OK (Success)
401Unauthorised (not Authenticated)
403Forbidden (invalid Authorisation)
404
Account not found
503Service Unavailable (due to maintenance)

Online Documentation



    • Related Articles

    • Dealer Account Details

      Purpose Dealer Accounts are just a specialised sundry creditor account that records amounts that are to be paid out to third parties as a result of system processes. These processes include paying out loan funds, dealer commission or brokerage. The ...

    • 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 Account Transactions API

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

    • Unit Fund Account Type Setup

      Purpose To allow for different types of Unit Fund Accounts to be created, such as Unit Fund and Loan Repayments Each Account Type can be assigned a different Unit Value if required Access Accounts | Edit/View Account Types | | Unit Fund Account Type ...

    • Call Saving Account Details

      Purpose Call Accounts are used to record investments on call. The system does allow accounts to have debit balances also (overdrawn). This account structure may also be used for processing shares and dividends. Timing New Call Accounts may be viewed ...