Accounting Apex API Developer Reference

c2g.CODAAPIBudget_8_0

global with sharing class CODAAPIBudget_8_0

This service class provides budget functionality.

Properties

Name Type Description
VERSION_STRING string The API version of this service class.
SERVICE_NAME string The service name of this service class.
OPERATION_REPLACE string Replace operation constant
OPERATION_UPDATE string Update operation constant

Methods

GetAPIVersion

webservice static string GetAPIVersion()

Used to get the latest API version.

GetServiceName

webservice static string GetServiceName()

Used to get the name of the service.

CreateBudget

Deprecated: Use the Salesforce API for CRUD operations.

webservice static c2g.CODAAPICommon.Reference CreateBudget(c2g.CODAAPICommon_8_0.Context context, c2g.CODAAPIBudgetTypes_8_0.Budget value)

This service allows you to create a budget. See "Budget and Balance Fields" and "About Budgets and Balances" in the FinancialForce Help for more details.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_8_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPIBudgetTypes_8_0.Budget Holds details of the budget you want to create.

Return Value

This web service returns a CODAAPICommon.Reference object.

UpdateBudget

Deprecated: Use the Salesforce API for CRUD operations.

webservice static c2g.CODAAPICommon.Reference UpdateBudget(c2g.CODAAPICommon_8_0.Context context, c2g.CODAAPIBudgetTypes_8_0.Budget value)

This service allows you to update a budget.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_8_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPIBudgetTypes_8_0.Budget Holds details of the budget you want to update.

Return Value

This web service returns a CODAAPICommon.Reference object.

GetBudget

Deprecated: Use the Salesforce API for CRUD operations.

webservice static c2g.CODAAPIBudgetTypes_8_0.Budget GetBudget(c2g.CODAAPICommon_8_0.Context context, c2g.CODAAPICommon.Reference value)

This service allows you to retrieve a budget.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_8_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPICommon.Reference Identifies the budget you want to retrieve.

Return Value

This web service returns a CODAAPICommon.Reference object.

UpsertBudget

Deprecated: Use the Salesforce API for CRUD operations.

webservice static c2g.CODAAPICommon.Reference UpsertBudget(c2g.CODAAPICommon_8_0.Context context, c2g.CODAAPIBudgetTypes_8_0.Budget value, String operation)

This service allows you to update an existing budget, or create a new budget if it does not already exist.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_8_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPIBudgetTypes_8_0.Budget Holds details of the budget you want to update or create (upsert).
operation String This parameter is used if the budget already exists. If the operation is "Update" the budget's existing values will be increased; if the operation is "Replace" the budget's existing values will be replaced.

Return Value

This web service returns a CODAAPICommon.Reference object.

ReportingBalanceUpdate

webservice static Integer ReportingBalanceUpdate(c2g.CODAAPICommon_8_0.Context context, Boolean incremental)

This service allows you to update reporting balances.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_8_0.Context Identifies the FinancialForce company in which the current operation executes.
incremental Boolean Mandatory. False to rebuild all the reporting balances. True to update only the budget and balances that have changed since the last execution.

Return Value

This web service returns a CODAAPICommon.Reference object.

© Copyright 2009–2020 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.