ffbc.ContractsHoldingService

global with sharing class ContractsHoldingService

PlaceLinesOnHoldRequest
PlaceLinesOnHoldResponse
ReleaseLinesRequest
ReleaseLinesResponse

This class provides service functionality around placing Billing Contract Lines on hold.

Methods

global static ffbc.ContractsHoldingService.PlaceLinesOnHoldResponse placeContractLinesOnHold(ffbc.ContractsHoldingService.PlaceLinesOnHoldRequest request)
global static ffbc.ContractsHoldingService.ReleaseLinesResponse releaseContractLines(ffbc.ContractsHoldingService.ReleaseLinesRequest request)

placeContractLinesOnHold

global static ffbc.ContractsHoldingService.PlaceLinesOnHoldResponse placeContractLinesOnHold(ffbc.ContractsHoldingService.PlaceLinesOnHoldRequest request)

Place billing contract line items on hold so that they are not available for billing. Any amounts due to be billed while the lines are on hold will be not be included when their contracts are billed. This method requires update access to the billing contract line sobject type and its 'on hold' field.

Input Parameters

Name	Type	Description
request	ffbc.ContractsHoldingService.PlaceLinesOnHoldRequest	The request containing the IDs of the billing contract lines that will be placed on hold.

Exceptions Thrown

Value	Description
BillingCentralException	Thrown when the request is invalid.

Return Value

An object containing information about the execution of the request.

releaseContractLines

global static ffbc.ContractsHoldingService.ReleaseLinesResponse releaseContractLines(ffbc.ContractsHoldingService.ReleaseLinesRequest request)

Release billing contract line items from being on hold so that they are available for billing. Any amounts not billed while the lines were on hold will be included next time their contracts are billed. This method requires update access to the billing contract line sobject type and its 'on hold' field.

Input Parameters

Name	Type	Description
request	ffbc.ContractsHoldingService.ReleaseLinesRequest	The request containing the IDs of the billing contract lines that will be released from hold.

Exceptions Thrown

Value	Description
BillingCentralException	Thrown when the request is invalid.

Return Value

An object containing information about the execution of the request.

ffbc.ContractsHoldingService.PlaceLinesOnHoldRequest

global with sharing class PlaceLinesOnHoldRequest

A request to place the given billing contract lines on hold for billing.

Properties

Name	Type	Description
ContractLineIds	Set<Id>	The IDs of the billing contract lines to be placed on hold for billing.

Methods

global PlaceLinesOnHoldRequest(Set<Id> contractLineIds)

PlaceLinesOnHoldRequest

global PlaceLinesOnHoldRequest(Set<Id> contractLineIds)

Construct a request to place the given billing contract line items on hold.

Input Parameters

Name	Type	Description
contractLineIds	Set<Id>	The IDs of the billing contract lines.

ffbc.ContractsHoldingService.PlaceLinesOnHoldResponse

global with sharing class PlaceLinesOnHoldResponse

The result of placing the contract lines on hold for billing. This currently contains no information, but exists as a placeholder to allow information to be added to the service response in future.

ffbc.ContractsHoldingService.ReleaseLinesRequest

global with sharing class ReleaseLinesRequest

A request to release the given billing contract lines for billing.

Properties

Name	Type	Description
ContractLineIds	Set<Id>	The IDs of the billing contract lines to be released for billing.

Methods

global ReleaseLinesRequest(Set<Id> contractLineIds)

ReleaseLinesRequest

global ReleaseLinesRequest(Set<Id> contractLineIds)

Construct a request to release the given billing contract line items.

Input Parameters

Name	Type	Description
contractLineIds	Set<Id>	The IDs of the billing contract lines to be released for billing.

ffbc.ContractsHoldingService.ReleaseLinesResponse

global with sharing class ReleaseLinesResponse

The result of releasing contract lines for billing. This currently contains no information, but exists as a placeholder to allow information to be added to the service response in future.