The ATL COM module generalInvoiceRequest is capable of
generating electronic and printed invoices & reminders
generating electronic and printed invoices & reminders
API browser of generalInvoiceRequest450 COM module
IGeneralInvoiceResult::GetEsrQR method | |||
---|---|---|---|
Retrieves the ESR information of type enEsrQR or enEsrQRplus.
Call this method only if GetEsrType returns enEsrQR or enEsrQRplus otherwise this ESR information is undefined. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralInvoiceResult/GetEsrQR | ||
[JSON input data] | pIGeneralInvoiceResult: | longValue, //interface address |
|
[JSON result data] | peEsrType: pbstrIBAN: pbstrReferenceNumber: bstrCustomerNote: pIBankAddress: pICreditorAddress: plPaymentPeriod: pbStatus: |
longValue, "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. | ||
C/C++ calling syntax | |||
HRESULT GetEsrQR( | EsrType
BSTR BSTR BSTR IAddress IAddress long VARIANT_BOOL |
*peEsrType,
*pbstrIBAN, *pbstrReferenceNumber, *bstrCustomerNote, **pIBankAddress, **pICreditorAddress, *plPaymentPeriod, *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. | ||
Calling argument description | |||
[out] EsrType | *peEsrType | The type of ESR, either 'enEsrQR' or 'enEsrQRplus' | |
[out] BSTR | *pbstrIBAN | The account number in form of an QR-IBAN | |
[out] BSTR | *pbstrReferenceNumber | The ESR reference number in the usual 27-digit form. | |
[out] BSTR | *bstrCustomerNote | The optional customer note that is part of the QR code. | |
[out] IAddress | **pIBankAddress | The instance of an IAddress interface that allows to read back the bank address.
If no address is defined then the handle is NULL. |
|
[out] IAddress | **pICreditorAddress | The instance of an IAddress interface that allows to read back the ESR creditor address.
If no address is defined then the handle is NULL. |
|
[out] long | *plPaymentPeriod | 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. | |