本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # 連線至 QuickBooks QuickBooks 是一款針對中小型企業的領先會計應用程式。QuickBooks 會計應用程式可追溯至 20 世紀 80 年代，是 Intuit 的首批產品之一，因此最初是桌面軟體。今天，QuickBooks 提供數個會計和商業金融應用程式作為可安裝的軟體和以雲端為基礎的 SaaS 軟體。身為 QuickBooks 使用者，您可以 AWS Glue 連線至 QuickBooks 帳戶。然後，您可以在 ETL 任務中使用 QuickBooks 作為資料來源。執行這些任務以在 QuickBooks AWS 和服務或其他支援的應用程式之間傳輸資料。 **Topics** + [AWS Glue 支援 QuickBooks](quickbooks-support.md) + [包含用於建立和使用連線的 API 操作的政策](quickbooks-configuring-iam-permissions.md) + [設定 QuickBooks](quickbooks-configuring.md) + [設定 QuickBooks 連線](quickbooks-configuring-connections.md) + [從 QuickBooks 實體中讀取](quickbooks-reading-from-entities.md) + [QuickBooks 連線選項](quickbooks-connection-options.md) + [QuickBooks 連接器的限制和備註](quickbooks-connector-limitations.md) # AWS Glue 支援 QuickBooks AWS Glue 支援 QuickBooks，如下所示： **支援作為來源？** 是。您可以使用 AWS Glue ETL 任務從 QuickBooks 查詢資料。 **支援作為目標？** 否。 **支援的 QuickBooks API 版本** 支援以下 QuickBooks API 版本： + v3 # 包含用於建立和使用連線的 API 操作的政策 下列範例政策說明建立和使用 連線所需的 AWS IAM 許可。如果您要建立新角色，請建立包含下列項目的政策： ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "glue:ListConnectionTypes", "glue:DescribeConnectionType", "glue:RefreshOAuth2Tokens", "glue:ListEntities", "glue:DescribeEntity" ], "Resource": "*" } ] } ``` ------ 如果不想使用上述方法，可選擇使用下列受管 IAM 政策： + [AWSGlueServiceRole](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AWSGlueServiceRole) – 准許存取各種 AWS Glue 程序代表您執行所需的資源。這些資源包括 AWS Glue Amazon S3、IAM、CloudWatch Logs 和 Amazon EC2。如果您遵循此政策中指定資源的命名慣例，則 AWS Glue 程序具有必要的許可。此政策通常會連接至定義編目程式、工作和開發端點時所指定的角色。 + [AWSGlueConsoleFullAccess](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/AWSGlueConsoleFullAccess) – 當政策連接至 的身分使用 AWS 管理主控台時，授予 AWS Glue 資源的完整存取權。如果您依照此政策中指定的資源命名慣例，使用者就能擁有完整的主控台功能。此政策通常連接到 AWS Glue 主控台的使用者。 # 設定 QuickBooks 您必須先符合下列要求，才能使用 從 QuickBooks AWS Glue 傳輸資料： ## 最低需求 以下是最低要求： + 您擁有一個 QuickBooks 帳戶。 + 您的 QuickBooks 帳戶已啟用 API 存取。 如需詳細資訊，請參閱 QuickBooks 文件中的下列主題： + [建立 Intuit 帳戶](https://quickbooks.intuit.com/learn-support/en-us/help-article/account-management/create-intuit-user-account/L62kSFEOM_US_en_US) + [建立並開始開發您的應用程式](https://developer.intuit.com/app/developer/qbo/docs/get-started/start-developing-your-app) 如果您符合這些要求，就可以 AWS Glue 連線到 QuickBooks 帳戶。對於一般連線，不需要在 QuickBooks 中執行任何其他操作。 # 設定 QuickBooks 連線 QuickBooks 支援 OAuth2 的 AUTHORIZATION\$1CODE 授權類型。授予類型會決定 如何與 QuickBooks AWS Glue 通訊，以請求存取您的資料。 + 此授權類型被視為「三條腿的」OAuth，因為其依賴將使用者重新導向至第三方授權伺服器來驗證使用者。透過 AWS Glue 主控台建立連線時，會使用它。 + 使用者仍然可以選擇在 QuickBooks 中建立自己的連線應用程式，並在透過 AWS Glue 主控台建立連線時提供自己的用戶端 ID 和用戶端秘密。在此案例中，它們仍會重新導向至 QuickBooks 以登入並授權 AWS Glue 存取其資源。 + 此授權類型會產生重新整理字符和存取字符。存取字符是短期存留的，可以使用重新整理字符自動重新整理，而無需使用者互動。 + 如需有關建立授權碼 OAuth 流程之連線應用程式的公有 QuickBooks 文件，請參閱[設定 OAuth 2.0](https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0)。 若要設定 QuickBooks 連線： 1. 在 AWS Glue Glue Studio 中，依照下列步驟在 **Data Connections** 下建立連線： 1. 選取**連線類型**時，請選取 QuickBooks。 1. 提供您要連線之 QuickBooks 執行個體的執行個體 URL 和公司 ID。 1. 選取 AWS Glue 可以擔任並具有下列動作許可的 AWS IAM 角色： ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:DescribeSecret", "secretsmanager:GetSecretValue", "secretsmanager:PutSecretValue", "ec2:CreateNetworkInterface", "ec2:DescribeNetworkInterfaces", "ec2:DeleteNetworkInterface" ], "Resource": "*" } ] } ``` ------ 1. 選取您要用於此連線`secretName`的 AWS Glue ，以放置字符。 1. 如果想要使用您的網路，請選取網路選項。 1. 授予與您的 AWS Glue 任務相關聯的 IAM 角色讀取 的許可`secretName`。 # 從 QuickBooks 實體中讀取 **必要條件** 您要從中讀取的 QuickBooks 物件。 **來源的支援實體**： | 實體 | 可以篩選 | 支援限制 | 支援排序依據 | 支援選取 \$1 | 支援分區 | | --- | --- | --- | --- | --- | --- | | 帳戶 | 是 | 是 | 是 | 是 | 是 | | 帳單 | 是 | 是 | 是 | 是 | 是 | | 公司資訊 | 否 | 否 | 否 | 是 | 否 | | 客戶 | 是 | 是 | 是 | 是 | 是 | | 員工 | 是 | 是 | 是 | 是 | 是 | | 預估 | 是 | 是 | 是 | 是 | 是 | | 發票 | 是 | 是 | 是 | 是 | 是 | | 項目 | 是 | 是 | 是 | 是 | 是 | | 付款 | 是 | 是 | 是 | 是 | 是 | | Preferences (偏好設定) | 否 | 否 | 否 | 是 | 否 | | 損益 | 是 | 否 | 否 | 是 | 否 | | 稅務局 | 是 | 是 | 是 | 是 | 是 | | 廠商 | 是 | 是 | 是 | 是 | 是 | **範例**： ``` QuickBooks_read = glueContext.create_dynamic_frame.from_options( connection_type="quickbooks", connection_options={ "connectionName": "connectionName", "ENTITY_NAME": "Account", "API_VERSION": "v3" } ``` **QuickBooks 實體和欄位詳細資訊**： 如需實體和欄位詳細資訊的更多資訊，請參閱： + [帳戶](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/account) + [帳單](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/bill) + [公司資訊](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/companyinfo) + [客戶](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/customer) + [員工](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/employee) + [預估](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/estimate) + [發票](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/invoice) + [Item (項目)](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/item) + [付款](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/payment) + [Preferences (偏好設定)](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/preferences) + [損益](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/profitandloss) + [稅務局](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/taxagency) + [廠商](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/vendor) ## 分區查詢 **欄位型分區**： 在 QuickBooks 中，Integer 和 DateTime 資料類型欄位支援欄位型分區。 如果想要在 Spark 中使用並行，可以提供其他 Spark 選項 `PARTITION_FIELD`、`LOWER_BOUND`、`UPPER_BOUND` 和 `NUM_PARTITIONS`。使用這些參數，原始查詢會分區為可由 Spark 任務並行執行的子查詢的 `NUM_PARTITIONS` 數目。 + `PARTITION_FIELD`：用來分區查詢的欄位名稱。 + `LOWER_BOUND`：所選分區欄位的**包含**下限值。 對於 Datetime 欄位，我們接受 Spark SQL 查詢中使用的 Spark 時間戳記格式。 有效值的範例： ``` "2024-05-07T02:03:00.00Z" ``` + `UPPER_BOUND`：所選分區欄位的**唯一**上限值。 + `NUM_PARTITIONS`：分區數目。 範例： ``` QuickBooks_read = glueContext.create_dynamic_frame.from_options( connection_type="quickbooks", connection_options={ "connectionName": "connectionName", "REALMID": "12345678690123456789", "ENTITY_NAME": "Account", "API_VERSION": "v3", "PARTITION_FIELD": "MetaData_CreateTime" "LOWER_BOUND": "2023-09-07T02:03:00.000Z" "UPPER_BOUND": "2024-05-07T02:03:00.000Z" "NUM_PARTITIONS": "10" } ``` **記錄型分區**： 原始查詢會分區為 Spark 任務可同時執行的子查詢的 `NUM_PARTITIONS` 數目： + `NUM_PARTITIONS`：分區數目。 範例： ``` QuickBooks_read = glueContext.create_dynamic_frame.from_options( connection_type="quickbooks", connection_options={ "connectionName": "connectionName", "REALMID": "1234567890123456789", "ENTITY_NAME": "Bill", "API_VERSION": "v3", "NUM_PARTITIONS": "10" } ``` # QuickBooks 連線選項 以下是 QuickBooks 的連線選項： + `ENTITY_NAME`(String) - (必要) 用於讀取。QuickBooks 中的物件名稱。 + `INSTANCE_URL`(String) - (必要) 有效的 QuickBooks 執行個體 URL。 + `API_VERSION`(String) - (必要) 用於讀取。您要使用的 QuickBooks Rest API 版本。 + `REALM_ID`(String) - 一個 ID，其識別您在其中傳送請求的個別 QuickBooks 線上公司。 + `SELECTED_FIELDS`(List) - 預設：empty(SELECT \$1)。用於讀取。您要為物件選取的資料欄。 + `FILTER_PREDICATE`(String) - 預設：空白。用於讀取。其應該為 Spark SQL 格式。 + `QUERY`(String) - 預設：空白。用於讀取。完整的 Spark SQL 查詢。 + `PARTITION_FIELD`(String) - 用於讀取。用於分區查詢的欄位。 + `LOWER_BOUND`(String) - 用於讀取。所選分區欄位的包含下限值。 + `UPPER_BOUND`(String) - 用於讀取。所選分區欄位的唯一上限值。 + `NUM_PARTITIONS`(Integer) - 預設：1。用於讀取。要讀取的分區數目。 # QuickBooks 連接器的限制和備註 以下是 QuickBooks 連接器的限制或備註： + 在 `taxAgency` API 中，按篩選排序未按預期運作。