Accounting API Developer's Reference

c2g.CODAAPIMappingFormat_2_0

global with sharing class CODAAPIMappingFormat_2_0

The service class relating to Mapping Formats. These are used when loading data into FinancialForce Accounting from Microsoft Excel.

Properties

Name Type Description
VERSION_STRING String The API version.
SERVICE_NAME String The name of the service.

Methods

GetAPIVersion

webservice static String GetAPIVersion()

Used to get the latest API version.

Return Value

Text

GetServiceName

webservice static String GetServiceName()

Used to get the name of the service.

Return Value

Text

CreateMappingFormat

webservice static c2g.CODAAPICommon.Reference CreateMappingFormat(c2g.CODAAPICommon_2_0.Context context, c2g.CODAAPIMappingFormatTypes_2_0.MappingFormat value, String name, boolean overrideExisting)

This service allows you to create a data map for loading data into FinancialForce using Microsoft Excel. See the FinancialForce XL Help for more information.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_2_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPIMappingFormatTypes_2_0.MappingFormat Holds details of the mapping format you want to create.
name String The name of an existing mapping format that you want to override. Leave this blank if you do not want to override an existing mapping format.
overrideExisting boolean Set to true if you want this mapping format to override the existing format identified by the 'name' parameter.

Return Value

This web service returns a CODAAPICommon.Reference object.

GetMappingFormat

webservice static c2g.CODAAPIMappingFormatTypes_2_0.MappingFormat GetMappingFormat(c2g.CODAAPICommon_2_0.Context context, c2g.CODAAPICommon.Reference value)

This service allows you to retrieve a mapping format.

Input Parameters

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

Return Value

This web service returns a c2g.CODAAPIMappingFormatTypes_2_0.MappingFormat object.

GetMappingFormatsByUserAndType

webservice static List<String> GetMappingFormatsByUserAndType(c2g.CODAAPICommon_2_0.Context context, String objectUser, String objectType)

This service allows you to retrieve mapping formats by user or object type.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_2_0.Context Identifies the FinancialForce company in which the current operation executes.
objectUser String The user you are interested in.
objectType String The object type you are interested in.

Return Value

This web service returns a list of String objects.