Atividades de Exclusão do Conector do QuickBooks

Antes de poder excluir os dados do QuickBooks do Jitterbit, você precisará criar um endpoint do QuickBooks no Jitterbit Studio (consulte QuickBooks Connector OAuth 1.0a - Create Endpoint ou Conector QuickBooks 2.0 - Criar Endpoint. Agora que o Jitterbit tem acesso à sua instância do QuickBooks Online, você pode realizar quatro atividades principais com seus dados do QuickBooks : Consultar, Criar, Atualizar ou Excluir.

Esta página se concentra na exclusão de dados do QuickBooks, usando um exemplo de exclusão de um crédito de fornecedor com uma ID específica no QuickBooks por meio de um arquivo XML por meio do Jitterbit. Essas etapas são divididas em iniciar a atividade de exclusão, definir os componentes da operação e implantar e executar a operação.

Como solução alternativa, se desejar excluir dados associados a um componente específico para o qual a atividade Excluir não é permitida, você pode executar uma atividade Atualizar e definir sparse="0" para definir todos os campos como nulos. Veja mais em Conector do QuickBooks - Atualizar atividades.

Para referência, consulte o Jitterpak QuickBooksExample.jpk e os arquivos correspondentes em QuickBooksSampleRequestFiles.zip necessário para executar as operações do Jitterpak. Descompacte QuickBooksSampleRequestFiles.zip em sua unidade "C:\" ou, se descompactar em outro diretório, certifique-se de editar os diretórios de origem e destino nas operações. Se esta é a primeira vez que usa um Jitterpak, consulte Importing a Jitterpak.

Criando uma Operação de Exclusão do QuickBooks

1. Dentro do seu projeto no Jitterbit Studio, existem várias maneiras de iniciar uma nova atividade de exclusão do QuickBooks. Cada uma das opções a seguir iniciará o Assistente de exclusão do QuickBooks para guiá-lo durante o processo.

   • Vá para Arquivo > Novo > Conectores > Novo QuickBooks Excluir.
   • Na árvore à esquerda em Conectores, clique com o botão direito do mouse na categoria QuickBooks e selecione Novo QuickBooks Excluir.
   • Na árvore à esquerda em Conectores, clique duas vezes na categoria QuickBooks, clique com o botão direito do mouse em QuickBooks Excluir Atividades e selecione Novo QuickBooks Excluir.
   • Na barra de ferramentas superior, clique no ícone do conector (peça de quebra-cabeça laranja) . No pop-up, selecione QuickBooks e selecione QuickBooks Delete.

2. A tela Endpoint do QuickBooks Delete Wizard solicita que você selecione o endpoint do qual gostaria de excluir os dados. Você já deve ter configurado endpoints em QuickBooks Connector OAuth 1.0a - Create Endpoint ou Conector QuickBooks 2.0 - Criar Endpoint. Selecione o endpoint apropriado, por exemplo, um sandbox ou endpoint de produção. Clique em Avançar quando terminar.

   Nota

   O exemplo usado nesta documentação exclui um Crédito de fornecedor para um cliente específico em uma conta sandbox do QuickBooks. Para referência adicional, você também pode acompanhar os exemplos de criação e atualização para crédito de fornecedor fornecidos no Jitterpak.

   

3. A tela Objeto do Assistente de exclusão do QuickBooks solicita que você selecione o Objeto do qual gostaria de excluir. Neste exemplo, usamos a API de contabilidade durante a criação do aplicativo QuickBooks Online e, portanto, temos apenas um Objeto para selecionar: Contabilidade. Clique no Objeto e em Avançar para continuar.

   

4. A tela Componente do Assistente de exclusão do QuickBooks exibe todos os componentes associados ao objeto Contabilidade na sua instância do QuickBooks conectada. Para fins deste passo a passo, excluiremos um Vendor Credit existente e, portanto, selecionaremos o componente VendorCredit. Em seguida, clique no botão Concluir.

   Nota

   Nem todos esses componentes podem necessariamente ser excluídos do Jitterbit devido às limitações impostas pelo software QuickBooks.

5. O Jitterbit Studio prosseguirá com a criação de uma estrutura de solicitação e resposta da API do QuickBooks que permitirá que os dados sejam atualizados em sua instância conectada do QuickBooks Online. Uma nova aba deve aparecer no Studio chamada QuickBooks Delete Activities. Você pode renomear sua atividade de criação aqui, se desejar; no exemplo, o nosso é chamado de "Excluir QuickBooks do cliente".

   Clique no ícone + na extremidade direita das exibições de estrutura de solicitação e resposta para expandir todos os elementos dentro de cada estrutura. Com cada lado agora expandido, você deve ver uma tela semelhante à imagem mostrada abaixo.

6. Em seguida, na mesma tela, clique no botão Criar Operação localizado em Usar em uma Integração no canto superior direito. Isso criará a operação Jitterbit que excluirá os dados de crédito do fornecedor existentes no QuickBooks.

7. Uma nova aba deve abrir no Studio chamada Operações, contendo uma representação gráfica da atividade Excluir. Salve sua operação clicando no ícone de disco único para salvar apenas esta operação ou no ícone de vários discos para salvar todas as alterações em seu projeto de integração. Você deve ver o asterisco na aba Operações e o título da Operação desaparecer, pois sua nova atividade Excluir foi criada e salva em seu projeto.

Definindo os Componentes da Operação

Agora precisamos definir os outros componentes da Operação que aparecem na representação gráfica, incluindo Origem, Solicitação, Resposta e Destino. Para fins deste passo a passo, fornecemos os seguintes exemplos para referência acima: Jitterpak QuickBooksExample.jpk e arquivos anexos QuickBooksSampleRequestFiles.zip.

• Fonte: No exemplo, o XML a seguir é uma solicitação de entrada para excluir um Crédito de fornecedor existente com o ID do QuickBooks especificado.

  Nota

  É importante usar o Id e o SyncToken usados no QuickBooks para associar o registro que queremos excluir. Observe que sparse está definido como "0" porque queremos excluir todos os dados de crédito do fornecedor.

  VendorCreditDeleteRequest.xml

  <?xml version="1.0" encoding="utf-8"?>
  <ns:INPUT xmlns:ns="urn:qboln-res:document:qboln:oln:functions">
  <VendorCredit sparse="0">
      <Id>155</Id>
      <SyncToken>1</SyncToken>
  </VendorCredit>
  </ns:INPUT>
  

  Para usar o arquivo XML, primeiro clique duas vezes no ícone Fonte e selecione um novo tipo de fonte. Para este exemplo, estamos usando um Agente Privado com arquivos locais habilitados e, assim, selecione um Tipo de "Arquivo local" e, em seguida, Navegue até o local. Se você estiver usando os arquivos de exemplo, a Pasta é 'C:\projects\quickbooks' e o Obter arquivos é 'VendorCreditDeleteRequest.xml'.

• Alvo: Clique duas vezes no ícone Alvo. No exemplo, enviaremos os dados excluídos do QuickBooks para um arquivo XML para garantir que eles foram excluídos. Para isso, selecionaremos novamente um Tipo de "Arquivo Local" e Navegar até um local no Agente Privado onde queremos salvar os dados. No exemplo, a Pasta é 'C:\projects\quickbooks' e o Filename é 'VendorCreditDeleteResponse.xml'.

• Request: Clique duas vezes no ícone Request e selecione Create New Transformação. Ou clique no botão Create Request na aba QuickBooks Delete Activities. Isso abrirá o Assistente de Transformação, que orientará você na criação da solicitação.

  1. Na primeira tela, Nome, selecione o tipo de fonte usado acima. Para o exemplo, escolhemos XML. Deixe o Alvo como padrão.
  2. Na próxima tela, Fonte, selecione o botão para Selecionar uma estrutura XML existente. No menu suspenso, selecione "Esquemas do QuickBooks ". Em seguida, selecione 'QuickBooksDeleteRequest.xsd' para usar como seu arquivo de estrutura. Na tela seguinte, clique em Concluir.
  3. A aba Transformações deve abrir onde você pode concluir seu mapeamento. Clique no + na parte inferior de cada lado da Origem e do lado Alvo para expandir os itens em cada árvore. Em seguida, clique no ícone Mapa automático que aparece abaixo do lado Alvo da árvore: Sua tela de mapeamento agora deve ser semelhante à abaixo:

• Resposta: Para este exemplo, clique com o botão direito do mouse no ícone Resposta e selecione Pass-Through. Em vez disso, você pode criar uma nova Transformação e mapear seus campos como nas atividades de criação, consulta e atualização.

Implantando e Executando a Operação

Com a atividade de exclusão do QuickBooks configurada, estamos prontos para implantar e executar a operação.

Na aba Operações, clique em Implantar ícone. Em seguida, clique em Executar para colocar a Operação na fila para execução.

Na parte inferior da tela, o monitor de Operação deve indicar que sua Operação foi executada com sucesso. Caso contrário, você pode clicar duas vezes no ícone Status para visualizar as mensagens de log.

Agora você também deve ver os dados excluídos da saída do QuickBooks para o destino especificado. Para o exemplo, o arquivo agora é criado em 'C:\projects\quickbooks\VendorCreditDeleteResponse.xml':

Além disso, ao verificar sua conta do QuickBooks, você deve descobrir que o Crédito de fornecedor especificado não existe mais.