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


/images/arrow_right.png IGeneralCreditResult::GetServices method space
This method has a Restful Webservice representation only!
Method for collecting all service records covered by the IGeneralCreditResult interface and returned as JSON array.
 
Please note that IGeneralCreditResult::GetServices takes over the functionality of the iterator pair IGeneralCreditResult::GetFirstService / IGeneralCreditResult::GetNextService with a single call, making the latter superfluous.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralCreditResult/GetServices
[JSON input data] pIGeneralCreditResult: longValue,    //interface address
[JSON result array] { pbstrTariffType:
pbstrTariffCode:
pbstrTariffRefCode:
pbstrTariffText:
pdQuantity:
pdDateBegin:
pdTP:
pdTPV:
pdExternalFactor:
pdAmount:
pbstrRemark:
pbStatus:		 "utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
doubleValue,
"stringISODateValue",
doubleValue,
doubleValue,
doubleValue,
doubleValue,
"utf8StringValue",
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 Calling argument description
[out] BSTR *pbstrTariffType The official tariff type as defined by Forum Datenaustausch
[out] BSTR *pbstrTariffCode The tariff code as defined by the used tariff
[out] BSTR *pbstrTariffRefCode The tariff reference code if any such code was defined in the input.
[out] BSTR *pbstrTariffText The name of the tariff record as defined by the used tariff
[out] double *pdQuantity 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.
[out] DATE *pdDateBegin 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 the service date is unknown, the treatment begin date is applied.
[out] double *pdTP The tax points (TP) of the current service.
[out] double *pdTPV The tax point value (TPV) of the current service.
[out] double *pdExternalFactor The external scaling factor used to scale the service e.g. to give a discount or surcharge.
[out] double *pdAmount dAmount is the caused incurred cost given by the tariff record and calculated as follows:
dQuantity * dTP * dTPV * dExternalFactor = dAmount

 
The equation is calculated in full precision and the result rounded to 2 significant decimal places.
[out] BSTR *pbstrRemark An optional remark for the given service
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
space