The generalInvoiceResponse ATL COM module loads &
analyzes electronic responses to general invoice requests
analyzes electronic responses to general invoice requests
API browser of generalInvoiceResponse450 COM module
IGeneralInvoiceResponse::GetBalance method | |||
---|---|---|---|
Retrieves the balance information for the reimbursement process.
Call this method only if the main response type returned by GetResponse is enResponseAccepted and GetAcceptType@eHasReimbursement=enYes. In all other circumstance the balance information is undefined. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralInvoiceResponse/GetBalance | ||
[JSON input data] | pIGeneralInvoiceResponse: | longValue, //interface address |
|
[JSON result data] | pdAmountDue: pdAmountVat: pbstrCurrency: pbstrVatNumber: plPaymentPeriod: pbStatus: |
doubleValue, doubleValue, "utf8StringValue", "utf8StringValue", 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 GetBalance( | double
double BSTR BSTR long VARIANT_BOOL |
*pdAmountDue,
*pdAmountVat, *pbstrCurrency, *pbstrVatNumber, *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] double | *pdAmountDue | The reimbursement amount in CHF to pay back. | |
[out] double | *pdAmountVat | The total VAT amount in CHF. | |
[out] BSTR | *pbstrCurrency | The currency of the ESR - this is fixed to "CHF" - Swiss Francs! | |
[out] BSTR | *pbstrVatNumber | The VAT number of the ESR creditor (mostly the insurance) as given by the "Swiss Federal Tax Administration". if one was supplied.
The VAT number is returned is its printed form as requested by the federal authorities. |
|
[out] long | *plPaymentPeriod | The payment period in which the reimbursement should be paid back. | |
[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. | |