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::SetEsrQR method space
Sets the ESR information of type enEsrQR or enEsrQRplus.
 
Caution: 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/SetEsrQR
[JSON input data] pIGeneralInvoiceRequest:
eEsrType:
bstrIBAN:
bstrReferenceNumber:
bstrCustomerNote:
pIBankAddress:
pICreditorAddress:
lPaymentPeriod:		 longValue,    //interface address
longValue,
"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 SetEsrQR( EsrType
BSTR
BSTR
BSTR
IAddress
IAddress
long
VARIANT_BOOL 		eEsrType,
bstrIBAN,
bstrReferenceNumber,
bstrCustomerNote,
*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] EsrType eEsrType The type of ESR, either 'enEsrQR' or 'enEsrQRplus'
[in] BSTR bstrIBAN The account number in form of a QR-IBAN supplied from the bank. The IBAN format is either the one for Switzerland or Lichtenstein.
 
Please note that a QR-IBAN basically has the digit '3' at the 5th position of the IBAN code.
[in] BSTR bstrReferenceNumber The required ESR reference number in the usual 27-digit form.
[in] BSTR bstrCustomerNote The optional customer note that is part of the QR code.
[in] IAddress *pIBankAddress The instance of an IAddress interface that defines the bank address.
 
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 The defined payment period
[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