generating electronic and printed invoices & reminders
 IGeneralInvoiceResult::GetReminder method |
|||
|---|---|---|---|
|
Retrieves the reminder object reference parameters.
The credit, invoice and reminder object references (if supplied in the request) form a object reference chain (credit -> invoice -> reminder) with the reminder as topmost object reference if supplied in the request otherwise the invoice is the topmost object reference (the invoice object is mandatory in all cases!). The page "object reference" provides an in-depth description of the concepts of "object reference", "object reference chain", and "topmost object reference". |
 |
||
| C/C++ calling syntax |
|||
| HRESULT GetReminder( | BSTR
DATE long long BSTR double VARIANT_BOOL |
*pbstrRequestReminderID,
*pdRequestReminderDate, *plRequestReminderTimestamp, *plReminderLevel, *pbstrReminderText, *pdAmountReminder, *pbStatus); |
|
| Calling argument description |
|||
| [out] BSTR | *pbstrRequestReminderID | The request ID is the main software's identification of the reminder ("Mahnnummer").
This is one of 3 identifiers that form the reminder object reference. |
|
| [out] DATE | *pdRequestReminderDate | The request date is the main software's date of the reminder request ("Mahndatum").
This is one of 3 identifiers that form the reminder object reference. |
|
| [out] long | *plRequestReminderTimestamp | This is a UNIX timestamp defined at the moment of the reminder's infoset generation.
This is one of 3 identifiers that form the reminder object reference. |
|
| [out] long | *plReminderLevel | The lReminderLevel is the main software's reminder level ("Mahnstufe") which must be between 1 and 3. | |
| [out] BSTR | *pbstrReminderText | A reminder text that is either in plain text format or RTF format.
Note that the reminder text is printed instead of the remark if bstrReminderText is set in the IGeneralInvoiceRequest::SetReminder method. |
|
| [out] double | *pdAmountReminder | The optional reminder charge. | |
| [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. | ||