/* Ċ Ġ* ĠCopyright Ġ 2 0 2 0 ĠAlex i ĠBre Ċ Ġ* Ċ Ġ* ĠLicensed Ġunder Ġthe ĠApache ĠLicense , ĠVersion Ġ 2 . 0 Ġ( the Ġ" License "); Ċ Ġ* Ġyou Ġmay Ġnot Ġuse Ġthis Ġfile Ġexcept Ġin Ġcompliance Ġwith Ġthe ĠLicense . Ċ Ġ* ĠYou Ġmay Ġobtain Ġa Ġcopy Ġof Ġthe ĠLicense Ġat Ċ Ġ* Ċ Ġ* ĠĠĠĠ Ġhttps :// www . apache . org / licenses / LICENSE - 2 . 0 Ċ Ġ* Ċ Ġ* ĠUnless Ġrequired Ġby Ġapplicable Ġlaw Ġor Ġagreed Ġto Ġin Ġwriting , Ġsoftware Ċ Ġ* Ġdistributed Ġunder Ġthe ĠLicense Ġis Ġdistributed Ġon Ġan Ġ" AS ĠIS " ĠBASIS , Ċ Ġ* ĠWITHOUT ĠWARRANTIES ĠOR ĠCONDITIONS ĠOF ĠANY ĠKIND , Ġeither Ġexpress Ġor Ġimplied . Ċ Ġ* ĠSee Ġthe ĠLicense Ġfor Ġthe Ġspecific Ġlanguage Ġgoverning Ġpermissions Ġand Ċ Ġ* Ġlimitations Ġunder Ġthe ĠLicense . Ċ Ġ*/ Ċ package Ġtech . alex ib . pl aid . client . model Ċ Ċ import Ġkotlinx . serialization . Serial Name Ċ import Ġkotlinx . serialization . Serializable Ċ Ċ /** Ċ Ġ* ĠA Ġset Ġof Ġfields Ġdescribing Ġthe Ġbalance Ġfor Ġan Ġaccount . ĠBalance Ġinformation Ġmay Ġbe Ġcached Ġunless Ċ Ġ* Ġthe Ġbalance Ġobject Ġwas Ġreturned Ġby Ġ`/ accounts / balance / get `. Ċ Ġ* Ġ@ param Ġavailable ĠThe Ġamount Ġof Ġfunds Ġavailable Ġto Ġbe Ġwithdraw n Ġfrom Ġthe Ġaccount , Ġas Ġdetermined Ġby Ċ Ġ* Ġthe Ġfinancial Ġinstitution . Ċ Ġ* Ċ Ġ* ĠFor Ġ` credit `- type Ġaccounts , Ġthe Ġ` available ` Ġbalance Ġtypically Ġequals Ġthe Ġ` limit ` Ġless Ġthe Ċ Ġ* Ġ` current ` Ġbalance , Ġless Ġany Ġpending Ġout flows Ġplus Ġany Ġpending Ġin flows . Ċ Ġ* Ċ Ġ* ĠFor Ġ` de pository `- type Ġaccounts , Ġthe Ġ` available ` Ġbalance Ġtypically Ġequals Ġthe Ġ` current ` Ġbalance Ċ Ġ* Ġless Ġany Ġpending Ġout flows Ġplus Ġany Ġpending Ġin flows . ĠFor Ġ` de pository `- type Ġaccounts , Ġthe Ġ` available ` Ċ Ġ* Ġbalance Ġdoes Ġnot Ġinclude Ġthe Ġover draft Ġlimit . Ċ Ġ* Ċ Ġ* ĠFor Ġ` invest ment `- type Ġaccounts , Ġthe Ġ` available ` Ġbalance Ġis Ġthe Ġtotal Ġcash Ġavailable Ġto Ġwithdraw Ċ Ġ* Ġas Ġpresented Ġby Ġthe Ġinstitution . Ċ Ġ* Ċ Ġ* ĠNote Ġthat Ġnot Ġall Ġinstitution s Ġcalculate Ġthe Ġ` available ` Ġ Ġbalance . ĠIn Ġthe Ġevent Ġthat Ġ` available ` Ċ Ġ* Ġbalance Ġis Ġunavailable , ĠP la id Ġwill Ġreturn Ġan Ġ` available ` Ġbalance Ġvalue Ġof Ġ` null `. Ċ Ġ* Ċ Ġ* ĠAvailable Ġbalance Ġmay Ġbe Ġcached Ġand Ġis Ġnot Ġguaranteed Ġto Ġbe Ġup - to - date Ġin Ġreal time Ġunless Ġthe Ċ Ġ* Ġvalue Ġwas Ġreturned Ġby Ġ`/ accounts / balance / get `. Ċ Ġ* Ġ@ param Ġcurrent ĠThe Ġtotal Ġamount Ġof Ġfunds Ġin Ġor Ġow ed Ġby Ġthe Ġaccount . Ċ Ġ* Ċ Ġ* ĠFor Ġ` credit `- type Ġaccounts , Ġa Ġpositive Ġbalance Ġindicates Ġthe Ġamount Ġow ed ; Ġa Ġnegative Ġamount Ċ Ġ* Ġindicates Ġthe Ġl ender Ġow ing Ġthe Ġaccount Ġholder . Ċ Ġ* Ċ Ġ* ĠFor Ġ` loan `- type Ġaccounts , Ġthe Ġcurrent Ġbalance Ġis Ġthe Ġprincipal Ġremaining Ġon Ġthe Ġloan , Ġexcept Ġin Ċ Ġ* Ġthe Ġcase Ġof Ġstudent Ġloan Ġaccounts Ġat ĠSal lie ĠM ae Ġ(` ins _ 1 1 6 9 4 4 `). ĠFor ĠSal lie ĠM ae Ġstudent Ġlo ans , Ġthe Ċ Ġ* Ġaccount 's Ġbalance Ġincludes Ġboth Ġprincipal Ġand Ġany Ġoutstanding Ġinterest . Ċ Ġ* Ċ Ġ* ĠFor Ġ` invest ment `- type Ġaccounts , Ġthe Ġcurrent Ġbalance Ġis Ġthe Ġtotal Ġvalue Ġof Ġassets Ġas Ġpresented Ġby Ċ Ġ* Ġthe Ġinstitution . Ċ Ġ* Ċ Ġ* ĠNote Ġthat Ġbalance Ġinformation Ġmay Ġbe Ġcached Ġunless Ġthe Ġvalue Ġwas Ġreturned Ġby Ċ Ġ* Ġ`/ accounts / balance / get `, Ġand Ġcurrent Ġbalance Ġinformation Ġis Ġtypically Ġnot Ġupdated Ġintra - day . ĠIf Ġyou Ċ Ġ* Ġrequire Ġreal time Ġbalance Ġinformation , Ġuse Ġthe Ġ` available ` Ġbalance Ġas Ġprovided Ġby Ċ Ġ* Ġ`/ accounts / balance / get `. Ċ Ġ* Ġ@ param Ġlimit ĠFor Ġ` credit `- type Ġaccounts , Ġthis Ġrepresents Ġthe Ġcredit Ġlimit . Ċ Ġ* Ċ Ġ* ĠFor Ġ` de pository `- type Ġaccounts , Ġthis Ġrepresents Ġthe Ġpre - arrange d Ġover draft Ġlimit , Ġwhich Ġis Ġcommon Ċ Ġ* Ġfor Ġcurrent Ġ( checking ) Ġaccounts Ġin ĠEurope . Ċ Ġ* Ċ Ġ* ĠIn ĠNorth ĠAmerica , Ġthis Ġfield Ġis Ġtypically Ġonly Ġavailable Ġfor Ġ` credit `- type Ġaccounts . Ċ Ġ* Ġ@ param Ġiso Currency Code ĠThe ĠISO - 4 2 1 7 Ġcurrency Ġcode Ġof Ġthe Ġbalance . ĠAlways Ġnull Ġif Ċ Ġ* Ġ` un official _ currency _ code ` Ġis Ġnon - null . Ċ Ġ* Ġ@ param Ġun official Currency Code ĠThe Ġun official Ġcurrency Ġcode Ġassociated Ġwith Ġthe Ġbalance . ĠAlways Ċ Ġ* Ġnull Ġif Ġ` iso _ currency _ code ` Ġis Ġnon - null . ĠU no ffic ial Ġcurrency Ġcodes Ġare Ġused Ġfor Ġc urrencies Ġthat Ġdo Ċ Ġ* Ġnot Ġhave Ġofficial ĠISO Ġcurrency Ġcodes , Ġsuch Ġas Ġcrypt oc urrencies Ġand Ġthe Ġc urrencies Ġof Ġcertain Ċ Ġ* Ġcountries . Ċ Ġ* Ċ Ġ* ĠSee Ġthe Ġ[ currency Ġcode Ġschema ](/ docs / api / accounts # currency - code - schema ) Ġfor Ġa Ġfull Ġlisting Ġof Ċ Ġ* Ġsupported Ġ` un official _ currency _ code ` s . Ċ Ġ*/ Ċ @ Serializable Ċ data Ġclass ĠAccount Balance ( ĊĠĠĠ Ġ@ Serial Name (" available ") ĊĠĠĠ Ġval Ġavailable : ĠDouble ? Ġ= Ġnull , ĊĠĠĠ Ġ@ Serial Name (" current ") ĊĠĠĠ Ġval Ġcurrent : ĠDouble , ĊĠĠĠ Ġ@ Serial Name (" limit ") ĊĠĠĠ Ġval Ġlimit : ĠDouble ? Ġ= Ġnull , ĊĠĠĠ Ġ@ Serial Name (" iso _ currency _ code ") ĊĠĠĠ Ġval Ġiso Currency Code : ĠString ? Ġ= Ġnull , ĊĠĠĠ Ġ@ Serial Name (" un official _ currency _ code ") ĊĠĠĠ Ġval Ġun official Currency Code : ĠString ? Ġ= Ġnull Ċ ) Ċ