This page provides a guide to Establishing a Connection to Money Forward Expense in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Money Forward Expense

Establishing a Connection shows how to authenticate to Money Forward Expense and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Money Forward Expense through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Money Forward Expense by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Money Forward Expense

Money Forward Expense supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to Money Forward Expense from the three most common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Money Forward Expense, see Connection.

Note: In addition to the connection properties listed below, most Money Forward Expense tables also require the user to set OfficeId.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token:

1. Before connecting to data for the first time, set these connection parameters:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: The client Id in your application settings.
   • OAuthClientSecret: The client secret in your application settings.
   • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
2. On subsequent data connections, set:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set these connection properties:
   • OAuthClientId: The Client Id in your application settings.
   • OAuthClientSecret: The Client Secret in your application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Creating a Custom OAuth Application

The following procedure obtains the OAuth client credentials, the OAuthClientId, OAuthClientSecret, and CallbackURL.

1. Log into your Money Forward Expense account and click API Linkage under the For Developers section.
2. Click Create Application.

3. If you are making a desktop application, set the Redirect URI to https://oauth.cdata.com/oauth/, the default CallbackURL value.
   Note: Money Forward Expense requires an HTTPS redirect URI.

   If you are making a Web application, set the Redirect URI to a page on your Web app where you would like the user to return after authorizing your application.

4. Set Scopes to office_setting:write user_setting:write transaction:write report:write account:write public_resource:read.
5. Save your changes. The console displays the settings for the application you just created.

Note the client Id, client secret, and callback URL for future use.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud models entities in the Money Forward Expense API as tables, views, and stored procedures. These are defined in schema files, which are text-based, extensible configuration files.

Tables and Views

The following sections provide information on executing SQL to the available API Tables and Views. The Cloud offloads as much of the SELECT statement processing as possible to Money Forward Expense and then processes the rest of the query in memory; API limitations and requirements are documented in this section.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

The Cloud models the data in Money Forward Expense as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Money Forward Expense Tables

Name	Description
Departments	Create, update, delete, and query all the report units for an office.
MyTransactions	Create, update, delete, and query your own transactions.
OfficeMembers	Query and delete the report units for an office.
OfficeMemberSettings	Create, update, and query the settings for an office.
OfficeMemberWorkflows	Create, update, delete, and query the workflows for the members of the specified office.
Positions	Create, update, delete, and query all the positions for an office.
Projects	Create, update, delete, and query projects for an office.

Create, update, delete, and query all the report units for an office.

Table Specific Information

SELECT

To get a list of all the departments of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, following query is processed server side:

SELECT * FROM Departments

Insert

To insert a department the following columns are required: OfficeId and Name.

INSERT INTO Departments (OfficeId, Name, Code, Memo) VALUES ('OfficeId123', 'OfficeName123', 'DepCode123', 'Memo123')

Update

To update a department the following columns are required: OfficeId and Id.

UPDATE Departments SET Name = 'NewDepName', Code = 'NewDepCode', Memo = 'NewDepMemo' WHERE OfficeId = '1234' AND Id = '12345'

Delete

To delete a department, the following columns are required: OfficeId and Id.

DELETE FROM Departments WHERE OfficeId = '12345' AND Id = '123456'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The department Id.
OfficeId [KEY]	String	False	The office Id.
Name	String	False	The department name.
Code	String	False	The department code.
Memo	String	False	The RootId of the department.
ParentId	String	False	The ParentId of the department.
RootId	String	True	The RootId of the project.

Create, update, delete, and query your own transactions.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The position Id.
OfficeId [KEY]	String	False	The transaction Id.
Remark	String	False	The transaction contents.
Value	Double	False	The transaction value.
ItemId	String	False	The Expense item Id.
RecognizedAt	Date	False	The date of payment.
Number	Integer	True	The transaction number.
Memo	String	False	The transaction notes.
JpyRate	Double	False	The exchange rate.
Currency	String	False	The transaction currency.
UseCustomJypRate	Boolean	False	Indicates if the exchange rate is manually set.
AutomaticStatus	String	True	The transaction status.
ErrorMessage	String	True	The error message.
WarningMessage	String	True	The warning message.
WaitingMessage	String	True	The waiting message.
OfficeMemberId	String	True	The office member Id.
CreditItemId	String	False	The credit account item Id.
CreditSubItemId	String	False	The credit account subitem Id.
ExciseId	String	False	The tax division Id.
DepartmentId	String	False	The department Id.
ProjectId	String	False	The project Id.
CreatedAt	Datetime	True	The date when the transaction was craeted.
UpdatedAt	Datetime	True	The date when the transaction was last updated.

Query and delete the report units for an office.

Table Specific Information

SELECT

To get a list of all the members of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used. The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, following query is processed server side:

SELECT * FROM OfficeMembers

The column PermissionRoleID may take the value of 0 if the member has been created from the UI, and it hasn't been given any permissions.

Insert

To insert an OfficeMember, the following columns are required: OfficeId, Email and PermissionRoleID.
PermissionRoleID can take only these values: 201: general user, 202: recognizer, 203: manager.
-if PermissionRoleID = 201 IsExUser will be set to true
-if PermissionRoleID = 202 IsExUser, IsExAuthorizer will be set to true
-if PermissionRoleID = 203 IsExUser, IsExAuthorizer, IsExAdministrator will be set to true
Departments is a aggregate field, so the value for inserting and updating would be a json string containing an array of objects with its only attribute Department Id

INSERT INTO OfficeMembers (OfficeId, Email, PermissionRoleID) VALUES ('12345', '[email protected]', '201')

INSERT INTO OfficeMembers (OfficeId, Email, PermissionRoleID, PositionID, Departments) VALUES ('23457', '[email protected]', '202', '2457', '[{"id": "7457"},{"id": "24577"}]')

Update

To update an OfficeMember you will need the OfficeMember ID and OfficeID specified:

UPDATE OfficeMembers SET Name = 'hello world', Number = '1245', PermissionRoleID = 203 WHERE ID = '345' AND OfficeID = '123'

UPDATE OfficeMembers SET  Name = 'hey world', Number = '346', PermissionRoleID = 201, PositionID = '2457754', Departments = '[{\"id\": \"457\"},{\"id\": \"346\"}]' WHERE ID = '345' AND OfficeID = '346'

Delete

To delete an OfficeMember, the following columns are required: OfficeId, Id.

DELETE FROM OfficeMembers WHERE OfficeId = '12345' AND Id = '123456'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The report unit Id.
OfficeId [KEY]	String	True	The report unit Id.
IdentificationCode	String	True	The office id.
Name	String	False	The report unit title.
Number	Integer	False	The report unit title.
CreatedAt	Datetime	True	The date when the report unit was created.
UpdatedAt	Datetime	True	The date when the report unit was last updated.
IsExUser	Boolean	True	The report unit number.
IsExAuthorizer	Boolean	True	The report unit number.
IsExAdministrator	Boolean	True	The report unit number.
PositionId	String	True	The report unit title.
PositionName	String	True	The report unit title.
PositionPriority	Integer	True	The report unit title.
PermissionRoleID	String	False	Permission role ID (Required on insert - 201: general user, 202: recognizer, 203: manager)
Departments	String	False	Aggregate field representing departments of an office member.

Create, update, and query the settings for an office.

Table Specific Information

SELECT

To get the settings of an office member, the OfficeId and OfficeMemberId columns are required in the WHERE clause. If not specified, the settings of all the office members will be returned.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and OfficeMemberId. The Cloud processes other filters client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM OfficeMemberSettings WHERE OfficeId = '1234' AND OfficeMemberId = '12345'

INSERT

INSERTs are not supported for this table.

UPDATE

To update the settings of an office member, the following columns required: OfficeId and OfficeMemberId.

UPDATE OfficeMemberSettings SET UseAgent = false, ApprovingPriority = 1234, ProjectId = '1234', CreditItemId = '1234', CreditSubItemId = '1234', TransportationItemId = '1234', DrivingItemId = '1234' WHERE OfficeMemberId = '1234' AND OfficeId = '123456'

Delete

Deletes are not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The setting Id.
OfficeId [KEY]	String	False	The office Id.
OfficeMemberId [KEY]	String	False	The office member Id.
UseAgent	Boolean	False	Indicates the use agent status.
ApprovingPriority	Integer	False	The approving priority.
ProjectId	String	False	The project Id.
ProjectName	String	True	The project name.
ProjectCode	String	True	The project code.
CreditItemId	String	False	The credit item Id.
CreditItemExciseId	String	True	The credit item excise Id.
CreditItemName	String	True	The credit item name.
CreditItemCode	String	True	The credit item code.
CreditSubItemId	String	False	The credit subitem Id.
CreditSubItemItemId	String	True	The credit subitem item Id.
CreditSubItemExciseId	String	True	The credit subitem excise Id.
CreditSubItemName	String	True	The credit subitem name.
CreditSubItemCode	String	True	The credit subitem code.
TransportationItemId	String	False	The transportation item Id.
TransportationItemName	String	True	The transportation item name.
DrivingItemId	String	False	The driving item Id.
DrivingItemName	String	True	The driving item name.

Create, update, delete, and query the workflows for the members of the specified office.

Table Specific Information

SELECT

To get a list of the workflows of an office member, the OfficeId and OfficeMemberId columns are required. If not specified, the workflows of all the office members will be returned by the Money Forward Expense server.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and OfficeMemberId. Other filters the Cloud processes client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM OfficeMemberWorkflows WHERE OfficeId = '1234' AND OfficeMemberId = '12345'

INSERT

To insert a workflow for an office member, the following columns are required: OfficeId, OfficeMemberId, WorkFlowId, and ReportTypeId

INSERT INTO OfficeMemberWorkflows (OfficeId, OfficeMemberId, WorkFlowId, ReportTypeId) VALUES ('123', '12345', '123456', '1234567')

UPDATE

To update a workflow for an office member, the following columns are required: Id, OfficeId, OfficeMemberId, WorkFlowId, AND ReportTypeId.

UPDATE OfficeMemberWorkflows SET WorkFlowId = '123', ReportTypeId = '1234' WHERE OfficeId = '12345' AND OfficeMemberId = '123456' AND Id = '1234567'

DELETE

Deletes are not supported for this table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The workflow Id.
OfficeId [KEY]	String	False	The office Id.
OfficeMemberId [KEY]	String	False	The workflow name.
WorkflowId	String	False	The workflow priority.
ReportTypeId	String	False	The workflow priority.
ReportTypeName	String	True	The workflow priority.
ReportTypeUseTransactionReserves	Boolean	True	The workflow priority.
ReportTypeUseTransactionActionAfterApproval	String	True	The workflow priority.
ReportTypeIsActive	Boolean	True	The workflow priority.

Create, update, delete, and query all the positions for an office.

Table Specific Information

SELECT

To get a list of all the positions of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, the following query is processed by the Money Forward Expense APIs:

SELECT * FROM Positions

Insert

To insert a position the following columns are required: OfficeId and Name.

INSERT INTO Positions (OfficeId, Name, IsAuthorizer, Priority) VALUES ('OfficeId1234', 'PositionName123', false, 150)

Update

To update a position the following columns are required: OfficeId and Id.

UPDATE Positions SET Name = 'UpdatedPositionName', IsAuthorizer = true, Priority = 170 WHERE OfficeId = '12345' AND Id = '123456'

Delete

To delete a position, the following columns are required: OfficeId and Id.

DELETE FROM Positions WHERE OfficeId = '12345' AND Id = '123456'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The position Id.
OfficeId [KEY]	String	False	The office Id.
Name	String	False	The position name.
IsAuthorizer	Boolean	False	Indicates if the position is an authorizer.
Priority	Integer	False	The position's priority on the list.

Create, update, delete, and query projects for an office.

Table Specific Information

SELECT

To get a list of all the projects of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used. The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Projects

Insert

To insert a project the following columns are required: OfficeId, Name, Code.

INSERT INTO Projects (OfficeId, Name, Code) VALUES ('OfficeId123', 'ProjectName123', 'ProjectCode123')

Update

To update a project the following columns are required: OfficeId, Id.

UPDATE Projects SET Name = 'NewProjectName', Code = 'NewProjectCode' WHERE OfficeId = '12345' AND Id = '123456'

Delete

To delete a project, the following columns are required: OfficeId, Id.

DELETE FROM Projects WHERE OfficeId = '12345' AND Id = '123456'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The project Id.
OfficeId [KEY]	String	False	The office Id.
Name	String	False	The project name.
Code	String	False	The project code.
ParentId	String	True	The ParentId of the project.
RootId	String	True	The RootId of the project.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Money Forward Expense Views

Name	Description
ApprovingReports	Query the approving reports for an office.
Excises	Lists the Excises for an office.
InvoiceReports	null
Items	Lists the items for an office.
MyApprovingReports	Query your own approving reports.
MyInvoiceReports	null
MyReports	Query your own Reports.
Offices	Lists all the offices you belong to.
Reports	Lists the reports for an office.
ReportUnits	Lists the report units for an office.
Transactions	Query the transactions for an office.

Query the approving reports for an office.

Columns

Name	Type	Description
Id [KEY]	String	The report Id.
OfficeId	String	The office Id.
ReportTypeId	String	The report type Id.
OfficeMemberId	String	The office member Id.
Number	Integer	The report number.
Title	String	The report title.
Status	String	The report status.
SubmittedAt	Datetime	The date when the report was subbmited.
ApprovedAt	Datetime	The date when the report was approved.
CreatedAt	Datetime	The date when the report was created.
UpdatedAt	Datetime	The date when the report was last updated.

Lists the Excises for an office.

Columns

Name	Type	Description
Id [KEY]	String	The Excise Id.
OfficeId [KEY]	String	The office Id.
Rate	String	The Excise Rate.
Code	String	The Excise Code.
LongName	String	The Excise LongName.

null

Columns

Name	Type	Description
Id [KEY]	String	id
CreatedAt	Datetime
OfficeId [KEY]	String	The office id
ApprovedAt	Datetime
Number	String
SubmittedAt	Datetime
Status	String
UpdatedAt	Datetime
Title	String
OfficeMemberId	String
NumberWithoutPrefix	String	number_without_prefix
ReportApprovals	String	Report Approvals

Lists the items for an office.

Columns

Name	Type	Description
Id [KEY]	String	The project Id.
OfficeId [KEY]	String	The office Id.
Name	String	The item name.
SubItemId	String	The sub item id.

Query your own approving reports.

Columns

Name	Type	Description
Id [KEY]	String	The report Id.
OfficeId	String	The office Id.
ReportTypeId	String	The report type Id.
OfficeMemberId	String	The office member Id.
Number	Integer	The report number.
Title	String	The report title.
Status	String	The report status.
SubmittedAt	Datetime	The date when the report was subbmited.
ApprovedAt	Datetime	The date when the report was approved.
CreatedAt	Datetime	The date when the report was created.
UpdatedAt	Datetime	The date when the report was last updated.

null

Columns

Name	Type	Description
Id [KEY]	String	id
CreatedAt	Datetime
OfficeId [KEY]	String	The office id
ApprovedAt	Datetime
Number	String
SubmittedAt	Datetime
Status	String
UpdatedAt	Datetime
Title	String
OfficeMemberId	String	OfficeMemberId
NumberWithoutPrefix	String	number_without_prefix
ReportApprovals	String	Report Approvals

Query your own Reports.

Columns

Name	Type	Description
Id [KEY]	String	The report Id.
OfficeId	String	The office Id.
ReportTypeId	String	The report type Id.
OfficeMemberId	String	The office member Id.
Number	Integer	The report number.
Title	String	The report title.
Status	String	The report status.
SubmittedAt	Datetime	The date when the report was subbmited.
ApprovedAt	Datetime	The date when the report was approved.
CreatedAt	Datetime	The date when the report was created.
UpdatedAt	Datetime	The date when the report was last updated.

Lists all the offices you belong to.

Table Specific Information

SELECT

The Cloud processes all filters on this table client-side within the Cloud. For example, the following query is the only query processed by the Money Forward Expense APIs and returns a list of all the offices you belong to.

SELECT * FROM Offices

Columns

Name	Type	Description
Id [KEY]	String	The office Id.
IdentificationCode	String	The identification code for the office.
Name	String	The office name.
OfficeTypeId	String	The office type Id.

Lists the reports for an office.

Table Specific Information

SELECT

To get a list of all the reports of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used. The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Reports

Columns

Name	Type	Description
Id [KEY]	String	The report Id.
OfficeId	String	The office Id.
ReportTypeId	String	The report type Id.
OfficeMemberId	String	The office member Id.
Number	Integer	The report number.
Title	String	The report title.
Status	String	The report status.
SubmittedAt	Datetime	The date when the report was subbmited.
ApprovedAt	Datetime	The date when the report was approved.
CreatedAt	Datetime	The date when the report was created.
UpdatedAt	Datetime	The date when the report was last updated.

Lists the report units for an office.

Table Specific Information

SELECT

To get a list of all the report units of an office, the OfficeId column or the OfficeId connection string parameter is required. If not specified, the OfficeId of the first office from the Offices table will be used.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM ReportUnits

Columns

Name	Type	Description
Id [KEY]	String	The report unit Id.
OfficeId	String	The office id.
Title	String	The report unit title.
CreatedAt	Datetime	The date when the report unit was created.
UpdatedAt	Datetime	The date when the report unit was last updated.
Number	String	The report unit number.

Query the transactions for an office.

Table Specific Information

SELECT

To get a list of all the transactions of an office, the OfficeId column or the OfficeId connection string parameter and a range of RecognizedAt column is required. If OfficeId is not specified, the OfficeId of the first office from the Offices table will be used.

The Cloud uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Transactions WHERE RecognizedAt <= '2020-04-30' AND RecognizedAt >= '2020-04-01' 

Insert

To insert a transaction the following columns are required: OfficeId, Remark, ItemId, Value, RecognizedAt.

INSERT INTO Transactions (OfficeId, Remark, ItemId, Value, RecognizedAt, Memo, JpyRate, Currency, UseCustomJpyRate, CreditItemId, CreditSubItemId, ExciseId, DepartmentId, ProjectId) VALUES ('OfficeId123', 'RemarkValue', 'ItemId1234', 100.11, '01-01-2017', 'MemoValue', 100.123, 'JPY', false, 'CreditItemId213', 'CreditSubItemId213', 'ExciseId123', 'DepartmentId123', 'ProjectId123')

Update

To update a transaction the following columns are required: OfficeId, Id. You can update the transactions that belong the authenticated user, but not those that belong to the other office members.

UPDATE Transactions SET Remark = 'NewRemark', ItemId = 'NewItemId', Value = 123.123, Memo = 'NewMemo', UseCustomJypRate = false, RecognizedAt = '01-02-2018', Currency = 'USD', ExciseId = 'NewExciseId', CreditItemId = 'NewCreditItemId', CreditSubItemId = 'NewCreditSubItemId', DepartmentId = 'NewDepartmentId', ProjectId = 'NewProjectId' WHERE OfficeId = '12345' AND Id = '123456'

Delete

To delete a transaction, the following columns are required: OfficeId, Id. You can delete the transactions that belong the authenticated user, but not those that belong to the other office members.

DELETE FROM Transactions WHERE OfficeId = '12345' AND Id = '123456'

Columns

Name	Type	Description
Id [KEY]	String	The position Id.
OfficeId [KEY]	String	The transaction Id.
Remark	String	The transaction contents.
Value	Double	The transaction value.
ItemId	String	The Expense item Id.
RecognizedAt	Date	The date of payment.
Number	Integer	The transaction number.
Memo	String	The transaction notes.
JpyRate	Double	The exchange rate.
Currency	String	The transaction currency.
UseCustomJypRate	Boolean	Indicates if the exchange rate is manually set.
AutomaticStatus	String	The transaction status.
ErrorMessage	String	The error message.
WarningMessage	String	The warning message.
WaitingMessage	String	The waiting message.
OfficeMemberId	String	The office member Id.
CreditItemId	String	The credit account item Id.
CreditSubItemId	String	The credit account subitem Id.
ExciseId	String	The tax division Id.
DepartmentId	String	The department Id.
ProjectId	String	The project Id.
CreatedAt	Datetime	The date when the transaction was craeted.
UpdatedAt	Datetime	The date when the transaction was last updated.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Money Forward Expense.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Money Forward Expense, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Money Forward Expense Stored Procedures

Name	Description

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Money Forward Expense:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Offices table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Offices' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Offices table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Offices' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:mfexpense:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
OfficeId	Id of the office. Required for most queries.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
OfficeId	Id of the office. Required for most queries.

Id of the office. Required for most queries.

Data Type

string

Default Value

""

Remarks

Id of the office. Required for most queries. This value restricts query results to the specified office. If you do not have direct access to the SQL query, you can set this connection property instead.

If you do have access to the query, you can override the connection property value for a specific query by setting the OfficeId pseudo column.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

The client Id assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Cloud throws an exception.