generating electronic and printed invoices & reminders
 IGeneralInvoiceResult::GetRequest method |
|||
|---|---|---|---|
| Retrieves the role and place information, the processing parameters "storno" and "copy" besides data language and optional remark. |  |
||
| C/C++ calling syntax |
|||
| HRESULT GetRequest( | LanguageType
RoleType PlaceType BSTR YesNoType YesNoType BSTR VARIANT_BOOL |
*peDataLanguage,
*peRoleType, *pePlaceType, *pbstrRoleTitle, *peIsStorno, *peIsCopy, *pbstrRemark, *pbStatus); |
|
| Calling argument description |
|||
| [out] LanguageType | *peDataLanguage | Sets the language in which the data part is coded. It is exactly the language in which the response is formulated.
Note, that the data language and the module language (given by IGeneralInvoiceRequestManager::SetModuleLanguage) are independent and can be different! |
|
| [out] RoleType | *peRoleType | Defines the role categories that the main provider is best categorized.
If the main provider has an other role than defined then use enRoleOther and additionally supply a role title with a description of the role |
|
| [out] PlaceType | *pePlaceType | Defines the principle place where the main provider is applying the treatment | |
| [out] BSTR | *pbstrRoleTitle | Optional role title/description of the main provider.
If a suitable predefined role can not be set then bstrRoleTitle is mandatory (use enRoleOther as role in that case) |
|
| [out] YesNoType | *peIsStorno | Boolean value that defines the "storno" status of the invoice/reminder.
eIsStorno should be false when the initial invoice or reminder is produced. At this step the timestamp is generated and returned in the GeneralInvoiceRequestManager::Print and/or GeneralInvoiceRequestManager::GetXML method. Whenever eIsStorno is true then the invoice or reminder timestamp must be set otherwise an error will result. |
|
| [out] YesNoType | *peIsCopy | Boolean value that defines the "copy" status of the invoice/reminder.
eIsCopy should be false when the initial invoice or reminder is produced. At this step the timestamp is generated and returned in the IGeneralInvoiceRequestManager::Print and/or IGeneralInvoiceRequestRequestManager::GetXML method. Whenever eIsCopy is true then the invoice or reminder timestamp must be set otherwise an error will result. |
|
| [out] BSTR | *pbstrRemark | An overall optional remark for the invoice/reminder
Note that the reminder text is printed instead of the remark if bstrReminderText is set in the IGeneralInvoiceRequest::SetReminder method. |
|
| [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. | ||