The CData Sync App provides a straightforward way to continuously pipeline your Money Forward Expense data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Money Forward Expense connector can be used from the CData Sync application to pull data from Money Forward Expense and move it to any of the supported destinations.
The Sync App models entities in version 1.x of the Money Forward Expense REST API as relational tables.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
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 Sync App automatically refresh the OAuth access token:
Manual refresh of the OAuth access token:
The only value needed to manually refresh the OAuth access token is the OAuth refresh token.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
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.
Note the client Id, client secret, and callback URL for future use.
This section details a selection of advanced features of the Money Forward Expense Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App 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.
The following sections provide information on executing SQL to the available API Tables and Views. The Sync App 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 are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
The Sync App models the data in Money Forward Expense as a list of tables in a relational database that can be queried using standard SQL statements.
| 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.
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 Sync App uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Sync App. For example, following query is processed server side:
SELECT * FROM Departments
To insert a department the following columns are required: OfficeId and Name.
INSERT INTO Departments (OfficeId, Name, Code, Memo) VALUES ('OfficeId123', 'OfficeName123', 'DepCode123', 'Memo123')
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'
To delete a department, the following columns are required: OfficeId and Id.
DELETE FROM Departments WHERE OfficeId = '12345' AND Id = '123456'
| 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.
| 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.
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 Sync App uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Sync App.
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.
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"}]')
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'
To delete an OfficeMember, the following columns are required: OfficeId, Id.
DELETE FROM OfficeMembers WHERE OfficeId = '12345' AND Id = '123456'
| 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.
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 Sync App uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and OfficeMemberId. The Sync App processes other filters client-side within the Sync App. For example, the following query is processed server side:
SELECT * FROM OfficeMemberSettings WHERE OfficeId = '1234' AND OfficeMemberId = '12345'
INSERTs are not supported for this table.
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'
Deletes are not supported for this table.
| 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.
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 Sync App uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and OfficeMemberId. Other filters the Sync App processes client-side within the Sync App. For example, the following query is processed server side:
SELECT * FROM OfficeMemberWorkflows WHERE OfficeId = '1234' AND OfficeMemberId = '12345'
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')
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'
Deletes are not supported for this table.
| 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.
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 Sync App uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Sync App. For example, the following query is processed by the Money Forward Expense APIs:
SELECT * FROM Positions
To insert a position the following columns are required: OfficeId and Name.
INSERT INTO Positions (OfficeId, Name, IsAuthorizer, Priority) VALUES ('OfficeId1234', 'PositionName123', false, 150)
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'
To delete a position, the following columns are required: OfficeId and Id.
DELETE FROM Positions WHERE OfficeId = '12345' AND Id = '123456'
| 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.
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 Sync App uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Sync App. For example, the following query is processed server side:
SELECT * FROM Projects
To insert a project the following columns are required: OfficeId, Name, Code.
INSERT INTO Projects (OfficeId, Name, Code) VALUES ('OfficeId123', 'ProjectName123', 'ProjectCode123')
To update a project the following columns are required: OfficeId, Id.
UPDATE Projects SET Name = 'NewProjectName', Code = 'NewProjectCode' WHERE OfficeId = '12345' AND Id = '123456'
To delete a project, the following columns are required: OfficeId, Id.
DELETE FROM Projects WHERE OfficeId = '12345' AND Id = '123456'
| 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.
| 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 | null |
Query the approving reports for an office.
| 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.
| 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
| 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.
| 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.
| 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
| 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.
| 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.
The Sync App processes all filters on this table client-side within the Sync App. 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
| 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.
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 Sync App uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Sync App. For example, the following query is processed server side:
SELECT * FROM Reports
| 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.
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 Sync App uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Sync App. For example, the following query is processed server side:
SELECT * FROM ReportUnits
| 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. |
null
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 Sync App uses the Money Forward Expense APIs to process search criteria that refer to OfficeId and processes other filters client-side within the Sync App. For example, the following query is processed server side:
SELECT * FROM Transactions WHERE RecognizedAt <= '2020-04-30' AND RecognizedAt >= '2020-04-01'
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')
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'
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'
| Name | Type | Description |
| Id [KEY] | String | The Transaction Id. |
| OfficeId [KEY] | String | The Office Id. |
| DepartmentId | String | The DepartmentId. |
| InvoiceRegistrationNumber | String | InvoiceRegistrationNumber |
| Number | Int | Number |
| Currency | String | Currency |
| ExTransactionCustomFieldValuesValue | String | ExTransactionCustomFieldValuesValue |
| Value | Decimal | Value |
| UseCustomJpyRate | Bool | UseCustomJpyRate |
| ExReportNumber | Int | ExReportNumber |
| Remark | String | Remark |
| Memo | String | Memo |
| OfficeMemberReimburseBankAccountNumber | String | OfficeMemberReimburseBankAccountNumber |
| OfficeMemberNumber | String | OfficeMemberNumber |
| ExReportUnitNumber | Int | ExReportUnitNumber |
| PurchaseTaxCredit | Int | PurchaseTaxCredit |
| ExReportUnitPaymentDate | Date | ExReportUnitPaymentDate |
| ExReportUnitUpdatedAt | Datetime | ExReportUnitUpdatedAt |
| ExReportUnitOfficeId | String | ExReportUnitOfficeId |
| ExReportUnitCreatedAt | Datetime | ExReportUnitCreatedAt |
| ExReportUnitTitle | String | ExReportUnitTitle |
| ExReportUnitId | String | ExReportUnitId |
| SpecialExceptionStatus | String | SpecialExceptionStatus |
| ReportNumber | String | ReportNumber |
| ExciseValue | Int | ExciseValue |
| OfficeMemberId | String | OfficeMemberId |
| OfficeMemberCreatedAt | Datetime | OfficeMemberCreatedAt |
| OfficeMemberIsExAuthorizer | Bool | OfficeMemberIsExAuthorizer |
| OfficeMemberName | String | OfficeMemberName |
| OfficeMemberId2 | String | OfficeMemberId2 |
| OfficeMemberIsExAdministrator | Bool | OfficeMemberIsExAdministrator |
| OfficeMemberIdentificationCode | String | OfficeMemberIdentificationCode |
| OfficeMemberPositionName | String | OfficeMemberPositionName |
| OfficeMemberPositionPriority | Int | OfficeMemberPositionPriority |
| OfficeMemberPositionId | String | OfficeMemberPositionId |
| OfficeMemberPositionIsAuthorizer | Bool | OfficeMemberPositionIsAuthorizer |
| OfficeMemberReimburseBankAccountBankBranchName | String | OfficeMemberReimburseBankAccountBankBranchName |
| OfficeMemberReimburseBankAccountBankBranchNameKana | String | OfficeMemberReimburseBankAccountBankBranchNameKana |
| OfficeMemberReimburseBankAccountBankBranchCode | String | OfficeMemberReimburseBankAccountBankBranchCode |
| OfficeMemberReimburseBankAccountBankName | String | OfficeMemberReimburseBankAccountBankName |
| OfficeMemberReimburseBankAccountBankNameKana | String | OfficeMemberReimburseBankAccountBankNameKana |
| OfficeMemberReimburseBankAccountBankCode | String | OfficeMemberReimburseBankAccountBankCode |
| OfficeMemberReimburseBankAccountHolderName | String | OfficeMemberReimburseBankAccountHolderName |
| OfficeMemberReimburseBankAccountId | String | OfficeMemberReimburseBankAccountId |
| OfficeMemberReimburseBankAccountAccountType | Int | OfficeMemberReimburseBankAccountAccountType |
| OfficeMemberReimburseBankAccountHolderNameKana | String | OfficeMemberReimburseBankAccountHolderNameKana |
| OfficeMemberUpdatedAt | Datetime | OfficeMemberUpdatedAt |
| OfficeMemberIsExUser | Bool | OfficeMemberIsExUser |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemName | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemName |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemId | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemId |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemCode | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemCode |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemId | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemId |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemIsActive | Bool | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemIsActive |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemExciseId | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemExciseId |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemItemId | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemItemId |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemName | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemName |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemCode | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemCode |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemId2 | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemSubItemId2 |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseRate | Decimal | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseRate |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseCode | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseCode |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseLongName | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseLongName |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseId | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseId |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemExciseId | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemExciseId |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemName | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemName |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemCode | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemCode |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemId | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemId |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemId2 | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemItemId2 |
| OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseId2 | String | OfficeMemberExOfficeMemberSettingDefaultDrivingExpenseItemDefaultExciseId2 |
| OfficeMemberExOfficeMemberSettingDefaultCreditSubItemExciseId | String | OfficeMemberExOfficeMemberSettingDefaultCreditSubItemExciseId |
| OfficeMemberExOfficeMemberSettingDefaultCreditSubItemItemId | String | OfficeMemberExOfficeMemberSettingDefaultCreditSubItemItemId |
| OfficeMemberExOfficeMemberSettingDefaultCreditSubItemName | String | OfficeMemberExOfficeMemberSettingDefaultCreditSubItemName |
| OfficeMemberExOfficeMemberSettingDefaultCreditSubItemCode | String | OfficeMemberExOfficeMemberSettingDefaultCreditSubItemCode |
| OfficeMemberExOfficeMemberSettingDefaultCreditSubItemId | String | OfficeMemberExOfficeMemberSettingDefaultCreditSubItemId |
| OfficeMemberExOfficeMemberSettingIsTemplateOnDisplay | Bool | OfficeMemberExOfficeMemberSettingIsTemplateOnDisplay |
| OfficeMemberExOfficeMemberSettingDefaultCreditExciseId | String | OfficeMemberExOfficeMemberSettingDefaultCreditExciseId |
| OfficeMemberExOfficeMemberSettingDefaultCreditName | String | OfficeMemberExOfficeMemberSettingDefaultCreditName |
| OfficeMemberExOfficeMemberSettingDefaultCreditCode | String | OfficeMemberExOfficeMemberSettingDefaultCreditCode |
| OfficeMemberExOfficeMemberSettingDefaultCreditId | String | OfficeMemberExOfficeMemberSettingDefaultCreditId |
| OfficeMemberExOfficeMemberSettingDefaultProjectName | String | OfficeMemberExOfficeMemberSettingDefaultProjectName |
| OfficeMemberExOfficeMemberSettingDefaultProjectPriority | Int | OfficeMemberExOfficeMemberSettingDefaultProjectPriority |
| OfficeMemberExOfficeMemberSettingDefaultProjectCode | String | OfficeMemberExOfficeMemberSettingDefaultProjectCode |
| OfficeMemberExOfficeMemberSettingDefaultProjectIsActive | Bool | OfficeMemberExOfficeMemberSettingDefaultProjectIsActive |
| OfficeMemberExOfficeMemberSettingDefaultProjectParentId | String | OfficeMemberExOfficeMemberSettingDefaultProjectParentId |
| OfficeMemberExOfficeMemberSettingDefaultProjectRootId | String | OfficeMemberExOfficeMemberSettingDefaultProjectRootId |
| OfficeMemberExOfficeMemberSettingDefaultProjectId | String | OfficeMemberExOfficeMemberSettingDefaultProjectId |
| OfficeMemberExOfficeMemberSettingExMemberRoleId | Int | OfficeMemberExOfficeMemberSettingExMemberRoleId |
| OfficeMemberExOfficeMemberSettingIsAutoUpdateDefaultDepartmentId | Bool | OfficeMemberExOfficeMemberSettingIsAutoUpdateDefaultDepartmentId |
| OfficeMemberExOfficeMemberSettingIsCreditOnDisplay | Bool | OfficeMemberExOfficeMemberSettingIsCreditOnDisplay |
| OfficeMemberExOfficeMemberSettingIsExpenseSubAccountOnDisplay | Bool | OfficeMemberExOfficeMemberSettingIsExpenseSubAccountOnDisplay |
| OfficeMemberExOfficeMemberSettingApprovingPriority | Int | OfficeMemberExOfficeMemberSettingApprovingPriority |
| OfficeMemberExOfficeMemberSettingId | String | OfficeMemberExOfficeMemberSettingId |
| OfficeMemberExOfficeMemberSettingIsExciseOnDisplay | Bool | OfficeMemberExOfficeMemberSettingIsExciseOnDisplay |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemName | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemName |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemId | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemId |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemCode | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemCode |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemId | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemId |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemIsActive | Bool | OfficeMemberExOfficeMemberSettingDefaultTransportationItemIsActive |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemExciseId | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemExciseId |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemItemId | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemItemId |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemName | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemName |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemCode | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemCode |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemId2 | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemSubItemId2 |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseRate | Decimal | OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseRate |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseCode | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseCode |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseLongName | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseLongName |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseId | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseId |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemExciseId | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemExciseId |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemName | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemName |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemCode | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemCode |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemId | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemId |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemId2 | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemItemId2 |
| OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseId2 | String | OfficeMemberExOfficeMemberSettingDefaultTransportationItemDefaultExciseId2 |
| OfficeMemberExOfficeMemberSettingDefaultDepartmentDispOrder | Int | OfficeMemberExOfficeMemberSettingDefaultDepartmentDispOrder |
| OfficeMemberExOfficeMemberSettingDefaultDepartmentAncestryDepth | Int | OfficeMemberExOfficeMemberSettingDefaultDepartmentAncestryDepth |
| OfficeMemberExOfficeMemberSettingDefaultDepartmentName | String | OfficeMemberExOfficeMemberSettingDefaultDepartmentName |
| OfficeMemberExOfficeMemberSettingDefaultDepartmentId | String | OfficeMemberExOfficeMemberSettingDefaultDepartmentId |
| OfficeMemberExOfficeMemberSettingDefaultDepartmentCode | String | OfficeMemberExOfficeMemberSettingDefaultDepartmentCode |
| OfficeMemberExOfficeMemberSettingDefaultDepartmentIsActive | Bool | OfficeMemberExOfficeMemberSettingDefaultDepartmentIsActive |
| OfficeMemberExOfficeMemberSettingDefaultDepartmentParentId | String | OfficeMemberExOfficeMemberSettingDefaultDepartmentParentId |
| OfficeMemberExOfficeMemberSettingDefaultDepartmentRootId | String | OfficeMemberExOfficeMemberSettingDefaultDepartmentRootId |
| OfficeMemberExOfficeMemberSettingDefaultDepartmentExJournalDepartmentId | String | OfficeMemberExOfficeMemberSettingDefaultDepartmentExJournalDepartmentId |
| OfficeMemberExOfficeMemberSettingUseAgent | Bool | OfficeMemberExOfficeMemberSettingUseAgent |
| OfficeMemberExOfficeMemberSettingIsReportNumberOnDisplay | Bool | OfficeMemberExOfficeMemberSettingIsReportNumberOnDisplay |
| OfficeMemberExOfficeMemberSettingIsProjectOnDisplay | Bool | OfficeMemberExOfficeMemberSettingIsProjectOnDisplay |
| OfficeMemberExOfficeMemberSettingIsDepartmentOnDisplay | Bool | OfficeMemberExOfficeMemberSettingIsDepartmentOnDisplay |
| OfficeMemberExActivatedAt | Datetime | OfficeMemberExActivatedAt |
| OfficeMemberDepartmentDispOrder | Int | OfficeMemberDepartmentDispOrder |
| OfficeMemberDepartmentAncestryDepth | Int | OfficeMemberDepartmentAncestryDepth |
| OfficeMemberDepartmentName | String | OfficeMemberDepartmentName |
| OfficeMemberDepartmentId | String | OfficeMemberDepartmentId |
| OfficeMemberDepartmentCode | String | OfficeMemberDepartmentCode |
| OfficeMemberDepartmentIsActive | Bool | OfficeMemberDepartmentIsActive |
| OfficeMemberDepartmentParentId | String | OfficeMemberDepartmentParentId |
| OfficeMemberDepartmentRootId | String | OfficeMemberDepartmentRootId |
| OfficeMemberDepartmentExJournalDepartmentId | String | OfficeMemberDepartmentExJournalDepartmentId |
| ErrorMessage | String | ErrorMessage |
| MfFileUpdatedAt | Datetime | MfFileUpdatedAt |
| MfFileName | String | MfFileName |
| MfFileContentType | String | MfFileContentType |
| MfFileCreatedAt | Datetime | MfFileCreatedAt |
| MfFileId | String | MfFileId |
| ProjectId | String | ProjectId |
| ItemId | String | ItemId |
| ProjectName | String | ProjectName |
| ProjectPriority | Int | ProjectPriority |
| ProjectCode | String | ProjectCode |
| ProjectIsActive | Bool | ProjectIsActive |
| ProjectParentId | String | ProjectParentId |
| ProjectRootId | String | ProjectRootId |
| ProjectId2 | String | ProjectId2 |
| FamilyState | Int | FamilyState |
| UpdatedAt | Datetime | UpdatedAt |
| ReceiptType | String | ReceiptType |
| CreditId | String | CreditId |
| ExReportSuspensePaymentReports | String | ExReportSuspensePaymentReports |
| ExReportCreatedAt | Datetime | ExReportCreatedAt |
| ExReportExReportTypeId | String | ExReportExReportTypeId |
| ExReportApprovedAt | Datetime | ExReportApprovedAt |
| ExReportId | String | ExReportId |
| ExReportSubmittedAt | Datetime | ExReportSubmittedAt |
| ExReportStatus | String | ExReportStatus |
| ExReportUpdatedAt | Datetime | ExReportUpdatedAt |
| ExReportTitle | String | ExReportTitle |
| ExReportOfficeMemberId | String | ExReportOfficeMemberId |
| DepartmentDispOrder | Int | DepartmentDispOrder |
| DepartmentAncestryDepth | Int | DepartmentAncestryDepth |
| DepartmentName | String | DepartmentName |
| DepartmentId2 | String | DepartmentId2 |
| DepartmentCode | String | DepartmentCode |
| DepartmentIsActive | Bool | DepartmentIsActive |
| DepartmentParentId | String | DepartmentParentId |
| DepartmentRootId | String | DepartmentRootId |
| DepartmentExJournalDepartmentId | String | DepartmentExJournalDepartmentId |
| Jpyrate | Decimal | Jpyrate |
| CreditExciseId | String | CreditExciseId |
| CreditName | String | CreditName |
| CreditCode | String | CreditCode |
| CreditId2 | String | CreditId2 |
| CreatedAt | Datetime | CreatedAt |
| AutomaticStatus | String | AutomaticStatus |
| ItemName | String | ItemName |
| ItemId2 | String | ItemId2 |
| ItemCode | String | ItemCode |
| ItemSubItemId | String | ItemSubItemId |
| ItemIsActive | Bool | ItemIsActive |
| ItemSubItemExciseId | String | ItemSubItemExciseId |
| ItemSubItemItemId | String | ItemSubItemItemId |
| ItemSubItemName | String | ItemSubItemName |
| ItemSubItemCode | String | ItemSubItemCode |
| ItemSubItemId2 | String | ItemSubItemId2 |
| ItemDefaultExciseRate | Decimal | ItemDefaultExciseRate |
| ItemDefaultExciseCode | String | ItemDefaultExciseCode |
| ItemDefaultExciseLongName | String | ItemDefaultExciseLongName |
| ItemDefaultExciseId | String | ItemDefaultExciseId |
| ItemItemExciseId | String | ItemItemExciseId |
| ItemItemName | String | ItemItemName |
| ItemItemCode | String | ItemItemCode |
| ItemItemId | String | ItemItemId |
| ItemItemId2 | String | ItemItemId2 |
| ItemDefaultExciseId2 | String | ItemDefaultExciseId2 |
| ExTransactionCustomFieldValuesExTransactionCustomFieldId | String | ExTransactionCustomFieldValuesExTransactionCustomFieldId |
| ExTransactionCustomFieldValuesName | String | ExTransactionCustomFieldValuesName |
| ExTransactionCustomFieldValuesExTransactionCustomFieldLabel | String | ExTransactionCustomFieldValuesExTransactionCustomFieldLabel |
| ExTransactionCustomFieldValuesExTransactionCustomFieldType | String | ExTransactionCustomFieldValuesExTransactionCustomFieldType |
| ExTransactionCustomFieldValuesDisplayValue | String | ExTransactionCustomFieldValuesDisplayValue |
| CreditSubItemExciseId | String | CreditSubItemExciseId |
| CreditSubItemItemId | String | CreditSubItemItemId |
| CreditSubItemName | String | CreditSubItemName |
| CreditSubItemCode | String | CreditSubItemCode |
| CreditSubItemId | String | CreditSubItemId |
| InvoiceKind | Int | InvoiceKind |
| RecognizedAt | Date | RecognizedAt |
| WaitingMessage | String | WaitingMessage |
| ExciseId | String | ExciseId |
| CreditSubItemId2 | String | CreditSubItemId2 |
| ExciseCode | String | ExciseCode |
| WarningMessage | String | WarningMessage |
| ExciseRate | Decimal | ExciseRate |
| ExciseCode2 | String | ExciseCode2 |
| ExciseLongName | String | ExciseLongName |
| ExciseId2 | String | ExciseId2 |
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.
| Property | Description |
| OfficeId | Id of the office. Required for most queries. |
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
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.
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 | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
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 Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Money Forward Expense. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Money Forward Expense. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Money Forward Expense. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
The authentication type can be one of the following:
For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The user name of a user registered with the proxy server. |
| DIGEST | The user name of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\MFExpense Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"
To include all pseudocolumns for all tables use: "*=*"
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:
{
"MyView": {
"query": "SELECT * FROM Offices WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.
Refer to User Defined Views for more information.