PrincipalBalance Property
Amount of the loan principal balance for the current statement.
Syntax
ANSI (Cross Platform) char* GetPrincipalBalance(); Unicode (Windows) LPWSTR GetPrincipalBalance();
@property (nonatomic,readonly,assign,getter=principalBalance) NSString* principalBalance; - (NSString*)principalBalance;
#define PID_LOANSTATEMENT_PRINCIPALBALANCE 39 IPWORKSOFX_EXTERNAL void* IPWORKSOFX_CALL IPWorksOFX_LoanStatement_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
Default Value
""
Remarks
This value reflects the loan principle balance as posted in the financial institution's records.
Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.
Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting. .
This property is read-only.
Data Type
String