API browser of generalInvoiceRequest440 COM module


/images/arrow_right.png IGeneralInvoiceRequest::SetEsrRed method
Sets the information for red payin slips (aka esrRed).
 
Please note, that the IBAN number is used to extract the accounting number of the creditor at the bank. This accounting number is part of codingline 1 and must be build purely from digits. In seldom cases valid Swiss IBAN numbers can contain letters, in which case the extraction process for the accounting number eventually fails! There is no technical remedy for this situation, as there is no rule how to translate the letters to digits.
 
In such a case, the accounting number must be appended to the IBAN number, separated by a '#', e.g bstrIBAN = 'IBAN#accountingNumber'.
space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT SetEsrRed( BSTR
BSTR
BSTR
BSTR
IAddress
long
VARIANT_BOOL
bstrPostAccount,
bstrIBAN,
bstrReferenceNumber,
bstrRemarks,
*pIBankAddress,
lPaymentPeriod,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[in] BSTR bstrPostAccount Postal account number
[in] BSTR bstrIBAN The IBAN number.
 
In cases where the IBAN contains letters, the accounting number must be appended to the IBAN number, separated by a '#', e.g bstrIBAN = 'IBAN#accountingNumber'. If the accounting number is not given, an error is generated.
 
The IBAN number is defined only if it is a bank transaction - the IBankAddress interface handle is not NULL in this situation.
[in] BSTR bstrReferenceNumber Reference number with the coded bank account if it is a bank transaction
 
Note that this reference number is copied to the remarks section if it is a postal based invoice because there is no reference section in the coding line 1.
[in] BSTR bstrRemarks The optional remark that should be printed on the payin slip
[in] IAddress *pIBankAddress The IBankAddress is an IAddress interface handle to the bank address. The handle allows to get the bank's structured address data back.
If no address is defined then the handle is NULL.
[in] long lPaymentPeriod Payment period for the invoice/reminder
[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.
 
/images/arrow_right.png 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.