Acumatica

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

• Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
  • Lista
  • Receber
  • Criar
  • Atualizar
  • Excluir

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações não serão listadas na lista Operations.

• Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Ações

Esta seção lista as ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ações.

Ação ExecuteAction

Essa ação permite executar uma ação.

Parâmetros de entrada da ação ExecuteAction

Parâmetros de saída da ação ExecuteAction

Essa ação retorna uma mensagem de confirmação do ExecuteAction.

Para ver um exemplo de como configurar a ação ExecuteAction, consulte Exemplos.

Exemplos de ações

Exemplo: executar uma ação

Essa ação executa a ação especificada.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação ExecuteAction e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa ExecuteAction terá um valor semelhante a este:

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

Exemplos de operações de entidade

Nesta seção, mostramos como realizar algumas das operações de entidade neste conector.

Exemplo: listar todos os clientes

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Customer na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Se quiser, na seção Entrada de tarefa da tarefa Conectores, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Sempre especifique o valor da cláusula de filtro entre aspas simples (').

Exemplo: listar todas as transações do diário

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione JournalTransaction na lista Entity.
3. Selecione a operação List e clique em Concluído.

Exemplo: listar todos os pedidos de venda

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione SalesOrder na lista Entity.
3. Selecione a operação List e clique em Concluído.

Exemplo: receber os detalhes de uma ordem de compra

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione PurchaseOrder na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Defina o ID da entidade para receber os detalhes de uma ordem de compra. Para definir o ID da entidade, na seção Data Mapper do Data Mapping, clique em Open Data Mapping Editor e insira 000001 no campo Input Value. Escolha EntityId como variável local.

Exemplo: receber os detalhes de um vendedor

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Salesperson na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Defina o ID da entidade para receber os detalhes de um vendedor. Para definir o ID da entidade, na seção Data Mapper do Data Mapping, clique em Open Data Mapping Editor e insira SP0001 no campo Input Value. Escolha EntityId como variável local.

Exemplo: receber detalhes de um fornecedor

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Vendor na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Defina o ID da entidade para receber os detalhes de um fornecedor. Para definir o ID da entidade, na seção Data Mapper do Data Mapping, clique em Open Data Mapping Editor e insira ACMEDO no campo Input Value. Escolha EntityId como variável local.

Exemplo: excluir uma conta

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Account na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Defina o ID da entidade para excluir uma conta. Para definir o ID da entidade, na seção Data Mapper do Data Mapping, clique em Open Data Mapping Editor e insira 10250 no campo Input Value. Escolha EntityId como variável local.

Exemplo: excluir um cliente

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Customer na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Defina o ID da entidade para excluir um cliente. Para definir o ID da entidade, na seção Data Mapper do Data Mapping, clique em Open Data Mapping Editor e insira SANDWICH no campo Input Value. Escolha EntityId como variável local.

Exemplo: excluir um vendedor

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Salesperson na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Defina o ID da entidade para excluir o representante de vendas. Para definir o ID da entidade, na seção Data Mapper do Data Mapping, clique em Open Data Mapping Editor e insira SP0004 no campo Input Value. Escolha EntityId como variável local.

Exemplo: criar uma transação de diário

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione JournalTransaction na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

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

Exemplo: criar um cliente

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Customer na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data mapper da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
        "CustomerID": "BISCCITY"
        }

Exemplo: criar um pedido de venda

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione SalesOrder na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data mapper da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: criar uma ordem de compra

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione PurchaseOrder na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data mapper da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: criar um vendedor

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Salesperson na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data mapper da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
        "SalespersonID": "SP0009" 
        }

Exemplo: criar um fornecedor

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Vendor na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data mapper da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
        "VendorID": "ALLFRUITS"
        }

Exemplo: criar uma fatura

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Bill na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data mapper da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: criar uma verificação

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Check na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data mapper da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: criar uma fatura de venda

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione SalesInvoice na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data mapper da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: criar uma fatura

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Invoice na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Data mapper da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

   A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: atualizar os detalhes de um pedido de venda

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione SalesOrder na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

5. Clique em entityId e digite 000025 no campo Valor padrão.

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

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

Exemplo: atualizar detalhes de pagamento

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Payment na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar os detalhes de pagamento. Para definir o ID da entidade, na seção Data mapper das Tarefas, clique em FilterClause e insira ReferenceNbr='000007' AND Type='Payment' no campo indicado.
5. Na seção Mapeador de dados da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

   {
   "CurrencyID": "INR"
   }
   

Em vez de especificar o entityId, você também pode definir a filterClause como ReferenceNbr='000007' AND Type='Payment'.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: atualizar os detalhes de uma transação de projeto

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione ProjectTransaction na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar os detalhes de uma transação do projeto. Para definir o ID da entidade, na seção Data mapper das Tarefas, clique em FilterClause e insira Module='PM' AND ReferenceNbr='PM00000003' no campo indicado.
5. Na seção Mapeador de dados da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

   {
   "Description": "updated"
   }
   

Em vez de especificar o entityId, você também pode definir a filterClause como Module='PM' AND ReferenceNbr='PM00000003'.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: atualizar os detalhes de uma transação de diário

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione JournalTransaction na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar os detalhes de uma transação de diário. Para definir o ID da entidade, na seção Data mapper das Tarefas, clique em FilterClause e insira BatchNbr='000016' AND Module='GL' no campo indicado.
5. Na seção Mapeador de dados da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

Em vez de especificar o entityId, você também pode definir a filterClause como BatchNbr='000016' AND Module='GL'.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: atualizar os detalhes de um cliente

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Customer na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar os detalhes de um cliente. Para definir o ID da entidade, na seção Data mapper de Tasks, clique em entityId e insira BISCCITY no campo indicado.
5. Na seção Mapeador de dados da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

Em vez de especificar o entityId, você também pode definir a filterClause como BISCCITY.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

 {
"CustomerID": "BISCCITY"
} 

Exemplo: atualizar os detalhes de uma ordem de compra

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione PurchaseOrder na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar os detalhes de uma ordem de compra. Para definir o ID da entidade, na seção Data mapper das Tarefas, clique em FilterClause e insira OrderNbr='000025' AND OrderType='CS' no campo indicado.
5. Na seção Mapeador de dados da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

Em vez de especificar o entityId, você também pode definir a filterClause como OrderNbr='000025' AND OrderType='CS'.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: atualizar os detalhes de um vendedor

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Salesperson na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar os detalhes de um vendedor. Para definir o ID da entidade, na seção Data mapper de Tasks, clique em entityId e insira SP0009 no campo indicado.
5. Na seção Mapeador de dados da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

   {
   "DefaultCommission": 20.0
   }
   

Em vez de especificar o entityId, você também pode definir a filterClause como SP0009.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

{
"SalespersonID": "SP0009"
}

Exemplo: atualizar os detalhes de uma fatura

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Bill na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar os detalhes de uma fatura. Para definir o ID da entidade, na seção Data mapper das Tarefas, clique em FilterClause e insira ReferenceNbr='000019' AND Type='Bill' no campo indicado.
5. Na seção Mapeador de dados da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

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

Em vez de especificar o entityId, você também pode definir a filterClause como ReferenceNbr='000019' AND Type='Bill'.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: atualizar os detalhes de uma verificação

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Check na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar os detalhes de uma verificação. Para definir o ID da entidade, na seção Data mapper das Tarefas, clique em FilterClause e insira ReferenceNbr='000013' AND Type='Payment' no campo indicado.
5. Na seção Mapeador de dados da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

   {
   "Description": "updated check"
   }
   

Em vez de especificar o entityId, você também pode definir a filterClause como ReferenceNbr='000013' AND Type='Payment'.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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

Exemplo: atualizar os detalhes de uma fatura de venda

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione SalesInvoice na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar os detalhes de uma fatura de venda. Para definir o ID da entidade, na seção Data mapper das Tarefas, clique em FilterClause e insira ReferenceNbr='000024' no campo indicado.
5. Na seção Mapeador de dados da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

    
   {
   "Description": "shipping pastries"
   }
   

Em vez de especificar o entityId, você também pode definir a filterClause como ReferenceNbr='000024'.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

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