GET api/user/{id}/contraaccountsbalance

Get user's contra accounts balance for a given user id.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/user/{id}/contraaccountsbalance. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique identifier of a user.

 integer

Required

Body Parameters

None.

Response Information

Response Codes

Success Status:

  • OK (200), please see resource description below.

Failed Status(es):

Resource Description

User's accounts balance for each currency.

Collection of UserGLLinkDto
NameDescriptionTypeAdditional information
AccountID

Unique identifier of a user's contra account.

 integer
AccountBalance

Balnce of a contra account.

 string

Response Formats

application/json, text/json

Sample: 
[
  {
    "accountID": 1,
    "accountBalance": "sample string 1"
  },
  {
    "accountID": 1,
    "accountBalance": "sample string 1"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfUserGLLinkDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <UserGLLinkDto>
    <AccountBalance>sample string 1</AccountBalance>
    <AccountID>1</AccountID>
  </UserGLLinkDto>
  <UserGLLinkDto>
    <AccountBalance>sample string 1</AccountBalance>
    <AccountID>1</AccountID>
  </UserGLLinkDto>
</ArrayOfUserGLLinkDto>