API browser of generalInvoiceRequest450 COM module


/images/arrow_right.png IGeneralInvoiceRequest::SetTiers method space
Sets the Tiers Garant (TG) or Tiers Payant (TP) mode together with the VAT number.
 
  • In the TG case a prepaid amount can be defined, such that the due amount is calculated as «amount + reminder amount - prepaid amount».
  • In the TP case the prepaid amount must be zero, as the debitor is not the patient (that prepaid the amount!)!
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceRequest/SetTiers
[JSON input data] pIGeneralInvoiceRequest:
eTiersMode:
bstrVatNumber:
dAmountPrepaid:
longValue,    //interface address
longValue,
"utf8StringValue",
doubleValue
[JSON result data] pbStatus: 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 SetTiers( TiersModeType
BSTR
double
VARIANT_BOOL
eTiersMode,
bstrVatNumber,
dAmountPrepaid,
*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
[in] TiersModeType eTiersMode The tiers mode ("Tiers Garant" or "Tiers Payant") is set from the TiersMode enumeration list
[in] BSTR bstrVatNumber The VAT number of the biller as given by the "Swiss Federal Tax Administration". if he possesses one.
 
Both forms the old 6-digit number as well as the new UID dependent number are allowed. The latter one can be given in its full form, as UID, or just the digits whereas the last digit is automatically expanded if missing.
[in] double dAmountPrepaid The prepaid amount.
The due amount is calculated as «amount + reminder amount - prepaid amount»
 
As of version 450, the prepaid amount is fixed to 0.00 in the TP case. If this rule is violated then an error is returned from the finalizing step Finalize.
[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