API browser of generalInvoiceRequest450 COM module


/images/arrow_right.png IGeneralInvoiceResult::GetEsr method space
Retrieves the ESR information of type en9to16or27 or en9to16or27plus.
 
Call this method only if GetEsrType returns en9to16or27 or en9to16or27 otherwise this ESR information is undefined.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceResult/GetEsr
[JSON input data] pIGeneralInvoiceResult: longValue,    //interface address
[JSON result data] peEsrType:
pbstrParticipantNumber:
pbstrReferenceNumber:
pbstrBankAccount:
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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetEsr( EsrType
BSTR
BSTR
BSTR
IAddress
IAddress
long
VARIANT_BOOL
*peEsrType,
*pbstrParticipantNumber,
*pbstrReferenceNumber,
*pbstrBankAccount,
**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.
space
/images/arrow_right.png Calling argument description
[out] EsrType *peEsrType The type of ESR, either 'en9to16or27' or 'en9to16or27plus'
[out] BSTR *pbstrParticipantNumber The ESR participant number
[out] BSTR *pbstrReferenceNumber The ESR reference number
[out] BSTR *pbstrBankAccount The ESR bank account number
[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.
space