Detalhes da Conexão do Zoho Books¶

Introdução¶

Versão do conector

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

Começando¶

Suporte à versão do Zoho Books

O conector utiliza a API do Zoho Books para permitir o acesso bidirecional ao Zoho Books.

Estabelecendo uma Conexão¶

Autenticação no Zoho Books¶

Zoho Books usa o padrão de autenticação OAuth. Para autenticar usando OAuth, você precisará criar um aplicativo para obter o OAuthClientId, OAuthClientSecret, e CallbackURL propriedades de conexão. Consulte Usando autenticação OAuth para obter um guia de autenticação.

Usando Autenticação OAuth¶

Use o padrão de autenticação OAuth para se conectar ao Zoho Books. OAuth requer que o usuário autenticado interaja com o Zoho Books usando o navegador.

Credenciais Personalizadas¶

Você precisará registrar um aplicativo para obter o OAuthClientId, OAuthClientSecret. Consulte Credenciais personalizadas para um procedimento.

Criando um Aplicativo OAuth Personalizado¶

Você pode criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no Zoho Books. Você pode registrar um aplicativo para obter o OAuthClientId, OAuthClientSecret, e OrganizationId.

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Credenciais Incorporadas¶

Autenticar Usando as Credenciais OAuth Incorporadas¶

Autenticação de Desktop com o Aplicativo OAuth Integrado¶

Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário. Depois de definir o seguinte, você está pronto para se conectar:

• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth.

1. Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
2. Obtém um novo token de acesso quando o antigo expira.
3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Credenciais Personalizadas¶

Esta seção descreve a autenticação da área de trabalho usando as credenciais para seu aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado Para maiores informações.

Autenticação de Área de Trabalho com Seu Aplicativo OAuth¶

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.

Obtenha um Token de Acesso OAuth¶

Depois de definir o seguinte, você está pronto para se conectar:

• OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
• CallbackURL: Defina isso para o URL de redirecionamento nas configurações do aplicativo.
• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth:

1. Extrai o token de acesso da URL de retorno de chamada e autentica as solicitações.
2. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Máquinas Sem Cabeça¶

Usando OAuth em uma Máquina Sem Cabeça¶

Para criar fontes de dados Zoho Books em servidores headless ou outras máquinas nas quais o conector não pode abrir um navegador, você precisa autenticar de outra máquina. A autenticação é um processo de duas etapas.

1. Ao invés de instalar o conector em outra máquina, você pode seguir os passos abaixo para obter o OAuthVerifier valor. Ou você pode instalar o conector em outra máquina e transferir os valores de autenticação OAuth, depois de autenticar por meio do fluxo normal baseado em navegador.
2. Em seguida, você pode configurar o conector para atualizar automaticamente o token de acesso da máquina sem periféricos.

Usando as Credenciais para um Aplicativo OAuth Personalizado¶

Crie um aplicativo OAuth personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento. Você pode seguir os procedimentos abaixo para autenticar e conectar-se aos dados.

Obtenha um código verificador

Defina as seguintes propriedades na máquina sem periféricos:

• InitiateOAuth: Defina como DESLIGADO.
• OAuthClientId: Defina isso como o ID do aplicativo nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o Segredo do aplicativo nas configurações do aplicativo.

Você pode seguir as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier propriedade de conexão.

1. Chame o GetOAuthAuthorizationURL procedimento armazenado* com o parâmetro de entrada CallbackURL definido para o URI de redirecionamento exato que você especificou nas configurações do aplicativo.
2. Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
3. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth:

• OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
• OAuthVerifier: Defina isso para o código do verificador.
• OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
• InitiateOAuth: Configure para ATUALIZAR.

Conecte-se aos dados

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

• OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao provedor para ativar a atualização automática do token de acesso.
• InitiateOAuth: Configure para ATUALIZAR.

Configurações de transferência OAuth

Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.

Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:

• OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
• InitiateOAuth: Defina como GETANDREFRESH.
• OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
• CallbackURL: Defina isso para o URL de retorno de chamada nas configurações do aplicativo.

Teste a conexão para autenticar. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

• InitiateOAuth: Configure para ATUALIZAR.
• OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.

Criando um Aplicativo OAuth Personalizado¶

Para obter um OAuthClientId, OAuthClientSecret, CallbackURL, e OrganizationId você primeiro precisa criar um aplicativo vinculado à sua conta do Zoho Books.

Crie e Configure um Aplicativo OAuth Personalizado¶

Você terá que primeiro registrar seu aplicativo no console do desenvolvedor do Zoho para obter seu ID e segredo do cliente. Você pode criar um aplicativo vinculado à sua conta do Zoho Books da seguinte maneira:

1. Para registrar seu aplicativo, acesse <https://accounts.zoho.com/developerconsole>.
2. Clique em Add Client ID, especifique um Domínio de Cliente de Nome de Cliente.
3. Preencha os dados solicitados no formulário.
   • Defina o Auth Callback URL para https://localhost:33333 ou uma porta diferente de sua escolha.
   • Você pode escolher o tipo de cliente como baseado na WEB/Javascript/Mobile e clicar em Create.
4. No Zoho Books, sua empresa é denominada organização. Se você tiver vários negócios, basta configurar cada um deles como uma organização individual. Cada organização é uma organização Zoho Books independente com seu próprio ID de organização, moeda base, fuso horário, idioma, contatos, relatórios etc.
   • O parâmetro organization_id juntamente com o ID da organização devem ser enviados com cada solicitação de API para identificar a organização.
   • Clique Organization Name, na seção superior direita. Dentro disso, você pode escolher o ID da organização.
   • Se o valor do ID da organização não for especificado na string de conexão, faremos uma chamada para obter todas as organizações disponíveis e selecionaremos o primeiro ID da organização como padrão.
5. Depois de concluir as alterações, o navegador solicitará que você salve.

Assim que terminar de criar um novo cliente, ele será exibido na tela. A partir daí, você pode clicar em More Options > Edit para revelar o ID do cliente e o segredo do cliente do seu aplicativo recém-criado. Agora você pode usar essas credenciais para se conectar ao Zoho Books, definindo-as como as seguintes propriedades de conexão:

• OAuthClientId = ID do cliente
• OAuthClientSecret = Segredo do cliente
• CallbackURL = URL de retorno de chamada de autenticação

Acesso a Dados de Ajuste Fino¶

Acesso a Dados de Ajuste Fino¶

Você pode usar as seguintes propriedades para obter mais controle sobre os dados retornados do Zoho Books:

• OrganizationId: O ID associado à organização Zoho Books específica à qual você deseja se conectar. No Zoho Books, sua empresa é denominada organização.
  Se você tiver vários negócios, basta configurar cada um deles como uma organização individual.
  Cada organização é uma organização Zoho Books independente com seu próprio ID de organização, moeda base, fuso horário, idioma, contatos, relatórios, etc.
  Se o valor do ID da organização não for especificado na string de conexão, faremos uma chamada para obter todas as organizações disponíveis e selecionaremos o primeiro ID da organização como padrão.
  
• AccountsServer: O URL completo do servidor da conta. Na maioria das vezes, o valor desta propriedade será https://books.zoho.com, mas se sua conta residir em um local diferente, o domínio deverá ser alterado de acordo (.eu, .in, .com.au, ...).

Características Avançadas¶

Esta seção detalha uma seleção de recursos avançados do conector Zoho Books.

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.

Visualizações Definidas pelo Usuário¶

O conector Jitterbit para Zoho Books permite que você defina uma tabela 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 exibiçã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 INVOICES 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 Exibiçõ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.

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¶

Visão geral

Esta seção mostra os objetos de API disponíveis e fornece mais informações sobre como executar SQL para APIs do Zoho Books.

Características principais

• O conector modela entidades do Zoho Books, como faturas, contas e despesas como exibições relacionais, permitindo que você escreva SQL para consultar dados do Zoho Books.
• Procedimentos armazenados* permitem que você execute operações para Zoho Books, incluindo recibo de despesas, anexo de fatura de retenção e anexos.
• A conectividade ao vivo com esses objetos significa que quaisquer alterações em sua conta do Zoho Books são refletidas imediatamente ao usar o conector.
• IncludeCustomFields propriedade de conexão permite que você recupere campos personalizados para exibições suportadas. Defina esta propriedade como True, para habilitar este recurso.

Visualizações

Visualizações descreve as exibições disponíveis. As visualizações são definidas estaticamente para modelar faturas, contas, despesas e muito mais.

Procedimentos armazenados

NOTE: Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.

Procedimentos armazenados são interfaces semelhantes a funções para o Zoho Books. Procedimentos armazenados* permitem que você execute operações para Zoho Books, incluindo recibo de despesas, anexo de fatura de retenção e anexos.

Processamento de consulta colaborativa

O conector descarrega o máximo possível do processamento da instrução SELECT para o Zoho Books e, em seguida, processa o restante da consultar na memória. As limitações e requisitos da API também estão documentados nesta seção.

Ver SupportEnhancedSQL para obter mais informações sobre como o conector contorna as limitações da API com processamento na memória do lado do cliente.

Visualizações¶

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.

Conector Jitterbit para Exibições do Zoho Books¶

Contas Bancárias¶

Recupera a lista de todas as contas bancárias e de cartão de crédito da sua organização.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• AccountId suporta a comparação '='.
• AccountCodeAccountName suporta a comparação '='.
• AccountType suporta a comparação '='.
• Status suporta a comparação '='.

Por exemplo:

SELECT * FROM BankAccounts WHERE Status = 'All'

SELECT * FROM BankAccounts WHERE AccountId = '1894343000000085314'

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

BankMatchingTransactions¶

Recupera a lista de transações que inclui faturas/faturas/notas de crédito.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector. Você pode até fornecer critérios para pesquisar transações não categorizadas correspondentes.

• TransactionId suporta a comparação '='.
• TransactionType suporta a comparação '='.
• ReferenceNumber suporta a comparação '='.
• Date suporta '=,<,>' comparações.
• Contact suporta a comparação '='.
• ShowAllTransactions. suporta a comparação '='.

Por exemplo:

SELECT * FROM BankMatchingTransactions WHERE TransactionId = '1894578000000087001

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

BankRuleCriterions¶

Obter critérios de uma regra de banco específica.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a coluna e o operador a seguir. O restante do filtro é executado no lado do cliente dentro do conector.

• RuleAccountId suporta a comparação '='.

Por exemplo:

SELECT * FROM BankRuleCriterions WHERE RuleAccountId = '1894553000000085382

Colunas¶

Regras do Banco¶

Busque todas as regras ou uma regra específica criada para um banco específico ou ID de conta de cartão de crédito.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• RuleAccountId suporta a comparação '='.
• RuleId suporta a comparação '='.

Por exemplo:

SELECT * FROM BankRules WHERE RuleAccountId = '1894553000000085382' AND RuleId = '1894553000000085386'

Colunas¶

BankTransactionLineItems¶

Obtenha detalhes de itens de linha de transação bancária.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: TransactionId é necessário para consultar BankTransactionLineItems.

• TransactionId suporta a comparação '='.

Por exemplo:

SELECT * FROM BankTransactionLineItems WHERE TransactionId = '1894553000000098001'

Colunas¶

Transações Bancárias¶

Obtenha todos os detalhes da transação envolvidos em uma conta.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• AccountId suporta a comparação '='.
• TransactionType suporta a comparação '='.
• Amount suporta a comparação '='.
• Date suporta a comparação '='.
• ReferenceNumber suporta a comparação '='.
• Status suporta a comparação '='.
• BankTransactionFilter suporta a comparação '='.

Por exemplo:

SELECT * FROM BankTransactions WHERE Status = 'All'

SELECT * FROM BankTransactions LIMIT 5

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

BaseCurrencyAdjustmentAccounts¶

Recupera listas de contas de ajuste de moeda base.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• BaseCurrencyAdjustmentId suporta a comparação '='.

Por exemplo:

SELECT * FROM BaseCurrencyAdjustmentAccounts WHERE BaseCurrencyAdjustmentId = '1894553000000000065'

Colunas¶

BaseCurrencyAdjustments¶

Recupera a lista de ajuste de moeda base.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a coluna e o operador a seguir. O restante do filtro é executado no lado do cliente dentro do conector. Por padrão, a resposta mostrará apenas os ajustes de moeda base do mês atual.

• BaseCurrencyAdjustmentId suporta a comparação '='.
• BaseCurrencyAdjustmentsFilter suporta a comparação '='.

Por exemplo:

SELECT * FROM BaseCurrencyAdjustments WHERE BaseCurrencyAdjustmentsFilter = 'Date.All'

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Detalhes da Fatura¶

Obtenha os detalhes de uma fatura.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: BillId é necessário para consultar BillDetails.

• BillId suporta a comparação '='.

Por exemplo:

SELECT * FROM BillDetails WHERE BillId = '1894553000000085259'

Colunas¶

BillLineItems¶

Obtenha os detalhes de itens de linha de contas.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a coluna e o operador a seguir. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: BillId é necessário para consultar BillLineItems.

• BillId suporta a comparação '='.

Por exemplo:

SELECT * FROM BillLineItems WHERE BillId = '1894253000000085259'

Colunas¶

Pagamento de Contas¶

Obtenha a lista de pagamentos feitos para uma conta.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• BillId suporta a comparação '='.

Por exemplo:

SELECT * FROM BillPayments WHERE BillId = '1894253000000085259'

Colunas¶

Contas¶

Recupera a lista de contas.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• BillNumber suporta a comparação '='.
• Date suporta '=,<,>' comparações.
• LastModifiedTime suporta a comparação '='.
• ReferenceNumber suporta a comparação '='.
• Status suporta a comparação '='.
• Total suporta as comparações '=,<,<=,>,>='.
• VendorId suporta a comparação '='.
• VendorName suporta a comparação '='.
• PurchaseOrderId suporta a comparação '='.
• RecurringBillId suporta a comparação '='.
• BillFilter suporta a comparação '='.
• ItemId suporta a comparação '='.
• ItemDescription. suporta a comparação '='.

Por exemplo:

SELECT * FROM Bills WHERE Total < 100 AND Total <= 98

SELECT * FROM Bills WHERE Date < '2018-07-03'

SELECT * FROM Bills WHERE CONTAINS(BillNumber,'Bi')

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

ChartOfAccountInlineTransactions¶

Recupera a lista de transações em linha.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• ChartAccountId suporta a comparação '='.

Por exemplo:

SELECT * FROM ChartOfAccountInlineTransactions WHERE ChartAccountId = '1894553000000003003'

Colunas¶

GráficoDeContas¶

Recupera a lista de todos os planos de contas.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a coluna e o operador a seguir. O restante do filtro é executado no lado do cliente dentro do conector. Você pode até fornecer critérios para pesquisar transações não categorizadas correspondentes.

• LastModifiedTime suporta a comparação '='.
• ShowBalance suporta a comparação '='.
• AccountType suporta a comparação '='.

Por exemplo:

SELECT * FROM ChartOfAccounts WHERE AccountType = 'All' AND ShowBalance = true

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

ChartOfAccountTransactions¶

Recupera a lista de todas as transações envolvidas para a conta especificada.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector. Você pode até fornecer critérios para pesquisar transações não categorizadas correspondentes.

• ChartAccountId suporta a comparação '='.
• TransactionType suporta a comparação '='.
• Date suporta '=,<,>' comparações.
• Amount suporta as comparações '=,<,<=,>,>='.

Por exemplo:

SELECT * FROM ChartOfAccountTransactions WHERE ChartAccountId = '1894553000000003001' AND TransactionType = 'opening_balance'

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Endereços de Contato¶

Obtenha endereços de um contato, incluindo seu endereço de entrega, endereço de cobrança.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• ContactId suporta a comparação '='.

Por exemplo:

SELECT * FROM ContactAddresses WHERE ContactId = '1894952000000071009'

Colunas¶

Detalhes do Contato¶

Obter detalhes de um contato.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ContactId é necessário para consultar ContactDetails.

• ContactId suporta a comparação '='.

Por exemplo:

SELECT * FROM ContactDetails WHERE ContactId = '1894952000000071009'

Colunas¶

Contatos¶

Recupera a lista de todos os contatos.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• ContactName suporta a comparação '='.
• CompanyName suporta a comparação '='.
• Status suporta a comparação '='.
• FirstName suporta a comparação '='.
• LastName suporta a comparação '='.
• Email suporta a comparação '='.
• Phone suporta a comparação '='.
• Address suporta a comparação '='.
• PlaceOfContact suporta a comparação '='.

Por exemplo:

SELECT * FROM Contacts WHERE CONTAINS(LastName,'D')

SELECT * FROM Contacts WHERE FirstName = 'John' AND Status = 'Active'

SELECT * FROM Contacts LIMIT 5

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Detalhes da Nota de Crédito¶

Recupera detalhes de uma Nota de Crédito existente.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a coluna e o operador a seguir. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: CreditnoteId é necessário para consultar CreditNoteDetails.

• CreditnoteId suporta a comparação '='.

Por exemplo:

SELECT * FROM CreditNoteDetails WHERE CreditnoteId = '1895452000000083136'

Colunas¶

Nota de CréditoFaturas¶

Recupera detalhes de faturas de uma Nota de Crédito existente.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: CreditnoteId é necessário para consultar CreditNoteInvoices.

• CreditnoteId suporta a comparação '='.

Por exemplo:

SELECT * FROM CreditNoteInvoices WHERE CreditnoteId = '1895452000000083136'

Colunas¶

CreditNoteLineItems¶

Recupera detalhes de itens de linha de Notas de Crédito existentes.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a coluna e o operador a seguir. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: CreditnoteId é necessário para consultar CreditNoteLineItems.

• CreditnoteId suporta a comparação '='.

Por exemplo:

SELECT * FROM CreditNoteLineItems WHERE CreditnoteId = '1895452000000083136'

Colunas¶

Notas de Credito¶

Recupera a lista de todas as Notas de Crédito.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• CreditnoteNumber suporta a comparação '='.
• CustomerId suporta a comparação '='.
• CustomerName suporta a comparação '='.
• Date suporta a comparação '='.
• ReferenceNumber suporta a comparação '='.
• Status suporta a comparação '='.
• Total suporta a comparação '='.
• CreditNoteFilter suporta a comparação '='.
• LineItemId suporta a comparação '='.
• TaxId suporta a comparação '='.
• ItemId suporta a comparação '='.
• ItemName suporta a comparação '='.
• ItemDescription suporta a comparação '='.

Por exemplo:

SELECT * FROM CreditNotes WHERE CreditnoteNumber = 'CN-00006' AND ReferenceNumber = 'Ref-0075' AND CustomerName = 'AWS Stores'

SELECT * FROM CreditNotes WHERE CreditNoteFilter = 'Status.All'

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Moedas¶

Obter lista de moedas configuradas. Além disso, obtenha os detalhes de uma moeda.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• CurrencyFilter suporta a comparação '='.
• CurrencyId suporta a comparação '='.

Por exemplo:

SELECT * FROM Currencies WHERE CurrencyId = '1894553000000000099'

SELECT * FROM Currencies WHERE CurrencyFilter = 'Currencies.ExcludeBaseCurrency'

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Taxas de Câmbio¶

Recupera a lista de taxas de câmbio configuradas para a moeda.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• FromDate suporta a comparação '='.
• IsCurrentDate suporta a comparação '='.
• CurrencyId suporta a comparação '='.

Por exemplo:

SELECT * FROM CurrencyExchangeRates WHERE CurrencyId = '1894553000000000089'

SELECT * FROM CurrencyExchangeRates WHERE CurrencyId = '1894553000000000087' AND IsCurrentDate = true

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

ClienteContatos¶

Recupera a lista de todas as pessoas de contato. Além disso, obtenha os detalhes da pessoa de contato.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• ContactId suporta a comparação '='.
• CustomerContactId suporta a comparação '='.

Por exemplo:

SELECT * FROM CustomerContacts WHERE ContactId = '1864553000000072009' AND CustomerContactId = '1896253000000071011'

Colunas¶

Detalhes de Pagamento do Cliente¶

Recupera detalhes de um pagamento existente.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a coluna e o operador a seguir. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: PaymentId é necessário para consultar CustomerPaymentDetails.

• PaymentId suporta a comparação '='.

Por exemplo:

SELECT * FROM CustomerPaymentDetails WHERE PaymentId = '1894553000000083001'

Colunas¶

Pagamentos do Cliente¶

Recupera a lista de todos os pagamentos feitos pelo seu cliente.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• PaymentMode suporta a comparação '='.
• Amount suporta as comparações '=,<,<=,>,>='.
• CustomerName suporta a comparação '='.
• Date suporta a comparação '='.
• ReferenceNumber suporta a comparação '='.
• PaymentModeFilter suporta a comparação '='.
• Notes suporta a comparação '='.

Por exemplo:

SELECT * FROM CustomerPayments WHERE Amount < 900 AND Amount > 50 AND ReferenceNumber = '1894553000000079879'

SELECT * FROM CustomerPayments WHERE CustomerName = 'Harry'

SELECT * FROM CustomerPayments WHERE CONTAINS(ReferenceNumber,'455')

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Funcionários¶

Recupera a lista de funcionários. Além disso, obtenha os detalhes de um funcionário.

Informações Específicas da Tabela¶

Selecione¶

O conector usará a API do Zoho Books para processar as condições da cláusula WHERE criadas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

• EmployeeId suporta a comparação '='.
• Status suporta a comparação '='.