GET api/units/{unitId}/accountbalance

Get unit's account balance

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
unitId

(Required)

 integer

Required

Body Parameters

None.

Response Information

Resource Description

AccountInformation
NameDescriptionTypeAdditional information
Status

Account Status

 string

None.
AccountNumber

Account Number

 string

None.
Balance

Account Balance

 decimal number

None.
LastPayDate

Account Last Payment Date

 string

None.
LastPayAmount

Account Last Payment Amount

 decimal number

None.

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "AccountNumber": "sample string 2",
  "Balance": 3.0,
  "LastPayDate": "sample string 4",
  "LastPayAmount": 5.0
}

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)
  • 105: ResourceNotLinkedToUser
    (User is trying to access a resource that belongs to a property not linked to the user., Forbidden)