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


/images/arrow_right.png IGeneralInvoiceRequest::SetReminder method space
Sets 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".
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceRequest/SetReminder
[JSON input data] pIGeneralInvoiceRequest:
bstrRequestReminderID:
dRequestReminderDate:
lRequestReminderTimestamp:
lReminderLevel:
bstrReminderText:
dAmountReminder:		 longValue,    //interface address
"utf8StringValue",
variantDateValue | "stringISODateValue",
longValue,
longValue,
"utf8StringValue",
doubleValue
[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 SetReminder( BSTR
DATE
long
long
BSTR
double
VARIANT_BOOL 		bstrRequestReminderID,
dRequestReminderDate,
lRequestReminderTimestamp,
lReminderLevel,
bstrReminderText,
dAmountReminder,
*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] BSTR bstrRequestReminderID 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.
[in] DATE dRequestReminderDate 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.
[in] long lRequestReminderTimestamp This is a UNIX timestamp defined at the moment of the reminder infoset generation. Set this variable 0 to indicate the generation of a new reminder object reference. The IGeneralInvoiceRequestManager::GetXML and/or IGeneralInvoiceRequestManager::Print method will return the timestamp that must be used from that point on as 3rd parameter of the object reference.
 
This is one of 3 identifiers that form the reminder object reference. The timestamp will be generated once for a certain reminder object reference and thereafter the timestamp is always referenced.
[in] long lReminderLevel The lReminderLevel is the main software's reminder level ("Mahnstufe") which must be between 1 and 3.
[in] BSTR bstrReminderText 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 here.
[in] double dAmountReminder 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.
space