Detalhes da Conexão do Ponto de Venda do QuickBooks¶

Introdução¶

Versão do conector

Esta documentação é baseada na versão 21.0.8361 do conector.

Começando¶

Suporte à versão QuickBooks POS

O conector Jitterbit para QuickBooks POS suporta QuickBooks Point Of Sale Basic e Professional Editions. A edição QuickBooks Point of Sale Multi-Store não é suportada.

Estabelecendo uma Conexão¶

Conectando-se ao QuickBooks¶

O conector faz solicitações ao QuickBooks POS por meio do QuickBooks Gateway. O QuickBooks Gateway é executado na mesma máquina que o QuickBooks POS e aceita conexões por meio de um servidor da Web leve e integrado. O servidor oferece suporte a SSL/TLS, permitindo que os usuários se conectem com segurança a partir de máquinas remotas. Na primeira vez que você se conectar, precisará autorizar o conector com o QuickBooks POS. Para obter mais informações, consulte nosso Usando o QuickBooks Gateway guia.

Para trabalhar com seus dados no modo de prática, defina QBPOSPractice. Além disso, defina QBPOSVersion.

Conectando-se a um Arquivo Local da Empresa¶

Siga as etapas abaixo para autorizar com o QuickBooks POS e conectar-se a um arquivo da empresa quando o QuickBooks POS e o conector estiverem em execução em sua máquina local.

1. Abra o QuickBooks POS como administrador e abra o arquivo da empresa ao qual deseja se conectar.

2. Conecte-se ao QuickBooks POS. Uma caixa de diálogo aparecerá no QuickBooks POS solicitando que você autorize o conector. Depois de conceder acesso ao conector, agora você pode executar comandos para o QuickBooks POS.

3. Se você deseja se conectar ao arquivo da empresa quando o QuickBooks POS estiver fechado, defina o CompanyFile opção de conexão ao executar comandos. O QuickBooks POS abrirá automaticamente em segundo plano com o arquivo especificado.

   Observe que, se o QuickBooks POS estiver aberto por meio da interface do usuário do aplicativo, apenas CompanyFile pode ser usado.

Solução de Problemas de Conexão¶

Se você receber um erro de conexão (como "Erro interno 160002"), talvez seja necessário alternar o QuickBooks POS para o modo multiusuário. Isso é feito selecionando a opção "Mudar o arquivo da empresa para o modo multiusuário" no menu Arquivo. Você deve ser capaz de se conectar ao arquivo da empresa.

Se um CompanyFile não for especificado na string de conexão, o QuickBooks POS pode apresentar uma janela "Insira o nome da empresa" na primeira vez que você se conectar. Nesta janela, você deve especificar o arquivo da empresa e o nome do computador onde o arquivo da empresa está localizado.

Usando o Conector Remoto¶

O conector remoto pode ser usado para ler e gravar no QuickBooks POS em situações em que o acesso COM direto ao QuickBooks POS não está disponível (por exemplo, ASP.NET, Java ou QuickBooks POS em uma máquina remota). Siga o procedimento abaixo para se conectar ao QuickBooks POS pela primeira vez através do Conector Remoto:

1. Se ainda não o fez, baixe o Conector Remoto aqui e instale o Remote Connector na máquina onde o QuickBooks POS está instalado.

2. Abra o arquivo da empresa ao qual deseja se conectar no QuickBooks POS usando uma conta de administrador no modo de usuário único.

3. Abra o Remote Connector na bandeja do sistema e adicione um usuário na aba Users. Digite um Usuário e Senha e selecione o nível de acesso no menu Acesso a Dados.

   Nota: O conector remoto não usa as propriedades de usuário e senha para acessar o QuickBooks POS; as propriedades Usuário e Senha autenticam o usuário no Conector Remoto. A autenticação para QuickBooks POS é feita com base no ApplicationName propriedade.

4. Quando você se conectar pela primeira vez, uma caixa de diálogo aparecerá no QuickBooks POS solicitando que você autorize o aplicativo. Depois de autorizar o aplicativo, você pode executar comandos para o QuickBooks POS. Especifique o URL do Conector Remoto e do User e Password. Por padrão, o Remote Connector se conecta ao arquivo da empresa aberto no momento.

5. Se desejar acessar o QuickBooks POS quando o QuickBooks POS não estiver em execução, salve as informações do arquivo da empresa para o usuário. O Remote Connector abrirá automaticamente o QuickBooks POS em segundo plano com o arquivo da empresa para esse usuário.

Observe que, se a interface do usuário do QuickBooks POS estiver aberta, você só poderá se conectar a esse arquivo da empresa. Além disso, observe que as permissões de usuário sob as quais você executa o Remote Connector devem corresponder às permissões de usuário sob as quais você executa o QuickBooks POS. O processo de instalação do Remote Connector instala o Remote Connector como um serviço na conta de usuário atual.

Como Me Conecto ao QuickBooks POS por SSL/TLS?¶

Você pode ativar SSL/TLS na aba Avançado.

Você também precisará enviar seu certificado de chave pública para o conector. Você pode fazer isso definindo o SSLServerCert propriedade.

Notas importantes¶

Stored Procedures¶

• Os recursos de procedimentos armazenados descritos nesta documentação não são suportados no momento.
• Como os procedimentos armazenados não são suportados atualmente, qualquer recurso dependente de procedimentos armazenados também não é suportado atualmente.

Arquivos de configuração e seus caminhos¶

• Todas as referências para adicionar arquivos de configuração e seus caminhos referem-se a arquivos e locais no Harmony Agente onde o conector está instalado. Esses caminhos devem ser ajustados conforme apropriado, dependendo do agente e do sistema operacional. Se vários agentes forem usados em um grupo de agentes, arquivos idênticos serão necessários em cada agente.

Conector remoto¶

O QuickBooks Gateway para QuickBooks POS é um aplicativo simples que facilita as conexões com os arquivos da empresa a partir do seu aplicativo. O QuickBooks Gateway aceita conexões por meio de um servidor da Web incorporado leve que é executado na máquina em que o QuickBooks POS está instalado. O servidor oferece suporte a SSL/TLS, permitindo que os usuários se conectem com segurança a partir de máquinas remotas.

Na primeira vez que você se conectar ao QuickBooks POS, você deve autorizar seu aplicativo. Complementando a autenticação por aplicativo do QuickBooks POS, o QuickBooks Gateway possui autenticação por usuário. Antes de se conectar ao QuickBooks POS pela primeira vez, configure pelo menos um usuário do QuickBooks Gateway.

Você pode configurar usuários por meio da interface do usuário em Usuários aba. Você pode seguir o procedimento em "Introdução" para conectar um aplicativo ao QuickBooks POS. Após a conexão, você pode monitorar as conexões QuickBooks POS no Status aba.

É recomendável configurar o QuickBooks Gateway na interface do usuário, mas você também pode executar o QuickBooks Gateway na linha de comando. Isso pode simplificar a implantação do QuickBooks Gateway em cenários onde normalmente não há um usuário conectado, como executar um servidor Web. Veja Avançado para configurar o QuickBooks Gateway quando você não estiver usando a IU.

O QuickBooks Gateway gerencia automaticamente a conexão com o QuickBooks POS, mas você pode configurar quase todos os aspectos de como os usuários se conectam ao QuickBooks POS por meio do QuickBooks Gateway. As páginas a seguir descrevem os recursos do QuickBooks Gateway e como começar.

Usuários¶

A aba Usuários fornece uma interface para adicionar, editar e excluir usuários. Pelo menos um usuário deve ser adicionado antes de se comunicar com o QuickBooks POS.

Essa aba exibe uma lista de usuários existentes junto com informações sobre a configuração do usuário.

Ao adicionar ou editar um usuário, as seguintes opções estão disponíveis:

• User: Define o nome de usuário. Isso é necessário.
• Password: Define a senha para o usuário. Isso é necessário ao usar a autenticação básica (padrão).
• Company File: Especifica o arquivo da empresa com o qual o aplicativo se comunicará. Por padrão, este é o arquivo da empresa que está aberto no QuickBooks POS. Defina-o como o nome do arquivo da empresa (observação: especificar todo o caminho do arquivo resultará em um erro "Não é possível conectar ao banco de dados" do QuickBooks POS). Um arquivo da empresa deve ser especificado para acessar o arquivo da empresa quando o QuickBooks POS estiver fechado.
• Authentication: Especifica o tipo de autenticação a ser executada quando o usuário se conecta. O QuickBooks Gateway suporta os seguintes métodos de autenticação: | | | |----------------------------|------- -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- -------------------------------------------------- ----------------------------------| | | | | Autenticação básica (padrão): | Autentica o usuário com um nome de usuário e senha. | | Autenticação do Windows: | Autentica o usuário como um usuário do Windows. Neste caso, o campo Senha não é aplicável. Quando o QuickBooks Gateway recebe uma solicitação de conexão, ele autentica o usuário no Windows usando as credenciais fornecidas na solicitação. |
• Application Name: Opcionalmente define o nome do aplicativo conforme visto pelo QuickBooks POS. A autenticação para o QuickBooks POS é feita com base no nome do aplicativo fornecido.
• Data Access: Especifica o acesso permitido para o usuário. | | | |----------------|---------------------------- -------------------------------------------------- -------| | | | | Completo: | Permite acesso de leitura e gravação para o usuário. | | Somente leitura: | Restringe o usuário a operações somente leitura. Os dados do QuickBooks POS não podem ser modificados. |

O botão Testar conexão fornece uma maneira rápida de verificar se o aplicativo pode se conectar ao QuickBooks POS.

Quando um usuário é adicionado, o QuickBooks Gateway solicitará que você autorize o aplicativo com o QuickBooks POS, se necessário.

Status¶

A aba Status fornece um log da atividade que está acontecendo com o QuickBooks Gateway. Os logs podem ser limpos ou copiados clicando com o botão direito do mouse na janela Atividade recente.

Você pode ajustar os detalhes dos logs para incluir informações úteis ao solucionar problemas: Selecione a granularidade no menu Log Mode na aba Advanced. Na aba Avançado, você também pode configurar o QuickBooks Gateway para gravar logs em um arquivo e selecionar o intervalo de rotação do log.

Avançado¶

A aba Avançado permite controle granular sobre o servidor do QuickBooks Gateway. O QuickBooks Gateway contém um servidor da Web incorporado que é executado como um serviço do Windows e atende a solicitações HTTP. Cada solicitação contém os dados XML a serem comunicados ao QuickBooks POS, bem como as definições de configuração que especificam como a conexão deve ser aberta. O QuickBooks Gateway então se comunica com o QuickBooks POS via COM e retorna a resposta do QuickBooks POS (ou uma mensagem de erro) na resposta HTTP.

Este capítulo detalha como controlar cada um desses aspectos da conexão com o QuickBooks POS por meio da interface do usuário, da interface de linha de comando e do registro. As seções a seguir detalham as opções disponíveis na aba Avançado.

Opções de registro¶

• Write Logs to a Folder: Ativa ou desativa a gravação de arquivos de log na pasta especificada, além de gravar logs na aba Status.
• Folder: Especifica a pasta onde os arquivos de log são gravados.
• Log Rotation: Determina como os logs são organizados no disco. Cria um arquivo para cada dia, semana ou mês, dependendo dos seguintes valores: | | | |----------------------|---------------------- -------------------------------------------------- -------------------------------------------------- ----------------------------------| | | | | Diário (padrão): | Usa um novo arquivo de log todos os dias. Os arquivos são gravados no formato "aaaa_MM_dd.txt". Por exemplo, "2013_09_23.txt". | | Semanal: | Usa um novo arquivo de log toda semana. Os arquivos são gravados no formato "yyyy_ww.txt". Por exemplo, "2013_34.txt", onde 34 significa que esta é a 34ª semana de 2013. Voltar para o início | | Mensal: | Usa um novo arquivo de log todo mês. Os arquivos são gravados no formato "aaaa_mm.txt". Por exemplo, "2013_09.txt". |
• Log Mode: Define a verbosidade da saída do log. Na maioria das situações, Info (o padrão) é suficiente. A opção Verbose é útil para fins de depuração.

Opções de IP¶

• Port: A porta na qual o servidor atende.
• Allowed Clients: Uma lista separada por vírgulas de nomes de hospedar ou endereços IP que podem acessar o servidor. O caractere curinga '*' é suportado. Se não especificado (padrão), qualquer cliente pode se conectar.

Ativando conexões persistentes¶

Todas as comunicações com os arquivos da empresa do QuickBooks POS devem primeiro passar pelo QuickBooks POS. Se o QuickBooks POS estiver fechado, isso significa que, para cada tentativa de conexão com o arquivo da empresa, o QuickBooks POS precisa ser iniciado e fechado novamente. Por padrão, o QuickBooks Gateway enfileira solicitações de dados e executa a autenticação necessária para cada solicitação. As opções a seguir podem ser usadas para substituir esse comportamento e manter a conexão com o arquivo da empresa ativa após o término da execução da consultar, para que outras solicitações respondam mais rapidamente.

Aviso: Se um usuário tentar abrir manualmente o QuickBooks POS enquanto uma conexão persistente estiver aberta, o QuickBooks POS lançará um erro informando que o arquivo da empresa já está em uso.

• Enable Persistent Connection: Isso é desabilitado por padrão: Normalmente, seu código controla quando a conexão com o QuickBooks POS é aberta e fechada chamando os métodos Open e Close; no entanto, quando essa configuração está habilitada, o QuickBooks Gateway estabelece uma conexão persistente com o QuickBooks POS, mesmo quando Abrir e Fechar não são usados. Isso permite que vários aplicativos compartilhem a conexão e acessem simultaneamente o QuickBooks Gateway.
• Idle Timeout: Define o tempo limite de inatividade para a conexão persistente em segundos. Isso só é aplicável à conexão persistente. Se não houver atividade dentro desta janela de tempo, o QuickBooks Gateway fecha a conexão.

Ativando TLS/SSL¶

Habilite o TLS (1.x) para criptografar a comunicação entre seu aplicativo e o QuickBooks Gateway. TLS/SSL usa certificados digitais para proteger a confidencialidade, integridade e autenticidade de seus dados: Você pode gerar esses certificados na aba Avançado. Depois de ativar o TLS, você precisará enviar seu certificado de chave pública para qualquer aplicativo conectado.

As seguintes opções são usadas para configurar TLS/SSL:

• Enable TLS: Ativa ou desativa a comunicação TLS (1.x).
• Select Certificate: Carrega um certificado existente.
• Generate Certificate: Cria um novo certificado.

Carregar um certificado exibe informações sobre o certificado; as propriedades do certificado não podem ser definidas diretamente. Observação: habilitar o TLS desabilita as conexões de texto sem formatação.

Interface de linha de comando¶

Além da interface do usuário, o QuickBooks Gateway possui uma interface de linha de comando que facilita a implantar em máquinas nas quais um usuário nem sempre está conectado, por exemplo, um servidor da Web. Para facilitar a implantação nesses ambientes, o QuickBooks Gateway contém dois executáveis:

A sintaxe para gerenciar o serviço QuickBooks Gateway Windows a partir da linha de comando é a seguinte:

RemoteConnectorService.exe /Service <Command>

Os seguintes comandos estão disponíveis:

Você pode iniciar o daemon MySQL a partir da linha de comando, conforme mostrado abaixo:

java -jar cdata.jdbc.quickbookspos.jar [options ]

As seguintes opções de linha de comando estão disponíveis:

As opções especificadas na linha de comando têm precedência sobre as opções especificadas no arquivo de configuração. Você pode passar opções de linha de comando para especificar um subconjunto restrito das opções permitidas no Arquivo de configuração.

Chaves do Registro¶

Todos os dados de configuração são lidos do registro em "HKEY_LOCAL_MACHINE\SOFTWARE\RemoteConnector". Cada usuário terá uma subchave separada com configurações específicas do usuário. Por exemplo, "HKEY_LOCAL_MACHINE\SOFTWARE\RemoteConnector\User1".

Configurações no nível do aplicativo¶

Configurações no nível do usuário¶

Recursos avançados¶

Esta seção detalha uma seleção de recursos avançados do conector QuickBooks POS.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visualizações definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Exibições definidas pelo usuário¶

O Jitterbit Connector para QuickBooks POS permite definir uma mesa virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

• Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
• declarações DDL.

Definindo visualizações usando um arquivo de configuração¶

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

• Cada elemento raiz define o nome de uma visualização.
• Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM Customers WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para exibições definidas pelo usuário¶

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com visualizações definidas pelo usuário¶

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resultando na consultar efetiva à fonte:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Inserindo registros pai e filho¶

Use Case¶

Ao inserir registros, muitas vezes há a necessidade de preencher detalhes sobre os registros filhos que dependem de um pai.

Por exemplo, ao lidar com um sistema de CRM, as faturas geralmente não podem ser inseridas sem pelo menos um item de linha.

As faturas podem ter muitos itens de linha, com cada item de linha composto por vários campos. Isso apresenta um desafio único ao oferecer os dados como tabelas relacionais.

Ao ler os dados, é fácil modelar uma fatura e uma tabela InvoiceLineItem com uma chave estrangeira conectando as duas.
Porém, durante as inserções, o sistema de CRM exigirá que os itens Invoice e InvoiceLineItems sejam criados em um único envio.

Para resolver esse tipo de problema, nossas ferramentas oferecem colunas de coleção filho no pai.
Essas colunas podem ser usadas para enviar instruções de inserção que incluem detalhes dos registros pai e filho.

No nosso exemplo, a tabela Invoice pode ter uma coluna chamada InvoiceLineItems.
Durante a inserção, podemos passar os detalhes dos registros que precisariam ser inseridos na tabela InvoiceLineItems na coluna InvoiceLineItems do registro Invoice.
Isso pode ser feito usando os seguintes métodos:

Métodos para inserir registros pai/filho¶

O conector facilita dois métodos para inserir registros pai/filho: inserção de tabela temporária e inserção agregada XML/JSON.

Tabelas temporárias (#TEMP)¶

A maneira mais simples de inserir dados seria usar uma tabela #TEMP, ou tabela temporária, que o conector armazenará na memória.

Faça referência à tabela #TEMP com a seguinte sintaxe:

TableName#TEMP

#Tabelas TEMP são armazenadas na memória durante uma conexão.

Portanto, para utilizá-los, não é possível fechar a conexão entre o envio de inserções a eles, e eles não podem ser utilizados em ambientes onde possa ser utilizada uma conexão diferente para cada consultar.

Nessa única conexão, a tabela permanece na memória até que a inserção em massa seja bem-sucedida, momento em que a tabela temporária será apagada da memória.

Por exemplo:

INSERT INTO InvoiceLineItems#TEMP (ReferenceNumber, Item, Quantity, Amount) VALUES ('INV001', 'Basketball', 10, 9.99)
INSERT INTO InvoiceLineItems#TEMP (ReferenceNumber, Item, Quantity, Amount) VALUES ('INV001', 'Football', 5, 12.99)

Uma vez preenchida a tabela InvoiceLineItems, a tabela #TEMP pode ser referenciada durante uma inserção na tabela Invoice:

INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', 'InvoiceLineItems#TEMP')

Nos bastidores, o conector lerá os valores da tabela #TEMP.

Observe que o ReferenceNumber foi usado para identificar a qual Nota Fiscal as linhas estão vinculadas.
Isso ocorre porque a tabela #TEMP pode ser preenchida e usada com uma inserção em massa, onde você terá linhas diferentes para diferentes Faturas.
Isso permite que as tabelas #TEMP sejam usadas com uma inserção em massa. Por exemplo:

INSERT INTO Invoices#TEMP (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', 'InvoiceLineItems#TEMP')
INSERT INTO Invoices#TEMP (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV002', 'Jane Doe', 'InvoiceLineItems#TEMP')
INSERT INTO Invoices SELECT ReferenceNumber, Customer, InvoiceLines FROM Invoices#TEMP

Neste caso, estamos inserindo duas Notas Fiscais diferentes. O ReferenceNumber é como determinamos quais linhas acompanham qual fatura.

Note: As tabelas e colunas aqui apresentadas são um exemplo de como o conector funciona de forma geral. Os nomes específicos da tabela e da coluna podem ser diferentes no conector.

Agregados XML/JSON¶

Como alternativa às tabelas #TEMP, XML/JSON direto pode ser usado. Como as tabelas #TEMP não são usadas para construí-las, não importa se você usa a mesma conexão ou fecha a conexão após a inserção.

Por exemplo:

[
  {
    "Item", "Basketball",
    "Quantity": 10
    "Amount": 9.99
  },
  {
    "Item", "Football",
    "Quantity": 5
    "Amount": 12.99
  }
]

OU

<Row>
  <Item>Basketball</Item>
  <Quantity>10</Quantity>
  <Amount>9.99</Amount>
</Row>
<Row>
  <Item>Football</Item>
  <Quantity>5</Quantity>
  <Amount>12.99</Amount>
</Row>

Observe que o ReferenceNumber não está presente nesses exemplos.

Isso ocorre porque o XML/JSON, por sua natureza, não está sendo passado por referência, mas passado integralmente por inserção no registro pai.
Não há necessidade de fornecer algo para vincular o filho ao pai, pois o XML/JSON completo deve ser construído e enviado para cada linha.

Em seguida, insira os valores:

INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', '{...}')

OU

INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', '<Row>...</Row>')

Exemplo para QuickBooks POS¶

Para obter um exemplo prático de como as tabelas temporárias podem ser usadas para inserção em massa no QuickBooks POS, consulte o seguinte:

// Insert into Invoices table
INSERT INTO InvoiceLineItems#TEMP (ItemName, ItemQuantity) VALUES ('Repairs','1')
INSERT INTO InvoiceLineItems#TEMP (ItemName, ItemQuantity) VALUES ('Removal','2')

INSERT INTO Invoices (CustomerName, Memo, ItemAggregate) VALUES ('Abercrombie, Kristy', 'NUnit Memo', 'InvoiceLineItems#TEMP')


// Insert into InvoiceLineItems table
INSERT INTO InvoiceLineItems#TEMP (CustomerName, Date, ShipMethod, ShipDate, Memo, Message, DueDate, Other, ItemName, ItemQuantity, ItemRate) VALUES ('Abercrombie, Kristy', '2011-01-01', 'UPS', '2011-01-02', 'NUnit Memo', 'We appreciate your prompt payment.', '2011-01-03', 'Some other data', 'Repairs', '1', '3.50')
INSERT INTO InvoiceLineItems#TEMP (CustomerName, Date, ShipMethod, ShipDate, Memo, Message, DueDate, Other, ItemName, ItemQuantity, ItemRate) VALUES ('Abercrombie, Kristy', '2011-01-01', 'UPS', '2011-01-02', 'NUnit Memo', 'We appreciate your prompt payment.', '2011-01-03', 'Some other data', 'Removal', '2', '3.50')

INSERT INTO InvoiceLineItems (CustomerName, Date, ShipMethod, ShipDate, Memo, Message, DueDate, Other, ItemName, ItemQuantity, ItemRate) SELECT CustomerName, Date, ShipMethod, ShipDate, Memo, Message, DueDate, Other, ItemName, ItemQuantity, ItemRate InvoiceLineItems#TEMP

Configuração SSL¶

Personalizando a configuração SSL¶

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de dados¶

O Modelo de Dados tem duas partes: Tabelas e Exibições.

Mesas

Tabelas permitem o acesso aos dados da fonte de dados. O Jitterbit Connector para QuickBooks POS modela os dados da fonte de dados em tabelas para que possam ser facilmente consultados e atualizados.

Visualizações

Visualizações são tabelas que não podem ser modificadas. Normalmente, os dados somente leitura são mostrados como exibições.

Tabelas¶

O conector modela os dados no QuickBooks POS em uma lista de tabelas que podem ser consultadas usando instruções SQL padrão.

Geralmente, consultar tabelas QuickBooks POS é o mesmo que consultar uma tabela em um banco de dados relacional. Às vezes, há casos especiais, por exemplo, incluir uma determinada coluna na cláusula WHERE pode ser necessário para obter dados para determinadas colunas na tabela. Isso geralmente é necessário para situações em que uma solicitação separada deve ser feita para cada linha para obter determinadas colunas. Esses tipos de situações estão claramente documentados na parte superior da página da tabela vinculada abaixo.

Conector Jitterbit para tabelas QuickBooks POS¶

Clientes¶

Crie, atualize, exclua e consultar os clientes do QuickBooks POS.

Informações específicas da tabela¶

A tabela Clientes permite selecionar, inserir, atualizar e excluir clientes no QuickBooks POS.

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM Customers WHERE FirstName LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014' AND AccountBalance > 100.00

Inserir¶

Para criar um novo registro de Cliente, o campo Sobrenome é obrigatório.

Os endereços de envio são especificados por meio de um agregado XML na coluna ShipAddressesAggregate. As colunas que podem ser usadas nesses agregados são definidas nos CustomerShipAddresses tabela como # colunas. Observe que ShipAddressAddressName é necessário ao adicionar um endereço de entrega.

O exemplo a seguir demonstra como inserir um novo Cliente com dois endereços de entrega:

INSERT INTO Customers (FirstName, LastName, ShipAddressesAggregate)
VALUES ('Kristy', 'Abercrombie', '<CustomerShipAddresses>
<Row><ShipAddressAddressName>Home</ShipAddressAddressName><ShipAddressStreet>123 Main Street</ShipAddressStreet><ShipAddressCity>Chapel Hill</ShipAddressCity><ShipAddressState>NC</ShipAddressState><ShipAddressPostalCode>12345</ShipAddressPostalCode></Row>
<Row><ShipAddressAddressName>Office</ShipAddressAddressName><ShipAddressStreet>456 Downtown Drive</ShipAddressStreet><ShipAddressCity>Raleigh</ShipAddressCity><ShipAddressState>NC</ShipAddressState><ShipAddressPostalCode>98765</ShipAddressPostalCode></Row>
</CustomerShipAddresses>')

Atualizar¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Ao atualizar um registro de cliente, os endereços de remessa podem ser adicionados ou modificados por meio da coluna ShipAddressesAggregate (como em uma inserção). Nesses casos, a coluna ShipAddressAddressName é necessária para identificar o endereço de entrega que está sendo adicionado ou atualizado.

No caso de atualizar um endereço de entrega, os valores pré-existentes permanecerão inalterados, a menos que explicitamente especificado no ShipAddressesAggregate. Portanto, para remover um valor, o valor da coluna no agregado deve ser definido como "" (string vazia).

UPDATE Customers SET ShipAddressesAggregate='<CustomerShipAddresses>
<Row><ShipAddressAddressName>Office</ShipAddressAddressName><ShipAddressCompany>MyCompany</ShipAddressCompany></Row>
</CustomerShipAddresses>' 
WHERE ListId='-1234567890123456789'

Colunas¶

CustomerShipAddresses¶

Crie, atualize, exclua e consultar os endereços de entrega do cliente QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM CustomerShipAddresses WHERE FirstName LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Insert pode ser usado para criar um novo registro de cliente ou para adicionar um endereço de entrega a um registro de cliente existente. Para criar um novo registro de Cliente, o campo Sobrenome é obrigatório. Para adicionar um endereço de entrega a um registro existente, a coluna ListId do registro do cliente ao qual o endereço deve ser adicionado e o ShipAddressAddressName são obrigatórios.

Criar um novo cliente:

INSERT INTO CustomerShipAddresses (FirstName, LastName, ShipAddressAddressName, ShipAddressStreet, ShipAddressCity, ShipAddressState, ShipAddressPostalCode)
VALUES ('Kristy', 'Abercrombie', 'Home', '123 Main Street', 'Chapel Hill', 'NC', '12345')

Adicione um endereço de entrega a um cliente existente:

INSERT INTO CustomerShipAddresses (ListId, ShipAddressAddressName, ShipAddressStreet, ShipAddressCity, ShipAddressState, ShipAddressPostalCode)
VALUES ('-1234567890123456789', 'Office', '456 Downtown Drive', 'Raleigh', 'NC', '98765')

Atualização¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Para realizar uma atualização, ListId e ShipAddressAddressName são campos obrigatórios.

UPDATE CustomerShipAddresses SET ShipAddressCompanyName='MyCompany' WHERE ListId='-1234567890123456789' AND ShipAddressAddressName='Office'

Excluir¶

Excluir é usado para remover um endereço de entrega do registro do Cliente especificado (não excluirá o próprio registro do Cliente). Para executar uma exclusão, ListId e ShipAddressAddressName são campos obrigatórios.

DELETE FROM CustomerShipAddresses WHERE ListId='-1234567890123456789' AND ShipAddressAddressName='Home'

Colunas¶

Departamentos¶

Crie, atualize, exclua e consultar os departamentos de PDV do QuickBooks.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM Departments WHERE DepartmentName LIKE '%WEAR%'

Inserir¶

Para criar um novo registro de departamento, o campo DepartmentName é obrigatório.

INSERT INTO Departments (DepartmentName, DepartmentCode, DefaultMarginPercent)
VALUES ('Sports Wear', 'SPW', '7.25')

Atualizar¶

Qualquer campo que não seja somente leitura pode ser atualizado.

UPDATE Departments SET DefaultMarkupPercent='20.50' WHERE ListId='-1234567890123456789' 

Colunas¶

Empregados¶

Crie, atualize e consultar os funcionários do QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM Employees WHERE LoginName LIKE '%test%'

Inserir¶

Para criar um novo registro de funcionário, o campo LoginName é obrigatório.

INSERT INTO Employees (LoginName, FirstName, LastName)
VALUES ('japple', 'John', 'Apple')

Atualizar¶

Qualquer campo que não seja somente leitura pode ser atualizado.

UPDATE Employees SET Phone='555-123-9876' WHERE ListId='-1234567890123456789' 

Excluir¶

A exclusão de um funcionário requer privilégios de administrador do sistema, que só estão disponíveis ao fazer login diretamente no QuickBooks POS.

Colunas¶

InventoryCostAdjustmentItems¶

Crie e consultar itens de ajuste de custo de inventário de PDV do QuickBooks.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM InventoryCostAdjustmentItems WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Insert pode ser usado para adicionar um item a um registro InventoryCostAdjustment existente. Para adicionar um item a um registro existente, a coluna TxnId do registro InventoryCostAdjustment ao qual o item deve ser adicionado, ItemListId e ItemNewCost são obrigatórios.

INSERT INTO InventoryCostAdjustmentItems (TxnId, ItemListId, ItemNewCost)
VALUES ('-1234567890123456789', '-1000000000000000004', '2.00')

Colunas¶

InventoryCostAdjustments¶

Crie, atualize e consultar os ajustes de custo de estoque do QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM InventoryCostAdjustments WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Para criar um novo registro InventoryCostAdjustment, o campo Motivo é obrigatório. Os itens são especificados por meio de um agregado XML na coluna ItemsAggregate. As colunas que podem ser usadas nesses agregados são definidas em InventoryCostAdjustmentItems tabela como # colunas. Observe que ItemListId e ItemNewCost são necessários ao adicionar um item.

O exemplo a seguir irá inserir um novo InventoryCostAdjustment com dois itens:

INSERT INTO InventoryCostAdjustments (Reason, ItemsAggregate)
VALUES ('Discontinued', '<InventoryCostAdjustmentItems>
<Row><ItemListId>-1000000000000000001</ItemListId><ItemNewCost>4.99</ItemNewCost></Row>
<Row><ItemListId>-1000000000000000002</ItemListId><ItemNewCost>11.97</ItemNewCost></Row>
</InventoryCostAdjustmentItems>')

Atualização¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Ao atualizar um registro InventoryCostAdjustment, os custos do item podem ser ajustados por meio da coluna ItemsAggregate, assim como em uma inserção. Nesses casos, a coluna ItemListId é necessária para identificar o item que está sendo ajustado e ItemNewCost é necessária para especificar o novo custo.

Os itens de observação não podem ser removidos de um registro InventoryCostAdjustment, mas apenas o custo pode ser ajustado, portanto, um registro de ajustes para um item é sempre mantido.

UPDATE InventoryCostAdjustments SET ItemsAggregate='<InventoryCostAdjustmentItems>
<Row><ItemListId>-1000000000000000003</ItemListId><ItemNewCost>19.99</ItemNewCost></Row>
</InventoryCostAdjustmentItems>'
WHERE TxnId='-1234567890123456789'

Colunas¶

InventoryQtyAdjustmentItems¶

Crie e consultar itens de ajuste de quantidade de inventário de PDV do QuickBooks.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM InventoryQtyAdjustmentItems WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Insert pode ser usado para adicionar um item a um registro InventoryQtyAdjustment existente. Para adicionar um item a um registro existente, a coluna TxnId do registro InventoryQtyAdjustment ao qual o item deve ser adicionado, ItemListId e ItemNewQuantity são obrigatórios.

INSERT INTO InventoryQtyAdjustmentItems (TxnId, ItemListId, ItemNewQuantity)
VALUES ('-1234567890123456789', '-1000000000000000004', '10')

Colunas¶

InventoryQtyAdjustments¶

Crie, atualize e consultar Ajustes de quantidade de estoque de PDV do QuickBooks.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM InventoryCostAdjustments WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Para criar um novo registro InventoryQtyAdjustment, o campo Motivo é obrigatório. Os itens são especificados por meio de um agregado XML na coluna ItemsAggregate. As colunas que podem ser usadas nesses agregados são definidas em InventoryQtyAdjustmentItems tabela como # colunas. Observe que ItemListId e ItemNewQuantity são necessários ao adicionar um item.

O exemplo a seguir irá inserir um novo InventoryQtyAdjustment com dois itens:

INSERT INTO InventoryQtyAdjustments (Reason, ItemsAggregate)
VALUES ('New Shipment', '<InventoryQtyAdjustmentItems>
<Row><ItemListId>-1000000000000000001</ItemListId><ItemNewQuantity>10</ItemNewQuantity></Row>
<Row><ItemListId>-1000000000000000002</ItemListId><ItemNewQuantity>20</ItemNewQuantity></Row>
</InventoryQtyAdjustmentItems>')

Atualização¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Ao atualizar um registro InventoryQtyAdjustment, as quantidades de itens podem ser ajustadas por meio da coluna ItemsAggregate, assim como em uma inserção. Nesses casos, a coluna ItemListId é necessária para identificar o item que está sendo ajustado e ItemNewQuantity é necessária para especificar a nova quantidade.

Os itens de observação não podem ser removidos de um registro InventoryQtyAdjustment, mas apenas o custo pode ser ajustado, portanto, um registro de ajustes para um item é sempre mantido.

UPDATE InventoryQtyAdjustments SET ItemsAggregate='<InventoryQtyAdjustmentItems>
<Row><ItemListId>-1000000000000000003</ItemListId><ItemNewQuantity>30</ItemNewQuantity></Row>
</InventoryQtyAdjustmentItems>' 
WHERE TxnId='-1234567890123456789'

Colunas¶

ItemImagens¶

Crie, atualize e consultar imagens de itens do QuickBooks POS.

Colunas¶

Itens¶

Crie, atualize, exclua e consultar itens QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM Items WHERE QuantityOnHand < 5

Inserir¶

Para criar um novo registro de item, o campo DepartmentListId é obrigatório.

INSERT INTO Items (DepartmentListId, Desc1, Cost)
VALUES ('-1234567890123456789', 'T-Shirt', '9.99')

Atualizar¶

Qualquer campo que não seja somente leitura pode ser atualizado.

UPDATE Items SET Size='L' WHERE ListId='-1000000000000000001' 

Colunas¶

PriceAdjustmentItems¶

Crie, atualize, exclua e consultar os itens de ajuste de preço do QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM PriceAdjustmentItems WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Insert pode ser usado para criar um novo registro PriceAdjustment ou para adicionar um item a um registro PriceAdjustment existente.

Para criar um novo registro PriceAdjustment, o campo PriceAdjustmentName é obrigatório.

INSERT INTO PriceAdjustmentItems (PriceAdjustmentName, ItemListId, ItemNewPrice)
VALUES ('New Adjustment', '-1000000000000000001', '10.00')

Para adicionar um item a um registro existente, a coluna TxnId do registro PriceAdjustment ao qual o item deve ser adicionado e o ItemListId são obrigatórios.

INSERT INTO PriceAdjustmentItems (TxnId, ItemListId, ItemNewPrice)
VALUES ('-1234567890123456789', '-1000000000000000001', '10.00')

Atualização¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Observação: as operações de atualização contarão como duas operações na API QuickBooks POS. Um é necessário para recuperar o registro existente e outro para atualizar o registro com novos dados.

Para realizar uma atualização, TxnId e ItemTxnLineId são campos obrigatórios.

UPDATE PriceAdjustmentItems SET ItemNewPrice='30.00' WHERE TxnId='-1234567890123456789' AND ItemTxnLineId='1'

Excluir¶

Excluir é usado para remover um item do registro especificado (não excluirá o registro inteiro).

Nota: A exclusão de um item requer que todos os itens desejados que existem atualmente no registro sejam enviados na solicitação, excluindo assim aqueles que não foram especificados. Portanto, as operações de exclusão contarão como duas operações na API QuickBooks POS. Um é necessário para recuperar o registro existente para obter todos os ItemTxnLineIds existentes e outro para excluir o item especificado.

Para realizar uma exclusão, TxnId e ItemTxnLineId são campos obrigatórios.

DELETE FROM PriceAdjustmentItems WHERE TxnId='-1234567890123456789' AND ItemTxnLineId='3'

Colunas¶

Ajustes de preço¶

Crie, atualize e consultar os ajustes de preço do QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM PriceAdjustments WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Para criar um novo registro PriceAdjustment, o campo PriceAdjustmentName é obrigatório. Os itens são especificados por meio de um agregado XML na coluna ItemsAggregate. As colunas que podem ser usadas nesses agregados são definidas nos PriceAdjustmentItems tabela como # colunas. Observe que ItemListId é necessário ao adicionar um item.

O exemplo a seguir irá inserir um novo PriceAdjustment com dois itens:

INSERT INTO PriceAdjustments (PriceAdjustmentName, ItemsAggregate)
VALUES ('New Adjustment', '<PriceAdjustmentItems>
<Row><ItemListId>-1000000000000000001</ItemListId><ItemNewPrice>10.00</ItemNewPrice></Row>
<Row><ItemListId>-1000000000000000002</ItemListId><ItemNewPrice>20.00</ItemNewPrice></Row>
</PriceAdjustmentItems>')

Atualização¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Ao atualizar um registro PriceAdjustment, os preços dos itens podem ser adicionados ou modificados por meio da coluna ItemsAggregate.

Para modificar um item existente em um registro PriceAdjustment, a coluna ItemTxnLineId é necessária para identificar o item. Em uma atualização usando um ItemsAggregate, especifique todos os valores de ItemTxnLineId a serem mantidos, pois os valores não especificados serão excluídos.

Para adicionar um novo item, deve-se especificar o ItemListId que corresponde ao item a ser adicionado (como em um insert).

Observe que os itens não podem ser modificados e adicionados na mesma solicitação ItemsAggregate. A modificação de um item, usando ItemTxnLineId, tem precedência sobre os itens adicionados e, portanto, o QuickBooks POS ignora os itens adicionados e executa a modificação dos itens existentes.

Modificar itens Exemplo: totalize três itens com valores de ItemTxnLineId de 1, 2 e 3. O item 1 é atualizado, o item 2 é deixado sozinho e o item 3 será excluído.

UPDATE PriceAdjustments SET ItemsAggregate='<PriceAdjustmentItems>
<Row><ItemTxnLineId>1</ItemTxnLineId><ItemNewPrice>30.00</ItemNewPrice></Row>
<Row><ItemTxnLineId>2</ItemTxnLineId></Row>
</PriceAdjustmentItems>'
WHERE TxnId='-1234567890123456789'

Exemplo de Adicionar Novo Item: Os itens existentes permanecem intactos ao adicionar novos itens.

UPDATE PriceAdjustments SET ItemsAggregate='<PriceAdjustmentItems>
<Row><ItemListId>-1000000000000000003</ItemListId><ItemNewPrice>30.00</ItemNewPrice></Row>
</PriceAdjustmentItems>' 
WHERE TxnId='-1234567890123456789'

Colunas¶

PriceDiscountItems¶

Crie, atualize, exclua e consultar os itens de desconto de preço do QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM PriceDiscountItems WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Insert pode ser usado para criar um novo registro PriceDiscount ou para adicionar um item a um registro PriceDiscount existente.

Para criar um novo registro PriceDiscount, os campos PriceDiscountName e PriceDiscountReason são obrigatórios.

INSERT INTO PriceDiscountItems (PriceDiscountName, PriceDiscountReason, PriceDiscountXValue, ItemListId, ItemUnitOfMeasure)
VALUES ('New Discount', 'Sale', '10', '-1000000000000000001', 'lbs')

Para adicionar um item a um registro existente, a coluna TxnId do registro PriceDiscount ao qual o item deve ser adicionado e o ItemListId são obrigatórios.

INSERT INTO PriceDiscountItems (TxnId, ItemListId, ItemUnitOfMeasure)
VALUES ('-1234567890123456789', '-1000000000000000001', 'lbs')

Atualizar¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Observação: as operações de atualização contarão como duas operações na API QuickBooks POS. Um é necessário para recuperar o registro existente e outro para atualizar o registro com novos dados.

Para realizar uma atualização, TxnId e ItemTxnLineId são campos obrigatórios.

UPDATE PriceDiscountItems SET ItemUnitOfMeasure='lbs' WHERE TxnId='-1234567890123456789' AND ItemTxnLineId='1'

Excluir¶

Excluir é usado para remover um item do registro especificado (não excluirá o registro inteiro).

Nota: A exclusão de um item requer que todos os itens desejados que existem atualmente no registro sejam enviados na solicitação, excluindo assim aqueles que não foram especificados. Portanto, as operações de exclusão contarão como duas operações na API QuickBooks POS. Um é necessário para recuperar o registro existente para obter todos os ItemTxnLineIds existentes e outro para excluir o item especificado.

Para realizar uma exclusão, TxnId e ItemTxnLineId são campos obrigatórios.

DELETE FROM PriceDiscountItems WHERE TxnId='-1234567890123456789' AND ItemTxnLineId='3'

Colunas¶

PreçoDescontos¶

Crie, atualize e consultar os descontos de preço do QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM PriceDiscounts WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Para criar um novo registro PriceDiscount, os campos PriceDiscountName e PriceDiscountReason são obrigatórios. Os itens são especificados por meio de um agregado XML na coluna ItemsAggregate. As colunas que podem ser usadas nesses agregados são definidas no PriceDiscountItems tabela como # colunas. Observe que ItemListId é necessário ao adicionar um item.

O exemplo a seguir irá inserir um novo PriceDiscount com dois itens:

INSERT INTO PriceDiscounts (PriceDiscountName, PriceDiscountReason, PriceDiscountXValue, ItemsAggregate)
VALUES ('New Discount', 'Sale', '10', '<PriceDiscountItems>
<Row><ItemListId>-1000000000000000001</ItemListId></Row>
<Row><ItemListId>-1000000000000000002</ItemListId></Row>
</PriceDiscountItems>')

Atualização¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Ao atualizar um registro PriceDiscount, os itens podem ser adicionados ou modificados por meio da coluna ItemsAggregate.

Para modificar um item existente em um registro PriceDiscount, a coluna ItemTxnLineId é necessária para identificar o item. Em uma atualização usando um ItemsAggregate, especifique todos os valores de ItemTxnLineId a serem mantidos, pois os valores não especificados serão excluídos.

Para adicionar um novo item, deve-se especificar o ItemListId que corresponde ao item a ser adicionado, como em um insert.

Observe que os itens não podem ser modificados e adicionados na mesma solicitação ItemsAggregate. A modificação de um item, usando ItemTxnLineId, tem precedência sobre os itens adicionados e, portanto, o QuickBooks POS ignora os itens adicionados e executa a modificação apenas dos itens existentes.

Modificar itens Exemplo: totalize dois itens com valores de ItemTxnLineId de 1 e 2. O item 1 é atualizado e o item 2 será excluído.

UPDATE PriceDiscounts SET ItemsAggregate='<PriceDiscountItems>
<Row><ItemTxnLineId>1</ItemTxnLineId><ItemUnitOfMeasure>lbs</ItemUnitOfMeasure></Row>
</PriceDiscountItems>'
WHERE TxnId='-1234567890123456789'

Exemplo de Adicionar Novo Item: Os itens existentes permanecem intactos ao adicionar novos itens.

UPDATE PriceDiscounts SET ItemsAggregate='<PriceDiscountItems>
<Row><ItemListId>-1000000000000000003</ItemListId><ItemUnitOfMeasure>lbs</ItemUnitOfMeasure></Row>
</PriceDiscountItems>' 
WHERE TxnId='-1234567890123456789'

Colunas¶

PurchaseOrderItems¶

Crie, atualize, exclua e consultar itens de pedido de compra do QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM PurchaseOrderItems WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Inserir pode ser usado para criar um novo registro de Pedido de Compra ou para adicionar um item a um registro de Pedido de Compra existente.

Para criar um novo registro de Pedido de Compra, os campos PurchaseOrderNumber e VendorListId são obrigatórios.

INSERT INTO PurchaseOrderItems (PurchaseOrderNumber, VendorListId, ItemListId, ItemCost, ItemQty)
VALUES ('PO12345', '-9876543210987654321', '-1000000000000000001', 15.00, 10)

Para adicionar um item a um registro existente, a coluna TxnId do registro do Pedido de Compra ao qual o item deve ser adicionado e o ItemListId são obrigatórios.

INSERT INTO PurchaseOrderItems (TxnId, ItemListId, ItemCost, ItemQty)
VALUES ('-1234567890123456789', '-1000000000000000001', 15.00, 10)

Atualização¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Observação: as operações de atualização contarão como duas operações na API QuickBooks POS. Um é necessário para recuperar o registro existente e outro para atualizar o registro com novos dados.

Para realizar uma atualização, TxnId e ItemTxnLineId são campos obrigatórios.

UPDATE PurchaseOrderItems SET ItemSize='L' WHERE TxnId='-1234567890123456789' AND ItemTxnLineId='1'

Excluir¶

Excluir é usado para remover um item do registro especificado (não excluirá o registro inteiro).

Nota: A exclusão de um item requer que todos os itens desejados que existem atualmente no registro sejam enviados na solicitação, excluindo assim aqueles que não foram especificados. Portanto, as operações de exclusão contarão como duas operações na API QuickBooks POS. Um é necessário para recuperar o registro existente para obter todos os ItemTxnLineIds existentes e outro para excluir o item especificado.

Para realizar uma exclusão, TxnId e ItemTxnLineId são campos obrigatórios.

DELETE FROM PurchaseOrderItems WHERE TxnId='-1234567890123456789' AND ItemTxnLineId='3'

Colunas¶

Pedidos de compra¶

Crie, atualize, exclua e consultar pedidos de compra do QuickBooks POS.

Informações específicas da tabela¶

A tabela PurchaseOrders permite SELECIONAR, INSERIR, ATUALIZAR e EXCLUIR pedidos de compra no QuickBooks POS.

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM PurchaseOrders WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Para criar um novo registro de Pedido de Compra, os campos PurchaseOrderNumber e VendorListId são obrigatórios. Os itens são especificados por meio de um agregado XML na coluna ItemsAggregate. As colunas que podem ser usadas nesses agregados são definidas no PurchaseOrderItems tabela como # colunas. Observe que ItemListId é necessário ao adicionar um item.

O exemplo a seguir irá inserir um novo Pedido de Compra com dois itens:

INSERT INTO PurchaseOrders (PurchaseOrderNumber, VendorListId, ItemsAggregate)
VALUES ('PO12345', '-9876543210987654321', '<PurchaseOrderItems>
<Row><ItemListId>-1000000000000000001</ItemListId><ItemCost>10.00</ItemCost><ItemQty>25</ItemQty></Row>
<Row><ItemListId>-1000000000000000002</ItemListId><ItemCost>20.00</ItemCost><ItemQty>25</ItemQty></Row>
</PurchaseOrderItems>')

Atualização¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Ao atualizar um registro de Pedido de Compra, os itens podem ser adicionados ou modificados por meio da coluna ItemsAggregate.

Para modificar um item existente em um registro de Pedido de Compra, a coluna ItemTxnLineId é necessária para identificar o item. Em uma atualização usando um ItemsAggregate, especifique todos os valores de ItemTxnLineId a serem mantidos, pois os valores não especificados serão excluídos.

Para adicionar um novo item, deve-se especificar o ItemListId que corresponde ao item a ser adicionado, assim como em um insert.

Observe que os itens não podem ser modificados e adicionados na mesma solicitação ItemsAggregate. A modificação de um item, usando ItemTxnLineId, tem precedência sobre os itens adicionados e, portanto, o QuickBooks POS ignora os itens adicionados e executa a modificação apenas dos itens existentes.

Modificar itens Exemplo: totalize três itens com valores de ItemTxnLineId de 1, 2 e 3. O item 1 é atualizado, o item 2 é deixado sozinho e o item 3 será excluído.

UPDATE PurchaseOrders SET ItemsAggregate='<PurchaseOrderItems>
<Row><ItemTxnLineId>1</ItemTxnLineId><ItemSize>L</ItemSize></Row>
<Row><ItemTxnLineId>2</ItemTxnLineId></Row>
</PurchaseOrderItems>'
WHERE TxnId='-1234567890123456789'

Exemplo de Adicionar Novo Item: Os itens existentes permanecem intactos ao adicionar novos itens.

UPDATE PurchaseOrders SET ItemsAggregate='<PurchaseOrderItems>
<Row><ItemListId>-1000000000000000003</ItemListId><ItemCost>30.00</ItemCost><ItemQty>10</ItemQty></Row>
</PurchaseOrderItems>' 
WHERE TxnId='-1234567890123456789'

Colunas¶

SalesOrderItems¶

Crie, atualize, exclua e consultar itens de pedidos de vendas do QuickBooks PDV.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM SalesOrderItems WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Inserir pode ser usado para criar um novo registro de Pedido de Vendas ou para adicionar um item a um registro de Pedido de Vendas existente.

Para criar um novo registro de Pedido de Vendas, os campos PurchaseOrderNumber e VendorListId são obrigatórios.

INSERT INTO SalesOrderItems (CustomerListId, SalesOrderNumber, ItemListId, ItemCost, ItemQty)
VALUES ('-9876543210987654321', 'SO12345', '-1000000000000000001', 15.00, 1)

Para adicionar um item a um registro existente, a coluna TxnId do registro do pedido de vendas ao qual o item deve ser adicionado e o ItemListId são obrigatórios.

INSERT INTO SalesOrderItems (TxnId, ItemListId, ItemCost, ItemQty)
VALUES ('-1234567890123456789', '-1000000000000000001', 15.00, 1)

Atualização¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Observação: as operações de atualização contarão como duas operações na API QuickBooks POS. Um é necessário para recuperar o registro existente e outro para atualizar o registro com novos dados.

Para realizar uma atualização, TxnId e ItemTxnLineId são campos obrigatórios.

UPDATE SalesOrderItems SET ItemSize='L' WHERE TxnId='-1234567890123456789' AND ItemTxnLineId='1'

Excluir¶

Excluir é usado para remover um item do registro especificado (não excluirá o registro inteiro).

Nota: A exclusão de um item requer que todos os itens desejados que existem atualmente no registro sejam enviados na solicitação, excluindo assim aqueles que não foram especificados. Portanto, as operações de exclusão contarão como duas operações na API QuickBooks POS. Um é necessário para recuperar o registro existente para obter todos os ItemTxnLineIds existentes e outro para excluir o item especificado.

Para realizar uma exclusão, TxnId e ItemTxnLineId são campos obrigatórios.

DELETE FROM SalesOrderItems WHERE TxnId='-1234567890123456789' AND ItemTxnLineId='3'

Colunas¶

SalesOrders¶

Crie, atualize, exclua e consultar pedidos de vendas do QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM SalesOrders WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Para criar um novo registro de Pedidos de Vendas, o campo CustomerListId é obrigatório. Os itens são especificados por meio de um agregado XML na coluna ItemsAggregate. As colunas que podem ser usadas nesses agregados são definidas no SalesOrderItems tabela como # colunas. Observe que ItemListId é necessário ao adicionar um item.

O exemplo a seguir irá inserir um novo Pedido de Venda com dois itens:

INSERT INTO SalesOrders (CustomerListId, SalesOrderNumber, ItemsAggregate)
VALUES ('-9876543210987654321', 'SO12345', '<SalesOrderItems>
<Row><ItemListId>-1000000000000000001</ItemListId><ItemPrice>15.00</ItemPrice><ItemQty>1</ItemQty></Row>
<Row><ItemListId>-1000000000000000002</ItemListId><ItemPrice>25.00</ItemPrice><ItemQty>1</ItemQty></Row>
</SalesOrderItems>')

Atualização¶

Qualquer campo que não seja somente leitura pode ser atualizado.

Ao atualizar um registro de Pedido de Vendas, os itens podem ser adicionados ou modificados por meio da coluna ItemsAggregate.

Para modificar um item existente em um registro de Pedido de Vendas, a coluna ItemTxnLineId é necessária para identificar o item. Em uma atualização usando um ItemsAggregate, especifique todos os valores de ItemTxnLineId a serem mantidos, pois os valores não especificados serão excluídos.

Para adicionar um novo item, deve-se especificar o ItemListId que corresponde ao item a ser adicionado, assim como em um insert.

Observe que os itens não podem ser modificados e adicionados na mesma solicitação ItemsAggregate. A modificação de um item, usando ItemTxnLineId, tem precedência sobre os itens adicionados e, portanto, o QuickBooks POS ignora os itens adicionados e executa a modificação apenas dos itens existentes.

Modificar itens Exemplo: Total de três itens com valores ItemTxnLineId de 1, 2 e 3. O item 1 é atualizado, o item 2 é deixado sozinho e o item 3 será excluído.

UPDATE SalesOrders SET ItemsAggregate='<SalesOrderItems>
<Row><ItemTxnLineId>1</ItemTxnLineId><ItemSize>L</ItemSize></Row>
<Row><ItemTxnLineId>2</ItemTxnLineId></Row>
</SalesOrderItems>'
WHERE TxnId='-1234567890123456789'

Exemplo de Adicionar Novo Item: Os itens existentes permanecem intactos ao adicionar novos itens.

UPDATE SalesOrders SET ItemsAggregate='<SalesOrderItems>
<Row><ItemListId>-1000000000000000003</ItemListId><ItemCost>40.00</ItemCost><ItemQty>1</ItemQty></Row>
</SalesOrderItems>' 
WHERE TxnId='-1234567890123456789'

Colunas¶

SalesReceiptItems¶

Crie, atualize e consultar itens de pedido de venda QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM SalesReceiptItems WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Inserir pode ser usado para criar um novo registro de Recibo de Vendas ou para adicionar um item a um registro de Recibo de Vendas existente.

Para criar um novo registro de Recibo de Vendas, o CustomerListId é necessário junto com um Item.

INSERT INTO SalesReceiptItems (SalesReceiptType, CustomerListId, SalesReceiptNumber, CashTenderAmount, ItemListId, ItemPrice, ItemQty)
VALUES ('Sales', '-9876543210987654321', 'SR12345', 2.15, '-1000000000000000001', 2.00, 1)

Para adicionar um item a um registro existente, a coluna TxnId do registro de recibo de venda ao qual o item deve ser adicionado e o ItemListId são obrigatórios.

INSERT INTO SalesReceiptItems (TxnId, CashTenderAmount, ItemListId, ItemPrice, ItemQty)
VALUES ('-1234567890123456789', 2.15, '-1000000000000000001', 2.00, 1)

Colunas¶

SalesReceipts¶

Crie, atualize e consultar recibos de vendas do QuickBooks POS.

Informações específicas da tabela¶

Selecione¶

QuickBooks POS permite que muitas das colunas sejam usadas na cláusula WHERE de uma consultar SELECT. Essas colunas podem criar filtros Single ou Range, conforme definido no esquema da tabela.

SELECT * FROM SalesReceipts WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'

Inserir¶

Para criar um novo registro de Recibo de Vendas, o campo CustomerListId é obrigatório. Os itens são especificados por meio de um agregado XML na coluna ItemsAggregate. As colunas que podem ser usadas nesses agregados são definidas no SalesReceiptItems tabela como # colunas. Observe que ItemListId é necessário ao adicionar um item.

O exemplo a seguir irá inserir um novo recibo de venda com dois itens (nota: 7,5% de imposto sobre vendas):