Billing Central Apex API Developer Reference

ffbc.ContractsServiceActionApplyChangeRequest

global with sharing class ContractsServiceActionApplyChangeRequest

Invocable action to allow change requests to be applied using clicks-not-code customisations. For the API exposing this functionality, see ContractsService.applyChangeRequests For information about using the invocable method in a flow, search for "Apex action" in the Certinia Help.

Methods

applyChangeRequests

global static List<ffbc.ContractsServiceActionApplyChangeRequest.Response> applyChangeRequests(List<ffbc.ContractsServiceActionApplyChangeRequest.Request> requests)

Apply Change Requests to active contracts.

Input Parameters

Name Type Description
requests List<ffbc.ContractsServiceActionApplyChangeRequest.Request> List of request objects containing the change requests to be applied.

ffbc.ContractsServiceActionApplyChangeRequest.Request

global with sharing class Request

This class wraps the change requests to be applied and the application criteria.

Properties

Name Type Description
changeRequestId Id The ID of a change request to be applied.
disableCrediting Boolean True if Billing Central should avoid creating a credit note when applying the change request.
generateSchedules Boolean True if the billing schedules should be generated on applying the change request using the default settings. If false no schedules will be generated.

Methods

Request

global Request()

The default constructor for a Request.

ffbc.ContractsServiceActionApplyChangeRequest.Response

global with sharing class Response

The response to a request to apply a change request. This contains the change request being applied, the ID of any credit note generated as a result of applying the change request, and the errors if the change request could not be applied.

Properties

Name Type Description
changeRequestId Id The ID of a change request that the action tried to apply.
hasErrors Boolean True if there was an error applying the change request.
errorMessage String Error message if the change request was not applied successfully.
creditNoteId Id The ID of any credit note created by applying the change request, or null if none was created.

Methods

Response

global Response()

© Copyright 2009–2024 Certinia Inc. All rights reserved. Various trademarks held by their respective owners.