The ATL COM module generalInvoiceRequest is capable of
generating electronic and printed invoices & reminders
generating electronic and printed invoices & reminders
API browser of generalInvoiceRequest430 COM module
 IGeneralInvoiceResult::GetBalance method |
|||
|---|---|---|---|
| Retrieves the balance information. |  |
||
| C/C++ calling syntax |
|||
| HRESULT GetBalance( | double
double double double double double VARIANT_BOOL |
*pdAmount,
*pdAmountObligatory, *pdAmountPrepaid, *pdAmountReminder, *pdAmountDue, *pdAmountVat, *pbStatus); |
|
| Calling argument description |
|||
| [out] double | *pdAmount | The total amount in CHF of the invoice/reminder accumulated over all 2-digit precision service amounts. Therefore, the amount implicitly has a 2-digit precision as well.
Note that amount is negative if a credit advice or a storno request is produced. |
|
| [out] double | *pdAmountObligatory | The total amount in CHF of obligatory services (eIsObligatory = enObligationYes) accumulated over the 2-digit precision service amounts. Therefore, the amount implicitly has a 2-digit precision as well.
Note that amount might be negative if a credit advice or a storno request is produced. |
|
| [out] double | *pdAmountPrepaid | The prepaid amount in CHF of the invoice/reminder rounded to 2-digit precision that is subtracted from the total amount to calculate the amount due.
This amount can only be set in the /IGeneralInvoiceRequest::SetTiers method. Furthermore this amount changes the sign if a credit advice or a storno request is produced. |
|
| [out] double | *pdAmountReminder | The optional reminder charge in CHF of the reminder rounded to 2-digit precision that is added to the total amount to calculate the amount due.
This amount can only be set in the /IGeneralInvoiceRequest::SetReminder method. Furthermore this amount changes the sign if a credit advice or a storno request is produced. |
|
| [out] double | *pdAmountDue | The due amount in CHF of the invoice/reminder (and coded into the ESR payment transaction) calculated as
where the used summands are 2-digit precision amounts and the result is finally rounded half up ("Kaufmännisches Runden") Note that amount is negative if a credit advice or a storno request is produced. |
|
| [out] double | *pdAmountVat | The total VAT amount in CHF accumulated over all 2-digit precision service VAT amounts. Therefore, the total VAT amount implicitly has a 2-digit precision as well. | |
| [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. | |
| 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. | ||