Acumatica

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

• 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

  但可能的情况是，连接器不支持或不具有任何实体，在这种情况下，Entities 列表将为空。

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • 列表
  • 获取
  • 创建
  • 更新
  • 删除

  从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。不过，如果连接器不支持任何实体操作，则不支持的操作不会列在 Operations 列表中。

• 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作会包含一些输入参数和一个输出参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

操作

本部分列出了连接器支持的操作。如需了解如何配置操作，请参阅操作示例。

ExecuteAction 操作

此操作可让您执行操作。

ExecuteAction 操作的输入参数

ExecuteAction 操作的输出参数

此操作会返回 ExecuteAction 的确认消息。

如需查看有关如何配置 ExecuteAction 操作的示例，请参阅示例。

操作示例

示例 - 执行操作

此操作会执行指定的操作。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 ExecuteAction 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "ActionName": "PrintSalesOrder",   
   "TopLevelEntity": "SalesOrder"
   "EntityRecord": "{
   "Type": {
     "value": "IN"
   },
   "OrderNbr": {
     "value": "000007"
   },
   "CustomerID": {
     "value": "CANDYY"
   },
   "LocationID": {
     "value": "MAIN"
   }}}"

如果操作成功，ExecuteAction 任务的 connectorOutputPayload 响应形参将具有类似以下的值：

[{
"Status": "Success",   
"AffectedRecords": "1"
}] 

实体操作示例

本部分介绍如何在此连接器中执行一些实体操作。

示例 - 列出所有客户

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Customer。
3. 选择 List 操作，然后点击完成。
4. （可选）在连接器任务的任务输入部分，您可以通过指定过滤条件子句来过滤结果集。 请务必使用英文单引号 (') 括起过滤条件子句值。

示例 - 列出所有日志交易

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 JournalTransaction。
3. 选择 List 操作，然后点击完成。

示例 - 列出所有销售订单

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 SalesOrder。
3. 选择 List 操作，然后点击完成。

示例 - 获取采购订单详细信息

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 PurchaseOrder。
3. 选择 Get 操作，然后点击完成。
4. 设置实体 ID 以获取采购订单详细信息。如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 000001，并选择 EntityId 作为局部变量。

示例 - 获取销售人员的详细信息

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Salesperson。
3. 选择 Get 操作，然后点击完成。
4. 设置实体 ID 以获取销售人员详细信息。如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 SP0001，并选择 EntityId 作为局部变量。

示例 - 获取供应商详细信息

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Vendor。
3. 选择 Get 操作，然后点击完成。
4. 设置实体 ID 以获取供应商详细信息。如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 ACMEDO，并选择 EntityId 作为局部变量。

示例 - 删除账号

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Account。
3. 选择 Delete 操作，然后点击完成。
4. 设置实体 ID 以删除账号。如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 10250，并选择 EntityId 作为局部变量。

示例 - 删除客户

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Customer。
3. 选择 Delete 操作，然后点击完成。
4. 设置实体 ID 以删除客户。如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 SANDWICH，并选择 EntityId 作为局部变量。

示例 - 删除销售人员

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Salesperson。
3. 选择 Delete 操作，然后点击完成。
4. 设置要删除的销售人员的实体 ID。如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 SP0004，并选择 EntityId 作为局部变量。

示例 - 创建日记账交易

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 JournalTransaction。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
     "Description": "go again",
     "BatchNbr": "000008",
     "CurrencyID": "INR",
     "Module": "GL" 
       }
     

   如果集成成功，连接器任务的 connectorOutputPayload 字段将具有类似于以下内容的值：

   [{
       "BatchNbr": "000016",   "Module": "GL" 
       }]
       

示例 - 创建客户

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Customer。
3. 选择 Create 操作，然后点击完成。
4. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
        "LocationName": "Primary Location",
        "StatementCycleID": "WEEKLY",
        "CustomerClass": "CSTMRCLAS1",
        "CurrencyID": "INR",
        "CustomerID": "BISCCITY",
        "CustomerName": "Biscuit City Cafe" 
        }

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
        "CustomerID": "BISCCITY"
        }

示例 - 创建销售订单

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 SalesOrder。
3. 选择 Create 操作，然后点击完成。
4. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
        "Approved": true,
        "BaseCurrencyID": "INR",
        "CashAccount": "10200",
        "ControlTotal": 30.0,
        "CustomerID": "BISCCITY",
        "Description": "SO--0016"
        }

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
        "OrderNbr": "000025",
        "OrderType": "CS" 
        }

示例 - 创建采购订单

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 PurchaseOrder。
3. 选择 Create 操作，然后点击完成。
4. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
        "ControlTotal": 200.0,
        "CurrencyID": "INR",
        "Description": "PO--14",
        "VendorID": "ACMEDO"
        }

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
        "OrderNbr": "000021",
        "Type": "Normal"
        }

示例 - 创建销售人员

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Salesperson。
3. 选择 Create 操作，然后点击完成。
4. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
        "Name": "Sales person 0009",
        "SalespersonID": "SP0009",
        "DefaultCommission": 10.0
        }

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
        "SalespersonID": "SP0009" 
        }

示例 - 创建供应商

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Vendor。
3. 选择 Create 操作，然后点击完成。
4. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
        "APAccount": "20000",
        "CashAccount": "10200",
        "LocationName": "Secondary Location",
        "MaxReceipt": 100.0,
        "MinReceipt": 0.0,
        "VendorClass": "DEFAULTV",
        "VendorID": "ALLFRUITS"
        }

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
        "VendorID": "ALLFRUITS"
        }

示例 - 创建账单

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Bill。
3. 选择 Create 操作，然后点击完成。
4. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
        "Amount": 10.0,
        "Description": "new test",
        "DueDate": "2024-01-26 00:00:00.0",
        "LocationID": "MAIN",
        "Terms": "30D",
        "Vendor": "TESTVENDOR"
        }

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
        "ReferenceNbr": "000020",
        "Type": "Bill"
        }

示例 - 创建检查

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Check。
3. 选择 Create 操作，然后点击完成。
4. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
        "Description": "check check check",
        "CurrencyID": "INR",
        "CashAccount": "10200",
        "PaymentMethod": "CHECK",
        "Vendor": "ACMEDO"
        }

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
        "ReferenceNbr": "000013",
        "Type": "Payment"
        }

示例 - 创建销售账单

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 SalesInvoice。
3. 选择 Create 操作，然后点击完成。
4. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
        "Description": "testing custom",
        "Amount": 10.0,
        "Balance": 0.0,
        "CustomerID": "BISCCITY",
        "DueDate": "2023-04-21 00:00:00.0"
        }

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
        "ReferenceNbr": "000024",
        "Type": "Invoice"
        }

示例 - 创建账单

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Invoice。
3. 选择 Create 操作，然后点击完成。
4. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   { 
        "Terms": "30D",
        "Description": "forever",
        "LocationID": "MAIN",
        "Customer": "BISCCITY", 
        "LinkARAccount": "11000"
        }

   运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

   {
        "ReferenceNbr": "000026",
        "Type": "Invoice"
        }

示例 - 更新销售订单详情

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 SalesOrder。
3. 选择 Update 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
         "Approved": true,
         "Description": "SO--0014"
           }
     

5. 点击 entityId，然后在默认值字段中输入 000025。

   如果集成成功，连接器任务的 connectorOutputPayload 字段将具有类似于以下内容的值：

   [{
         "OrderNbr": "000025",
         "OrderType": "CS"
           }]
     

示例 - 更新付款信息

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Payment。
3. 选择 Update 操作，然后点击完成。
4. 设置要更新的付款信息的实体 ID。如需设置实体 ID，请在任务的数据映射器部分中，点击 FilterClause，然后在指定字段中输入 ReferenceNbr='000007' AND Type='Payment'。
5. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
   "CurrencyID": "INR"
   }
   

您也可以将 filterClause 设置为 ReferenceNbr='000007' AND Type='Payment'，而不是指定 entityId。

运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

{
"ReferenceNbr": "000007",
"Type": "Payment" 
}

示例 - 更新项目交易详情

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 ProjectTransaction。
3. 选择 Update 操作，然后点击完成。
4. 设置要更新项目交易详情的实体 ID。如需设置实体 ID，请在任务的数据映射器部分中，点击 FilterClause，然后在指定字段中输入 Module='PM' AND ReferenceNbr='PM00000003'。
5. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
   "Description": "updated"
   }
   

您也可以将 filterClause 设置为 Module='PM' AND ReferenceNbr='PM00000003'，而不是指定 entityId。

运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

{
"Module": "PM",
"ReferenceNbr": "PM00000003"
}

示例 - 更新日记账交易详情

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 JournalTransaction。
3. 选择 Update 操作，然后点击完成。
4. 设置要更新的日记账交易明细的实体 ID。如需设置实体 ID，请在任务的数据映射器部分中，点击 FilterClause，然后在指定字段中输入 BatchNbr='000016' AND Module='GL'。
5. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

    
   {
   "BatchNbr": "000012",
   "CurrencyID": "INR",
   "Description": "updated",
   "Module": "GL"
   }
   

您也可以将 filterClause 设置为 BatchNbr='000016' AND Module='GL'，而不是指定 entityId。

运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

{
"BatchNbr": "000012",
"Module": "GL"
}

示例 - 更新客户详细信息

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Customer。
3. 选择 Update 操作，然后点击完成。
4. 设置实体 ID 以更新客户详细信息。如需设置实体 ID，请在任务的数据映射器部分，点击 entityId，然后在指定字段中输入 BISCCITY。
5. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
   "LocationName": "Primary Location",
   "StatementCycleID": "DAILY",
   "CustomerID": "BISCCITY",
   "CustomerClass": "CSTMRCLAS1",
   "Terms": "30D"
   }
   

您也可以将 filterClause 设置为 BISCCITY，而不是指定 entityId。

运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

 {
"CustomerID": "BISCCITY"
} 

示例 - 更新采购订单详细信息

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 PurchaseOrder。
3. 选择 Update 操作，然后点击完成。
4. 设置要更新的采购订单详细信息的实体 ID。如需设置实体 ID，请在任务的数据映射器部分中，点击 FilterClause，然后在指定字段中输入 OrderNbr='000025' AND OrderType='CS'。
5. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
   "Approved": true,
   "Description": "SO--0014"
   }
   

您也可以将 filterClause 设置为 OrderNbr='000025' AND OrderType='CS'，而不是指定 entityId。

运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

{
"OrderNbr": "000025",
"OrderType": "CS"
}

示例 - 更新销售人员详细信息

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Salesperson。
3. 选择 Update 操作，然后点击完成。
4. 设置实体 ID 以更新销售人员详细信息。如需设置实体 ID，请在任务的数据映射器部分，点击 entityId，然后在指定字段中输入 SP0009。
5. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
   "DefaultCommission": 20.0
   }
   

您也可以将 filterClause 设置为 SP0009，而不是指定 entityId。

运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

{
"SalespersonID": "SP0009"
}

示例 - 更新账单明细

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Bill。
3. 选择 Update 操作，然后点击完成。
4. 设置要更新的账单明细的实体 ID。如需设置实体 ID，请在任务的数据映射器部分中，点击 FilterClause，然后在指定字段中输入 ReferenceNbr='000019' AND Type='Bill'。
5. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
   "Amount": 10.0,
   "Description": "updated"
   }
   

您也可以将 filterClause 设置为 ReferenceNbr='000019' AND Type='Bill'，而不是指定 entityId。

运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

{
"ReferenceNbr": "000019",
"Type": "Bill"
}

示例 - 更新检查详情

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Check。
3. 选择 Update 操作，然后点击完成。
4. 设置实体 ID 以更新检查详情。如需设置实体 ID，请在任务的数据映射器部分中，点击 FilterClause，然后在指定字段中输入 ReferenceNbr='000013' AND Type='Payment'。
5. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

   {
   "Description": "updated check"
   }
   

您也可以将 filterClause 设置为 ReferenceNbr='000013' AND Type='Payment'，而不是指定 entityId。

运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

{
"ReferenceNbr": "000013",
"Type": "Payment"
}

示例 - 更新销售账单明细

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 SalesInvoice。
3. 选择 Update 操作，然后点击完成。
4. 设置实体 ID 以更新销售账单明细。如需设置实体 ID，请在任务的数据映射器部分中，点击 FilterClause，然后在指定字段中输入 ReferenceNbr='000024'。
5. 在任务的数据映射器部分中，点击 OpenDataMapping 编辑器，然后在 field: 中输入类似于以下内容的值

    
   {
   "Description": "shipping pastries"
   }
   

您也可以将 filterClause 设置为 ReferenceNbr='000024'，而不是指定 entityId。

运行此示例后，连接器任务的 connectorOutputPayload 输出变量中会返回类似于以下内容的响应：

 {
"ReferenceNbr": "000024",
"Type": "Invoice"
}