Company Web Service Actions and Functions

The following company actions can be performed via the Web Service.

This list some of the end points available. See the Metadata Properties link for a list of all end points for specific properties for each end point.

Function	Description
AddPeriod	Adds a given Offset number of periods to a given period, optionally excluding adjustment periods.
AppName	Returns Mercury or Saturn, depending on the application running the Web Service.
Autodoc	Returns the automated documentation for Action and Function end points.
BaseCurrencyCode	Returns the base currency code for the Company.
COAddress	Returns all the delivery addresses for the Company.
COBankingMedia	Returns all the Banking Media set in the Company.
COBranch	For Accredo Saturn, returns details of the branches in the Company.
CODepartment	For Accredo Saturn, returns details of the departments in the Company.
COFXCurrency	Returns details of the FX currencies set in the Company.
COCurrencyRateType	Returns details of the FX currency rate types set.
COLinkCategory1, COLinkCategory2, COMOCategory1, COMOCategory2	Returns the Link or Memo categories set for the company.
COMemo	Returns details of the Company memos.
Company	Returns the Company Details.
CONarrative	Returns narratives in the Global Narrative List.
CORecoveryLog	Returns details in the File Recovery Log Viewer.
COUser	Returns details of the company Users, Groups and Roles.
CurrentPeriod	Returns the current period for a given module.
CustomTable	Returns all records in a given custom table.
DefaultBranchCode	For Accredo Saturn, returns the Default Branch Code for the User.
DefaultDepartmentCode	For Accredo Saturn, returns the Default Department Code for the User.
DefaultLocationCode	For Accredo Saturn, returns the Default Location Code for the User.
Enum	Returns all Enum types and their available values.
ExecuteSQL	Executes an SQL Query script located on the host.
FieldDependency	Returns field dependencies for Documents, Document Template (Dot), Graph or Validation (Validate), for a given Entity.
FirstUserPeriod	Returns the first available period for a given Module, for a specified User.
GetExchangeRate	Returns the exchange rate for a given Currency Code, Rate Type and Date.
GetPrimaryKey	Returns the primary key of a given sub-object.
GetUserCompanyList	Returns a list of the companies available to the requesting user.
ICAvailable	Used to query stock availability.
Image	Returns an image from a given image path.
LastUserPeriod	Returns the last available period for a given Module, for a specified User.
ModuleAvailable	Returns True if the given module is available.
openapi.json	Returns a JSON OAS output containing endpoints.
PeriodForDate	Returns the period a given date occurs in.
PlayLayout	Run a report layout to a disk file.
PlayScript / PlayReportScript	Executes a MaxBasic script that exists on the host, in a given Output Style.
ReportLayout	Returns details of all report layouts.
Settings	Returns all the settings with their values for the company.
ScriptDoc	Returns the objects that can be scripted.
SystemDate	Returns the current system date.
SystemPeriod	Returns the current system period.
User	Returns the user details for the logged in user.
UserSettings	Returns the settings and permissions for the logged in user.