TxPrincipal Property
This is the amount of payment applied to Principal.
Syntax
ANSI (Cross Platform) char* GetTxPrincipal(int iTxIndex); Unicode (Windows) LPWSTR GetTxPrincipal(INT iTxIndex);
- (NSString*)txPrincipal:(int)txIndex;
#define PID_LOANSTATEMENT_TXPRINCIPAL 64 IPWORKSOFX_EXTERNAL void* IPWORKSOFX_CALL IPWorksOFX_LoanStatement_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal); IPWORKSOFX_EXTERNAL int IPWORKSOFX_CALL IPWorksOFX_LoanStatement_CheckIndex(void *lpObj, int propid, int arridx);
Default Value
""
Remarks
This is the amount of payment applied to Principal.
This is applicable to loan statements only.
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. .
The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.
This property is read-only and not available at design time.
Data Type
String