Atividades de Atualização do Conector do QuickBooks

Antes de poder atualizar os dados do QuickBooks do Jitterbit, você precisará ter criado 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 atualização de dados do QuickBooks, usando um exemplo de atualização de um número de telefone para um cliente existente do QuickBooks por meio de um arquivo XML por meio do Jitterbit. Essas etapas são divididas em iniciar a atividade de atualização, definir os componentes da operação e implantar e executar a operação.

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

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

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

2. A tela Endpoint do QuickBooks Update Wizard solicita que você selecione o endpoint no qual gostaria de atualizar os dados existentes. Você já deve ter configurado endpoints em QuickBooks Connector OAuth 1.0a - Criar 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 atualiza os dados que foram criados em QuickBooks Connector - Create Activities usando uma caixa de areia do QuickBooks. Para acessar seu sandbox, vá para https://developer.intuit.com/ e entre na sua conta do QuickBooks Online. Uma vez conectado, vá para Docs & Tools > Sandbox > Go to company para o sandbox que você deseja usar.

   

3. A tela Objeto do Assistente de atualização do QuickBooks solicita que você selecione o Objeto no qual gostaria de atualizar os dados existentes. Neste exemplo, usamos a API de contabilidade durante a criação do aplicativo QuickBooks Online e assim tem apenas um Objeto para selecionar: Contabilidade. Clique no Objeto e em Avançar para continuar.

4. A tela Componentes do Assistente de atualização do QuickBooks exibe todos os componentes que estão disponíveis para que os dados existentes sejam atualizados na instância conectada do QuickBooks. Para fins deste passo a passo, atualizaremos os dados existentes do cliente (número de telefone) e, portanto, selecionaremos o componente Cliente. Em seguida, clique no botão Concluir.

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 Update Activities. Você pode renomear sua atividade de criação aqui, se desejar; no exemplo, o nosso é chamado de "Atualização do 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 atualizará os dados existentes do cliente no QuickBooks.

7. Uma nova aba deve abrir no Studio chamada Operations, contendo uma representação gráfica da atividade de atualização. 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 de atualização agora é 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 atualizar as informações de um cliente existente. Este cliente específico foi criado no exemplo usado em QuickBooks Connector - Create Activities. O XML abaixo mostra que queremos atualizar o PrimaryPhone do cliente para o valor fornecido no XML.

  Importante

  Observe que nem todos os campos estão listados no arquivo XML abaixo – apenas os campos que queremos atualizar. Podemos atualizar apenas campos específicos definindo:

  esparso="1"

  O valor de 1 indica um valor verdadeiro. Quando sparse for definido como true, no momento da atualização, apenas os valores fornecidos serão atualizados. Todos os outros valores não listados para o cliente em questão permanecem os mesmos.

  O valor 0 indica um valor falso. Se sparse fosse definido como falso, todos os outros campos não listados seriam substituídos por um valor nulo. Tome muito cuidado ao definir sparse="0", pois isso excluirá efetivamente todos os dados existentes nos campos que não estão listados.

  Nota

  É importante usar o Id e o SyncToken usados no QuickBooks para associar o cliente cujo registro queremos atualizar. Se você seguiu o exemplo usado em QuickBooks Connector - Create Activities, você pode obter o ID e o SyncToken de seu CustomerCreateResponse.xml.

  CustomerCreateRequest.xml

  <ns:INPUT xmlns:ns="urn:qboln-res:document:qboln:oln:functions">
      <Customer sparse="1">
          <Id>58</Id>
          <SyncToken>1</SyncToken>
          <GivenName>Peter1</GivenName>
      <PrimaryPhone>
        <FreeFormNumber>7678907699</FreeFormNumber>
        <Default>true</Default>
      </PrimaryPhone>
      </Customer>
  </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 estiver usando os arquivos de exemplo, a Pasta é 'C:\projects\quickbooks' e o Obter arquivos é 'CustomerUpdateRequest.xml'.

• Alvo: Clique duas vezes no ícone Alvo. No exemplo, enviaremos os dados atualizados do QuickBooks para um arquivo XML para garantir que ele foi atualizado. 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 é 'CustomerUpdateResponse.xml'.

• Request: Clique duas vezes no ícone Request e selecione Create New Transformação. Ou clique no botão Criar solicitação na aba Atividades de atualização do QuickBooks. 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 'QuickBooksUpdateRequest.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 + em cada lado da Origem e no 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: Clique duas vezes no ícone Resposta e selecione Criar nova Transformação. Ou clique no botão Criar resposta na aba Atividades de atualização do QuickBooks. Isso abrirá o Assistente de Transformação, que orientará você na criação da Resposta.

  1. Na primeira tela, Nome, selecione o tipo de Alvo usado acima. Para o exemplo, escolhemos XML. Deixe a Fonte 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 'QuickBooksUpdateResponse.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. Clique e arraste a pasta "SAÍDA" do lado esquerdo (lado Origem) para a pasta "SAÍDA" do lado direito (lado Destino). Sua tela de mapeamento agora deve ser semelhante à abaixo.

Implantando e Executando a Operação

Com a atividade de atualizaçã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 atualizados da saída do QuickBooks para o destino especificado. Para o exemplo, o arquivo agora é criado em 'C:\projects\quickbooks\CustomerUpdateResponse.xml':

<ns:OUTPUT xmlns:ns="urn:qboln-res:document:qboln:oln:functions">
    <ns:Customer>
        <ns:Id>58</ns:Id>
        <ns:SyncToken>2</ns:SyncToken>
        <ns:MetaData>
            <ns:CreateTime>2016-11-21T10:31:59-07:00</ns:CreateTime>
            <ns:LastUpdatedTime>2016-11-21T10:36:35-07:00</ns:LastUpdatedTime>
        </ns:MetaData>
        <ns:GivenName>Peter1</ns:GivenName>
        <ns:FamilyName>Hynes1</ns:FamilyName>
        <ns:FullyQualifiedName>Soft Tech1</ns:FullyQualifiedName>
        <ns:CompanyName>Soft Tech1</ns:CompanyName>
        <ns:DisplayName>Soft Tech1</ns:DisplayName>
        <ns:PrintOnCheckName>SoftTech LLC</ns:PrintOnCheckName>
        <ns:Active>1</ns:Active>
        <ns:PrimaryPhone>
            <ns:FreeFormNumber>7678907699</ns:FreeFormNumber>
        </ns:PrimaryPhone>
        <ns:Mobile>
            <ns:FreeFormNumber>8678907676</ns:FreeFormNumber>
        </ns:Mobile>
        <ns:Fax>
            <ns:FreeFormNumber>9678907676</ns:FreeFormNumber>
        </ns:Fax>
        <ns:PrimaryEmailAddr>
            <ns:Address>softtech@test.com</ns:Address>
        </ns:PrimaryEmailAddr>
        <ns:WebAddr>
            <ns:URI>http://stech.com</ns:URI>
        </ns:WebAddr>
        <ns:DefaultTaxCodeRef>2</ns:DefaultTaxCodeRef>
        <ns:Taxable>1</ns:Taxable>
        <ns:BillAddr>
            <ns:Id>96</ns:Id>
            <ns:Line1>456 Chinna Street</ns:Line1>
            <ns:City>Tracy</ns:City>
            <ns:Country>USA</ns:Country>
            <ns:CountrySubDivisionCode>767</ns:CountrySubDivisionCode>
            <ns:PostalCode>95391</ns:PostalCode>
            <ns:Lat>37.7582199</ns:Lat>
            <ns:Long>-121.548418</ns:Long>
        </ns:BillAddr>
        <ns:ShipAddr>
            <ns:Id>97</ns:Id>
            <ns:Line1>456 Chinna Street</ns:Line1>
            <ns:City>Tracy</ns:City>
            <ns:Country>str1234</ns:Country>
            <ns:CountrySubDivisionCode>767</ns:CountrySubDivisionCode>
            <ns:PostalCode>95391</ns:PostalCode>
            <ns:Lat>INVALID</ns:Lat>
            <ns:Long>INVALID</ns:Long>
        </ns:ShipAddr>
        <ns:Job>0</ns:Job>
        <ns:BillWithParent>0</ns:BillWithParent>
        <ns:Balance>0</ns:Balance>
        <ns:BalanceWithJobs>0</ns:BalanceWithJobs>
        <ns:CurrencyRef name="United States Dollar">USD</ns:CurrencyRef>
        <ns:PreferredDeliveryMethod>Print</ns:PreferredDeliveryMethod>
    </ns:Customer>
</ns:OUTPUT>

Além disso, ao verificar sua conta do QuickBooks, você deve encontrar o número de telefone do cliente atualizado.