Accounting Apex API Developer Reference

c2g.RecurringJournalService

global with sharing class RecurringJournalService

The service class relating to Recurring Journals.

Methods

buildJournalList

global static List<c2g__codajournal__c> buildJournalList(List<c2g.RecurringJournalService.RecurringJournal> recurringJournalList)

This service builds a list of journal objects based on the source journal. The number of journals produced is determined by the number of objects in the recurringJournalList.

Input Parameters

Name Type Description
recurringJournalList List<c2g.RecurringJournalService.RecurringJournal> Contains the details used to build each journal in a group of recurring journals.

Return Value

This service returns a list of codajournal__c objects.

buildAndPostJournalList

global static List<c2g__codajournal__c> buildAndPostJournalList(List<c2g.RecurringJournalService.RecurringJournal> recurringJournalList)

This service builds a list of journal objects based on the source journal and posts them. The number of journals produced is determined by the number of objects in the recurringJournalList.

Input Parameters

Name Type Description
recurringJournalList List<c2g.RecurringJournalService.RecurringJournal> Contains the details used to build each journal in a group of recurring journals.

Return Value

This service returns a list of codajournal__c objects.

cancelRecurringJournals

global static List<Id> cancelRecurringJournals(List<c2g__codajournal__c> recurringJournals)

This service allows you to create canceling journals for multiple manual and reversing journals.

Input Parameters

Name Type Description
recurringJournals List<c2g__codajournal__c> The list of journals you want to cancel.

Return Value

This service returns a list of Id objects.

cancelAndPostRecurringJournals

global static List<Id> cancelAndPostRecurringJournals(List<c2g__codajournal__c> recurringJournals)

This service allows you to create and post canceling journals for multiple manual and reversing journals.

Input Parameters

Name Type Description
recurringJournals List<c2g__codajournal__c> The list of journals you want to cancel.

Return Value

This service returns a list of Id objects.

buildJournalsInBatch

global static Id buildJournalsInBatch(List<c2g.RecurringJournalService.RecurringJournal> recurringJournalList, boolean postTheJournals)

This service saves and posts recurring journals in batch.
Note that for each company, you can only run one batch at a time for recurring journals.

Input Parameters

Name Type Description
recurringJournalList List<c2g.RecurringJournalService.RecurringJournal> Contains the details used to build each journal in a group of recurring journals.
postTheJournals boolean When True, posts the recurring journals in batch.

Return Value

This service returns an Id object.

c2g.RecurringJournalService.RecurringJournal

global class RecurringJournal

This class contains the methods you need to get and set details used to create recurring journals. getJournalAmount/setJournalAmount getJournalDate/setJournalDate getJournalDescription/setJournalDescription getJournalPeriod/setJournalPeriod getRecurringDetails/setRecurringDetails getSourceJournal/setSourceJournal getSourceJournalId/setSourceJournalId - used when building and posting recurring journals in batch.

Methods

getSourceJournal

global c2g__codajournal__c getSourceJournal()

This service retrieves the source journal being used to create a group of recurring journals.

Return Value

This service returns a codajournal__c object.

setSourceJournal

global void setSourceJournal(c2g__codaJournal__c sourceJournal)

This service sets the source journal that will be used to create a group of recurring journals. The source journal must be of Type 'Manual Journal' and Status 'Complete'.

Input Parameters

Name Type Description
sourceJournal c2g__codaJournal__c The source journal.

getRecurringDetails

global List<c2g.RecurringJournalService.RecurringJournalDetails> getRecurringDetails()

This service retrieves the details being used to create a group of recurring journals.

Return Value

This service returns a list of c2g.RecurringJournalService.RecurringJournalDetails objects.

setRecurringDetails

global void setRecurringDetails(List<c2g.RecurringJournalService.RecurringJournalDetails> recurringDetails)

This service sets the details that will be used to create a group of recurring journals.

Input Parameters

Name Type Description
recurringDetails List<c2g.RecurringJournalService.RecurringJournalDetails> Contains the details for each of the recurring journals.

equals

global Boolean equals(Object obj)

Compares this object to the specified object.

Input Parameters

Name Type Description
obj Object The object to compare this RecurringJournal against.

Return Value

True if the given object represents a RecurringJournal equivalent to this RecurringJournal, false otherwise.

hashCode

global Integer hashCode()

Compares this object to the specified object.

Return Value

Returns a hash code for this RecurringJournal.

c2g.RecurringJournalService.RecurringJournalDetails

global class RecurringJournalDetails

This class stores the following details for each of the recurring journals: JournalAmount JournalDate JournalDescription JournalPeriod

Methods

getSourceJournalId

global Id getSourceJournalId()

This service retrieves the sourceJournalId used with RecurringJournalDetails when building and posting recurring journals in batch.

Return Value

This service returns an Id object.

setSourceJournalId

global void setSourceJournalId(Id sourceJournalId)

This service sets the sourceJournalId for use with RecurringJournalDetails when building and posting recurring journals in batch.

Input Parameters

Name Type Description
sourceJournalId Id Identifies the source journal.

getJournalDescription

global String getJournalDescription()

This service retrieves the description being applied to each journal in a group of recurring journals.

Return Value

This service returns a String object.

setJournalDescription

global void setJournalDescription(String journalDescription)

This service sets the description that will be applied to each journal in a group of recurring journals.

Input Parameters

Name Type Description
journalDescription String The journal description.

getJournalAmount

global Decimal getJournalAmount()

This service retrieves the amount being applied to each journal in a group of recurring journals.

Return Value

This service returns a Decimal object.

setJournalAmount

global void setJournalAmount(Decimal journalAmount)

This service sets the amount that will be applied to each journal in a group of recurring journals.

Input Parameters

Name Type Description
journalAmount Decimal The journal amount.

getJournalPeriod

global Id getJournalPeriod()

This service retrieves the period being applied to each journal in a group of recurring journals.

Return Value

This service returns an Id object.

setJournalPeriod

global void setJournalPeriod(Id journalPeriod)

This service sets the period that will be applied to each journal in a group of recurring journals.

Input Parameters

Name Type Description
journalPeriod Id The journal period.

getJournalDate

global Date getJournalDate()

This service retrieves the date being applied to each journal in a group of recurring journals.

Return Value

This service returns a Date object.

setJournalDate

global void setJournalDate(Date journalDate)

This service sets the journal date that will be applied to each journal in a group of recurring journals.

Input Parameters

Name Type Description
journalDate Date The journal date.

equals

global Boolean equals(Object obj)

Compares this object to the specified object.

Input Parameters

Name Type Description
obj Object The object to compare this RecurringJournalDetails against.

Return Value

True if the given object represents a RecurringJournalDetails equivalent to this RecurringJournalDetails, false otherwise.

hashCode

global Integer hashCode()

Compares this object to the specified object.

Return Value

Returns a hash code for this RecurringJournalDetails.

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