Create a connection to Money Forward Invoice by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Money Forward Invoice icon is not available, click the Add More icon to download and install the Money Forward Invoice connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

OAuth is the only authentication method available. To authenticate using OAuth, you will need to register an app with Money Forward Invoice to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL.

MoneyForward uses the OAuth authentication standard.

OAuth requires the authenticating user to interact with Money Forward Invoice using the browser. The Sync App facilitates this in various ways as described in the following sections.

*MoneyForward is in Japanese only.

Create an App on MoneyForward

To obtain the OAuth client credentials, follow the steps below:

1. Log into MoneyForward, click on the "?" at the top right of the page and than click the "��" button.
2. Click Create New
3. Fill Name, Redirect URL(Callback URL) and Scope fields.
4. Set the Redirect URL to https://oauth.cdata.com/oauth/.
5. Check "Agree terms and condtitions"
6. Click Create and if creation is succesfull the OAuth client credentials Client ID, Client Secret, Redirect URL(Callback URL) and Scope will be displayed.

Authenticate to Money Forward Invoice

After setting the following connection properties, you are ready to connect:

• OAuthClientId: Set this to the Client Id in your app settings.
• OAuthClientSecret: Set this to the Client Secret in your app settings.
• CallbackURL: Set this to the Site URL in your app settings.

When you connect the Sync App opens the OAuth endpoint in your default browser. If browser shows a message like "There is a problem with this website's security certificate" click Continue to this website. Be careful, you have to log in to Money Forward Invoice in order to complete authorization. The Sync App then completes the OAuth process:

Additional Permissions

You may find while using the Sync App that Moneyforward returns an error stating your app does not have permissions to do a certain action. To resolve this, you will need to generate a new OAuth access token with the required permissions. Both the GetOAuthAuthorizationURL and GetOAuthAccessToken stored procedures have inputs for the permissions you would like to request.

Available permissions are READ,WRITE.

This section details a selection of advanced features of the Money Forward Invoice Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Money Forward Invoice and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App 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.

You can work with all the tables in your account using the Sync App.

Tables

The Sync App models the Money Forward Invoice API as relational Tables. The schemas are defined in schema files, simple text-based configuration files that are easy to extend.

In addition to the tables, the Sync App also offers stored procedures and views, enabling you to work with other aspects of the Moneyforward API, like bulk jobs, custom reports, etc.

Stored Procedures

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

Views

Views offer additional metadata information from Moneyforward.

The Sync App models the data in Money Forward Invoice into a list of tables that can be queried using standard SQL statements.

Generally, querying Money Forward Invoice tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Money Forward Invoice Connector for CData Sync Tables

Name	Description
Billings	Query the available categories in Moneyforward.
BillingsItems	Query the available BillingsItems in Moneyforward.
Items	Query the available Items in Moneyforward.
Office	Query the available Office in Moneyforward.
Partners	Query the available Partners in Moneyforward.
PartnersDepartments	Query the available PartnersDepartments in Moneyforward.

Query the available categories in Moneyforward.

Table Specific Information

Bills may be inserted, queried, or updated via the Billings, or BillingsItems tables. Bills may be deleted by using the Billings table.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

MoneyForward allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Bills are Id, BillingDate, DueDate and SalesDate. BillingDate, DueDate and SalesDate may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range, but only one of them can be used in query. For example:

SELECT * FROM Billings WHERE SalesDate > '1/1/2011' AND SalesDate < '2/1/2011'

Insert

Supported columns in INSERT statement are DepartmentId, Title, Memo, PaymentCondition, BillingDate, DueDate, SalesDate, Note, Tags, DocumentName and ItemsAggregate.

To add a Bill, specify a least DepartmentId. The ItemsAggregate column may be used to specify a JSON aggregate of Items data. The columns that may be used in these aggregates are defined in the BillingsItems and bill items may be added using Item Code of predefined items or by specifying at least Name, Quantity and Unit_price. For example, the following will insert a new Bill with two Items:

INSERT INTO Billings (DepartmentId,ItemsAggregate) VALUES ('atjCPi-Oy_EXwAw-4EpRLA','[{"name":"test prod","unit_price":1000.0,"unit":","quantity":5.0,"price":5000.0,"display_order":0,"excise":true},{"code":"AA-123"}]')

You can also use BillingsItems to insert bill items.

Update

MoneyForward allows to update DepartmentId, Title, Memo, PaymentCondition, BillingDate, DueDate, SalesDate, Note, Tags, DocumentName and ItemsAggregate columns. Id column is required in WHERE clause.

UPDATE Billings SET DepartmentId='Tp-SQwHAVjo_te2DWVLsUg',DueDate='2016-09-30',Note='new note' WHERE Id='p_eg9Tmj1lv5gMmY8uR4fw'

Delete

Bills can be deleted by issuing a DELETE statement and specifying the Id of the Bill.

DELETE FROM Billings WHERE Id='KOqtVY0chz-BgXYAyBzUvw'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		decritpion
UserId	String	True		decritpion
PartnerId	String	True		decritpion
DepartmentId	String	False		decritpion
PartnerName	String	True		decritpion
PartnerNameSuffix	String	True		decritpion
PartnerDetail	String	True		decritpion
MemberId	String	True		decritpion
MemberName	String	True		decritpion
OfficeName	String	True		decritpion
OfficeDetail	String	True		decritpion
Title	String	False		decritpion
ExcisePrice	Decimal	True		decritpion
DeductPrice	Decimal	True		decritpion
Subtotal	Decimal	True		decritpion
Memo	String	False		decritpion
PaymentCondition	String	False		decritpion
TotalPrice	Decimal	True		decritpion
BillingDate	Date	False		decritpion
DueDate	Date	False		decritpion
SalesDate	Date	False		decritpion
CreatedAt	Datetime	True		decritpion
UpdatedAt	Datetime	True		decritpion
BillingNumber	String	True		decritpion
Note	String	False		decritpion
DocumentName	String	False		decritpion
Tags	String	False		decritpion
StatusPosting	String	True		decritpion
StatusEmail	String	True		decritpion
StatusDownload	String	True		decritpion
StatusPayment	String	True		decritpion
ItemsAggregate	String	False		decritpion

Query the available BillingsItems in Moneyforward.

Table Specific Information

Bill items may be inserted,update,deleted by using the BillingsItems table.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

MoneyForward allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The only available columns for BillingsItems is BillingId and it is required in WHERE clause. For example:

SELECT * FROM BillingsItems WHERE BillingId='KOqtVY0chz-BgXYAyBzUvw'

Insert

BillingId column is required on INSERT statement. There are two ways of adding an item to an existing bill.

Using predefined items by specifying item Id.

INSERT INTO BillingsItems (BillingId,Code) VALUES ('KQvruJvizGQ8UlAkhLineA','021245447')

Creating a new item dynamically using Name, Quantity and Unit_Price columns.

INSERT INTO BillingsItems (BillingId,Name,Quantity,Unit_Price) VALUES ('KQvruJvizGQ8UlAkhLineA','New Product',10,15.5)

Update

MoneyForward allows to update BillingsItems columns except BillingId, Id CreatedAt and UpdatedAt that are readonly. BillingId and Id columns are required in WHERE clause.

UPDATE BillingsItems SET Name='Test Product',Unit='kg',Display_Order=10,Unit_Price=20 WHERE BillingId='KQvruJvizGQ8UlAkhLineA' AND Id='ozWPblxyZ5wphY1eZkKyJA'

Delete

BillingsItems can be deleted by issuing a DELETE statement and specifying the Id of the Bill and the Id of the Item.

DELETE FROM BillingsItems WHERE BillingId='EJQ9pIz4WhseeKwsq5Ecug' AND Id='NrexrTYS2BTsim4gnb5ExQ'

Columns

Name	Type	ReadOnly	References	Description
BillingId [KEY]	String	False		decritpion
Id [KEY]	String	True		decritpion
Code	String	False		decritpion
Name	String	False		decritpion
Detail	String	False		decritpion
Quantity	Double	False		decritpion
Unit_Price	Decimal	False		decritpion
Unit	String	False		decritpion
Price	Decimal	False		decritpion
Excise	String	False		decritpion The allowed values are true, false, untaxable, non_taxable, tax_exemption, five_percent, eight_percent, eight_percent_as_reduced_tax_rate, ten_percent.
Display_Order	Integer	False		decritpion
CreatedAt	Datetime	True		decritpion
UpdatedAt	Datetime	True		decritpion

Query the available Items in Moneyforward.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

MoneyForward allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The only available column for Items table is Id. For example:

SELECT * FROM Items WHERE Id='byhHeWKXKXcdzcBTEGXIgg'

Insert

Name column is required in INSERT statement.

INSERT INTO Items (Name) VALUES ('CData Driver')

Update

MoneyForward allows to update Items columns except Id, CreatedAt and UpdatedAt that are readonly. Id column is required in WHERE clause.

UPDATE Items SET Name='Test Product',Unit='kg',Display_Order=10,Unit_Price=20 WHERE Id='ozWPblxyZ5wphY1eZkKyJA'

Delete

Items can be deleted by issuing a DELETE statement and specifying the Id of the Item.

DELETE FROM ITEMS WHERE Id='byhHeWKXKXcdzcBTEGXIgg'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		decritpion
Code	String	False		decritpion
Name	String	False		decritpion
Quantity	Double	False		decritpion
Unit	String	False		decritpion
UnitPrice	Decimal	False		decritpion
Price	Decimal	True		decritpion
Excise	String	False		decritpion The allowed values are true, false, untaxable, non_taxable, tax_exemption, five_percent, eight_percent, eight_percent_as_reduced_tax_rate, ten_percent.
Detail	String	False		decritpion
CreatedAt	Datetime	True		decritpion
UpdatedAt	Datetime	True		decritpion

Query the available Office in Moneyforward.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

SELECT * FROM Office

Insert

MoneyForward does not allow offices to be added.

Update

All office columns may be updated.

UPDATE Office SET Name='New Office',Address1='New Address'");

Delete

MoneyForward does not allow offices to be deleted.

Columns

Name	Type	ReadOnly	References	Description
Name	String	False		decritpion
Zip	String	False		decritpion
Prefecture	String	False		decritpion
Address1	String	False		decritpion
Address2	String	False		decritpion
Tel	String	False		decritpion
Fax	String	False		decritpion

Query the available Partners in Moneyforward.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

MoneyForward allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The only available column for Partners is Id. For example:

SELECT * FROM Partners WHERE Id='KOqtVY0chz-BgXYAyBzUvw'

Insert

To add a Partner specify at least Name column.

INSERT INTO Partners (Name) VALUES ('New Partner')

Update

MoneyForward allows to update Partners Code, Name, Kana, Suffix and Memo columns. Id column is required in WHERE clause.

UPDATE Partners SET Name='Old Product' WHERE Id='ozWPblxyZ5wphY1eZkKyJA'

Delete

Partners can be deleted by issuing a DELETE statement and specifying the Id of the Partner.

DELETE FROM Partners WHERE Id='NrexrTYS2BTsim4gnb5ExQ'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		decritpion
Code	String	False		decritpion
Name	String	False		decritpion
Kana	String	False		decritpion
Suffix	String	False		decritpion
Memo	String	False		decritpion
CreatedAt	Datetime	True		decritpion
UpdatedAt	Datetime	True		decritpion
DepartmentsAggregate	String	True		decritpion

Query the available PartnersDepartments in Moneyforward.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

MoneyForward allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. Available columns for PartnersDepartments are Id and PartnerId that is required in WHERE clause. For example:

SELECT * FROM PartnersDepartments WHERE PartnerId='Br1hpsShuBmjMIc0BThklg'

Insert

To add a PartnerDepartment specify at least PartnerId and a non readonly column.

INSERT INTO PartnersDepartments (PartnerId,Name) VALUES ('Br1hpsShuBmjMIc0BThklg','old dep')

Update

MoneyForward allows to update all non readonly columns. PartnerId and Id columns are required in WHERE clause.

UPDATE PartnersDepartments SET Name='New Dep' WHERE PartnerId='Br1hpsShuBmjMIc0BThklg' AND Id='ozWPblxyZ5wphY1eZkKyJA'

Delete

MoneyForward does not allow PartnersDepartments to be deleted.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		decritpion
PartnerId [KEY]	String	False		decritpion
Name	String	False		decritpion
Zip	String	False		decritpion
Tel	String	False		decritpion
Prefecture	String	False		decritpion
Address1	String	False		decritpion
Address2	String	False		decritpion
PersonTitle	String	False		decritpion
PersonName	String	False		decritpion
Email	String	False		decritpion
CcEmails	String	False		decritpion
CreatedAt	Datetime	True		decritpion
UpdatedAt	Datetime	True		decritpion

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Money Forward Invoice Connector for CData Sync Views

Name	Description
SentHistory	Query the available SentHistory in Moneyforward.

Query the available SentHistory in Moneyforward.

Columns

Name	Type	References	Description
OperatorId	String		decritpion
Type	String		decritpion
DocumentType	String		decritpion
DocumentId	String		decritpion
From	String		decritpion
To	String		decritpion
Cc	String		decritpion
SentAt	Datetime		decritpion

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.

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.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
ExciseType	The type of value of the Excise column of BillingsItems and Items table.
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
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.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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.

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.

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.

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 Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that 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.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Money Forward Invoice and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your 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.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

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

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is 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 ProxyServer .

Remarks

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, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

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

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

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

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\MFInvoice Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

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

Remarks

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

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that 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
ExciseType	The type of value of the Excise column of BillingsItems and Items table.
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
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.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

The type of value of the Excise column of BillingsItems and Items table.

Remarks

It is either boolean or enum based on which Excise value is set for BillingsItems and Items entities.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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.

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

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.

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 Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Items WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"