Xero

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 for compatível com 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.

Limitações do sistema

O conector do Xero pode processar cinco transações por segundo, por nó, e limita qualquer transação além desse limite. No entanto, o número de transações que o conector do Xero pode processar também depende das restrições impostas pela instância do Xero. Para mais informações, consulte Limites de taxa da API Xero. Por padrão, o Integration Connectors aloca dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Ações

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

Ação DownloadAttachment

Essa ação baixa um anexo.

Parâmetros de entrada da ação DownloadAttachment

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

Essa ação retorna o status 200 (OK) se o download for bem-sucedido.

Para entender como configurar a ação DownloadAttachment, consulte Exemplos de ações.

Ação UploadAttachment

Com essa ação, você pode fazer upload de um anexo.

Parâmetros de entrada da ação UploadAttachment

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

Essa ação retorna o status 200 (OK) se o upload do objeto for bem-sucedido.

Para entender como configurar a ação UploadAttachment, consulte Exemplos de ações.

Ação ListAttachment

Essa ação permite listar todos os anexos de uma tabela.

Parâmetros de entrada da ação ListAttachment

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

Essa ação retorna o status 200 (OK) se a exclusão for bem-sucedida.

Para entender como configurar a ação ListAttachment, consulte Exemplos de ações.

Ação SendInvoiceMail

Com essa ação, você pode enviar e-mails para um faturador.

Parâmetros de entrada da ação SendInvoiceMail

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

Essa ação retorna o status 200 (OK) se a operação de movimentação for bem-sucedida.

Para entender como configurar a ação SendInvoiceMail, consulte Exemplos de ações.

Ação UploadFile

Essa ação permite fazer upload de um arquivo.

Parâmetros de entrada da ação UploadFile

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

Essa ação retorna o status 200 (OK) se o upload do objeto for bem-sucedido.

Para entender como configurar a ação UploadFile, consulte Exemplos de ações.

Exemplos de ações

Nesta seção, descrevemos como executar algumas das ações neste conector.

Exemplo: baixar um anexo

Este exemplo faz o download de um anexo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadAttachment 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:

   {
   "Filename": "Xero_Test.txt",
   "Table": "Contacts",
   "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41"
   }

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

[{
"Success": "True",
"Content": "Test content"
}]

Exemplo: fazer upload de um anexo

Este exemplo faz upload de um anexo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UploadAttachment 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:

   {
   "Filename": "Xero_Test.txt",
   "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
   "ContentType": "txt",
   "Table": "Contacts",
   "Content": "Test content upload attachment"
   }

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

[{
"Success": null,
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Test.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27",
"IncludeOnline": null,
"_": ""
}, {
"Success": null,
"AttachmentId": null,
"FileName": null,
"URL": null,
"MimeType": null,
"ContentLength": null,
"IncludeOnline": null,
"_": null
}]

Exemplo: listar anexos

Este exemplo lista os anexos da tabela especificada.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação ListAttachment 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:

   {
   "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
   "Table": "Contacts"
   }

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

[{
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Limit_Testing.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27"
}]

Exemplo: enviar um e-mail com uma fatura

Este exemplo envia um e-mail para a fatura especificada.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação SendInvoiceMail 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:

   {
   "InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566"
   }

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

[{
"Success": "true"
}]

Exemplo: fazer upload de um arquivo

Este exemplo faz o upload de um arquivo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UploadFile 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:

   {
   "Name": "Sample1.txt",
   "Content": "This is a sample file"
   }

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

[{
"Success": "true",
"FileId": "09039c7b-35a2-473d-aa79-16fe00b8d460",
"Name": "Sample1.txt",
"FolderId": "36e5115d-a9b6-4c22-baf3-40a8b28ee71d",
"MimeType": "text/plain",
"Size": 26.0,
"User_Id": "c1e33cc9-eb61-45cb-9e46-3ea4121cbdc6",
"User_Name": "test_user_1@test.com",
"User_FirstName": "John",
"User_LastName": "Smith",
"User_FullName": "John Smith",
"Created": "2023-12-18 17:38:53.01",
"Updated": "2023-12-18 17:38:53.01"
}]

Exemplos de operações de entidade

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

Exemplo: listar todos os registros

Este exemplo lista todos os registros na entidade Accounts.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Accounts 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. Por exemplo, City='Bangalore'. Também é possível especificar várias condições de filtro usando os operadores lógicos. Por exemplo, City='Bangalore' and region='asia-south2'.

Exemplo: receber uma fatura

Este exemplo recebe uma fatura com o ID especificado da entidade Invoices.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Invoices na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em EntityId e insira 1|016a64c7-be0b-45a2-acae-13057fdf1566 no campo Valor padrão.

   Aqui, 1|016a64c7-be0b-45a2-acae-13057fdf1566 é um valor de chave primária na entidade Invoices.

Exemplo: criar uma fatura

Este exemplo cria uma fatura na entidade Invoices.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Invoices 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:

   {
   "Type": "ACCPAY",
   "ContactName": "ContactName1",
   "LineItem_Description": "LineItemDescription"
   }

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

   {
   "Id": "1|7b29efe9-dacd-47bb-85a6-0c0640ce25de"
   }

Exemplo: atualizar um registro

Este exemplo atualiza um registro na entidade AssetTypes.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione AssetTypes 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:

   {
   "BookDepreciationSetting_DepreciationRate": 10.0
   }

5. Clique em entityId e digite f8d43548-25b0-4cc3-8f59-d97106974fe8 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:

   {
   "AssetTypeId": "f8d43548-25b0-4cc3-8f59-d97106974fe8"
   }

Exemplo: excluir um arquivo

Este exemplo exclui o arquivo com o ID especificado da entidade Files.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Files na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e insira 421c82f0-38fb-4074-a679-63b04c0d8832 no campo Valor padrão.