Billing Central Apex API Developer Reference

ffbc.ContractsServiceActionActivate

global with sharing class ContractsServiceActionActivate

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

Methods

activate

global static List<ffbc.ContractsServiceActionActivate.Response> activate(List<ffbc.ContractsServiceActionActivate.Request> requests)

Activate Billing Contracts.

Input Parameters

Name Type Description
requests List<ffbc.ContractsServiceActionActivate.Request> List of request objects containing the contracts to be activated.

Return Value

A list of response objects containing the contracts to be activated and any errors that occurred during the activation process.

ffbc.ContractsServiceActionActivate.Request

global with sharing class Request

This class wraps the contract to be activated and the activation criteria.

Properties

Name Type Description
contractId Id The ID of a billing contract to be activated.
generateSchedules Boolean True if the billing schedules should be generated on activation using the default settings. If false no schedules will be generated.

Methods

Request

global Request()

The default constructor for a Request.

ffbc.ContractsServiceActionActivate.Response

global with sharing class Response

The response to a request to activate contracts. This contains the contract being activated and the errors if the contract cannot be activated.

Properties

Name Type Description
contractId Id The ID of the billing contract to be activated.
hasErrors Boolean True if there was an error activating the contract.
errorMessages List<String> Error messages if the contract was not activated successfully.

Methods

Response

global Response()

The default constructor for a Response.

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