API browser of generalInvoiceResponse450 COM module


/images/arrow_right.png IGeneralInvoiceResponse::GetEsrRed method space
Retrieves the ESR information of type enRedPayinSlip (red payin slip) for the reimbursement process.

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

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceResponse/GetEsrRed
[JSON input data] pIGeneralInvoiceResponse: longValue,    //interface address
[JSON result data] pbstrPostAccount:
pbstrIBAN:
pbstrReferenceNumber:
pbstrRemarks:
pIBankAddress:
pICreditorAddress:
pIDebitorAddress:
pbStatus:
"utf8StringValue",
"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 GetEsrRed( BSTR
BSTR
BSTR
BSTR
IAddress
IAddress
IAddress
VARIANT_BOOL
*pbstrPostAccount,
*pbstrIBAN,
*pbstrReferenceNumber,
*pbstrRemarks,
**pIBankAddress,
**pICreditorAddress,
**pIDebitorAddress,
*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 *pbstrPostAccount Postal account number
[out] BSTR *pbstrIBAN The IBAN number

The IBAN number is defined only if it is a bank transaction - the IBankAddress interface handle is not NULL in this situation.

[out] BSTR *pbstrReferenceNumber 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.

[out] BSTR *pbstrRemarks The optional remark that should be printed on the payin slip
[out] 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.
[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] IAddress **pIDebitorAddress The instance of an IAddress interface that allows to read back the ESR debitor address.

If no address is defined then the handle is NULL.

[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