Package de.aeb.xnsg.billing.bf
Interface IBillingBF
@BusinessFacade
public interface IBillingBF
Billing related business facade methods.
-
Method Summary
Modifier and TypeMethodDescriptionAcknowledge that changed settlements were processed and should no longer be returned bygetChangedSettlements(BGetChangedSettlementsRequestDTO)
.Cancel the service items in the Billing engine.
Cancel a service item will try to logically remove the service item with all of its settelement items, if this is possible.
In some cases the cancellation of service items is not (or no longer) possible and will lead to errors.
E.g.Create new ServiceItems in the Billing engine.
Depending on switches in request.parms, the items may or may not be priced immediately and may or may not be settled immediately.
All processing of all items will be done in one transaction, so in case of any error nothing will be persisted.Returns all billing scenarios for the given clientReturns all services for the given client and billing scenario as optional parameter.Returns all changed settlements.Returns all service items for the given client.Offset the service items in the Billing engine.
Offsetting a service item will offset all relevant settlement items of this service item, by creating exact copies of the relevant settlement items with reversed sign.
Depending on customizing, some settlement items will not take part in offsetting the service item and some settlement items will prevent any offsetting at all, which leads to an error.
The processing of all items will be done in one transaction, so in case of any error, nothing will be persisted.Create or update multiple Services in the Billing engine.
Create or update multiple services in the master file data of the engine.This method does the same as createServiceItems(), but does not really store the results in the database of the engine (no side effects).
So this method can e.g.
-
Method Details
-
createServiceItems
Create new ServiceItems in the Billing engine.
Depending on switches in request.parms, the items may or may not be priced immediately and may or may not be settled immediately.
All processing of all items will be done in one transaction, so in case of any error nothing will be persisted. Check the message arrays in the response for any error to detect this case.
The following errors may happen:
- Retransmission of an item (having the same itemId and client system id and not beeing cancelled before)
- Missing or improper customizing settings for handling the item, e.g. using undefined itemId's, undefined companyNumbers of any party, improper customized contracts, price schemas or price components, and similar.- Parameters:
request
-- Returns:
- BCreateServiceItemsResponseDTO
-
simulateCreateServiceItems
This method does the same as createServiceItems(), but does not really store the results in the database of the engine (no side effects).
So this method can e.g. be used to precalculate prices for potential service items or just for testing purposes.- Parameters:
request
-- Returns:
-
getServiceItems
Returns all service items for the given client.- Parameters:
request
-- Returns:
-
cancelServiceItems
Cancel the service items in the Billing engine.
Cancel a service item will try to logically remove the service item with all of its settelement items, if this is possible.
In some cases the cancellation of service items is not (or no longer) possible and will lead to errors.
E.g. the service item can not be found, or some of the settlement items of the service item can not or no longer be logically removed.
The processing of all items will be done in one transaction, so in case of any error, nothing will be persisted. Therefore check the errorFlag and message arrays in the response for any error to detect this case.- Parameters:
request
-- Returns:
-
offsetServiceItems
Offset the service items in the Billing engine.
Offsetting a service item will offset all relevant settlement items of this service item, by creating exact copies of the relevant settlement items with reversed sign.
Depending on customizing, some settlement items will not take part in offsetting the service item and some settlement items will prevent any offsetting at all, which leads to an error.
The processing of all items will be done in one transaction, so in case of any error, nothing will be persisted. Therefore check the errorFlag and error message arrays in the response for any error to detect this case.- Parameters:
request
-- Returns:
-
setServiceMasterFileData
BSetServiceMasterFileDataResponseDTO setServiceMasterFileData(BSetServiceMasterFileDataRequestDTO request) Create or update multiple Services in the Billing engine.
Create or update multiple services in the master file data of the engine. Because of performance and transactional issues it is recommended to transfer about 100 services within one synchronous call. All transfered services will be either created or updated. The identCode and scenarioIdentCode (these are key values) of the service will be checked before processing. In case of any unfilled key value, nothing will be done. In case of other problems for a single service e.g locking or invalid identCode values the processing is usually continued with the next service, skipping, the problematic service. This means the record will be skipped completely and processing will continue with the next service. Anyway such errors will set the hasErrors or hasWarnings to true. To analyse situations check the response for details. Possible messageIdentCodes are documented inAbstractResponseDTO
andBSetServiceMasterFileDataResponseDTO
andBServiceMFResultDTO
and [@link AbstractResponseItemDTO} andBServiceMFResultDTO
- Parameters:
request
-- Returns:
-
getBillingServices
Returns all services for the given client and billing scenario as optional parameter.- Parameters:
parms
-- Returns:
-
getBillingScenarios
Returns all billing scenarios for the given client- Parameters:
parms
-- Returns:
-
getChangedSettlements
Returns all changed settlements.
This method should be used together with
acknowledgeChangedSettlements(BAcknowledgeChangedSettlementsRequestDTO)
.- Parameters:
request
-- Returns:
- See Also:
-
acknowledgeChangedSettlements
BAcknowledgeChangedSettlementsResponseDTO acknowledgeChangedSettlements(BAcknowledgeChangedSettlementsRequestDTO request) Acknowledge that changed settlements were processed and should no longer be returned bygetChangedSettlements(BGetChangedSettlementsRequestDTO)
.- Parameters:
request
-- Returns:
-