QuickBooksOnline - Connector Settings
This document outlines the connector-specific settings for the QuickBooks Online integration. These settings allow administrators and implementation consultants to configure how the App4Sales platform interacts with QuickBooks Online, controlling data synchronization, authentication, and various operational behaviors.
Settings are typically stored and managed within the App4Sales portal's connector configuration interface. They are applied at runtime to govern the behavior of data exchanges between App4Sales and QuickBooks Online.
Setting | Description | Values / Defaults | Dependencies / Effects |
Free Fields Configuration | Configures the visibility and naming of free fields within the App4Sales application. These fields can be used to display additional information from QuickBooks Online items. | String (JSON format expected) | Affects how item information is displayed in the App4Sales app. |
API client id | The client ID provided by QuickBooks Online for API access. This identifies your App4Sales integration to QuickBooks Online. | String (GUID-like format) | Required for authentication with the QuickBooks Online API. Must correspond to a registered application in QuickBooks Online. |
API client secret | The client secret provided by QuickBooks Online, used in conjunction with the client ID for secure API access. | String (alphanumeric) | Required for authentication with the QuickBooks Online API. Must be kept confidential. |
API discovery url | The URL used to discover QuickBooks Online API endpoints and authentication information. | String (URL format, e.g., | Used during the authentication process to find QuickBooks Online's authorization and token endpoints. |
API scope value | Defines the permissions App4Sales requests from QuickBooks Online. | String (comma-separated values, e.g., | Determines what data App4Sales can access and what operations it can perform within QuickBooks Online. |
API realm id | The Realm ID (Company ID) for the specific QuickBooks Online company to which App4Sales will connect. | String (numeric) | Identifies the target company in QuickBooks Online for all API operations. |
API base url | The base URL for the QuickBooks Online API endpoints. | String (URL format, e.g., | All API requests are sent to this base URL. |
Enable USA state fields for customers | When enabled, App4Sales will utilize specific fields for USA state information for customer records, aligning with QuickBooks Online's regional customer data structures. | Boolean ( | Affects the structure of customer data exchanged, specifically for US-based customers. |
Use the Payments API to register credit cards *requires the payments module* | Activates the use of the QuickBooks Online Payments API for credit card registration. This setting requires that the App4Sales payments module is also enabled and configured. | Boolean ( | Enabling this requires the App4Sales payments module. If enabled, credit card transactions will be processed via the QuickBooks Payments API. |
Use global(non-US) company | Indicates that the connected QuickBooks Online company is a global (non-US) company. This can affect tax handling and other regional settings. | Boolean ( | Influences tax calculations and other region-specific behaviors within the connector. Relevant for the 'Tax Code id for no vat customers in global(non-US) company' setting. |
Tax Code id for no vat customers in global(non-US) company | Specifies the QuickBooks Online tax code ID to be used for customers who are not subject to VAT (Value Added Tax) in a global (non-US) company setup. | String | Only applicable when 'Use global(non-US) company' is set to |
Include item id to item code | When enabled, the QuickBooks Online item ID will be appended or incorporated into the App4Sales item code. This can help ensure uniqueness or provide additional reference. | Boolean ( | Affects how App4Sales item codes are generated or mapped from QuickBooks Online. |
Use Item SKU as Item code | When enabled, the Item SKU (Stock Keeping Unit) from QuickBooks Online will be used as the item code in App4Sales. | Boolean ( | Overrides default item code mapping, using SKU instead. This setting is mutually exclusive with 'Include item id to item code'. |
Authentication
The following settings are crucial for establishing and maintaining a secure connection with your QuickBooks Online account:
API client id: Your unique identifier for the App4Sales integration.
API client secret: A confidential key used for authenticating your application.
API discovery url: Locates the necessary endpoints for authentication.
API scope value: Defines the permissions granted to App4Sales.
API realm id: Identifies the specific QuickBooks Online company.
API base url: The primary address for all API communications.
Catalog and Item Management
Free Fields Configuration: Customize how additional item details appear in App4Sales.
Include item id to item code: Incorporates the QuickBooks Online item ID into the App4Sales item code for unique identification.
Use Item SKU as Item code: Uses the SKU from QuickBooks Online as the primary item code in App4Sales, useful for systems where SKU is the primary identifier.
Customer and Order Processing
Enable USA state fields for customers: Ensures correct handling of customer addresses for US-based companies.
Use the Payments API to register credit cards *requires the payments module*: Integrates App4Sales with QuickBooks Payments for credit card processing.
Use global(non-US) company: Adapts the connector behavior for non-US QuickBooks Online companies, affecting tax and regional settings.
Tax Code id for no vat customers in global(non-US) company: Specifies the tax code for non-VAT customers in global company setups, ensuring compliance with local tax regulations.
Known Limitations
There are no known limitations explicitly documented in the provided code snippet.