Accounting Apex API Developer Reference

c2g.CODASelectionWebService

global with sharing class CODASelectionWebService

The service class relating to Selector API used for sending mass email and retrieving FinancialForce documents and transactions via Microsoft Excel.

Enums

enumObject

The list of valid options for selection of object type.

Value Description
CashEntry Specify this type if you want to retrieve Cash Entry object type.
CashEntryLineItem Specify this type if you want to retrieve Cash Entry Line Item object type.
Invoice Specify this type if you want to retrieve Invoice object type.
InvoiceLineItem Use this type if you want to retrieve Invoice Line Item object type.
InvoiceInstallmentLineItem Use this type if you want to retrieve Invoice Installment Line Item object type.
Journal Use this type if you want to retrieve Journal object type.
JournalLineItem Use this type if you want to retrieve Journal Line Item object type.
CreditNote Use this type if you want to retrieve Credit Note object type.
CreditNoteLineItem Use this type if you want to retrieve Credit Note Line Item object type.
Transact Use this type if you want to retrieve Transaction object type.
TransactionLineItem Use this type if you want to retrieve Transaction Line Item object type.
PaymentMediaSummary Use this type if you want to retrieve Payment Media Summary object type.
PaymentMediaDetail Use this type if you want to retrieve Payment Media Detail object type.
PurchaseCreditNote Use this type if you want to retrieve Purchase Credit Note object type.
PurchaseCreditNoteLineItem Use this type if you want to retrieve Purchase Credit Note Line Item object type.
PurchaseCreditNoteExpenseLineItem Use this type if you want to retrieve Purchase Credit Note Expense Line Item object type.
PurchaseInvoice Use this type if you want to retrieve Purchase Invoice object type.
PurchaseInvoiceLineItem Use this type if you want to retrieve Purchase Invoice Line Item object type.
PurchaseInvoiceExpenseLineItem Use this type if you want to retrieve Purchase Invoice Expense Line Item object type.
Budget Use this type if you want to retrieve Budget object type.
BankStatement Use this type if you want to retrieve Bank Statement object type.
BankStatementLineItem Use this type if you want to retrieve Bank Statement Line Item object type.
ReportingBalance Use this type if you want to retrieve Reporting Balance object type.

enumOperator

The list of valid options for operators to specify in selection criteria.

Value Description
Equal The equal operator.
Distinct The operator to fetch distinct values only.
Lower The operator to get lower values.
Greater The operator to get greater values.
LowerOrEqual The operator to get lower or equal values.
GreaterOrEqual The operator to get greater or equal values.
Between The operator to get values between a range.
StartsWith The operator to get data starting with a given value.
EndsWith The operator to get data ending with a given value.
Contains The operator to get data witch contains a given value.

enumType

The list of valid options for field types to specify in selection.

Value Description
TypeBoolean Use this if field type is Boolean.
TypeString Use this if field type is String.
TypeNumber Use this if field type is Number.
TypeReference Use this if field type is Reference.
TypeDate Use this if field type is Date.
TypeDateTime Use this if field type is DateTime.
TypeEnum Use this if field type is Enum.
TypeId Use this if field type is Id.
TypePercent Use this if field type is Percent.

enumSortDirection

The list of valid options to specify sort directions.

Value Description
Ascending Use this if sort direction is Ascending.
Descending Use this if sort direction is Descending.

c2g.CODASelectionWebService.ObjectField

global with sharing class ObjectField

Holds information about a Object field used in Selection.

Properties

Name Type Description
Path String The Path to field. If the field is from related object, specify full path.
Label String The label of field.
FieldType c2g.CODASelectionWebService.enumType The type of field.

c2g.CODASelectionWebService.SelectionCriterion

global with sharing Class SelectionCriterion

Holds information about a Selection Criterion.

Properties

Name Type Description
Field c2g.CODASelectionWebService.ObjectField The field for criterion.
Operator c2g.CODASelectionWebService.enumOperator The operator for criterion.
ValueFrom string From value for a range.
ValueTo string To value for a range.

c2g.CODASelectionWebService.SortOrder

global with sharing Class SortOrder

Holds information about a Sort Order in Selection.

Properties

Name Type Description
Field c2g.CODASelectionWebService.ObjectField The field to apply sort on.
Direction c2g.CODASelectionWebService.enumSortDirection The direction of sort.

c2g.CODASelectionWebService.Selection

global with sharing class Selection

Holds the selection definition you want to create.

Properties

Name Type Description
SelectionHeaderObject c2g.CODASelectionWebService.enumObject The Header object to retrieve for selection.
SelectionLineItemObject c2g.CODASelectionWebService.enumObject The Child object to retrieve for selection.
HeaderFields List<c2g.CODASelectionWebService.ObjectField> The Header object's fields to retrieve for selection.
LineItemFields List<c2g.CODASelectionWebService.ObjectField> The Child object's fields to retrieve for selection.
HeaderCriteria List<c2g.CODASelectionWebService.SelectionCriterion> The Selection Criterion for Header object.
LineItemCriteria List<c2g.CODASelectionWebService.SelectionCriterion> The Selection Criterion for Child object.
Company String The company for which selection is being done.
SelectionDescription String The Description for Selection.
SelectionSortOrder List<c2g.CODASelectionWebService.SortOrder> The sort order of retrieved records.
© Copyright 2009–2020 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.