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::SetEsrRed method space
Sets the ESR information of type enRedPayinSlip (red payin slip).
 
Caution: As of 30.09.2022, the processing of red and orange payment slips will be discontinued - the usage of the methods SetEsr() and/or SetEsrRed()is thus deprecated!
As of 01.10.2022 all payments must be processed exclusively using the new QR method (SetEsrQR() and SetEsrRedQR() methods).
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceRequest/SetEsrRed
[JSON input data] pIGeneralInvoiceRequest:
bstrPostAccount:
bstrIBAN:
bstrReferenceNumber:
bstrRemarks:
pIBankAddress:
pICreditorAddress:
lPaymentPeriod:		 longValue,    //interface address
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
longValue,
longValue,
longValue
[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 SetEsrRed( BSTR
BSTR
BSTR
BSTR
IAddress
IAddress
long
VARIANT_BOOL 		bstrPostAccount,
bstrIBAN,
bstrReferenceNumber,
bstrRemarks,
*pIBankAddress,
*pICreditorAddress,
lPaymentPeriod,
*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 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 red 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] IAddress *pICreditorAddress The instance of an IAddress interface that defines the creditor address.
 
If a NULL address is defined than a clone of the biller's address is automatically assigned in the Finalize method. However, due to the Anti-Money Laundering Act, Art. 95, 98 FC, the naming of the creditor should be the same as on the bank account and this naming scheme might be different from the biller's address.
[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.
space