The ATL COM module generalInvoiceRequest is capable of
generating electronic and printed invoices & reminders
generating electronic and printed invoices & reminders
API browser of generalInvoiceRequest500 COM module
 IGeneralInvoiceResult::GetRequest method |
 |
||
|---|---|---|---|
| Returns the primary parameters of the request, namely the language the data is supplied, the "storno" and "copy" status besides an optional remark. | |||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/IGeneralInvoiceResult/GetRequest | ||
| [JSON input data] | pIGeneralInvoiceResult: | longValue, //interface address |
|
| [JSON result data] | peDataLanguage: peRoleType: pePlaceType: pbstrRoleTitle: peRequestType: peRequestSubtype: pbstrRemark: pbstrGUID: pbStatus: |
longValue, longValue, longValue, "utf8StringValue", longValue, longValue, "utf8StringValue", "utf8StringValue", booleanValue |
|
| [HTTP result status] | 200 | Return status 200 signals a successful method call | |
| 204 | Return status 204 (noContent) signals that the end of an iteration is reached | ||
| >= 400 | Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do. | ||
| |||
| C/C++ calling syntax |
|||
| HRESULT GetRequest( | LanguageType
RoleType PlaceType BSTR RequestType RequestSubtype BSTR BSTR VARIANT_BOOL |
*peDataLanguage,
*peRoleType, *pePlaceType, *pbstrRoleTitle, *peRequestType, *peRequestSubtype, *pbstrRemark, *pbstrGUID, *pbStatus); |
|
| [C/C++ return value] | S_OK | This value is returned if the function call was successful. | |
| S_FALSE | This value is returned if the end of an iteration is reached | ||
| 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. | ||
| |||
| Calling argument description |
|||
| [out] LanguageType | *peDataLanguage | Gets the language in which the data part is coded. It is exactly the language in which the request 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] RequestType | *peRequestType | Gets the principle type of request encoded by a terminal set of tokens. | |
| [out] RequestSubtype | *peRequestSubtype | Gets the allowed subtype of request encoded by a terminal set of tokens. | |
| [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] BSTR | *pbstrGUID | Gets the unique GUID (Globally Unique IDentifier) allocated to the current XML infoset defined as a 32 hex-digit string covered by the pattern [A-Fa-f0-9]{32}. |
|
| [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. | |
|
|||