Ir para o conteúdo

Detalhes da Conexão do Xero WorkflowMax

Introdução

Versão do conector

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

Começando

Suporte à versão Xero WorkflowMax

O conector aproveita a API XeroWorkflowMax para permitir o acesso bidirecional ao XeroWorkflowMax.

Estabelecendo uma Conexão

Conectando-se ao Xero WorkflowMax

Autenticar Via Autenticação OAuth

Use o padrão de autenticação OAuth para se conectar à API Xero WorkflowMax. Você pode autenticar com uma conta de usuário. O conector facilita isso conforme descrito abaixo.

Usando uma Conta de Usuário para Autenticar no Xero WorkflowMax

O fluxo da conta do usuário exige que o usuário autenticado interaja com o Xero WorkflowMax por meio do navegador.

Credenciais Personalizadas

Como a conexão com credenciais incorporadas está obsoleta, você deve registrar um aplicativo para obter o OAuthClientId e OAuthClientSecret.

Criando um Aplicativo OAuth Personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Usando Autenticação OAuth

Use o padrão de autenticação OAuth para se conectar à API Xero WorkflowMax V3. Você pode autenticar com OAuth 2.0. O conector facilita isso conforme descrito abaixo.

Credenciais Personalizadas

Para se conectar com o conector, você deve registrar um aplicativo para obter o OAuthClientId e OAuthClientSecret.

Quando Criar um Aplicativo OAuth Personalizado

Você deve criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no endpoint Xero WorkflowMax OAuth para conceder permissões ao conector.

Usando uma Conta de Serviço para Se Conectar ao Xero WorkflowMax

As contas de serviço têm autenticação silenciosa, sem autenticação do usuário no navegador. Você também pode usar uma conta de serviço para delegar escopos de acesso em toda a empresa ao conector.

Você precisa criar um aplicativo OAuth neste fluxo. Você pode se conectar aos dados do Xero WorkflowMax que a conta de serviço tem permissão para acessar. Consulte Credenciais personalizadas para obter um guia de autenticação.

Criando um Aplicativo OAuth Personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Credenciais Personalizadas

Você pode usar um aplicativo OAuth personalizado para autenticar com uma conta de serviço ou uma conta de usuário. Consulte Usando autenticação OAuth Para maiores informações.

Autenticar com uma Conta de Usuário
Autenticação de Desktop com um Aplicativo OAuth Personalizado

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

Obtenha e atualize o token de acesso OAuth

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.
  • OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
  • CallbackURL: Defina para http://localhost:33333.

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. Atualiza o token de acesso quando ele expira.
  3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Máquinas Sem Cabeça

Usando OAuth em uma Máquina Sem Periféricos

As seções a seguir mostram como autenticar um servidor headless ou outra máquina na qual o conector não pode abrir um navegador. Você pode autenticar com uma conta de usuário ou com uma conta de serviço.

Autenticar com uma Conta de Usuário

Para autenticar com uma conta de usuário, 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.

Você pode seguir o fluxo de autenticação OAuth headless usando as credenciais OAuth para seu aplicativo OAuth personalizado.

Usando as Credenciais para um Aplicativo OAuth Personalizado

Crie um aplicativo OAuth personalizado

A criação de um aplicativo OAuth personalizado é obrigatória no fluxo OAuth headless.

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 cliente nas configurações do aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
  • CallbackURL: Configure para http://localhost:33333.

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:

  • InitiateOAuth: Configure para ATUALIZAR.
  • 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.

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

  • InitiateOAuth: Configure para ATUALIZAR.
  • 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.
  • 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.

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:

  • InitiateOAuth: Defina como GETANDREFRESH.
  • OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
  • OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
  • CallbackURL: Defina para http://localhost:33333.

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.
  • 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.
  • 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 configurar corretamente um aplicativo Xero Workflow Max, siga as instruções abaixo.

Registrar um Aplicativo

Para obter as credenciais do cliente OAuth, o ID do cliente e o segredo do cliente, siga estas etapas abaixo:

  1. Vá para Gerenciador de aplicativos Xero WorkflowMax
  2. No canto superior direito, clique em New App.
  3. Selecione Web App.
  4. Adicione o URL de redirecionamento a OAuth 2.0 redirect URI campo por exemplo: http://localhost:33333 que é nosso URL interno de retorno de chamada.
  5. Preencha os demais campos do formulário conforme desejado.
  6. Clique em Create App.
  7. Clique em Save e você será redirecionado para a página do seu novo aplicativo.
  8. Role até o final e você encontrará o ID do cliente.
  9. Clique em Generate a secret para criar seu segredo do cliente.
Definindo as Permissões Corretas

Um novo privilégio de equipe foi adicionado para controlar quem tem permissão para conectar sua conta a complementos de terceiros. Qualquer funcionário com privilégios de administrador pode atribuir esse novo privilégio a si mesmo ou a outros administradores. Siga estas etapas abaixo para cada membro da equipe que deseja autorizar conexões com complementos de terceiros.

  1. Vá para Configurações de equipe do Xero WorkflowMax
  2. Pesquise o funcionário ao qual você gostaria de adicionar essa permissão e clique nele.
  3. Caso o Staff não possua Administrator privilégio sob Admin Privileges, você terá que marcar a caixa e clicar em Save. Você será redirecionado para a lista de funcionários, onde deverá clicar no membro da equipe novamente.
  4. Role até o final em API Access Privileges, marque a caixa em Authorise 3rd Party Full Access e clique Save.
  5. Agora a equipe selecionada tem acesso à API do Xero Workflow Max V3

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector Xero WorkflowMax.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visõ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 Xero WorkflowMax permite definir 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 visualização.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM Clients 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 Xero WorkflowMax.

Características principais

  • O conector modela entidades Xero WorkflowMax como Clientes, Fornecedores e Trabalhos como exibições relacionais, permitindo que você escreva SQL para consultar dados Xero WorkflowMax.
  • Procedimentos armazenados* permitem executar operações no Xero WorkflowMax.
  • A conectividade ao vivo com esses objetos significa que quaisquer alterações em sua conta Xero WorkflowMax são refletidas imediatamente ao usar o conector.

Os campos personalizados

O driver XeroWORKflowMax oferece suporte a campos personalizados. Para poder recuperar e atualizar campos personalizados IncludeCustomFields deve ser definido como uma propriedade de conexão. Lembre-se de que o driver será lento ao obter campos personalizados, pois os busca um por um. Para melhorar o desempenho, tente especificar o ID do recurso que você está tentando consultar.

Processamento de consulta colaborativa

O conector descarrega o máximo possível do processamento da instrução SELECT para o Xero WorkflowMax 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.

Tabelas

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

Geralmente, consultar tabelas Xero WorkflowMax é 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 Xero WorkflowMax

Nome Descrição
ClientContacts Retorna uma lista de todos os contatos dos clientes.
ClientGroups Retorna uma lista de todos os grupos de clientes
Clients Retorna uma lista de todos os clientes.
Costs Retorna uma lista de todos os custos
JobCosts Retorna uma lista de todos os custos dos trabalhos.
JobNotes Retorna uma lista de todas as notas de um trabalho
Jobs Retorna uma lista de todos os trabalhos.
JobTasks Retorna uma lista de todas as tarefas de trabalhos.
Leads Retorna uma lista de todos os leads.
PurchaseOrderDrafts Retornar uma lista de todos os rascunhos de ordens de compra
PurchaseOrders Retornar uma lista de todos os pedidos de compra
StaffList Retorna uma lista de todos os membros da equipe
SupplierContacts Retorna uma lista de todos os fornecedores.
Suppliers Retorna uma lista de todos os fornecedores.
Times Retorna uma lista de todas as planilhas de tempo.

ClienteContatos

Retorna uma lista de todos os contatos dos clientes.

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • UUID suporta o = operador.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM ClientContacts WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
SELECT * FROM ClientContacts WHERE UUID IN ('3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9', 'd807cf4c-a2b9-428a-82e7-124b4f3ddab4')
Inserir

ClientUUID e Name são necessários para inserir. A consultar a seguir cria um novo ClientContact:

INSERT INTO ClientContacts (ClientUUID, Name) VALUES ('c6ec5c2c-2657-4ce3-b035-022c02b9f19e', 'Rambo')
Atualizar

Você pode atualizar um ClientContact especificando o ClientContact UUID:

UPDATE ClientContacts SET Name = 'Arnold' WHERE UUID='3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
Excluir

Exclua um ClientContact especificando o ClientContact UUID:

DELETE FROM ClientContacts WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
Colunas
Nome Tipo Somente leitura Descrição
ClientUUID String Falso O ID do cliente
UUID [KEY] String Verdadeiro A ID do contato que pertence ao cliente
Name String Falso O nome do contato
Mobile String Falso Número de telemóvel do contacto
Email String Falso E-mail do contato
Phone String Falso Número de telefone do contato
Position String Falso A posição do contato
Salutation String Falso A saudação é usada após 'Caro...
Addressee String Falso O endereço do contato
IsPrimary String Falso Determina se este contato é o contato principal utilizado pelo cliente Sim | Não

Grupos de Clientes

Retorna uma lista de todos os grupos de clientes

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • UUID suporta o = operador.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM ClientGroups WHERE UUID = '3cfb9bd0-dac7-40d0-8fb7-db8e23d14bd9'
SELECT * FROM ClientGroups WHERE UUID IN ('c6ec5c2c-2657-4ce3-b035-022c02b9f19e', '5a92d62b-089f-4d28-a4d2-c69692edc41a')
Inserir

ClientUUID e Name são necessários para inserir. A consultar a seguir cria um novo ClientGroup:

INSERT INTO ClientGroups (Name, ClientUUID, Taxable) VALUES('Clients', '446ddb14-4084-48fc-83bd-76b89125450a', true)
Excluir

Exclua um ClientGroup especificando o UUID do ClientGroup:

DELETE FROM ClientGroups WHERE UUID='c6ec5c2c-2657-4ce3-b035-022c02b9f19e'
Colunas
Nome Tipo Somente leitura Descrição
UUID [KEY] String Verdadeiro A ID do grupo de clientes
Name String Falso O nome do grupo de clientes
Taxable String Falso Configuração de grupo tributável opcional para usuários do Practice Manager
ClientUUID String Falso Usado para criar um ClientGroup, pois é necessário colocar pelo menos um cliente denotado por seu ID de cliente.

Clientes

Retorna uma lista de todos os clientes.

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • UUID suporta o = operador.
  • Name suporta 'CONTÉM'.

A coluna UUID permite que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM Clients WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Clients WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '446ddb14-4084-48fc-83bd-76b89125450a')
SELECT * FROM Clients WHERE CONTAINS(Name, 'Brian')
SELECT * FROM Clients WHERE ModifiedSince='2012-06-05T06:00:00'
Inserir

É necessário inserir o nome. A consultar a seguir cria um novo Clients:

INSERT INTO Clients (Name) VALUES ('some name')
Atualizar

Você pode atualizar especificando o UUID dos clientes:

UPDATE Clients SET Name='Arnold' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Excluir

Exclua um cliente especificando o UUID do cliente:

DELETE FROM Clients WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Arquive um cliente especificando o UUID do cliente e definindo Archive=true:

DELETE FROM Clients WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' AND Archive=true
Colunas
Nome Tipo Somente leitura Descrição
UUID [KEY] String Verdadeiro A identificação do cliente.
Name String Falso O nome do cliente.
Email String Falso O e-mail do cliente.
Address String Falso O endereço do cliente.
City String Falso A cidade onde o cliente está localizado.
Region String Falso A região onde o cliente está localizado.
PostCode String Falso O código postal de onde o cliente está localizado.
Country String Falso O país onde o cliente está localizado.
PostalAddress String Falso O endereço do correio.
PostalCity String Falso A cidade onde está localizada a agência postal.
PostalRegion String Falso A região onde o correio está localizado.
PostalPostCode String Falso O código postal da agência postal.
PostalCountry String Falso O país onde a agência postal está localizada.
Phone String Falso O número de telefone do cliente.
Fax String Falso O número de fax do cliente.
Website String Falso O site associado ao cliente.
ReferralSource String Falso Fonte pela qual o cliente foi indicado.
ExportCode String Falso O código de exportação (como um código de conta/código de imposto) associado ao cliente.
IsProspect String Falso Determina se o cliente é um cliente potencial
AccountManagerUUID String Falso Opcional - ID do funcionário.
AccountManagerName String Verdadeiro Nome do funcionário.
TypeName String Verdadeiro O tipo de cliente
TypeCostMarkup String Verdadeiro A % de markup do tipo de cliente
TypePaymentTerm String Verdadeiro As condições de pagamento do tipo de cliente
TypePaymentDay String Verdadeiro O dia de pagamento / número de dias do tipo de cliente
FirstName String Falso Opcional para pessoas físicas, primeiro nome da pessoa
LastName String Falso Opcional para pessoas físicas, Sobrenome da pessoa
OtherName String Falso Opcional para indivíduos, OtherName do indivíduo
DateOfBirth Datetime Falso Facultativo para indivíduos, data de nascimento do indivíduo
BillingClientUUID String Falso Usado nos casos em que o cliente é diferente do cliente de cobrança.
BillingClientName String Falso Nome do cliente de cobrança.
JobManagerUUID String Falso opcional - ID do funcionário
JobManagerName String Verdadeiro Nome do funcionário.
TaxNumber String Falso Número de identificação utilizado para efeitos fiscais
CompanyNumber String Falso O número de registro da empresa.
BusinessNumber String Falso Nome da estrutura comercial (conforme administrador)
BalanceMonth String Falso por exemplo. janeiro, 1, fevereiro, 2, março, 3 etc
PrepareGST String Falso Sim ou Não
GSTRegistered String Falso Sim ou Não
GSTPeriod String Falso 1, 2, 6
GSTBasis String Falso Fatura, Pagamento, Híbrido
ProvisionalTaxBasis String Falso Opção padrão, opção de estimativa, opção de proporção
ProvisionalTaxRatio String Falso Taxa de imposto para o cliente quando a opção Ratio é selecionada para ProvisionalTaxBasis.
SignedTaxAuthority String Falso Sim ou Não (somente clientes da Nova Zelândia)
TaxAgent String Falso Nome do Agente Fiscal (conforme Admin) (somente clientes da Nova Zelândia)
AgencyStatus String Falso Com EOT, Sem EOT, Desvinculado (somente clientes da Nova Zelândia)
ReturnType String Falso IR3, IR3NR, IR4, IR6, IR7, IR9, PTS (somente clientes da Nova Zelândia)
PrepareActivityStatement String Falso Sim ou Não (somente clientes AU)
PrepareTaxReturn String Falso Sim ou Não (somente clientes AU)
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.

Nome Tipo Descrição
ModifiedSince String Usado para filtrar clientes desde a última modificação.
Archive Boolean Usado para arquivar um Cliente sem apagá-lo completamente

Custos

Retorna uma lista de todos os custos

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • UUID suporta o = operador.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM Costs WHERE UUID = '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Costs WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26av43')
Inserir

Descrição, UnitPrice, UnitCost são necessários para inserir. A consultar a seguir cria um novo Custo:

INSERT INTO Costs (Description, UnitPrice, UnitCost) VALUES ('decr', 100, 200)
Atualizar

Você pode atualizar um custo especificando o custo UUID:

UPDATE Costs SET UnitPrice='101' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Excluir

Exclua um custo especificando o UUID de custo:

DELETE FROM Costs WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Colunas
Nome Tipo Somente leitura Descrição
UUID [KEY] String Verdadeiro O ID do custo.
Description String Falso A descrição relacionada ao custo.
Code String Falso O código da unidade.
Note String Falso A nota relacionada ao custo.
UnitCost Float Falso Custo por unidade.
UnitPrice Float Falso Preço por unidade.
SupplierUUID String Falso Determina o identificador do fornecedor.
SupplierName String Verdadeiro Determina o nome do fornecedor.

JobCosts

Retorna uma lista de todos os custos dos trabalhos.

Selecione

Note: Because of Xero WorkflowMax API restrictions the Job ID filters will not work properly while using custom Job numbers which have punctuation in them. This is a known issue that Xero refuses to fix. Please change the Job number so there is no punctuation and try again. In case you are using custom Job numbers with punctuation in them you may encounter 404 Not Found error in Jobs and JobCosts tables.

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • JobID suporta o = operador.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM JobCosts WHERE JobID='J000002'
SELECT * FROM JobCosts WHERE JobID IN ('J000001', 'J000002')
Inserir

JobID, Data, Descrição, Quantidade, UnitCost, UnitPrice são necessários para inserir. A consultar a seguir cria um novo JobCost:

INSERT INTO JobCosts (JobID, Date, Description, Quantity, UnitCost, UnitPrice) VALUES ('J000002', '2019-07-17T00:00:00', 'Maybach', '123', 30, 50)
Colunas
Nome Tipo Somente leitura Descrição
JobID String Falso Job Identificador relacionado ao custo.
UUID [KEY] String Verdadeiro Identificador de custos.
Date Datetime Falso A data em que o custo foi criado.
Description String Falso A descrição relacionada ao custo.
Code String Falso O código da unidade.
Note String Falso A nota relacionada ao custo.
Quantity Double Falso Quantidade de produto.
UnitCost Float Falso Custo por unidade.
UnitPrice Float Falso Preço por unidade.
SupplierUUID String Falso Determina o identificador do fornecedor.
SupplierName String Verdadeiro Determina o nome do fornecedor.
Billable String Verdadeiro Determina se o custo é faturável ou não true(padrão) | falso.

JobNotes

Retorna uma lista de todas as notas de um trabalho

Selecione

O conector processará todos os filtros do lado do cliente.

Inserir

JobID, Title, Text são necessários para inserir. A consultar a seguir cria um novo JobNote:

INSERT INTO JobNotes (JobID, Title, Text) VALUES ('J000001', '133193699', 'some notes')
Colunas
Nome Tipo Somente leitura Descrição
JobID String Falso O ID do trabalho que contém a nota.
UUID [KEY] String Verdadeiro O identificador da nota.
Title String Falso O título da nota.
Text String Falso O texto da nota.
Folder String Falso A pasta onde está a nota.
Date Datetime Verdadeiro A data em que a nota foi criada.
CreatedBy String Verdadeiro O nome da equipe que criou a nota.
Comments String Verdadeiro Todos os comentários em uma nota em formato xml.
Public String Falso Determina se a nota é pública para membros da equipe. Verdadeiro | Falso

Empregos

Retorna uma lista de todos os trabalhos.

Selecione

Note: Because of Xero WorkflowMax API restrictions the Job ID filters will not work properly while using custom Job numbers which have punctuation in them. This is a known issue that Xero refuses to fix. Please change the Job number so there is no punctuation and try again. In case you are using custom Job numbers with punctuation in them you may encounter 404 Not Found error in Jobs and JobCosts tables.

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • Id suporta o = operador.
  • AssignedStaffUUID suporta o = operador.
  • ClientUUID suporta o = operador.
  • CreatedDate suporta os operadores '<=,<,=,>,>='.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM Jobs WHERE CreatedDate>='2020-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Jobs WHERE CreatedDate='2020-12-12'
SELECT * FROM Jobs WHERE CreatedDate>='2020-12-12'
SELECT * FROM Jobs WHERE ID='J000001'
SELECT * FROM Jobs WHERE AssignedStaffUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Jobs WHERE ClientUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Jobs WHERE ID IN ('23423', '34534')
SELECT * FROM Jobs WHERE AssignedStaffUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a8f6', '9d382fcf-7013-4d97-8dd8-c08e8b26a4d2')
SELECT * FROM Jobs WHERE ClientUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a6i1')

Notes:
- Ao executar uma consultar SELECT * simples, o conector recuperará apenas suas faturas atuais.
- Ao especificar CreatedDate, o conector recuperará os trabalhos atuais e arquivados.

Inserir

Nome, ClientUUID, StartDate, DueDate são necessários para inserir. A consultar a seguir cria um novo trabalho:

INSERT INTO Jobs (Name, ClientUUID, StartDate, DueDate) VALUES ('Job Name', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', '2019-07-17T00:00:00')
Atualizar

Você pode atualizar especificando o ID do trabalho:

UPDATE Jobs SET StartDate='2007-07-16T00:00:00' WHERE Id='J000003'
Excluir

Exclua um trabalho especificando o ID do trabalho:

DELETE FROM Jobs WHERE ID='J000003'
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] String Falso Identificador de trabalho.
Name String Falso O nome do trabalho.
Description String Falso A descrição relacionada ao trabalho.
State String Verdadeiro O estado do trabalho.
ClientOrderNumber String Falso Número do pedido associado a este trabalho.
StartDate Datetime Falso A data em que o trabalho foi iniciado.
DueDate Datetime Falso A data em que o trabalho deve ser concluído.
CompletedDate Datetime Falso A data em que o trabalho foi concluído.
ClientUUID String Falso O identificador do cliente relacionado ao trabalho.
ClientName String Falso O nome do cliente relacionado ao trabalho.
ContactUUID String Falso O identificador do cliente relacionado ao trabalho.
ContactName String Falso O nome do cliente relacionado ao trabalho.
ManagerUUID String Falso O identificador do gerente relacionado ao trabalho.
ManagerName String Falso O nome do gerente relacionado ao trabalho.
PartnerUUID String Falso O identificador do parceiro relacionado ao trabalho.
PartnerName String Falso O nome do parceiro relacionado ao trabalho.
AssignedStaff String Verdadeiro Lista de funcionários designados para o trabalho em formato xml.
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.

Nome Tipo Descrição
TemplateUUID String Usado ao inserir um trabalho para determinar seu modelo inicial.
CategoryUUID String Usado ao inserir um trabalho para determinar sua categoria inicial.
AssignedStaffUUID String Usado para filtrar trabalhos com base no membro da equipe atribuído.
CreatedDate Date Usado para filtrar trabalhos de sua data de criação.

Tarefas de Trabalho

Retorna uma lista de todas as tarefas de trabalhos.

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • Complete suporta o = operador.
  • CreatedDate suporta os operadores '<=,<,=,>,>='.
SELECT * FROM JobTasks WHERE Complete=False
SELECT * FROM JobTasks WHERE CreatedDate>='2000-11-11' AND CreatedDate<='2020-11-11'
SELECT * FROM JobTasks WHERE CreatedDate='2000-11-11'
SELECT * FROM JobTasks WHERE CreatedDate>='2000-11-11'
SELECT * FROM JobTasks WHERE CreatedDate>='2000-11-11' AND CreatedDate<='2020-11-11' AND Complete=true
Inserir

EstimatedMinutes, TaskID, JobID, Name, StartDate, DueDate são necessários para inserir. A consultar a seguir cria uma nova JobTask:

INSERT INTO JobTasks (EstimatedMinutes, TaskUUID, JobID, Name, StartDate, DueDate) VALUES ('100', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', 'J000002', '21910642', '2019-07-17T00:00:00', '2019-07-17T00:00:00')
Colunas
Nome Tipo Somente leitura Descrição
JobID String Verdadeiro O identificador de trabalho relacionado à tarefa.
UUID [KEY] String Verdadeiro O identificador da tarefa.
TaskUUID String Verdadeiro O identificador de tarefa faz referência a Tasks.ID.
Name String Verdadeiro O nome da tarefa.
Description String Verdadeiro A descrição relacionada à tarefa.
EstimatedMinutes Int Verdadeiro O tempo estimado para concluir a tarefa.
ActualMinutes Int Verdadeiro O tempo real passou.
Completed Boolean Verdadeiro Determine se a tarefa foi concluída ou não.
Billable Boolean Verdadeiro Determina se a tarefa é faturável ou não true(padrão) | falso.
CreatedDate Date Verdadeiro Determina a data e hora em que a tarefa foi iniciada.
DueDate Date Verdadeiro Determina a data e hora em que a tarefa deve ser concluída.
AssignedStaffUUID String Verdadeiro Lista de funcionários atribuídos ao cargo em formato xml
Label String Falso Usado durante a inserção para determinar um rótulo para a tarefa.

Pistas

Retorna uma lista de todos os leads.

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • UUID suporta o = operador.
  • CreatedDate suporta os operadores '<=,<,=,>,>='.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM Leads WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Leads WHERE CreatedDate>='2000-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Leads WHERE CreatedDate='2000-12-12'
SELECT * FROM Leads WHERE CreatedDate>='2000-12-12'
SELECT * FROM Leads WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5k9')

Notes:
- Ao executar uma consultar SELECT * simples, o conector recuperará apenas seus Leads atuais.
- Ao especificar CreatedDate, o conector recuperará todos os Leads.

Inserir

Nome, ClientUUID, OwnerID são necessários para inserir. A consultar a seguir cria um novo Lead:

INSERT INTO Leads (Name, ClientUUID, OwnerUUID) VALUES ('hey', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a3f7')
Colunas
Nome Tipo Somente leitura Descrição
UUID [KEY] String Verdadeiro Identificador de leads.
Name String Verdadeiro O nome do líder.
Description String Verdadeiro A descrição do lead.
State String Verdadeiro O estado do chumbo.
CreatedDate Datetime Verdadeiro A data em que o lead foi criado.
DateWonLost String Verdadeiro Data em que este lead foi ganho ou perdido.
Category String Verdadeiro A categoria do lead.
EstimatedValue Int Verdadeiro Valor estimado do lead.
ClientUUID String Verdadeiro O identificador do cliente relacionado ao lead.
ClientName String Verdadeiro O nome do cliente relacionado ao lead.
ContactUUID String Verdadeiro O ID de contato do cliente relacionado ao lead.
ContactName String Verdadeiro O nome de contato do cliente relacionado ao lead.
OwnerUUID String Verdadeiro O ID do proprietário relacionado ao lead.
OwnerName String Verdadeiro O nome do proprietário relacionado ao lead.
CategoryUUID String Falso Usado durante a inserção para determinar uma categoria para o lead.
TemplateUUID String Falso Usado durante a inserção para determinar um modelo para o eletrodo.

Rascunhos de Pedido de Compra

Retorna uma lista de todos os rascunhos de ordens de compra

Selecione

O conector processará todos os filtros do lado do cliente.

Inserir

Para inserir em PurchaseOrderDrafts você precisará inserir temporariamente pelo menos um PurchaseOrderCost que servirá como itens para o PurchaseOrder. Você pode fazer isso denotando o nome da tabela como PurchaseOrderCosts#TEMP. Depois de inserir na tabela temporária, você pode executar uma inserção em PurchaseOrders definindo PurchaseOrderCosts = PurchaseOrderCosts#TEMP como na consultar abaixo. JobID, SupplierUUID, Data, PurchaseOrderCosts são necessários para inserir. As seguintes consultas são necessárias para criar um novo PurchaseOrder com 2 itens PurchaseOrderCost:

INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('first', 4, 50, '123', 'note')
INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('second', 42, 502, '1234', 'note2')
INSERT INTO PurchaseOrderDrafts (JobID, SupplierUUID, Date, PurchaseOrderCosts) VALUES ('J000002', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', 'PurchaseOrderCosts#TEMP')

Como alternativa, você pode executar uma operação INSERT em PurchaseOrder definindo o valor para PurchaseOrderCosts como uma string xml de itens na seguinte estrutura:

<Item>
<UnitCost>50</UnitCost>
<Description>first</Description>
<Quantity>4</Quantity>
<Code>123</Code>
<Note>note</Note>
</Item>
<Item>
<UnitCost>502</UnitCost>
<Description>second</Description>
<Quantity>42</Quantity>
<Code>1234</Code>
<Note>note2</Note>
</Item>
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] String Falso O identificador da ordem de compra.
Description String Falso A descrição relacionada ao pedido de compra.
State String Falso O estado da ordem de compra.
CreatedDate Datetime Verdadeiro A data em que o pedido de compra foi criado.
DeliveryAddress String Falso Endereço de entrega do pedido de compra.
Amount Float Verdadeiro O valor a pagar.
AmountTax Float Verdadeiro O valor do imposto a pagar.
AmountIncludingTax Float Verdadeiro O valor total a pagar, incluindo impostos.
SupplierUUID String Falso O identificador do fornecedor relacionado ao pedido de compra.
SupplierName String Verdadeiro O nome do fornecedor relacionado ao pedido de compra.
JobID String Falso O identificador do trabalho relacionado ao pedido de compra.
JobName String Verdadeiro O nome do trabalho relacionado ao pedido de compra.
PurchaseOrderCosts String Falso Lista todos os custos das ordens de compra, formato xml.

Ordens de Compra

Retornar uma lista de todos os pedidos de compra

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • Id suporta o = operador.
  • JobID suporta o = operador.
  • CreatedDate suporta os operadores '<=,<,=,>,>='.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM PurchaseOrders WHERE ID='2512811'
SELECT * FROM PurchaseOrders WHERE CreatedDate>='2000-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM PurchaseOrders WHERE CreatedDate='2000-12-12'
SELECT * FROM PurchaseOrders WHERE CreatedDate>='2000-12-12'
SELECT * FROM PurchaseOrders WHERE ID IN ('23423', '34534')
SELECT * FROM PurchaseOrders WHERE JobID IN ('23423', '34534')

Notes:
- Ao executar uma consultar SELECT * simples, o conector recuperará apenas seus pedidos de compra atuais.
- Ao especificar CreatedDate, o conector recuperará os PurchaseOrders atuais e arquivados.

Inserir

Para inserir em PurchaseOrders você precisará inserir temporariamente pelo menos um PurchaseOrderCost que servirá como itens para o PurchaseOrder. Você pode fazer isso denotando o nome da tabela como PurchaseOrderCosts#TEMP. Depois de inserir na tabela temporária, você pode executar uma inserção em PurchaseOrders definindo PurchaseOrderCosts = PurchaseOrderCosts#TEMP como na consultar abaixo. JobID, SupplierUUID, Data, PurchaseOrderCosts são necessários para inserir. As seguintes consultas são necessárias para criar um novo PurchaseOrder com 2 itens PurchaseOrderCost:

INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('first', 4, 50, '123', 'note')
INSERT INTO PurchaseOrderCosts#TEMP (Description,Quantity,UnitCost,Code,Note) VALUES ('second', 42, 502, '1234', 'note2')
INSERT INTO PurchaseOrders (JobID, SupplierUUID, Date, PurchaseOrderCosts) VALUES ('J000002', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '2019-07-17T00:00:00', 'PurchaseOrderCosts#TEMP')

Como alternativa, você pode executar uma operação INSERT em PurchaseOrder definindo o valor para PurchaseOrderCosts como uma string xml de itens na seguinte estrutura:

<Item>
<UnitCost>50</UnitCost>
<Description>first</Description>
<Quantity>4</Quantity>
<Code>123</Code>
<Note>note</Note>
</Item>
<Item>
<UnitCost>502</UnitCost>
<Description>second</Description>
<Quantity>42</Quantity>
<Code>1234</Code>
<Note>note2</Note>
</Item>
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] String Falso O identificador da ordem de compra.
Description String Falso A descrição relacionada ao pedido de compra.
State String Falso O estado da ordem de compra.
CreatedDate Datetime Verdadeiro A data em que o pedido de compra foi criado.
DeliveryAddress String Falso Endereço de entrega do pedido de compra.
Amount Float Verdadeiro O valor a pagar.
AmountTax Float Verdadeiro O valor do imposto a pagar.
AmountIncludingTax Float Verdadeiro O valor total a pagar, incluindo impostos.
SupplierUUID String Falso O identificador do fornecedor relacionado ao pedido de compra.
SupplierName String Verdadeiro O nome do fornecedor relacionado ao pedido de compra.
JobID String Falso O identificador do trabalho relacionado ao pedido de compra.
JobName String Verdadeiro O nome do trabalho relacionado ao pedido de compra.
PurchaseOrderCosts String Falso Lista todos os custos das ordens de compra, formato xml.

Lista de Trabalhadores

Retorna uma lista de todos os membros da equipe

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • UUID suporta o = operador.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM StaffList WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM StaffList WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a9f6')
Inserir

É necessário inserir o nome. A consultar a seguir cria um novo membro StaffList:

INSERT INTO StaffList (Name) VALUES ('J000002')
Atualizar

Você pode atualizar um membro da equipe especificando o UUID do membro da equipe:

UPDATE StaffList SET Email='hey@gmail.com', Phone='23489235' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Excluir

Exclua um membro da equipe especificando o UUID do membro da equipe:

DELETE FROM StaffList WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Colunas
Nome Tipo Somente leitura Descrição
UUID [KEY] String Verdadeiro O identificador do membro da equipe.
Name String Falso O nome do membro da equipe.
Email String Falso e-mail do membro da equipe.
Phone String Falso O número de telefone do funcionário.
Mobile String Falso O número do celular do membro da equipe.
Address String Falso O endereço do funcionário.
PayrollCode String Falso Código da folha de pagamento do funcionário.

FornecedorContatos

Retorna uma lista de todos os fornecedores.

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • UUID suporta o = operador.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM SupplierContacts WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5hj')
SELECT * FROM SupplierContacts WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Inserir

FornecedorUUID, Nome são necessários para inserir. A consultar a seguir cria um novo SupplierContact:

INSERT INTO SupplierContacts (SupplierUUID, Name) VALUES ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', 'ckemi')
Atualizar

Você pode atualizar um SupplierContact especificando o UUID do SupplierContact:

UPDATE SupplierContacts SET Name='hey@gmail.com', Mobile='23489235' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Colunas
Nome Tipo Somente leitura Descrição
SupplierUUID String Falso O ID do fornecedor.
UUID [KEY] String Verdadeiro O ID do contato que pertence ao fornecedor.
Name String Falso O nome do contato.
Mobile String Falso O número do celular do contato.
Email String Falso O e-mail do contato.
Phone String Falso O número de telefone do contato.
Position String Falso A posição do contato.

Fornecedores

Retorna uma lista de todos os fornecedores.

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • UUID suporta o = operador.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM Suppliers WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Suppliers WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a3f7')
Inserir

É necessário inserir o nome. A consultar a seguir cria um novo Fornecedor:

INSERT INTO Suppliers (Name) VALUES ('Arnold')
Atualizar

Você pode atualizar especificando o UUID:

UPDATE Suppliers SET Address='hey@hey.com', City='23489235' WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Excluir

Exclua um fornecedor especificando o UUID do fornecedor:

DELETE FROM Suppliers WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Arquive um fornecedor especificando o UUID do fornecedor e definindo Archive=true na consultar:

DELETE FROM Suppliers WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' and Archive=true
Colunas
Nome Tipo Somente leitura Descrição
UUID [KEY] String Verdadeiro O ID do fornecedor.
Name String Falso O nome do fornecedor.
Address String Falso O endereço do fornecedor.
City String Falso A cidade onde o fornecedor está localizado.
Region String Falso A região onde o cliente está localizado.
PostCode String Falso O código postal de onde o fornecedor está localizado.
Country String Falso O país onde o fornecedor está localizado.
PostalAddress String Falso O endereço do correio.
PostalCity String Falso A cidade onde está localizada a agência postal.
PostalRegion String Falso A região onde o correio está localizado.
PostalPostCode String Falso O código postal da agência postal.
PostalCountry String Falso O país onde a agência postal está localizada.
Phone String Falso O número de telefone do fornecedor.
Fax String Falso O número de fax do fornecedor.
Website String Falso O site do fornecedor.
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.

Nome Tipo Descrição
Archive String Usado para arquivar um fornecedor sem excluí-lo completamente

Horários

Retorna uma lista de todas as planilhas de tempo.

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • UUID suporta o = operador.
  • JobID suporta o = operador.
  • StaffID suporta o = operador.
  • CreatedDate suporta os operadores '<=,<,=,>,>='.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM Times WHERE JobID='J000001'
SELECT * FROM Times WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Times WHERE CreatedDate>='2018-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Times WHERE StaffUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2' AND CreatedDate>='2018-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Times WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26g3h2')
SELECT * FROM Times WHERE StaffUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26g3h2')
SELECT * FROM Times WHERE JobID IN ('J000001', 'J000002')
Inserir

JobID, TaskID, StaffID, Data, Minutos são necessários para inserir. A consultar a seguir cria uma nova entrada de hora:

INSERT INTO Times (JobID, TaskUUID, StaffUUID, Date, Minutes) VALUES ('J000001', '9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a5e8', '2019-06-27T00:00:00', '240')
Atualizar

Você pode atualizar especificando o UUID:

UPDATE Times SET Date='2019-06-27T00:00:00', Minutes='240' WHERE UUID='250193564'
Excluir

Exclua uma entrada de hora especificando o UUID:

DELETE FROM Times WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
Colunas
Nome Tipo Somente leitura Descrição
UUID [KEY] String Falso A ID da entrada do quadro de horários.
JobID String Falso O ID do trabalho relacionado à entrada do quadro de horários.
JobName String Verdadeiro O nome do trabalho relacionado à entrada do quadro de horários.
TaskUUID String Falso A ID da tarefa relacionada à entrada do quadro de horários.
TaskName String Verdadeiro O nome da tarefa relacionada à entrada do quadro de horários.
StaffUUID String Falso A ID da equipe relacionada à entrada do quadro de horários.
StaffName String Verdadeiro O nome da equipe relacionada à entrada do quadro de horários.
CreatedDate Datetime Falso A data da entrada do quadro de horários.
Minutes Int Falso Os minutos de duração da entrada da planilha de horas.
Note String Falso A observação relacionada à entrada do quadro de horários.
Billable Boolean Falso Booleano que indica se este horário é cobrável ou não.
Start Time Falso A hora de início da entrada da planilha de horas.
End Time Falso A hora em que a entrada da planilha de horas terminou.

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 Visualizações Xero WorkflowMax

Nome Descrição
Categories Retorna uma lista de todas as categorias
ClientDocuments Retorna uma lista de todos os documentos dos clientes.
ClientNotes Retornar todas as notas dos clientes
InvoiceDrafts Retornar uma lista de rascunhos de faturas
InvoicePayments Retornar uma lista de pagamentos de faturas
Invoices Retornar uma lista de faturas
InvoicesJobTask Retorna uma lista de faturas relacionadas a Tarefas.
JobDocuments Retorna uma lista de todos os documentos de um trabalho
JobMilestones Retornar todos os marcos de trabalhos
LeadCategories Retornar uma lista de categorias de leads
PurchaseOrderCosts Devolução de todos os custos da ordem de compra
QuoteDrafts Retorna uma lista de todos os rascunhos de cotações
Quotes Retorna uma lista de todas as cotações
QuotesCost Retorna uma lista de cotações relacionadas a custos.
QuotesOption Retorna uma lista de cotações relacionadas a opções.
QuotesTask Retorna uma lista de citações relacionadas a Tarefas.
Tasks Retorna uma lista de todas as tarefas
Templates Retorna uma lista de todos os modelos

Categorias

Retorna uma lista de todas as categorias

Selecione

O conector processará todos os filtros do lado do cliente.

Colunas
Nome Tipo Descrição
UUID [KEY] String O ID da categoria
Name String O nome da categoria

Documentos do Cliente

Retorna uma lista de todos os documentos dos clientes.

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • ClientUUID suporta o = operador.

Para executar uma consultar SELECT para ClientDocuments, você deve fornecer o ClientUUID como uma condição WHERE. Especificamente, o seguinte é processado do lado do servidor:

SELECT * FROM ClientDocuments WHERE ClientUUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM ClientDocuments WHERE ClientUUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '446ddb14-4084-48fc-83bd-76b89125450a')
Colunas
Nome Tipo Descrição
ClientUUID [KEY] String O ID do cliente que possui o documento.
Title String O título do documento.
Text String A nota relativa ao documento.
Folder String A pasta onde está o documento.
Date Datetime A data em que o documento foi criado.
CreatedBy String O nome da equipe que criou o documento.
URL String A URL usada para fazer o download direto do documento.

Notas do Cliente

Devolva todas as notas dos clientes

Selecione

O conector processará todos os filtros do lado do cliente.

Colunas
Nome Tipo Descrição
ClientUUID [KEY] String O ID do Cliente que possui as notas.
Title String O título da nota.
Text String O texto da nota.
Folder String A pasta onde está a nota.
Date Date A data em que a nota foi criada.
CreatedBy String O nome da equipe que criou o documento.

Rascunhos de Fatura

Retornar uma lista de rascunhos de faturas

Selecione

O conector processará todos os filtros do lado do cliente.

Colunas
Nome Tipo Descrição
UUID [KEY] String O nome da categoria
Type String Determina o tipo de fatura.
Status String Status da fatura Aprovado, Pago, Rascunho, Cancelado
JobID String ID do trabalho associado a esta Fatura.
CreatedDate Date Determina a data em que a fatura foi criada.
DueDate Date Determina a data de vencimento da fatura.
Amount Float O valor a pagar.
AmountTax Float O valor do imposto a pagar.
AmountIncludingTax Float O valor total a pagar, incluindo impostos.
AmountPaid Float Determine o valor que já foi pago.
AmountOutstanding Float Determina o valor que falta pagar.
ClientUUID String Identificador do cliente relacionado com a fatura.
ClientName String Nome do cliente relacionado à fatura.
ContactUUID String Identificador de contato do cliente relacionado à fatura.
ContactName String Nome de contato do cliente relacionado à fatura.

Pagamentos de Faturas

Retornar uma lista de pagamentos de faturas

Selecione

O conector processará todos os filtros do lado do cliente.

Colunas
Nome Tipo Descrição
InvoiceID [KEY] String O identificador da fatura
Date Date A data do pagamento
Amount Float O valor que foi pago.
Reference String A referência do pagamento

Faturas

Retornar uma lista de faturas

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • CreatedDate suporta os operadores '<=,<,=,>,>='.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM Invoices WHERE CreatedDate>='2019-08-07' and CreatedDate<='2019-08-07'
SELECT * FROM Invoices WHERE CreatedDate>='2019-08-07'
SELECT * FROM Invoices WHERE CreatedDate='2019-08-07'

Notes:
- Ao executar uma consultar SELECT * simples, o conector recuperará apenas suas faturas atuais.
- Ao especificar CreatedFrom e CreatedTo, o conector recuperará as faturas atuais e arquivadas.

Colunas
Nome Tipo Descrição
ID [KEY] String O nome da categoria
Type String Determina o tipo de fatura.
Status String Status da fatura Aprovado, Pago, Esboçado, Cancelado
JobID String ID do trabalho associado a esta Fatura.
CreatedDate Date Determina a data em que a fatura foi criada.
DueDate Date Determina a data de vencimento da fatura.
Amount Float O valor a pagar.
AmountTax Float O valor do imposto a pagar.
AmountIncludingTax Float O valor total a pagar, incluindo impostos.
AmountPaid Float Determine o valor que já foi pago.
AmountOutstanding Float Determina o valor que falta pagar.
ClientUUID String Identificador do cliente relacionado com a fatura.
ClientName String Nome do cliente relacionado à fatura.
ContactUUID String Identificador de contato do cliente relacionado à fatura.
ContactName String Nome de contato do cliente relacionado à fatura.

FaturasTrabalhoTarefa

Retorna uma lista de faturas relacionadas a Tarefas.

Selecione

O conector processará todos os filtros do lado do cliente, exceto InvoiceID.

SELECT * FROM InvoicesJobTask
Select * from InvoicesJobTask where InvoiceID = 'I000123'
Select * from InvoicesJobTask where InvoiceID IN ('I000124', 'I000123')
Colunas
Nome Tipo Descrição
InvoiceID [KEY] String O identificador da fatura
Name String O Nome da tarefa relacionada à fatura.
Description String A descrição da tarefa relacionada à fatura.
Minutes Int A ata da tarefa relacionada à fatura.
BillableRate Double O BillableRate da tarefa relacionada à fatura.
Billable String O Faturável da tarefa relacionada à fatura.
Amount Double O valor da tarefa relacionada à fatura.
AmountTax Double O AmountTax da tarefa relacionada à fatura.
AmountIncludingTax Double O AmountIncludingTax da tarefa relacionada à fatura.

TrabalhoDocumentos

Retorna uma lista de todos os documentos de um trabalho

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • JobID suporta o = operador.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM JobDocuments WHERE JobID='J000001'
SELECT * FROM JobDocuments WHERE JobID IN ('23423', '34534')
Colunas
Nome Tipo Descrição
JobID [KEY] String O ID do trabalho que contém o documento.
Title String O título do documento.
Text String A nota relativa ao documento.
Folder String A pasta onde está o documento.
Date Datetime A data em que o documento foi criado.
CreatedBy String O nome da equipe que criou o documento.
URL String A URL usada para fazer o download direto do documento.

Marcos do Trabalho

Retornar todos os marcos de trabalhos

Selecione

O conector processará todos os filtros do lado do cliente.

Colunas
Nome Tipo Descrição
JobID [KEY] String O ID do trabalho relacionado ao marco.
Date Date A data a que o marco se refere.
Description String A descrição relacionada ao marco.
Completed Boolean Determina se o marco foi concluído ou não.

LeadCategories

Retorna uma lista de categorias de leads

Selecione

O conector processará todos os filtros do lado do cliente.

Colunas
Nome Tipo Descrição
UUID [KEY] String O UUID da categoria
Name String O nome da categoria

Custos do Pedido de Compra

Devolver todos os custos da ordem de compra

Selecione

O conector processará todos os filtros do lado do cliente.

Inserir

Descrição, Quantidade, UnitCost, Código, Nota são necessários para inserir na tabela temporária. A consultar a seguir cria uma nova entrada PurchaseOrderCost na memória:

INSERT INTO PurchaseOrderCosts#TEMP (Description, Quantity, UnitCost, Code, Note) VALUES ('hey descr', 4, 50, '123', 'note')

Depois de inserir em PurchaseOrderCosts#TEMP, você tem todos os itens necessários para inserir o PurchaseOrder. Veja Pedidos de Compra para obter mais detalhes sobre como inserir pedidos de compra.

Colunas
Nome Tipo Descrição
PurchaseOrderID [KEY] String Como os custos não têm um identificador, este é o identificador da ordem de compra que faz referência a PurchaseOrders.ID
Description String A descrição relacionada ao custo
Code String O código da unidade.
Quantity Int Quantidade de produto.
UnitCost Float Custo por unidade.
Amount Float O valor a pagar.
AmountTax Float O valor do imposto a pagar.
AmountIncludingTax Float O valor total a pagar, incluindo impostos.
Note String A nota relacionada ao custo.

Rascunhos de Cotação

Retorna uma lista de todos os rascunhos de cotações

Selecione

O conector processará todos os filtros do lado do cliente.

Colunas
Nome Tipo Descrição
ID [KEY] String O identificador de cotação.
Type String O tipo da cotação.
State String O estado da cotação.
CreatedDate Datetime A data em que a cotação foi criada.
ValidDate Datetime A data até a cotação é válida.
Budget String O orçamento para a cotação.
OptionExplanation String Uma descrição para explicar as opções relacionadas à cotação.
EstimatedCost Float Valor do custo estimado.
EstimatedCostTax Float Valor estimado do custo do imposto.
EstimatedCostIncludingTax Float Valor total estimado, incluindo impostos.
AmountTax Float Valor a pagar.
AmountIncludingTax Float Valor do imposto a pagar.
Amount Float Valor total a pagar incluindo impostos.
ClientUUID String O identificador do cliente que está relacionado à cotação.
ClientName String O nome do cliente que está relacionado à cotação.
ContactUUID String O ID de contato do cliente relacionado à cotação.
ContactName String O nome de contato do cliente que está relacionado à cotação.

Citações

Retorna uma lista de todas as citações

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • Id suporta o = operador.
  • CreatedDate suporta os operadores '<=,<,=,>,>='.

Todas as colunas filtráveis, exceto CreatedDate, permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM Quotes WHERE ID='Q000001'
SELECT * FROM Quotes WHERE CreatedDate>='2000-12-12' AND CreatedDate<='2020-12-12'
SELECT * FROM Quotes WHERE CreatedDate='2000-12-12'
SELECT * FROM Quotes WHERE CreatedDate>='2000-12-12'
SELECT * FROM Quotes WHERE ID IN ('Q000001', 'Q000002')

Notes:
- Ao executar uma consultar SELECT * simples, o conector recuperará apenas suas cotações atuais.
- Ao especificar CreatedDate, o conector recuperará as cotações atuais e arquivadas.

Colunas
Nome Tipo Descrição
ID [KEY] String O identificador de cotação.
Type String O tipo da cotação.
State String O estado da cotação.
CreatedDate Datetime A data em que a cotação foi criada.
ValidDate Datetime A data até a cotação é válida.
Budget String O orçamento para a cotação.
OptionExplanation String Uma descrição para explicar as opções relacionadas à cotação.
EstimatedCost Float Valor do custo estimado.
EstimatedCostTax Float Valor estimado do custo do imposto.
EstimatedCostIncludingTax Float Valor total estimado, incluindo impostos.
AmountTax Float Valor a pagar.
AmountIncludingTax Float Valor do imposto a pagar.
Amount Float Valor total a pagar incluindo impostos.
ClientUUID String O identificador do cliente que está relacionado à cotação.
ClientName String O nome do cliente que está relacionado à cotação.
ContactUUID String O ID de contato do cliente relacionado à cotação.
ContactName String O nome de contato do cliente que está relacionado à cotação.

CotaçõesCusto

Retorna uma lista de cotações relacionadas a custos.

Selecione

O conector processará todos os filtros do lado do cliente, exceto QuoteID.

Select * from QuotesCost
Select * from QuotesCost where QuoteID = 'Q000123'
Select * from QuotesCost where QuoteID IN ('Q000124', 'Q000123')
Colunas
Nome Tipo Descrição
QuoteID [KEY] String O identificador da cotação.
Description String A descrição da tarefa relacionada aos custos.
Note String A nota da tarefa relacionada aos custos.
Code String O código da tarefa relacionada aos custos.
Billable String O Faturável da tarefa relacionado aos custos.
Quantity Int A Quantidade da tarefa relacionada aos custos.
UnitCost Double O UnitCost da tarefa relacionada aos custos.
UnitPrice Double O UnitPrice da tarefa relacionada aos custos.
Amount Double O valor da tarefa relacionado aos custos.
AmountTax Double O AmountTax da tarefa relacionada aos custos.
AmountIncludingTax Double O AmountIncludingTax da tarefa relacionada aos custos.

CotaçõesOpção

Retorna uma lista de cotações relacionadas a opções.

Selecione

O conector processará todos os filtros do lado do cliente, exceto QuoteID.

Select * from QuotesOption
Select * from QuotesOption where QuoteID = 'Q000123'
Select * from QuotesOption where QuoteID IN ('Q000124', 'Q000123')
Colunas
Nome Tipo Descrição
QuoteID [KEY] String O identificador da cotação.
Description String A descrição da tarefa relacionada às opções.
Note String A Nota da tarefa relacionada às opções.
Code String O Código da tarefa relacionada às opções.
Quantity Int A Quantidade da tarefa relacionada às opções.
UnitCost Double O UnitCost da tarefa relacionada às opções.
UnitPrice Double O UnitPrice da tarefa relacionada às opções.
Amount Double A quantidade da tarefa relacionada às opções.
AmountTax Double O AmountTax da tarefa relacionada às opções.
AmountIncludingTax Double O AmountIncludingTax da tarefa relacionada às opções.

CotaçõesTarefa

Retorna uma lista de citações relacionadas a Tarefas.

Selecione

O conector processará todos os filtros do lado do cliente, exceto QuoteID.

Select * from QuotesTask
Select * from QuotesTask where QuoteID = 'Q000123'
Select * from QuotesTask where QuoteID IN ('Q000124', 'Q000123')
Colunas
Nome Tipo Descrição
QuoteID [KEY] String O identificador da cotação.
Name String O Nome da tarefa relacionada à Cotação.
Description String A Descrição da tarefa relacionada à Cotação.
EstimatedMinutes Int A Ata da tarefa relacionada à Citação.
BillableRate Double O BillableRate da tarefa relacionada ao Quote.
Billable String O Faturável da tarefa relacionada ao Orçamento.
Amount Double O valor da tarefa relacionada à cotação.
AmountTax Double O AmountTax da tarefa relacionada ao Quote.
AmountIncludingTax Double O AmountIncludingTax da tarefa relacionada ao Quote.

Tarefas

Retorna uma lista de todas as tarefas

Selecione

O conector usará a API Xero WorkflowMax para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do driver. Especificamente, o seguinte é processado do lado do servidor:

  • UUID suporta o = operador.

Todas as colunas filtráveis permitem que vários valores sejam especificados usando o operador IN. O tempo de resposta do servidor pode ser melhorado identificando apenas as linhas que você deseja recuperar.

SELECT * FROM Tasks WHERE UUID='9d382fcf-7013-4d97-8dd8-c08e8b26a0b2'
SELECT * FROM Tasks WHERE UUID IN ('9d382fcf-7013-4d97-8dd8-c08e8b26a0b2', '9d382fcf-7013-4d97-8dd8-c08e8b26a6g9')
Colunas
Nome Tipo Descrição
UUID [KEY] String Identificador de tarefa.
Name String O nome da tarefa
Description String A descrição da tarefa.

Modelos

Retorna uma lista de todos os modelos

Selecione

O conector processará todos os filtros do lado do cliente.

Colunas
Nome Tipo Descrição
UUID [KEY] String O identificador do modelo.
Name String O nome dos modelos.

Procedimentos Armazenados

Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.

Conector Jitterbit para Procedimentos Armazenados Xero WorkflowMax

Nome Descrição
ApplyJobTemplate Aplicar um modelo adicional a um trabalho
ChangeJobStatus Usado para alterar o status do trabalho
ChangeTaskStatus Usado para alterar o status da tarefa concluída ou aberta
CreateJobEstimate Usado para criar uma estimativa de trabalho
CreateJobQuote Usado para criar uma cotação de trabalho.
DeleteAllCosts Usado para excluir todos os custos.
GetOAuthAccessToken Obtém um token de autenticação do Xero WorkflowMax.
GetOAuthAuthorizationURL Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o OAuthAccessToken deste URL.
ManageClientGroupMembers Gerenciar os membros de um grupo de clientes
ManageJobMembers Gerenciar os membros de um trabalho.
ManageStaffLogin Ativar ou desativar o login de membros da equipe.
ManageTaskStaff Gerenciar os membros da equipe de uma tarefa
RefreshOAuthAccessToken Atualiza o token de acesso OAuth usado para autenticação com vários serviços Basecamp.
UploadClientDocument Carregar um documento para um Cliente
UploadJobDocument Carregar um documento para um Trabalho

AplicarJobTemplate

Aplicar um modelo adicional a um trabalho

Entrada
Nome Tipo Descrição
JobID String A ID do trabalho
TemplateUUID String O UUID do modelo a ser aplicado
TaskMode String TaskMode descreve como as tarefas são adicionadas ao trabalho. AddNew: as tarefas são sempre adicionadas ao trabalho (padrão). AppendExisting: onde a mesma tarefa já existe no trabalho, a tarefa modelo será anexada aos detalhes da tarefa existente, caso contrário, a tarefa será adicionada ao trabalho
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

ChangeJobStatus

Usado para alterar o status do trabalho

Entrada
Nome Tipo Descrição
JobID String A ID do trabalho
State String O valor do elemento de estado é aquele no campo Código de interface para cada Estado do trabalho, conforme definido em Admin
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

AlterarTaskStatus

Usado para alterar o status da tarefa concluída ou aberta

Entrada
Nome Tipo Descrição
TaskUUID String O UUID da tarefa
State String Defina isso para concluir/reabrir para marcar uma tarefa como concluída ou não.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

CreateJobEstimate

Usado para criar uma estimativa de trabalho

Entrada
Nome Tipo Descrição
JobID String A ID do trabalho
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

CriarCotação de Trabalho

Usado para criar uma cotação de trabalho.

Entrada
Nome Tipo Descrição
JobID String A ID do trabalho
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

DeleteAllCosts

Usado para excluir todos os custos.

Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

GetOAuthAccessToken

Obtém um token de autenticação do Xero WorkflowMax.

Entrada
Nome Tipo Descrição
AuthMode String O tipo de modo de autenticação a ser usado. Selecione App para obter tokens de autenticação por meio de um aplicativo de desktop. Selecione Web para obter tokens de autenticação por meio de um aplicativo Web. Os valores permitidos são APP, WEB. O valor padrão é APP.
Scope String Uma lista separada por vírgulas de permissões a serem solicitadas ao usuário. Verifique a API Xero WorkflowMax para obter uma lista de permissões disponíveis.
CallbackUrl String A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Esse valor deve corresponder ao URL de redirecionamento que você especificou nas configurações do aplicativo Xero WorkflowMax. Necessário apenas quando o parâmetro Authmode for Web.
Verifier String O verificador retornou do Xero WorkflowMax depois que o usuário autorizou seu aplicativo a ter acesso aos seus dados. Esse valor será retornado como um parâmetro para a URL de retorno de chamada.
State String Indica qualquer estado que pode ser útil ao seu aplicativo após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta ao servidor de autorização Xero WorkflowMax. Os usos incluem redirecionar o usuário para o recurso correto em seu site, nonces e mitigações de falsificação de solicitação entre sites.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de acesso usado para comunicação com o Xero WorkflowMax.
OAuthRefreshToken String O token de atualização OAuth. É o mesmo que o token de acesso no caso do Xero WorkflowMax.
ExpiresIn String O tempo de vida restante no token de acesso. Um -1 denota que não irá expirar.
TenantId String A ID associada a um inquilino Xero WorkflowMax, que é necessária, juntamente com um OAuthAccessToken, para autenticar um aplicativo OAuth para Xero WorkflowMax.

GetOAuthAuthorizationURL

Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o OAuthAccessToken deste URL.

Entrada
Nome Tipo Descrição
CallbackUrl String A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Esse valor deve corresponder ao URL de redirecionamento nas configurações do aplicativo Xero WorkflowMax.
Scope String Uma lista separada por vírgulas de escopos a serem solicitados ao usuário. Verifique a documentação da API do Xero WorkflowMax para obter uma lista de permissões disponíveis.
State String Indica qualquer estado que pode ser útil ao seu aplicativo após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta ao servidor de autorização Xero WorkflowMax. Os usos incluem redirecionar o usuário para o recurso correto em seu site, nonces e mitigações de falsificação de solicitação entre sites.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
URL String O URL de autorização, inserido em um navegador da Web para obter o token do verificador e autorizar seu aplicativo.

ManageClientGroupMembers

Gerenciar os membros de um grupo de clientes

Entrada
Nome Tipo Descrição
ClientGroupUUID String ID do grupo ao qual adicionar o cliente
Add String ID do cliente a adicionar ao grupo
Remove String ID do cliente a ser removido do grupo
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

ManageJobMembers

Gerenciar os membros de um trabalho.

Entrada
Nome Tipo Descrição
JobID String ID do trabalho para adicionar/remover membros da equipe
Add String UUID do membro da equipe para adicionar
Remove String UUID do funcionário a ser removido
Operation String Especifique uma das seguintes operação : -ChangeStaff para adicionar/remover membros da equipe do trabalho -ChangeManager para adicionar/remover gerente do trabalho -ChangePartner para adicionar/remover parceiro do trabalho
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

ManageStaffLogin

Ativar ou desativar o login de membros da equipe.

Entrada
Nome Tipo Descrição
StaffUUID String O UUID do membro da equipe
Status String desabilitar/habilitar
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

ManageTaskStaff

Gerenciar os membros da equipe de uma tarefa

Entrada
Nome Tipo Descrição
JobID String ID do trabalho relacionado à tarefa.
TaskUUID String UUID da Tarefa para adicionar/remover membros da equipe
Add String UUID da equipe para adicionar à tarefa
Remove String UUID da equipe para remover da tarefa
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

RefreshOAuthAccessToken

Atualiza o token de acesso OAuth usado para autenticação com vários serviços Basecamp.

Entrada
Nome Tipo Descrição
OAuthRefreshToken String O token de atualização retornou com o token de acesso anterior.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de autenticação retornado do Basecamp. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico.
OAuthRefreshToken String Um token que pode ser usado para obter um novo token de acesso.
ExpiresIn String O tempo de vida restante no token de acesso.

UploadClientDocument

Carregar um documento para um cliente

Entrada
Nome Tipo Descrição
ClientUUID String O ID do cliente onde o documento será carregado.
Title String Título do documento
Text String A nota relativa ao documento
Folder String A pasta onde o documento será carregado
FileName String Nome do arquivo
LocalFile String Caminho completo do arquivo que será carregado
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

UploadJobDocument

Carregar um documento para um trabalho

Entrada
Nome Tipo Descrição
JobID String A ID do trabalho onde o documento será carregado.
Title String Título do documento
Text String A nota relativa ao documento
Folder String A pasta onde o documento será carregado
Public String Determina se o documento é aberto ao público
FileName String Nome do arquivo
LocalFile String Caminho completo do arquivo que será carregado
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não.

Tabelas do Sistema

Você pode consultar as tabelas do sistema descritas nesta seção para acessar informações de esquema, informações sobre a funcionalidade da fonte de dados e estatísticas de operação em lote.

Tabelas de Esquema

As tabelas a seguir retornam metadados do banco de dados para Xero WorkflowMax:

Tabelas de Fonte de Dados

As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:

  • sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
  • sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.

Consultar Tabelas de Informações

A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:

  • sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.

Sys_catalogs

Lista os bancos de dados disponíveis.

A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:

SELECT * FROM sys_catalogs
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.

Sys_schemas

Lista os esquemas disponíveis.

A consultar a seguir recupera todos os esquemas disponíveis:

SELECT * FROM sys_schemas
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.
SchemaName String O nome do esquema.

Sys_tables

Lista as tabelas disponíveis.

A consultar a seguir recupera as tabelas e exibições disponíveis:

SELECT * FROM sys_tables
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou visualização.
TableType String O tipo de tabela (tabela ou exibição).
Description String Uma descrição da tabela ou visualização.
IsUpdateable Boolean Se a tabela pode ser atualizada.

Sys_tablecolumns

Descreve as colunas das tabelas e exibições disponíveis.

A consultar a seguir retorna as colunas e os tipos de dados da tabela Clients:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Clients' 
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição que contém a coluna.
ColumnName String O nome da coluna.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O tamanho de armazenamento da coluna.
DisplaySize Int32 A largura máxima normal da coluna designada em caracteres.
NumericPrecision Int32 O número máximo de dígitos em dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 A escala da coluna ou o número de dígitos à direita do ponto decimal.
IsNullable Boolean Se a coluna pode conter null.
Description String Uma breve descrição da coluna.
Ordinal Int32 O número de sequência da coluna.
IsAutoIncrement String Se o valor da coluna é atribuído em incrementos fixos.
IsGeneratedColumn String Se a coluna é gerada.
IsHidden Boolean Se a coluna está oculta.
IsArray Boolean Se a coluna é uma matriz.

Sys_procedures

Lista os procedimentos armazenados disponíveis.

A consultar a seguir recupera os procedimentos armazenados disponíveis:

SELECT * FROM sys_procedures
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém o procedimento armazenado.
SchemaName String O esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado.
Description String Uma descrição do procedimento armazenado.
ProcedureType String O tipo do procedimento, como PROCEDURE ou FUNCTION.

Sys_procedureparameters

Descreve procedimento armazenado* parâmetros.

A consultar a seguir retorna informações sobre todos os parâmetros de entrada para o procedimento armazenado CreateJobEstimate:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateJobEstimate' AND Direction=1 OR Direction=2
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o procedimento armazenado.
SchemaName String O nome do esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado* contendo o parâmetro.
ColumnName String O nome do procedimento armazenado* parâmetro.
Direction Int32 Um número inteiro correspondente ao tipo do parâmetro: entrada (1), entrada/saída (2) ou saída (4). parâmetros de tipo de entrada/saída podem ser parâmetros de entrada e saída.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O número de caracteres permitido para dados de caractere. O número de dígitos permitidos para dados numéricos.
NumericPrecision Int32 A precisão máxima para dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 O número de dígitos à direita do ponto decimal em dados numéricos.
IsNullable Boolean Se o parâmetro pode conter null.
IsRequired Boolean Se o parâmetro é necessário para a execução do procedimento.
IsArray Boolean Se o parâmetro é uma matriz.
Description String A descrição do parâmetro.
Ordinal Int32 O índice do parâmetro.

Sys_keycolumns

Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela Clientes:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Clients'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
IsKey Boolean Se a coluna é uma chave primária na tabela referenciada no campo TableName.
IsForeignKey Boolean Se a coluna é uma chave estrangeira referenciada no campo TableName.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.

Sys_foreignkeys

Descreve as chaves estrangeiras. A consultar a seguir recupera todas as chaves estrangeiras que se referem a outras tabelas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.
ForeignKeyType String Designa se a chave estrangeira é uma chave de importação (aponta para outras tabelas) ou de exportação (referenciada de outras tabelas).

Sys_indexes

Descreve os índices disponíveis. Ao filtrar por índices, você pode escrever consultas mais seletivas com tempos de resposta de consultar mais rápidos.

A consultar a seguir recupera todos os índices que não são chaves primárias:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o índice.
SchemaName String O nome do esquema que contém o índice.
TableName String O nome da tabela que contém o índice.
IndexName String O nome do índice.
ColumnName String O nome da coluna associada ao índice.
IsUnique Boolean True se o índice for exclusivo. Falso caso contrário.
IsPrimary Boolean Verdadeiro se o índice for uma chave primária. Falso caso contrário.
Type Int16 Um valor inteiro correspondente ao tipo de índice: estatística (0), agrupado (1), hash (2) ou outro (3).
SortOrder String A ordem de classificação: A para crescente ou D para decrescente.
OrdinalPosition Int16 O número de sequência da coluna no índice.

Sys_connection_props

Retorna informações sobre as propriedades de conexão disponíveis e as definidas na string de conexão.

Ao consultar esta tabela, a string de conexão de configuração deve ser usada:

jdbc:cdata:xeroworkflowmax:config:

Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.

A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:

SELECT * FROM sys_connection_props WHERE Value <> ''
Colunas
Nome Tipo Descrição
Name String O nome da propriedade de conexão.
ShortDescription String Uma breve descrição.
Type String O tipo de dados da propriedade de conexão.
Default String O valor padrão, se não houver um definido explicitamente.
Values String Uma lista separada por vírgulas de valores possíveis. Um erro de validação é lançado se outro valor for especificado.
Value String O valor que você definiu ou um padrão pré-configurado.
Required Boolean Se a propriedade é necessária para se conectar.
Category String A categoria da propriedade de conexão.
IsSessionProperty String Se a propriedade é uma propriedade de sessão, usada para salvar informações sobre a conexão atual.
Sensitivity String O nível de sensibilidade da propriedade. Isso informa se a propriedade é ofuscada nos formulários de registro e autenticação.
PropertyName String Uma forma truncada em camel case do nome da propriedade de conexão.
Ordinal Int32 O índice do parâmetro.
CatOrdinal Int32 O índice da categoria do parâmetro.
Hierarchy String Mostra as propriedades dependentes associadas que precisam ser definidas juntamente com esta.
Visible Boolean Informa se a propriedade está visível na UI da conexão.
ETC String Diversas informações diversas sobre o imóvel.

Sys_sqlinfo

Descreve o processamento da consultar SELECT que o conector pode transferir para a fonte de dados.

Processamento de Consultas Colaborativas

Ao trabalhar com fontes de dados que não suportam SQL-92, você pode consultar a exibição sys_sqlinfo para determinar os recursos de consultar das APIs subjacentes, expressas na sintaxe SQL. O conector transfere o máximo possível do processamento da instrução SELECT para o servidor e, em seguida, processa o restante da consultar na memória.

Descobrindo os Recursos SELECT da Fonte de Dados

Abaixo está um exemplo de conjunto de dados de recursos SQL. O conjunto de resultados a seguir indica a funcionalidade SELECT que o conector pode descarregar para a fonte de dados ou processar o lado do cliente. Sua fonte de dados pode suportar sintaxe SQL adicional. Alguns aspectos da funcionalidade SELECT são retornados em uma lista separada por vírgulas, se suportados; caso contrário, a coluna contém NO.

Nome Descrição Valores Possíveis
AGGREGATE_FUNCTIONS Funções de agregação suportadas. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Se a função COUNT é suportada. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR O caractere de abertura usado para escapar de um identificador. [
IDENTIFIER_QUOTE_CLOSE_CHAR O caractere de fechamento usado para escapar de um identificador. ]
SUPPORTED_OPERATORS Uma lista de operadores SQL com suporte. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Se GROUP BY é compatível e, em caso afirmativo, o grau de suporte. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Funções de string suportadas. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Funções numéricas suportadas. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Funções de data/hora suportadas. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indica tabelas ignoradas durante a replicação.
REPLICATION_TIMECHECK_COLUMNS Uma matriz de string contendo uma lista de colunas que serão usadas para verificar (na ordem especificada) para usar como uma coluna modificada durante a replicação.
IDENTIFIER_PATTERN Valor de string que indica qual string é válida para um identificador.
SUPPORT_TRANSACTION Indica se o provedor oferece suporte a transações como confirmação e reversão. YES, NO
DIALECT Indica o dialeto SQL a ser usado.
KEY_PROPERTIES Indica as propriedades que identificam o banco de dados uniforme.
SUPPORTS_MULTIPLE_SCHEMAS Indica se vários esquemas podem existir para o provedor. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indica se vários catálogos podem existir para o provedor. YES, NO
DATASYNCVERSION A versão do Data Sync necessária para acessar este driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY A categoria Data Sync deste driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Se a funcionalidade SQL aprimorada além do que é oferecido pela API é suportada. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Se as operações em lote são suportadas. YES, NO
SQL_CAP Todos os recursos SQL suportados para este driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Um valor de string especifica o cacheOptions preferencial.
ENABLE_EF_ADVANCED_QUERY Indica se o driver oferece suporte direto a consultas avançadas provenientes do Entity Framework. Caso contrário, as consultas serão tratadas no lado do cliente. YES, NO
PSEUDO_COLUMNS Uma matriz de cadeia de caracteres que indica as pseudocolunas disponíveis.
MERGE_ALWAYS Se o valor for verdadeiro, o modo de mesclagem será executado à força no Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Uma consultar de seleção para retornar a data e hora de início da replicação.
REPLICATION_MIN_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um min do lado do servidor.
REPLICATION_START_DATE Permite que um provedor especifique uma data de início de replicação.
REPLICATION_MAX_DATE_QUERY Uma consultar de seleção para retornar a data e hora de término da replicação.
REPLICATION_MAX_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um máximo do lado do servidor.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Uma lista de tabelas que ignorará a divisão da replicação em blocos na replicação inicial.
CHECKCACHE_USE_PARENTID Indica se a instrução CheckCache deve ser executada na coluna de chave pai. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indica procedimentos armazenados* que pode ser usado para gerar arquivos de esquema.

A consultar a seguir recupera os operadores que podem ser usados na cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Observe que tabelas individuais podem ter diferentes limitações ou requisitos na cláusula WHERE; consulte o Modelo de Dados para obter mais informações.

Colunas
Nome Tipo Descrição
NAME String Um componente da sintaxe SQL ou um recurso que pode ser processado no servidor.
VALUE String Detalhes sobre a sintaxe SQL ou SQL suportada.

Sys_identity

Retorna informações sobre tentativas de modificação.

A consultar a seguir recupera os IDs das linhas modificadas em uma operação em lote:

SELECT * FROM sys_identity
Colunas
Nome Tipo Descrição
Id String O ID gerado pelo banco de dados retornado de uma operação de modificação de dados.
Batch String Um identificador para o lote. 1 para uma única operação.
Operation String O resultado da operação no lote: INSERTED, UPDATED ou DELETED.
Message String SUCCESS ou uma mensagem de erro se a atualização no lote falhou.

Propriedades de Configurações Avançadas

As propriedades de configurações avançadas são as várias opções que podem ser usadas para estabelecer uma conexão. Esta seção fornece uma lista completa das opções que você pode configurar. Clique nos links para mais detalhes.

OAuth

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
TenantId ID do locatário máximo do Workflow do Xero.
CallbackURL O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

SSL

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Esquema

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Outro

Propriedade Descrição
IncludeCustomFields Determina se os Campos Personalizados devem ser incluídos como colunas da tabela ou não. A inclusão de CustomFields afetará o desempenho.

Diversos

Propriedade Descrição
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

OAuth

Esta seção fornece uma lista completa de propriedades OAuth que você pode configurar.

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
TenantId ID do locatário máximo do Workflow do Xero.
CallbackURL O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

InitiateOAuth

Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.

Valores Possíveis

OFF, GETANDREFRESH, REFRESH

Tipo de Dados

string

Valor Padrão

"OFF"

Observações

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

  1. OFF: Indica que o fluxo OAuth será tratado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.
  2. GETANDREFRESH: Indica que todo o fluxo OAuth será tratado pelo conector. Se nenhum token existir atualmente, ele será obtido solicitando ao usuário por meio do navegador. Se existir um token, ele será atualizado quando aplicável.
  3. REFRESH: Indica que o conector tratará apenas da atualização do OAuthAccessToken. O usuário nunca será solicitado pelo conector a autenticar por meio do navegador. O usuário deve manipular a obtenção do OAuthAccessToken e OAuthRefreshToken inicialmente.

OAuthClientId

O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId valor, às vezes também chamado de chave do consumidor, e um segredo do cliente, o OAuthClientSecret.

OAuthClientSecret

O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId, também chamada de chave do consumidor. Você também receberá um segredo do cliente, também chamado de segredo do consumidor. Defina o segredo do cliente no OAuthClientSecret propriedade.

OAuthAccessToken

O token de acesso para conexão usando OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthAccessToken propriedade é usada para conectar usando OAuth. O OAuthAccessToken é recuperado do servidor OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre as solicitações.

O token de acesso é usado no lugar do seu nome de usuário e senha. O token de acesso protege suas credenciais, mantendo-as no servidor.

InquilinoId

ID do locatário máximo do Workflow do Xero.

Tipo de Dados

string

Valor Padrão

""

Observações

Se, por qualquer motivo, você estiver tentando usar um AccessToken para autenticar, observe que a autenticação Xero exige que um ID de locatário seja passado como um cabeçalho para cada solicitação de API.

Recupere o TenantId usando o GetOAuthAccessToken procedimento armazenado.

Como alternativa, você pode recuperar o TenantId do seguinte modo:

  1. Crie uma nova solicitação em uma ferramenta de desenvolvimento de API como o Postman.
  2. Defina o URL como <https://api.xero.com/connections>
  3. Definir Authorization cabeçalho para "Bearer " + access_token e finalmente execute a requisição.
  4. A resposta mostrará 1 ou mais informações de conexão com o Xero.
  5. Encontre a conexão que tem "tenantType": "WORKFLOWMAX" e obtenha seu TenantId.
  6. Defina essa propriedade de conexão para o TenantId recém-adquirido.

URL de Retorno

O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

Tipo de Dados

string

Valor Padrão

""

Observações

Durante o processo de autenticação, o servidor de autorização OAuth redireciona o usuário para esta URL. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

OAuthVerifier

O código do verificador retornado da URL de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O código do verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas onde um navegador não pode ser iniciado, como sistemas headless.

Autenticação em Máquinas Sem Cabeça

Consulte para obter o OAuthVerifier valor.

Defina OAuthSettingsLocation juntamente com OAuthVerifier. Quando você conecta, o conector troca o OAuthVerifier para os tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Defina InitiateOAuth para GETANDREFRESH automatizar a troca.

Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.

Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente defina InitiateOAuth para ATUALIZAR.

OAuthRefreshToken

O token de atualização OAuth para o token de acesso OAuth correspondente.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthRefreshToken a propriedade é usada para atualizar o OAuthAccessToken ao usar a autenticação OAuth.

OAuthExpiresIn

O tempo de vida em segundos do OAuth AccessToken.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.

OAuthTokenTimestamp

O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

SSL

Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

SSLServerCert

O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Tipo de Dados

string

Valor Padrão

""

Observações

Se estiver usando uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não seja confiável para a máquina é rejeitado.

Esta propriedade pode assumir as seguintes formas:

Descrição Exemplo
Um certificado PEM completo (exemplo abreviado para concisão) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Um caminho para um arquivo local contendo o certificado C:\cert.cer
A chave pública (exemplo abreviado para concisão) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
O Thumbprint MD5 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) ecadbdda5a1529c58a1e9e09828d70e4
A impressão digital SHA1 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Se não for especificado, qualquer certificado confiável pela máquina será aceito.

Os certificados são validados como confiáveis pela máquina com base no armazenamento confiável do sistema. O armazenamento confiável usado é o valor 'javax.net.ssl.trustStore' especificado para o sistema. Se nenhum valor for especificado para esta propriedade, o armazenamento confiável padrão do Java será usado (por exemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar a aceitação de todos os certificados. Observe que isso não é recomendado devido a questões de segurança.

Esquema

Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Localização

Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.

Tipo de Dados

string

Valor Padrão

"%APPDATA%\\\XeroWorkflowMax Data Provider\\Schema"

Observações

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.

Se não for especificado, o local padrão é "%APPDATA%\\XeroWorkflowMax Data Provider\Schema" com %APPDATA% sendo definido para o diretório de configuração do usuário:

Plataforma %APPDATA%
Windows O valor da variável de ambiente APPDATA
Mac ~/Biblioteca/Suporte de aplicativos
Linux ~/.config

Esquemas Navegáveis

Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.

Tabelas

Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Visualizações

Restringe as exibições relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Outro

Esta seção fornece uma lista completa das outras propriedades que você pode configurar.

Propriedade Descrição
IncludeCustomFields Determina se os Campos Personalizados devem ser incluídos como colunas da tabela ou não. A inclusão de CustomFields afetará o desempenho.

IncludeCustomFields

Determina se os Campos Personalizados devem ser incluídos como colunas da tabela ou não. A inclusão de CustomFields afetará o desempenho.

Tipo de Dados

string

Valor Padrão

"false"

Observações

É possível criar campos personalizados no Xero WorkflowMax. Para recuperar seus valores, você pode definir IncludeCustomFields=true como uma propriedade de conexão. Isso listará os campos personalizados criados como colunas da tabela. Esses campos personalizados também podem ser atualizados por ex.

UPDATE Costs SET CF_1='new CF value' WHERE ID='CostID'

Observação: você ainda pode atualizar campos personalizados mesmo quando uma tabela específica não oferece suporte à operação UPDATE.

Campos personalizados são muito caros. Eles exigem uma solicitação por registro para serem recuperados. Por esse motivo, eles estão desabilitados por padrão.

Diversos

Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.

Propriedade Descrição
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

MaxRows

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Tipo de Dados

int

Valor Padrão

-1

Observações

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Outro

Essas propriedades ocultas são usadas apenas em casos de uso específicos.

Tipo de Dados

string

Valor Padrão

""

Observações

As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Casos de uso de driver normal e funcionalidade não devem exigir essas propriedades.

Especifique várias propriedades em uma lista separada por ponto e vírgula.

Integração e Formatação
Propriedade Descrição
DefaultColumnSize Define o comprimento padrão dos campos de string quando a fonte de dados não fornece o comprimento da coluna nos metadados. O valor padrão é 2000. Voltar para o início
ConvertDateTimeToGMT Determina se os valores de data e hora devem ser convertidos em GMT, em vez da hora local da máquina.
RecordToFile=filename Registra a transferência de dados do soquete subjacente para o arquivo especificado.

Pseudocolunas

Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.

Tipo de Dados

string

Valor Padrão

""

Observações

Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

Tempo Esgotado

O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Tipo de Dados

int

Valor Padrão

60

Observações

Se Timeout = 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.

Se Timeout expira e a operação ainda não está concluída, o conector lança uma exceção.