Journal functions
AddEntry
Declaration
void AddEntry(GroupJournalDictionary dictionary, string key, GroupJournal value)Description
Adds a new journal with a specific key to a dictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to add to.
|
key
|
The key to add.
|
value
|
The journal to add.
|
Return Value
Does not return a value.
AddEntry
Declaration
void AddEntry(CompanyJournalDictionary dictionary, string key, CompanyJournal value)Description
Adds a new journal with a specific key to a dictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to add to.
|
key
|
The key to add.
|
value
|
The journal to add.
|
Return Value
Does not return a value.
AddEntry
Declaration
void AddEntry(GroupSegmentJournalDictionary dictionary, string key, GroupSegmentJournal value)Description
Adds a new journal with a specific key to a dictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to add to.
|
key
|
The key to add.
|
value
|
The journal to add.
|
Return Value
Does not return a value.
AddEntry
Declaration
void AddEntry(CompanySegmentJournalDictionary dictionary, string key, CompanySegmentJournal value)Description
Adds a new journal with a specific key to a dictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to add to.
|
key
|
The key to add.
|
value
|
The journal to add.
|
Return Value
Does not return a value.
ConsolidationAddCompanyJournalLine
Declaration
void ConsolidationAddCompanyJournalLine(CompanyJournal journal, string intercompany, string account, string detail, string description, double debit, double credit)Description
Adds a journal line to a company journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to add the line to.
|
intercompany
|
The intercompany to post to.
|
account
|
The account to post to.
|
detail
|
The detail to post to. Can be empty if no schedules should be used.
|
description
|
The description text of the line.
|
debit
|
The debit amount.
|
credit
|
The credit amount.
|
Return Value
Does not return a value.
ConsolidationAddCompanySegmentJournalLine
Declaration
void ConsolidationAddCompanySegmentJournalLine(CompanySegmentJournal journal, string intercompany, string account, string detail, string s1, string ps1, string s2, string ps2, string s3, string ps3, string description, double debit, double credit)Description
Adds a journal line to a company segment journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to add the line to.
|
intercompany
|
The intercompany to post to.
|
account
|
The account to post to.
|
detail
|
The schedule detail to post to.
|
s1
|
The first segment to post to.
|
ps1
|
The first partner segment to post to.
|
s2
|
The second segment to post to.
|
ps2
|
The second partner segment to post to.
|
s3
|
The third segment to post to.
|
ps3
|
The third partner segment to post to.
|
description
|
The description text of the line.
|
debit
|
The debit amount.
|
credit
|
The credit amount.
|
Return Value
Does not return a value.
ConsolidationAddGroupJournalLine
Declaration
void ConsolidationAddGroupJournalLine(GroupJournal journal, string company, string intercompany, string account, string detail, string description, double debit, double credit)Description
Adds a journal line to a company journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to add the line to.
|
company
|
The company to post to.
|
intercompany
|
The intercompany to post to.
|
account
|
The account to post to.
|
detail
|
The detail to post to. Can be empty if no schedules should be used.
|
description
|
The description text of the line.
|
debit
|
The debit amount.
|
credit
|
The credit amount.
|
Return Value
Does not return a value.
ConsolidationAddGroupSegmentJournalLine
Declaration
void ConsolidationAddGroupSegmentJournalLine(GroupSegmentJournal journal, string company, string intercompany, string account, string detail, string s1, string ps1, string s2, string ps2, string s3, string ps3, string description, double debit, double credit)Description
Adds a journal line to a group segment journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to add the line to.
|
company
|
The company to post to.
|
intercompany
|
The intercompany to post to.
|
account
|
The account to post to.
|
detail
|
The schedule detail to post to.
|
s1
|
The first segment to post to.
|
ps1
|
The first partner segment to post to.
|
s2
|
The second segment to post to.
|
ps2
|
The second partner segment to post to.
|
s3
|
The third segment to post to.
|
ps3
|
The third partner segment to post to.
|
description
|
The description text of the line.
|
debit
|
The debit amount.
|
credit
|
The credit amount.
|
Return Value
Does not return a value.
ConsolidationCancelCompanyJournals
Declaration
bool ConsolidationCancelCompanyJournals(JournalStore store, string cycle, string year, string period, string scenario, string company, string category, string level)Description
Cancels company journals filtered by the provided arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
A cycle to filter the journals.
|
year
|
A year to filter the journals.
|
period
|
A period to filter the journals.
|
scenario
|
A scenario to filter the journals.
|
company
|
A company to filter the journals.
|
category
|
A category to filter the journals.
|
level
|
The level at which to filter the journals. Leave empty to filter at all levels.
|
Return Value
True if successful, false otherwise.
ConsolidationCancelCompanySegmentJournals
Declaration
bool ConsolidationCancelCompanySegmentJournals(JournalStore store, string cycle, string year, string period, string scenario, string company, string category, string level)Description
Cancels company segment journals filtered by the provided arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
A cycle to filter the journals.
|
year
|
A year to filter the journals.
|
period
|
A period to filter the journals.
|
scenario
|
A scenario to filter the journals.
|
company
|
A company to filter the journals.
|
category
|
A category to filter the journals.
|
level
|
The level at which to filter the journals. Leave empty to filter at all levels.
|
Return Value
True if successful, false otherwise.
ConsolidationCancelGroupJournals
Declaration
bool ConsolidationCancelGroupJournals(JournalStore store, string cycle, string year, string period, string scenario, string group, string category, string level)Description
Cancels group journals filtered by the provided arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
A cycle to filter the journals.
|
year
|
A year to filter the journals.
|
period
|
A period to filter the journals.
|
scenario
|
A scenario to filter the journals.
|
group
|
A company to filter the journals.
|
category
|
A category to filter the journals.
|
level
|
The level at which to filter the journals. Leave empty to filter at all levels.
|
Return Value
True if successful, false otherwise.
ConsolidationCancelGroupSegmentJournals
Declaration
bool ConsolidationCancelGroupSegmentJournals(JournalStore store, string cycle, string year, string period, string scenario, string group, string category, string level)Description
Cancels group segment journals filtered by the provided arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
A cycle to filter the journals.
|
year
|
A year to filter the journals.
|
period
|
A period to filter the journals.
|
scenario
|
A scenario to filter the journals.
|
group
|
A group to filter the journals.
|
category
|
A category to filter the journals.
|
level
|
The level at which to filter the journals. Leave empty to filter at all levels.
|
Return Value
True if successful, false otherwise.
ConsolidationCopyParameters
Declaration
bool ConsolidationCopyParameters(StringArray parameterNames, string sourceCycle, string sourceVersion, string sourcePeriod, string sourceYear, string targetCycle, string targetVersion, string targetPeriod, string targetYear)Description
Copies the parameter settings of a given source context to target context.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
parameterNames
|
Parameters to be copied.
|
sourceCycle
|
The source cycle.
|
sourceVersion
|
The source version.
|
sourcePeriod
|
The source period.
|
sourceYear
|
The source year.
|
targetCycle
|
The target cycle.
|
targetVersion
|
The target version.
|
targetPeriod
|
The target period.
|
targetYear
|
The target year.
|
Return Value
True if successful, false otherwise.
ConsolidationCreateCompanyJournal
Declaration
CompanyJournal ConsolidationCreateCompanyJournal(JournalStore store, string cycle, string year, string period, string scenario, string company, string level, string category, string description, bool automatic)Description
Creates a new company journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal store.
|
cycle
|
A cycle to filter the journals.
|
year
|
The year to post to.
|
period
|
The period to post to.
|
scenario
|
The scenario to post to.
|
company
|
The company to post to.
|
level
|
The level to post to.
|
category
|
The category of the journal.
|
description
|
The comment of the journal.
|
automatic
|
Indicates whether the journal should be marked automatic.
|
Return Value
The new journal.
ConsolidationCreateCompanyJournal
Declaration
CompanyJournal ConsolidationCreateCompanyJournal(JournalStore store, string cycle, string year, string period, string scenario, string company, string level, string category, string description, bool automatic, string recurringJournalId)Description
Creates a new company journal with recurring journal reference.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal store.
|
cycle
|
A cycle to filter the journals.
|
year
|
The year to post to.
|
period
|
The period to post to.
|
scenario
|
The scenario to post to.
|
company
|
The company to post to.
|
level
|
The level to post to.
|
category
|
The category of the journal.
|
description
|
The comment of the journal.
|
automatic
|
Indicates whether the journal should be marked automatic.
|
recurringJournalId
|
The recurring ID reference of the journal.
|
Return Value
The new journal.
ConsolidationCreateCompanySegmentJournal
Declaration
CompanySegmentJournal ConsolidationCreateCompanySegmentJournal(JournalStore store, string cycle, string year, string period, string scenario, string company, string level, string segmentlevel, string category, string description, bool automatic)Description
Creates a new company segment journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal store.
|
cycle
|
A cycle to filter the journals.
|
year
|
The year to post to.
|
period
|
The period to post to.
|
scenario
|
The scenario to post to.
|
company
|
The company to post to.
|
level
|
The level to post to.
|
segmentlevel
|
The segment level to post to.
|
category
|
The category of the journal.
|
description
|
The comment of the journal.
|
automatic
|
Indicates whether the journal should be marked automatic.
|
Return Value
The new journal.
ConsolidationCreateCompanySegmentJournal
Declaration
CompanySegmentJournal ConsolidationCreateCompanySegmentJournal(JournalStore store, string cycle, string year, string period, string scenario, string company, string level, string segmentlevel, string category, string description, bool automatic, string recurringJournalId)Description
Creates a new company segment journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal store.
|
cycle
|
A cycle to filter the journals.
|
year
|
The year to post to.
|
period
|
The period to post to.
|
scenario
|
The scenario to post to.
|
company
|
The company to post to.
|
level
|
The level to post to.
|
segmentlevel
|
The segment level to post to.
|
category
|
The category of the journal.
|
description
|
The comment of the journal.
|
automatic
|
Indicates whether the journal should be marked automatic.
|
recurringJournalId
|
The recurring ID reference of the journal.
|
Return Value
The new journal.
ConsolidationCreateGroupJournal
Declaration
GroupJournal ConsolidationCreateGroupJournal(JournalStore store, string cycle, string year, string period, string scenario, string group, string level, string category, string description, bool automatic)Description
Creates a new group journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal stores.
|
cycle
|
The cycle to post to.
|
year
|
The year to post to.
|
period
|
The period to post to.
|
scenario
|
The scenario to post to.
|
group
|
The group to post to.
|
level
|
The level to post to.
|
category
|
The category of the journal.
|
description
|
The description of the journal.
|
automatic
|
Indicates whether the journal should be marked automatic.
|
Return Value
The new journal.
ConsolidationCreateGroupJournal
Declaration
GroupJournal ConsolidationCreateGroupJournal(JournalStore store, string cycle, string year, string period, string scenario, string group, string level, string category, string description, bool automatic, string recurringJournalId)Description
Creates a new group journal with recurring journal reference.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal stores.
|
cycle
|
The cycle to post to.
|
year
|
The year to post to.
|
period
|
The period to post to.
|
scenario
|
The scenario to post to.
|
group
|
The group to post to.
|
level
|
The level to post to.
|
category
|
The category of the journal.
|
description
|
The description of the journal.
|
automatic
|
Indicates whether the journal should be marked automatic.
|
recurringJournalId
|
The recurring ID reference of the journal.
|
Return Value
The new journal.
ConsolidationCreateGroupSegmentJournal
Declaration
GroupSegmentJournal ConsolidationCreateGroupSegmentJournal(JournalStore store, string cycle, string year, string period, string scenario, string group, string grouplevel, string segmentlevel, string category, string description, bool automatic)Description
Creates a new group segment journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal store.
|
cycle
|
The cycle to post to.
|
year
|
The year to post to.
|
period
|
The period to post to.
|
scenario
|
The scenario to post to.
|
group
|
The group to post to.
|
grouplevel
|
The group level to post to.
|
segmentlevel
|
The segment level to post to.
|
category
|
The category of the journal.
|
description
|
The description of the journal.
|
automatic
|
Indicates whether the journal should be marked automatic.
|
Return Value
The new journal.
ConsolidationCreateGroupSegmentJournal
Declaration
GroupSegmentJournal ConsolidationCreateGroupSegmentJournal(JournalStore store, string cycle, string year, string period, string scenario, string group, string grouplevel, string segmentlevel, string category, string description, bool automatic, string recurringJournalId)Description
Creates a new group segment journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal store.
|
cycle
|
The cycle to post to.
|
year
|
The year to post to.
|
period
|
The period to post to.
|
scenario
|
The scenario to post to.
|
group
|
The group to post to.
|
grouplevel
|
The group level to post to.
|
segmentlevel
|
The segment level to post to.
|
category
|
The category of the journal.
|
description
|
The description of the journal.
|
automatic
|
Indicates whether the journal should be marked automatic.
|
recurringJournalId
|
The recurring ID reference of the journal.
|
Return Value
The new journal.
ConsolidationCreateJournalStore
Declaration
JournalStore ConsolidationCreateJournalStore(OLAPConnection olapConnection)Description
Creates a new journal store. A journal store is used to load and save journals.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
olapConnection
|
A connection to an OLAP server.
|
Return Value
A new journal store.
ConsolidationGetCompanyJournalLineNumericProperty
Declaration
double ConsolidationGetCompanyJournalLineNumericProperty(CompanyJournalLine line, string propertyName)Description
Gets a certain numeric property from a CompanyJournalLine object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
line
|
The journal line to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetCompanyJournalLineProperty
Declaration
string ConsolidationGetCompanyJournalLineProperty(CompanyJournalLine line, string propertyName)Description
Gets a certain string property from a CompanyJournalLine object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
line
|
The journal line to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetCompanyJournalLines
Declaration
CompanyJournalLineList ConsolidationGetCompanyJournalLines(CompanyJournal journal)Description
Gets a list of all journal lines.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to return all lines for.
|
Return Value
A list of all lines stored in a journal.
ConsolidationGetCompanyJournalProperty
Declaration
string ConsolidationGetCompanyJournalProperty(CompanyJournal journal, string propertyName)Description
Gets a certain string property from a CompanyJournal object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetCompanyJournals
Declaration
CompanyJournalList ConsolidationGetCompanyJournals(JournalStore store, string cycle, string year, string period, string scenario, string company, string category, string level, bool automatic, bool cancelled)Description
Gets a list of company journals corresponding to the filters provided as arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
A cycle to filter the journals.
|
year
|
The year to filter.
|
period
|
The period to filter.
|
scenario
|
The scenario to filter.
|
company
|
The company to filter. If empty, companies will not be filtered.
|
category
|
The category to filter.
|
level
|
The level to filter.
|
automatic
|
If true, only automatic journals are returned.
|
cancelled
|
If true, only canceled journals are returned.
|
Return Value
The list of group journals matching the filters.
ConsolidationGetCompanyJournals
Declaration
CompanyJournalList ConsolidationGetCompanyJournals(JournalStore store, string cycle, string year, string period, string scenario, string company, string category, string level, string account, bool automatic, bool cancelled)Description
Gets a list of company journals corresponding to the filters provided as arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
A cycle to filter the journals.
|
year
|
The year to filter.
|
period
|
The period to filter.
|
scenario
|
The scenario to filter.
|
company
|
The company to filter. If empty, companies will not be filtered.
|
category
|
The category to filter.
|
level
|
The level to filter.
|
account
|
The account to filter.
|
automatic
|
If true, only automatic journals are returned.
|
cancelled
|
If true, only canceled journals are returned.
|
Return Value
The list of group journals matching the filters.
ConsolidationGetCompanySegmentJournalLineNumericProperty
Declaration
double ConsolidationGetCompanySegmentJournalLineNumericProperty(CompanyJournalLine line, string propertyName)Description
Receives a certain numeric property from a CompanySegmentJournalLine object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
line
|
The journal line to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetCompanySegmentJournalLineProperty
Declaration
string ConsolidationGetCompanySegmentJournalLineProperty(CompanyJournalLine line, string propertyName)Description
Receives a certain string property from a CompanySegmentJournalLine object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
line
|
The journal line to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetCompanySegmentJournalLines
Declaration
CompanySegmentJournalLineList ConsolidationGetCompanySegmentJournalLines(CompanySegmentJournal journal)Description
Receives a list of all journal lines belonging to a CompanySegmentJournal object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The CompanySegmentJournal object to return all lines for.
|
Return Value
A list of all lines stored in a journal.
ConsolidationGetCompanySegmentJournalProperty
Declaration
string ConsolidationGetCompanySegmentJournalProperty(CompanySegmentJournal journal, string propertyName)Description
Receives a certain string property from a CompanySegmentJournal object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetCompanySegmentJournals
Declaration
CompanySegmentJournalList ConsolidationGetCompanySegmentJournals(JournalStore store, string cycle, string year, string period, string scenario, string company, string category, string level, bool automatic, bool cancelled)Description
Gets a list of company segment journals corresponding to the filters provided as arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
The cycle to filter
|
year
|
The year to filter.
|
period
|
The period to filter.
|
scenario
|
The scenario to filter.
|
company
|
The company to filter. If empty, companies will not be filtered.
|
category
|
The category to filter.
|
level
|
The level to filter.
|
automatic
|
If true, only automatic journals are returned.
|
cancelled
|
If true, only canceled journals are returned.
|
Return Value
The list of group journals matching the filters.
ConsolidationGetCompanySegmentJournals
Declaration
CompanySegmentJournalList ConsolidationGetCompanySegmentJournals(JournalStore store, string cycle, string year, string period, string scenario, string company, string category, string level, string account, bool automatic, bool cancelled)Description
Gets a list of company segment journals corresponding to the filters provided as arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
The cycle to filter
|
year
|
The year to filter.
|
period
|
The period to filter.
|
scenario
|
The scenario to filter.
|
company
|
The company to filter. If empty, companies will not be filtered.
|
category
|
The category to filter.
|
level
|
The level to filter.
|
account
|
The account to filter.
|
automatic
|
If true, only automatic journals are returned.
|
cancelled
|
If true, only canceled journals are returned.
|
Return Value
The list of group journals matching the filters.
ConsolidationGetGroupJournalLineNumericProperty
Declaration
double ConsolidationGetGroupJournalLineNumericProperty(GroupJournalLine line, string propertyName)Description
Gets a certain numeric property from a GroupJournalLine object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
line
|
The journal line to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetGroupJournalLineProperty
Declaration
string ConsolidationGetGroupJournalLineProperty(GroupJournalLine line, string propertyName)Description
Gets a certain string property from a GroupJournalLine object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
line
|
The journal line to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetGroupJournalLines
Declaration
GroupJournalLineList ConsolidationGetGroupJournalLines(GroupJournal journal)Description
Gets a list of all journal lines.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to return all lines for.
|
Return Value
A list of all lines stored in a journal.
ConsolidationGetGroupJournalProperty
Declaration
string ConsolidationGetGroupJournalProperty(GroupJournal journal, string propertyName)Description
Gets a certain string property from a GroupJournal object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetGroupJournals
Declaration
GroupJournalList ConsolidationGetGroupJournals(JournalStore store, string cycle, string year, string period, string scenario, string group, string category, string level, bool automatic, bool cancelled)Description
Gets a list of group journals corresponding to the filters provided as arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
The cycle to filter.
|
year
|
The year to filter.
|
period
|
The period to filter.
|
scenario
|
The scenario to filter.
|
group
|
The group to filter. If empty, groups will not be filtered.
|
category
|
The category to filter.
|
level
|
The level to filter.
|
automatic
|
If true, only automatic journals are returned.
|
cancelled
|
If true, only canceled journals are returned.
|
Return Value
The list of group journals matching the filters.
ConsolidationGetGroupJournals
Declaration
GroupJournalList ConsolidationGetGroupJournals(JournalStore store, string cycle, string year, string period, string scenario, string group, string category, string level, string account, bool automatic, bool cancelled)Description
Gets a list of group journals corresponding to the filters provided as arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
The cycle to filter.
|
year
|
The year to filter.
|
period
|
The period to filter.
|
scenario
|
The scenario to filter.
|
group
|
The group to filter. If empty, groups will not be filtered.
|
category
|
The category to filter.
|
level
|
The level to filter.
|
account
|
The account to filter.
|
automatic
|
If true, only automatic journals are returned.
|
cancelled
|
If true, only canceled journals are returned.
|
Return Value
The list of group journals matching the filters.
ConsolidationGetGroupSegmentJournalLineNumericProperty
Declaration
double ConsolidationGetGroupSegmentJournalLineNumericProperty(GroupJournalLine line, string propertyName)Description
Receives a certain numeric property from a GroupSegmentJournalLine object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
line
|
The journal line to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetGroupSegmentJournalLineProperty
Declaration
string ConsolidationGetGroupSegmentJournalLineProperty(GroupJournalLine line, string propertyName)Description
Receives a certain string property from a GroupSegmentJournalLine object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
line
|
The journal line to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetGroupSegmentJournalLines
Declaration
GroupSegmentJournalLineList ConsolidationGetGroupSegmentJournalLines(GroupSegmentJournal journal)Description
Receives a list of all journal lines belonging to a GroupSegmentJournal object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The GroupSegmentJournal object to return all lines for.
|
Return Value
A list of all lines stored in a journal.
ConsolidationGetGroupSegmentJournalProperty
Declaration
string ConsolidationGetGroupSegmentJournalProperty(GroupSegmentJournal journal, string propertyName)Description
Receives a certain string property from a GroupSegmentJournal object.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to return the property for.
|
propertyName
|
Name of the property to be returned.
|
Return Value
The property named 'propertyName'.
ConsolidationGetGroupSegmentJournals
Declaration
GroupSegmentJournalList ConsolidationGetGroupSegmentJournals(JournalStore store, string cycle, string year, string period, string scenario, string group, string category, string level, bool automatic, bool cancelled)Description
Gets a list of group segment journals corresponding to the filters provided as arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
The cycle to filter.
|
year
|
The year to filter.
|
period
|
The period to filter.
|
scenario
|
The scenario to filter.
|
group
|
The group to filter. If empty, groups will not be filtered.
|
category
|
The category to filter.
|
level
|
The level to filter.
|
automatic
|
If true, only automatic journals are returned.
|
cancelled
|
If true, only canceled journals are returned.
|
Return Value
The list of group segment journals matching the filters.
ConsolidationGetGroupSegmentJournals
Declaration
GroupSegmentJournalList ConsolidationGetGroupSegmentJournals(JournalStore store, string cycle, string year, string period, string scenario, string group, string category, string level, string account, bool automatic, bool cancelled)Description
Gets a list of group segment journals corresponding to the filters provided as arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
The cycle to filter.
|
year
|
The year to filter.
|
period
|
The period to filter.
|
scenario
|
The scenario to filter.
|
group
|
The group to filter. If empty, groups will not be filtered.
|
category
|
The category to filter.
|
level
|
The level to filter.
|
account
|
The account to filter.
|
automatic
|
If true, only automatic journals are returned.
|
cancelled
|
If true, only canceled journals are returned.
|
Return Value
The list of group segment journals matching the filters.
ConsolidationGetRecurringCompanyJournals
Declaration
CompanyJournalList ConsolidationGetRecurringCompanyJournals(JournalStore store, string cycle, string year, string period, string scenario, string company)Description
Gets a list of recurring company journals corresponding to the filters provided as arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
A cycle to filter the journals.
|
year
|
The year to filter.
|
period
|
The period to filter.
|
scenario
|
The scenario to filter.
|
company
|
The company to filter.
|
Return Value
The list of recurring company journals matching the filters.
ConsolidationGetRecurringGroupJournals
Declaration
GroupJournalList ConsolidationGetRecurringGroupJournals(JournalStore store, string cycle, string year, string period, string scenario, string group)Description
Gets a list of recurring group journals corresponding to the filters provided as arguments.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The store to manage the journals.
|
cycle
|
The cycle to filter.
|
year
|
The year to filter.
|
period
|
The period to filter.
|
scenario
|
The scenario to filter.
|
group
|
The group to filter.
|
Return Value
The list of recurring group journals matching the filters.
ConsolidationJournalDifference
Declaration
double ConsolidationJournalDifference(CompanyJournal journal)Description
Gets the total difference of debit and credit for a journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to evaluate.
|
Return Value
The total debit credit difference.
ConsolidationJournalDifference
Declaration
double ConsolidationJournalDifference(CompanySegmentJournal journal)Description
Gets the total difference of debit and credit for a journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to evaluate.
|
Return Value
The total debit credit difference.
ConsolidationJournalDifference
Declaration
double ConsolidationJournalDifference(GroupJournal journal)Description
Gets the total difference of debit and credit for a journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to evaluate.
|
Return Value
The total debit credit difference.
ConsolidationJournalDifference
Declaration
double ConsolidationJournalDifference(GroupSegmentJournal journal)Description
Gets the total difference of debit and credit for a journal.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to evaluate.
|
Return Value
The total debit credit difference.
ConsolidationJournalIsBalanced
Declaration
bool ConsolidationJournalIsBalanced(CompanyJournal journal)Description
Indicates whether a company journal is balanced.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to check.
|
Return Value
True if the journal is balanced, false if not.
ConsolidationJournalIsBalanced
Declaration
bool ConsolidationJournalIsBalanced(CompanySegmentJournal journal)Description
Indicates whether a company segment journal is balanced.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to check.
|
Return Value
True if the journal is balanced, false if not.
ConsolidationJournalIsBalanced
Declaration
bool ConsolidationJournalIsBalanced(GroupJournal journal)Description
Indicates whether a journal is balanced.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to check.
|
Return Value
True if the journal is balanced, false if not.
ConsolidationJournalIsBalanced
Declaration
bool ConsolidationJournalIsBalanced(GroupSegmentJournal journal)Description
Indicates whether a journal is balanced.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to check.
|
Return Value
True if the journal is balanced, false if not.
ConsolidationJournalIsEmpty
Declaration
bool ConsolidationJournalIsEmpty(CompanyJournal journal)Description
Indicates whether a journal is empty, i.e. it has no journal lines.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to check.
|
Return Value
True if the journal is empty, false if not.
ConsolidationJournalIsEmpty
Declaration
bool ConsolidationJournalIsEmpty(CompanySegmentJournal journal)Description
Indicates whether a journal is empty, i.e. it has no journal lines.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to check.
|
Return Value
True if the journal is empty, false if not.
ConsolidationJournalIsEmpty
Declaration
bool ConsolidationJournalIsEmpty(GroupJournal journal)Description
Indicates whether a journal is empty, i.e. it has no journal lines.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to check.
|
Return Value
True if the journal is empty, false if not.
ConsolidationJournalIsEmpty
Declaration
bool ConsolidationJournalIsEmpty(GroupSegmentJournal journal)Description
Indicates whether a journal is empty, i.e. it has no journal lines.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
journal
|
The journal to check.
|
Return Value
True if the journal is empty, false if not.
ConsolidationPostJournal
Declaration
int ConsolidationPostJournal(JournalStore store, CompanyJournal journal)Description
Posts a company journal to the journal store and the journal values to the OLAP server.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal store to post to.
|
journal
|
The journal to post.
|
Return Value
The resulting journal number.
ConsolidationPostJournal
Declaration
int ConsolidationPostJournal(JournalStore store, CompanySegmentJournal journal)Description
Posts a company segment journal to the journal store and the journal values to the OLAP server.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal store to post to.
|
journal
|
The journal to post.
|
Return Value
The resulting journal number.
ConsolidationPostJournal
Declaration
int ConsolidationPostJournal(JournalStore store, GroupJournal journal)Description
Posts a group journal to the journal store and the journal values to the OLAP server.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal store to post to.
|
journal
|
The journal to post.
|
Return Value
The resulting journal number.
ConsolidationPostJournal
Declaration
int ConsolidationPostJournal(JournalStore store, GroupSegmentJournal journal)Description
Posts a group segment journal to the journal store and the journal values to the OLAP server.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
store
|
The journal store to post to.
|
journal
|
The journal to post.
|
Return Value
The resulting journal number.
CreateCompanyJournalDictionary
Declaration
CompanyJournalDictionary CreateCompanyJournalDictionary()Description
Creates a new company journal dictionary.
Supported Runtime Versions
5.0
Parameters
The function has no parameters.
Return Value
The new dictionary.
CreateCompanySegmentJournalDictionary
Declaration
CompanySegmentJournalDictionary CreateCompanySegmentJournalDictionary()Description
Creates a new company segment journal dictionary.
Supported Runtime Versions
5.0
Parameters
The function has no parameters.
Return Value
The new dictionary.
CreateGroupJournalDictionary
Declaration
GroupJournalDictionary CreateGroupJournalDictionary()Description
Creates a new group journal dictionary.
Supported Runtime Versions
5.0
Parameters
The function has no parameters.
Return Value
The new dictionary.
CreateGroupSegmentJournalDictionary
Declaration
GroupSegmentJournalDictionary CreateGroupSegmentJournalDictionary()Description
Creates a new group segment journal dictionary.
Supported Runtime Versions
5.0
Parameters
The function has no parameters.
Return Value
The new dictionary.
GetEntry
Declaration
GroupJournal GetEntry(GroupJournalDictionary dictionary, string key)Description
Gets a journal with a specific key from a dictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to read from.
|
key
|
The key of the journal to get.
|
Return Value
The journal corresponding to the key.
GetEntry
Declaration
CompanyJournal GetEntry(CompanyJournalDictionary dictionary, string key)Description
Gets a journal with a specific key from a dictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to read from.
|
key
|
The key of the journal to get.
|
Return Value
The journal corresponding to the key.
GetEntry
Declaration
GroupSegmentJournal GetEntry(GroupSegmentJournalDictionary dictionary, string key)Description
Gets a journal with a specific key from a dictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to read from.
|
key
|
The key of the journal to get.
|
Return Value
The journal corresponding to the key.
GetEntry
Declaration
CompanySegmentJournal GetEntry(CompanySegmentJournalDictionary dictionary, string key)Description
Gets a journal with a specific key from a dictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to read from.
|
key
|
The key of the journal to get.
|
Return Value
The journal corresponding to the key.