API browser of generalInvoiceResponse500 COM module


/images/arrow_right.png IGeneralInvoiceResponse::GetEsrRedQR method space
Retrieves the ESR information of type enRedPayinSlipQR or enRedPayinSlipQRPlus (red payin slip with QR code) for the reimbursement process.

Call this method only if the main response type returned by GetResponse is enResponseAccepted and GetAcceptType@eHasReimbursement=enYes and GetEsrType returns enRedPayinSlipQR or enRedPayinSlipQRPlus. In all other circumstance this ESR information is undefined.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceResponse/GetEsrRedQR
[JSON input data] pIGeneralInvoiceResponse: longValue,    //interface address
[JSON result data] pbstrIBAN:
pbstrRemarks:
pbstrCustomerNote:
plPaymentPeriod:
ppIESRCreditorAddress:
ppIESRDebitorAddress:
pbStatus:
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
longValue,
longValue,
longValue,
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 GetEsrRedQR( BSTR
BSTR
BSTR
long
IAddress
IAddress
VARIANT_BOOL
*pbstrIBAN,
*pbstrRemarks,
*pbstrCustomerNote,
*plPaymentPeriod,
**ppIESRCreditorAddress,
**ppIESRDebitorAddress,
*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
[out] BSTR *pbstrIBAN The account number in form of an IBAN
[out] BSTR *pbstrRemarks The optional remark that should be printed on the payin slip
[out] BSTR *pbstrCustomerNote The optional customer note that is part of the QR code.
[out] long *plPaymentPeriod The defined payment period
[out] IAddress **ppIESRCreditorAddress The instance of an IAddress interface that allows to read back the ESR creditor address.
[out] IAddress **ppIESRDebitorAddress The instance of an IAddress interface that allows to read back the ESR debitor address.
[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