The ATL COM module generalInvoiceRequest is capable of
generating electronic and printed invoices & reminders
API browser of generalInvoiceRequest500 COM module


/images/arrow_right.png IGeneralInvoiceRequest::SetRequest method space
Sets the primary parameters of the request, namely the language the data is supplied, the "storno" and "copy" status besides an optional remark.
 
Note, that whenever the "storno" and/or "copy" parameters are set then the timestamp of the topmost object reference (SetInvoice or SetReminder) must be defined as >0 otherwise an error will result in the Finalize method.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceRequest/SetRequest
[JSON input data] pIGeneralInvoiceRequest:
eRoleType:
ePlaceType:
bstrRoleTitle:
eRequestType:
eRequestSubtype:
bstrRefundList:
bstrRemark:		 longValue,    //interface address
longValue,
longValue,
"utf8StringValue",
longValue,
longValue,
"utf8StringValue",
"utf8StringValue"
[JSON result data] pbStatus: 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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT SetRequest( RoleType
PlaceType
BSTR
RequestType
RequestSubtype
BSTR
BSTR
VARIANT_BOOL 		eRoleType,
ePlaceType,
bstrRoleTitle,
eRequestType,
eRequestSubtype,
bstrRefundList,
bstrRemark,
*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.
space
/images/arrow_right.png Calling argument description
[in] RoleType eRoleType 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
[in] PlaceType ePlaceType Defines the principle place where the main provider is applying the treatment
[in] BSTR bstrRoleTitle 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)
[in] RequestType eRequestType Defines the principle type of request encoded by a terminal set of tokens.
 
Currently, there are two request types allowed: 'invoice' and 'reminder'
[in] RequestSubtype eRequestSubtype Subspecifies the XML infoset with respect to its modification from the standard data space.
Such a modification can be seen as a request variation, subsuming a specific data set, where the set of discrete subtypes is encoded by a terminal set of tokens.
[in] BSTR bstrRefundList If eRequestSubtype= enRequestSubtypeRefund and services have been prior loaded using LoadXML than the quantity of services given in the supplied comma-separated list of service Ids are multiplied by -1, whereas the quantity of the remaining services are nullified.
[in] BSTR bstrRemark 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 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.
space