Journal functions
AddCompanyJournalLine
Declaration
void AddCompanyJournalLine(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
1.0, 2.0, 3.0, 4.0, 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.
AddCompanySegmentJournalLine
Declaration
void AddCompanySegmentJournalLine(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
1.0, 2.0, 3.0, 4.0, 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.
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
1.0, 2.0, 3.0, 4.0, 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
1.0, 2.0, 3.0, 4.0, 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
1.0, 2.0, 3.0, 4.0, 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
1.0, 2.0, 3.0, 4.0, 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.
AddGroupJournalLine
Declaration
void AddGroupJournalLine(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
1.0, 2.0, 3.0, 4.0, 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.
AddGroupSegmentJournalLine
Declaration
void AddGroupSegmentJournalLine(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
1.0, 2.0, 3.0, 4.0, 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.
CancelCompanyJournals
Declaration
bool CancelCompanyJournals(JournalStore store, string year, string period, string scenario, string company, string category, string level)
Description
Cancels company journals filtered by the provided arguments.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The store to manage 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
|
A level to filter the journals. The level can be empty to consider any level. |
Return Value
True, if successful, false otherwise.
CancelCompanySegmentJournals
Declaration
bool CancelCompanySegmentJournals(JournalStore store, 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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The store to manage 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
|
A level to filter the journals. The level can be empty to consider any level. |
Return Value
True, if successful, false otherwise.
CancelGroupJournals
Declaration
bool CancelGroupJournals(JournalStore store, string year, string period, string scenario, string group, string category, string level)
Description
Cancels group journals filtered by the provided arguments.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The store to manage 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
|
A level to filter the journals. The level can be empty to consider any level. |
Return Value
True, if successful, false otherwise.
CancelGroupSegmentJournals
Declaration
bool CancelGroupSegmentJournals(JournalStore store, 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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The store to manage 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
|
A level to filter the journals. The level can be empty to consider any level. |
Return Value
True, if successful, false otherwise.
ContainsKey
Declaration
bool ContainsKey(IntDictionary dictionary, string key)
Description
Checks whether an IntDictionary contains a certain key.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The IntDictionary to be checked. |
key
|
The key to look up. |
Return Value
True, if the dictionary contains the key. False, if it does not contain the key.
ContainsKey
Declaration
bool ContainsKey(StringDictionary dictionary, string key)
Description
Checks whether a StringDictionary contains a certain key.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The StringDictionary to be checked. |
key
|
The key to look up. |
Return Value
True, if the dictionary contains the key. False, if it does not contain the key.
ContainsKey
Declaration
bool ContainsKey(DoubleDictionary dictionary, string key)
Description
Checks whether a DoubleDictionary contains a certain key.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The DoubleDictionary to be checked. |
key
|
The key to look up. |
Return Value
True, if the dictionary contains the key. False, if it does not contain the key.
ContainsKey
Declaration
bool ContainsKey(BoolDictionary dictionary, string key)
Description
Checks whether a BoolDictionary contains a certain key.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The BoolDictionary to be checked. |
key
|
The key to look up. |
Return Value
True, if the dictionary contains the key. False, if it does not contain the key.
ContainsKey
Declaration
bool ContainsKey(GroupJournalDictionary dictionary, string name)
Description
Checks whether a specific key is in the dictionary.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The dictionary to check. |
name
|
The key to check. |
Return Value
True, if the dictionary contains the key, false otherwise.
ContainsKey
Declaration
bool ContainsKey(CompanyJournalDictionary dictionary, string name)
Description
Checks whether a specific key is in the dictionary.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The dictionary to check. |
name
|
The key to check. |
Return Value
True, if the dictionary contains the key, false otherwise.
ContainsKey
Declaration
bool ContainsKey(GroupSegmentJournalDictionary dictionary, string name)
Description
Checks whether a specific key is in the dictionary.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The dictionary to check. |
name
|
The key to check. |
Return Value
True, if the dictionary contains the key, false otherwise.
ContainsKey
Declaration
bool ContainsKey(CompanySegmentJournalDictionary dictionary, string name)
Description
Checks whether a specific key is in the dictionary.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The dictionary to check. |
name
|
The key to check. |
Return Value
True, if the dictionary contains the key, false otherwise.
CreateCompanyJournal
Declaration
CompanyJournal CreateCompanyJournal(JournalStore store, 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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The journal store. |
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 as automatic. |
Return Value
The new journal.
CreateCompanyJournalDictionary
Declaration
CompanyJournalDictionary CreateCompanyJournalDictionary()
Description
Creates a new company journal dictionary.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
The new dictionary.
CreateCompanySegmentJournal
Declaration
CompanySegmentJournal CreateCompanySegmentJournal(JournalStore store, 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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The journal store. |
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 as automatic. |
Return Value
The new journal.
CreateCompanySegmentJournalDictionary
Declaration
CompanySegmentJournalDictionary CreateCompanySegmentJournalDictionary()
Description
Creates a new company segment journal dictionary.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
The new dictionary.
CreateGroupJournal
Declaration
GroupJournal CreateGroupJournal(JournalStore store, 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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The journal stores. |
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 as automatic. |
Return Value
The new journal.
CreateGroupJournalDictionary
Declaration
GroupJournalDictionary CreateGroupJournalDictionary()
Description
Creates a new group journal dictionary.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
The new dictionary.
CreateGroupSegmentJournal
Declaration
GroupSegmentJournal CreateGroupSegmentJournal(JournalStore store, 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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The journal store. |
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.
CreateGroupSegmentJournalDictionary
Declaration
GroupSegmentJournalDictionary CreateGroupSegmentJournalDictionary()
Description
Creates a new group segment journal dictionary.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
The new dictionary.
CreateJournalStore
Declaration
JournalStore CreateJournalStore(RepositoryConnection repositoryConnection, OLAPConnection olapConnection)
Description
Creates a new journal store. A journal store is used to load and save journals.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
repositoryConnection
|
A connection to a repository. |
olapConnection
|
A connection to an OLAP server. |
Return Value
A new journal store.
CreateRepositoryConnection
Declaration
RepositoryConnection CreateRepositoryConnection(string repository, string project, string user, string password)
Description
Creates a connection to a repository using password authentication.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
repository
|
Name of the repository to connect to. |
project
|
Name of the project in the repository. |
user
|
User name to be used for repository connection. |
password
|
Password to be used for repository connection. |
Return Value
Connection to a repository as specified by the connection parameters.
CreateRepositoryConnection
Declaration
RepositoryConnection CreateRepositoryConnection(string repository, string project, string ticket)
Description
Creates a connection to a repository using ticket authentication.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
repository
|
Name of the repository to connect to. |
project
|
Name of the project in the repository. |
ticket
|
Ticket to be used for authentication. |
Return Value
Connection to a repository as specified by the connection parameters.
GetCompanyJournalLineNumericProperty
Declaration
double GetCompanyJournalLineNumericProperty(CompanyJournalLine line, string propertyName)
Description
Gets a certain numeric property from a CompanyJournalLine object.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 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'.
GetCompanyJournalLineProperty
Declaration
string GetCompanyJournalLineProperty(CompanyJournalLine line, string propertyName)
Description
Gets a certain string property from a CompanyJournalLine object.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 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'.
GetCompanyJournalLines
Declaration
CompanyJournalLineList GetCompanyJournalLines(CompanyJournal journal)
Description
Gets a list of all journal lines.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to return all lines for. |
Return Value
A list of all lines stored in journal.
GetCompanyJournalProperty
Declaration
string GetCompanyJournalProperty(CompanyJournal journal, string propertyName)
Description
Gets a certain string property from a CompanyJournal object.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 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'.
GetCompanyJournals
Declaration
CompanyJournalList GetCompanyJournals(JournalStore store, 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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The store to manage 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.
GetCompanySegmentJournalLineNumericProperty
Declaration
double GetCompanySegmentJournalLineNumericProperty(CompanyJournalLine line, string propertyName)
Description
Gets a certain numeric property from a CompanySegmentJournalLine object.
Supported Runtime Versions
2.0, 3.0, 4.0, 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'.
GetCompanySegmentJournalLineProperty
Declaration
string GetCompanySegmentJournalLineProperty(CompanyJournalLine line, string propertyName)
Description
Receives a certain string property from a CompanySegmentJournalLine object.
Supported Runtime Versions
2.0, 3.0, 4.0, 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'.
GetCompanySegmentJournalLines
Declaration
CompanySegmentJournalLineList GetCompanySegmentJournalLines(CompanySegmentJournal journal)
Description
Receives a list of all journal lines belonging to a CompanySegmentJournal object.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The CompanySegmentJournal object to return all lines for. |
Return Value
A list of all lines stored in journal.
GetCompanySegmentJournalProperty
Declaration
string GetCompanySegmentJournalProperty(CompanySegmentJournal journal, string propertyName)
Description
Gets a certain string property from a CompanySegmentJournal object.
Supported Runtime Versions
2.0, 3.0, 4.0, 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'.
GetCompanySegmentJournals
Declaration
CompanySegmentJournalList GetCompanySegmentJournals(JournalStore store, 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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The store to manage 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.
GetEntry
Declaration
GroupJournal GetEntry(GroupJournalDictionary dictionary, string key)
Description
Gets a journal with a specific key from a dictionary.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 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
1.0, 2.0, 3.0, 4.0, 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
1.0, 2.0, 3.0, 4.0, 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
1.0, 2.0, 3.0, 4.0, 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.
GetGroupJournalLineNumericProperty
Declaration
double GetGroupJournalLineNumericProperty(GroupJournalLine line, string propertyName)
Description
Gets a certain numeric property from a GroupJournalLine object.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 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'.
GetGroupJournalLineProperty
Declaration
string GetGroupJournalLineProperty(GroupJournalLine line, string propertyName)
Description
Gets a certain string property from a GroupJournalLine object.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 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'.
GetGroupJournalLines
Declaration
GroupJournalLineList GetGroupJournalLines(GroupJournal journal)
Description
Gets a list of all journal lines.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to return all lines for. |
Return Value
A list of all lines stored in journal.
GetGroupJournalProperty
Declaration
string GetGroupJournalProperty(GroupJournal journal, string propertyName)
Description
Gets a certain string property from a GroupJournal object.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 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'.
GetGroupJournals
Declaration
GroupJournalList GetGroupJournals(JournalStore store, 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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The store to manage the journals. |
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.
GetGroupSegmentJournalLineNumericProperty
Declaration
double GetGroupSegmentJournalLineNumericProperty(GroupJournalLine line, string propertyName)
Description
Gets a certain numeric property from a GroupSegmentJournalLine object.
Supported Runtime Versions
2.0, 3.0, 4.0, 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'.
GetGroupSegmentJournalLineProperty
Declaration
string GetGroupSegmentJournalLineProperty(GroupJournalLine line, string propertyName)
Description
Receives a certain string property from a GroupSegmentJournalLine object.
Supported Runtime Versions
2.0, 3.0, 4.0, 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'.
GetGroupSegmentJournalLines
Declaration
GroupSegmentJournalLineList GetGroupSegmentJournalLines(GroupSegmentJournal journal)
Description
Receives a list of all journal lines belonging to a GroupSegmentJournal object.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The GroupSegmentJournal object to return all lines for. |
Return Value
A list of all lines stored in journal.
GetGroupSegmentJournalProperty
Declaration
string GetGroupSegmentJournalProperty(GroupSegmentJournal journal, string propertyName)
Description
Gets a certain string property from a GroupSegmentJournal object.
Supported Runtime Versions
2.0, 3.0, 4.0, 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'.
GetGroupSegmentJournals
Declaration
GroupSegmentJournalList GetGroupSegmentJournals(JournalStore store, 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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The store to manage the journals. |
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.
GetKeys
Declaration
StringArray GetKeys(GroupJournalDictionary dictionary)
Description
Returns all keys of a group journal dictionary.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The dictionary to return all keys for. |
Return Value
All keys stored in dictionary.
GetKeys
Declaration
StringArray GetKeys(CompanyJournalDictionary dictionary)
Description
Returns all keys of a company journal dictionary.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The dictionary to return all keys for. |
Return Value
All keys stored in dictionary.
GetKeys
Declaration
StringArray GetKeys(GroupSegmentJournalDictionary dictionary)
Description
Returns all keys of a group segment journal dictionary.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The dictionary to return all keys for. |
Return Value
All keys stored in dictionary.
GetKeys
Declaration
StringArray GetKeys(CompanySegmentJournalDictionary dictionary)
Description
Returns all keys of a company segment journal dictionary.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
dictionary
|
The dictionary to return all keys for. |
Return Value
All keys stored in dictionary.
GetLock
Declaration
ApplicationBookingLock GetLock(JournalStore store, string year, string period, string scenario, string group)
Description
Gets a lock for a specific context. The lock can only be created by one user, all other users will get an error.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The store to manage the journals. |
year
|
The year part of the context to lock. |
period
|
The period part of the context to lock. |
scenario
|
The scenario part of the context to lock. |
group
|
The group part of the context to lock. |
Return Value
A valid lock object that ensures the lock is reserved or null if already locked.
JournalDifference
Declaration
double JournalDifference(CompanyJournal journal)
Description
Gets the total difference of debit and credit for a journal.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to evaluate. |
Return Value
The total debit credit difference.
JournalDifference
Declaration
double JournalDifference(CompanySegmentJournal journal)
Description
Gets the total difference of debit and credit for a journal.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to evaluate. |
Return Value
The total debit credit difference.
JournalDifference
Declaration
double JournalDifference(GroupJournal journal)
Description
Gets the total difference of debit and credit for a journal.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to evaluate. |
Return Value
The total debit credit difference.
JournalDifference
Declaration
double JournalDifference(GroupSegmentJournal journal)
Description
Gets the total difference of debit and credit for a journal.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to evaluate. |
Return Value
The total debit credit difference.
JournalIsBalanced
Declaration
bool JournalIsBalanced(CompanyJournal journal)
Description
Indicates whether a company journal is balanced.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to check. |
Return Value
True, if the journal is balanced, false if not.
JournalIsBalanced
Declaration
bool JournalIsBalanced(CompanySegmentJournal journal)
Description
Indicates whether a company segment journal is balanced.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to check. |
Return Value
True, if the journal is balanced, false if not.
JournalIsBalanced
Declaration
bool JournalIsBalanced(GroupJournal journal)
Description
Indicates whether a journal is balanced.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to check. |
Return Value
True, if the journal is balanced, false if not.
JournalIsBalanced
Declaration
bool JournalIsBalanced(GroupSegmentJournal journal)
Description
Indicates whether a journal is balanced.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to check. |
Return Value
True, if the journal is balanced, false if not.
JournalIsEmpty
Declaration
bool JournalIsEmpty(CompanyJournal journal)
Description
Indicates whether a journal is empty, i.e. it has no journal lines.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to check. |
Return Value
True, if the journal is empty, false if not.
JournalIsEmpty
Declaration
bool JournalIsEmpty(CompanySegmentJournal journal)
Description
Indicates whether a journal is empty, i.e. it has no journal lines.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to check. |
Return Value
True, if the journal is empty, false if not.
JournalIsEmpty
Declaration
bool JournalIsEmpty(GroupJournal journal)
Description
Indicates whether a journal is empty, i.e. it has no journal lines.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to check. |
Return Value
True, if the journal is empty, false if not.
JournalIsEmpty
Declaration
bool JournalIsEmpty(GroupSegmentJournal journal)
Description
Indicates whether a journal is empty, i.e. it has no journal lines.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
journal
|
The journal to check. |
Return Value
True, if the journal is empty, false if not.
PostJournal
Declaration
int PostJournal(JournalStore store, CompanyJournal journal)
Description
Posts a company journal to the journal store and the journal values to the OLAP server.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The journal store to post to. |
journal
|
The journal to post. |
Return Value
The resulting journal number.
PostJournal
Declaration
int PostJournal(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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The journal store to post to. |
journal
|
The journal to post. |
Return Value
The resulting journal number.
PostJournal
Declaration
int PostJournal(JournalStore store, GroupJournal journal)
Description
Posts a group journal to the journal store and the journal values to the OLAP server.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The journal store to post to. |
journal
|
The journal to post. |
Return Value
The resulting journal number.
PostJournal
Declaration
int PostJournal(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
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The journal store to post to. |
journal
|
The journal to post. |
Return Value
The resulting journal number.
ReleaseLock
Declaration
void ReleaseLock(JournalStore store, ApplicationBookingLock lockToRelease)
Description
Releases a lock that was locked by the same user before.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The store to manage the journals. |
lockToRelease
|
The lock to release. |
Return Value
Does not return a value.
RepositoryDisconnect
Declaration
void RepositoryDisconnect(RepositoryConnection connection)
Description
Disconnects a certain repository connection.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Repository connection to be disconnected. |
Return Value
Does not return a value.
TransferCompaniesToGroup
Declaration
bool TransferCompaniesToGroup(JournalStore store, string year, string period, string scenario, string group, bool automaticSubgroupConsolidation, bool copyBaseSegmentStages)
Description
Transfers the data of all companies into the specified group and converts the values into group currency.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The journal store for the consolidation project. |
year
|
The year to transfer. |
period
|
The period to transfer. |
scenario
|
The scenario to transfer. |
group
|
The group to transfer to. |
automaticSubgroupConsolidation
|
True, if automatic subgroup consolidation should be used. This requires to have the automatic subgroup configuration set up properly, false otherwise. |
copyBaseSegmentStages
|
True, if base segment stages should be copied. False, if the total stage should be copied to the segment stage. |
Return Value
True, if successful, false, if any error occurred.
TransferCompaniesToGroupCancel
Declaration
bool TransferCompaniesToGroupCancel(JournalStore store, string year, string period, string scenario, string group)
Description
Cancels a transfer of companies into a specified group.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The journal store for the consolidation project. |
year
|
The year to transfer. |
period
|
The period to transfer. |
scenario
|
The scenario to transfer. |
group
|
The group to transfer to. |
Return Value
True, if the transfer could be canceled.
TransferSubgroupToGroup
Declaration
bool TransferSubgroupToGroup(JournalStore store, string year, string period, string scenario, string group, string company, bool copyBaseSegmentStages)
Description
Transfers the consolidated results of a subgroup to its parent group into a representing subgroup company.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
store
|
The journal store for the consolidation project. |
year
|
The year to use. |
period
|
The period to use. |
scenario
|
The scenario to use. |
group
|
The group to transfer. |
company
|
The subgroup company to transfer to. |
copyBaseSegmentStages
|
If true, all base segment stages will be copied. If false, only the total segment stage will be copied as one value. |
Return Value
True, if successful or false, if an error occurred.