QuickBooks Online¶
The QuickBooks Online connector is a Palantir-provided driver for QuickBooks Online.
To create a new QuickBooks Online source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for QuickBooks Online-specific configuration and networking. For the complete property reference, see the official QuickBooks Online driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
CompanyId ↗ |
Mandatory | The unique identifier of a given company in QuickBooks Online. | — |
CountryCode ↗ |
Recommended | The country code for the edition of QuickBooks Online being used. | US |
InitiateOAuth ↗ |
Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | REFRESH |
OAuthClientId ↗ |
Recommended | Specifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. | — |
OAuthClientSecret ↗ |
Recommended | 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. | — |
UseSandbox ↗ |
Recommended | A boolean indicating if you are using a Sandbox account. | FALSE |
Networking¶
The table below lists the domains that the source needs to be able to access in order to successfully run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| quickbooks.api.intuit.com | If UseSandbox=FALSE (Default) |
| sandbox-quickbooks.api.intuit.com | If UseSandbox=TRUE |
| qbo.sbfinance.intuit.com | Used when retrieving Entitlements (only available when UseSandbox=FALSE) |
| appcenter.intuit.com | Authorization URL |
| developer.api.intuit.com | Always. May be used for token disconnects |
| oauth.platform.intuit.com | Always. Token URL |
中文翻译¶
QuickBooks Online¶
QuickBooks Online 连接器是 Palantir 为 QuickBooks Online 提供的驱动程序（Palantir-provided driver）。
要创建新的 QuickBooks Online 数据源，请遵循 Palantir 提供驱动程序的标准设置流程（standard setup flow），然后使用以下各节进行 QuickBooks Online 特定的配置和网络设置。有关完整的属性参考，请参阅官方 QuickBooks Online 驱动程序文档（official QuickBooks Online driver documentation）↗。
配置（Configuration）¶
以下属性为必填或推荐项。
| 属性（Property） | 是否必填 | 描述（Description） | 默认值（Default） |
|---|---|---|---|
CompanyId ↗ |
必填 | QuickBooks Online 中特定公司的唯一标识符。 | — |
CountryCode ↗ |
推荐 | 所使用的 QuickBooks Online 版本对应的国家/地区代码。 | US |
InitiateOAuth ↗ |
推荐 | 指定获取或刷新 OAuth 访问令牌（access token）的流程，该令牌用于在已认证的授权用户操作期间维持用户访问权限。 | REFRESH |
OAuthClientId ↗ |
推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端 ID（client Id）。（也称为消费者密钥 consumer key。）该 ID 用于向 OAuth 授权服务器注册自定义应用程序。 | — |
OAuthClientSecret ↗ |
推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端密钥（client secret）。（也称为消费者密钥 consumer secret。）该密钥用于向 OAuth 授权服务器注册自定义应用程序。 | — |
UseSandbox ↗ |
推荐 | 一个布尔值，指示是否使用沙箱账户（Sandbox account）。 | FALSE |
网络配置（Networking）¶
下表列出了数据源为成功运行而需要能够访问的域名。
对于每个域名，请添加相应的出站策略（egress policy）。如果数据源部署在本地且无法直接从 Foundry 访问，请改用代理出站策略（agent proxy egress policy）；代理主机本身也必须能够访问所列出的域名。详情请参阅使用代理作为代理（using an agent as a proxy）。
| 域名（Domain） | 是否必需 |
|---|---|
| quickbooks.api.intuit.com | 当 UseSandbox=FALSE（默认值）时 |
| sandbox-quickbooks.api.intuit.com | 当 UseSandbox=TRUE 时 |
| qbo.sbfinance.intuit.com | 用于检索授权（Entitlements）（仅在 UseSandbox=FALSE 时可用） |
| appcenter.intuit.com | 授权 URL（Authorization URL） |
| developer.api.intuit.com | 始终必需。可能用于令牌断开连接 |
| oauth.platform.intuit.com | 始终必需。令牌 URL（Token URL） |