The generalCreditRequest ATL COM module for
generating electronic and paper based credit requests
API browser of generalCreditRequest450 COM module


/images/arrow_right.png IGeneralCreditRequest::AddService method space
Adds a service record from a simple/normal tariff to the list of services. The services describes an applied treatment part in terms of incurred costs.

The term "normal" means a tariff with a simple (code, name, tax point, tax point value) structure as opposed to "extended" tariffs like the Tarmed. If a record from an extended tariff should be added than supply TP(medical)+TP(technical) as tax point.
 
If the return status is VARIANT_FALSE then the service record is not added to the list of services

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralCreditRequest/AddService
[JSON input data] pIGeneralCreditRequest:
bstrTariffType:
bstrTariffCode:
bstrReferenceCode:
bstrTariffText:
dQuantity:
dDateBegin:
dTP:
dTPV:
dExternalFactor:
bstrRemark:		 longValue,    //interface address
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
doubleValue,
variantDateValue | "stringISODateValue",
doubleValue,
doubleValue,
doubleValue,
"utf8StringValue"
[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 AddService( BSTR
BSTR
BSTR
BSTR
double
DATE
double
double
double
BSTR
VARIANT_BOOL 		bstrTariffType,
bstrTariffCode,
bstrReferenceCode,
bstrTariffText,
dQuantity,
dDateBegin,
dTP,
dTPV,
dExternalFactor,
bstrRemark,
*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] BSTR bstrTariffType The official tariff type as defined by Forum Datenaustausch
[in] BSTR bstrTariffCode The tariff code as defined by the used tariff catalog
[in] BSTR bstrReferenceCode A reference code to define a master-slave connection between two service records. Please note, that the tariff code implies the existence of a reference code.
[in] BSTR bstrTariffText The name of the tariff record as defined by the used tariff
[in] double dQuantity The quantity of the current service.
 
Note, that the quantity is defined as double, spanning zero and positive fractional values!
  • a zero quantity is used for "non-billable" and "pro memoria" services
  • positive quantities are used for "normal" services
  • fractional values are used whenever a part of the "full" service is used (e.g. quantity=0.5 for 500ml of a 1000ml infusion solution)
  • negative quantities are set for a storno to reflect the negative incurred cost situation
The quantity must not be rounded but given in full precision.
[in] DATE dDateBegin The supposed application date of the service.
 
Please note, that the service date defines the existence of a service as well as the correct TP and TPV. Therefore, if you do not know the service date, supply the treatment begin date (SetTreatment) for all services.
[in] double dTP The tax points (TP) of the current service.
[in] double dTPV The tax point value (TPV) of the current service.
[in] double dExternalFactor The external scaling factor used to scale the service e.g. to give a discount or surcharge.
 
The external scale factor can as well be used to define a customer cost splitting situation (for example, between a KV and IV insurance or between a canton and a KV insurance).
[in] BSTR bstrRemark An optional remark for the given service.
[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