API browser of generalInvoiceResponse440 COM module


/images/arrow_right.png IGeneralInvoiceResponse::GetBalance method
Retrieves the balance information for the reimbursement process.

Call this method only if the main response type returned by the GetResponse method is enResponseAccepted and eHasReimbursement=enYes. In all other circumstance the balance information are undefined.

If the data stem from loading a lower version XML file, then a compatibility error is issued! If full support is needed for a lower version then there is not resort than using the native COM versions directly.

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetBalance( double
double
BSTR
BSTR
long
VARIANT_BOOL
*pdAmountDue,
*pdAmountVat,
*pbstrCurrency,
*pbstrVatNumber,
*plPaymentPeriod,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[out] double *pdAmountDue The reimbursement amount in CHF to pay back
[out] double *pdAmountVat The VAT amount in CHF.
[out] BSTR *pbstrCurrency The currency - this is fixed to "CHF" - Swiss Francs!
[out] BSTR *pbstrVatNumber The VAT number of the debitor as given by the "Swiss Federal Tax Administration". if one was supplied.

The VAT number is returned is its printed form as requested by the federal authorities.

[out] long *plPaymentPeriod The payment period in which the reimbursement should be paid back.
[out, retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string.
 
/images/arrow_right.png C/C++ return value
S_OK This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE.
S_FALSE This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE.
E_name This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions.