Detalhes da Conexão Xero¶

Introdução¶

Versão do conector

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

Começando¶

Suporte à versão Xero

O Jitterbit Connector for Xero modela objetos Xero Accounting, Australian Payroll, Files, Assets e Projects como um banco de dados relacional.

Estabelecendo uma Conexão¶

Conectando-se a uma API do Xero¶

O conector suporta as seguintes APIs Xero:

• API de contabilidade: defina o Schema propriedade de conexão para ACCOUNTING
• API de folha de pagamento australiana: Defina o Schema propriedade de conexão para PAYROLLAUS
• API de arquivos: Defina o Schema propriedade de conexão para FILES
• API de ativos fixos: defina o Schema propriedade de conexão para ASSETS
• API de projetos: defina o Schema propriedade de conexão para PROJECTS

Também é recomendado que você defina o Tenant propriedade, que pode ser o nome ou ID de uma organização Xero. O Xero permite que você autorize o conector a acessar várias organizações. Por padrão, o conector escolherá o primeiro, que pode não ser o esperado se o conector tiver acesso a organizações adicionais.

Se você precisar confirmar a quais organizações o conector tem acesso, conecte-se sem um Tenant e leia a visualização dos locatários. Isso fornecerá o ID e o nome de cada organização conectada. Você deve usar o ID para definir o Tenant propriedade quando possível, pois várias organizações podem ter o mesmo nome.

Autenticação no Xero¶

Todas as conexões com o Xero são autenticadas usando OAuth. O conector oferece suporte ao uso de aplicativos PKCE e aplicativos OAuth. Para aplicativos de desktop, o aplicativo padrão do conector é a maneira mais simples de autenticação. O único requisito adicional é definir InitiateOAuth para GETANDREFRESH.

Quando o conector for iniciado, ele abrirá um navegador e o Xero solicitará suas informações de login. O conector usará as credenciais que você fornecer para acessar seus dados Xero. Essas credenciais serão salvas e atualizadas automaticamente conforme necessário.

Usando Autenticação OAuth¶

O Xero usa o padrão de autenticação OAuth. O conector facilita isso de várias maneiras, conforme descrito abaixo.

Credenciais Incorporadas¶

Consulte Credenciais incorporadas para se conectar com as credenciais incorporadas do conector e pule a criação de um aplicativo OAuth personalizado.

Credenciais Personalizadas¶

Consulte Criando um aplicativo OAuth personalizado para registrar seu aplicativo no Xero. Isso só é recomendado se você precisar personalizar a própria tela de autorização, como fornecer seu próprio URL de retorno de chamada ou marca.

Credenciais Incorporadas¶

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

Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário.

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

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

Credenciais Personalizadas¶

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:

• AuthScheme: Defina para OAuth, ou PKCE se você configurou um aplicativo PKCE.
• InitiateOAuth: Defina para 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: OAuth apenas. Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
• CallbackURL: Defina isso para o URI de redirecionamento definido quando você registrou seu aplicativo.

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

1. Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
2. Obtém um novo token de acesso quando 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 Cabeça¶

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

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

Autorize a Conexão¶

A criação de um aplicativo de código de autenticação OAuth personalizado é necessária para o fluxo a seguir, pois PKCE não é compatível com ele. Consulte Criando um aplicativo OAuth personalizado para um procedimento. Você pode seguir os procedimentos abaixo para autenticar e conectar-se aos dados.

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

• AuthScheme: Defina para OAuth.
• InitiateOAuth: Defina para OFF.
• 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.

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:

• AuthScheme: Defina para OAuth.
• InitiateOAuth: Defina para REFRESH.
• 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.

Conectar aos Dados¶

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

• AuthScheme: Defina para OAuth.
• InitiateOAuth: Defina para REFRESH.
• 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.

Transferir Configurações de OAuth¶

Em vez de concluir manualmente o fluxo OAuth acima, você também pode seguir as etapas abaixo para instalar o conector em outra máquina, autenticar e transferir os valores OAuth resultantes.

Este fluxo não requer o uso de um aplicativo OAuth customizado.

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

• Definir InitiateOAuth para GETANDREFRESH.
• OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.

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: Defina para REFRESH.
• 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¶

As seções a seguir mostram como criar um aplicativo OAuth personalizado para uso nas Credenciais personalizadas fluxo de autenticação.

Registrar um Aplicativo OAuth: Desktop¶

Siga as etapas abaixo para registrar um aplicativo público para obter as credenciais do cliente OAuth:

1. Faça login no portal do desenvolvedor Xero.
2. Clique em Meus aplicativos -> Adicionar aplicativo. Escolha o tipo de aplicativo Auth Code.
3. Insira um nome para seu aplicativo e a URL de sua empresa. Essas informações são exibidas aos usuários quando eles se conectam.
4. Registre o URI de redirecionamento apropriado para o produto que você está usando.

Depois de clicar em Salvar, você verá seu ID do cliente OAuth e poderá criar um novo segredo do cliente OAuth. Você os definirá como OAuthClientId e OAuthClientSecret no guia de autenticação, Credenciais personalizadas.

Registrar um Aplicativo PKCE: Desktop¶

Além do tipo de aplicativo de código de autenticação padrão, você também pode criar aplicativos usando PKCE. Isso é recomendado para desenvolvedores que escrevem aplicativos do lado do cliente porque o PKCE não requer um segredo do cliente.

O registro de um aplicativo PKCE é semelhante ao processo de registro de um aplicativo OAuth. A única diferença que o Xero não retorna um OAuthClientSecret porque não é utilizado no fluxo PKCE.

Limites da API Xero¶

Limites da API Xero¶

A API do Xero tem limitações de uso que podem ser encontradas durante o uso do Jitterbit Connector for Xero. Observe que tudo isso se aplica por aplicativo e por organização. Um aplicativo pode exceder esses limites se estiver consultando várias organizações, desde que obedeça aos limites dentro de cada organização.

Limite Simultâneo¶

No máximo 5 chamadas de API do aplicativo podem estar ativas na mesma organização ao mesmo tempo. Normalmente, esse limite não é um problema porque o conector repetirá automaticamente a solicitação atual se isso ocorrer.

Limite por Minuto¶

No máximo 60 chamadas de API por minuto podem ser feitas do aplicativo para a mesma organização. Esse limite também não é um problema, pois o Xero relata um tempo de atraso recomendado que o conector usará para evitar atingir o limite novamente.

Limite por Dia¶

No máximo 5.000 chamadas de API por dia podem ser feitas do aplicativo para a mesma organização. Atingir esse limite é raro, mas pode acontecer com certas tabelas (como tabelas de histórico e alguns relatórios) ou certas configurações (como AutoExpandDetails) são usados, pois exigem que o conector faça uma única chamada de API para cada fatura/contato/etc. que é lido.

Se esse limite for atingido com frequência, o primeiro passo deve ser evitar as tabelas ou configurações que o acionam. Também é possível converter as consultas em versões que leem menos linhas de uma só vez. Isso geralmente é feito substituindo seleções simples por subconsultas que selecionam pequenos grupos de linhas e, em seguida, usando várias versões dessas consultas em momentos diferentes:

/* Retreives history for about 1/16 of the invoices */
SELECT * FROM HistoryInvoices WHERE InvoiceId IN (
  SELECT InvoiceId FROM Invoices WHERE InvoiceId LIKE '0%'
) 

O RetryDailyLimit opção também está disponível, mas seu uso é fortemente desencorajado, pois nos piores casos, os atrasos sugeridos Xero podem durar várias horas durante as quais o conector ficará indisponível. Normalmente, é melhor reestruturar como você solicita dados para caber dentro dos limites do que ignorar os limites e executar consultas que levam várias horas para serem executadas.

Anotações Importantes¶

Procedimentos Armazenados¶

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

Arquivos de Configuração e Seus Caminhos¶

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

Características Avançadas¶

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

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 Jitterbit Connector for Xero 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 exibição.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM Contacts 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¶

O Jitterbit Connector for Xero modela cinco APIs Xero como bancos de dados relacionais: Accounting, Australian Payroll, Files, Fixed Assets e Projects APIs. Colocou o Schema e use as informações em cada seção para selecionar a API adequada com base nas necessidades do seu projeto.

Usando a API de Contabilidade

A API de contabilidade contém as informações financeiras da empresa, como contatos, faturas e relatórios. Ele também contém tabelas de histórico que registram alterações na maioria dos tipos de entidades.

Consulte Modelo de dados contábeis para as entidades disponíveis na API Accounting.

Usando a API de folha de pagamento australiana

A API de folha de pagamento australiana contém informações sobre os funcionários da empresa, como planilhas de horas, férias e declarações fiscais.

Consulte Modelo de dados de folha de pagamento australiano para as entidades disponíveis na API de folha de pagamento australiana.

Usando a API de arquivos

A API de arquivos contém informações sobre os arquivos e anexos gerenciados pelo Xero. Ele pode ser usado para fazer upload e download de arquivos e anexá-los a entidades contábeis.

Consulte Modelo de dados de arquivos para as entidades disponíveis na API de arquivos.

Usando a API de Ativos Fixos

A API de Ativos Fixos contém informações sobre os ativos fixos da empresa, como registro, depreciação e revenda.

Consulte Modelo de dados de ativos fixos para as entidades disponíveis na API de Ativos Fixos.

Usando a API de Projetos

A API de Projetos contém informações sobre os projetos da empresa, como cobrança e controle de tempo.

Consulte Modelo de dados de projetos para as entidades disponíveis na API de Projetos.

Modelo de Dados Contábeis¶

O Jitterbit Connector for Xero modela a API Xero Accounting como tabelas relacionais, exibições e procedimentos armazenados. As limitações e requisitos da API estão documentados nesta seção; você pode usar o SupportEnhancedSQL recurso, definido por padrão, para contornar a maioria dessas limitações.

Tabelas¶

Tabelas descreve as tabelas disponíveis.

Visualizações¶

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

Procedimentos Armazenados¶

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

Procedimentos armazenados são interfaces semelhantes a funções para a fonte de dados. Eles podem ser usados para pesquisar, atualizar e modificar informações na fonte de dados.

Tabelas¶

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

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

Contas¶

Crie, exclua e consultar contas para uma organização Xero.

Informações Específicas da Tabela¶

A tabela Contas permite SELECIONAR e INSERIR contas para uma organização Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Os seguintes campos são obrigatórios para inserções: Código, Nome e Tipo.

INSERT INTO Accounts (Name,Code,Type) VALUES ('John Doe','2000','BANK')

Colunas¶

Transações Bancárias¶

Crie, atualize, exclua e consultar transações bancárias para uma organização Xero.

Informações Específicas da Tabela¶

A tabela BankTransactions permite SELECIONAR, INSERIR, ATUALIZAR e EXCLUIR transações bancárias para uma organização Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Para criar um novo registro de transação bancária, os seguintes campos são obrigatórios, além de pelo menos um item de linha: Tipo, Contact_ContactName ou Contact_ContactId e BankAccount_AccountId ou BankAccount_Code. Para criar um novo item de linha, os seguintes campos são obrigatórios: LineItem_Description, LineItem_Quantity, LineItem_UnitAmount e LineItem_AccountCode.

Além de inserir uma única linha, as tabelas de itens de linha oferecem duas maneiras adicionais de inserir em uma tabela.

1. Você pode inserir um novo objeto com vários itens de linha usando agregados XML. Os elementos suportados aqui são os mesmos que as colunas LineItem sem o prefixo "LineItem_", exceto ao atribuir categorias de rastreamento. Consulte a documentação Xero da API BankTransactions para obter mais detalhes.

   INSERT INTO BankTransactions(Type, Contact_ContactName, BankAccount_Code, LineItemAggregate) VALUES (
     'RECEIVE',
     'John Doe',
     '200',
     '<LineItem><Description>LineItem1Desc</Description><Quantity>1</Quantity><AccountCode>100</AccountCode></LineItem> <LineItem><Description>LineItem2Desc</Description><Quantity>2</Quantity><AccountCode>100</AccountCode></LineItem>'
   )
   

2. Você também pode inserir um novo item de linha em um objeto existente especificando o identificador gerado pelo Xero do registro existente. Por exemplo, para adicionar um item de linha a uma transação bancária existente:

   INSERT INTO BankTransactions (BankTransactionId, LineItem_Description, LineItem_Quantity) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'New Line Item Desc', 1)
   

Observação: a inserção em registros existentes contará como duas operações na API do Xero. Um é necessário para recuperar o registro existente e outro para atualizar o registro com novos dados.

Atualizar

Você pode atualizar qualquer campo que não seja somente leitura.

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

Excluir

A API do Xero tem suporte limitado para excluir qualquer objeto. Para excluir um registro da tabela BankTransactions, você deve atualizar o campo Status para um valor apropriado.

Colunas¶

Transferência Bancária¶

Informações de uso para a operação BankTransfers.rsd.

Informações Específicas da Tabela¶

A tabela BankTransfers permite SELECIONAR e INSERIR transferências bancárias para uma organização Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Os seguintes campos são obrigatórios para inserções: FromBankAccount_Code, ToBankAccount_Code e Amount

INSERT INTO BankTransfers (FromBankAccount_Code,ToBankAccount_Code,Amount) VALUES ('3d08fd48-434d-4c18-a57b-831663ab70d2','ceef65a5-a545-423b-9312-78a53caadbc4','1000.00')

Colunas¶

Pagamentos em Lote¶

Crie e consultar BatchPayments para uma organização Xero.

Informações Específicas da Tabela¶

A tabela BatchPayments permite SELECIONAR e INSERIR pagamentos em lote para uma organização Xero. A coluna ID é gerada pelo conector, esse valor combina o índice do pagamento individual dentro do lote com o BatchPaymentId exclusivo gerado pelo Xero

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Para criar um novo pagamento em lote, AccountId e Date são necessários, além de pelo menos um item de pagamento; os campos Payment_InvoiceId e Payment_Amount são obrigatórios para inserir um item de pagamento.

Você também pode fornecer vários pagamentos usando um agregado XML que contém os dados de cada pagamento no lote. Os elementos suportados são iguais aos nomes das colunas "Payment_" sem o prefixo "Payment_".

INSERT INTO BatchPayments(AccountId, Date, PaymentAggregate) VALUES (
  'AAAAA-AAAAA-AAAAA-AAAAA',
  '2019-03-01',
  '<Payment><InvoiceID>BBBBB-...</InvoiceID><Amount>50.21</Amount></Payment> <Payment><InvoiceID>CCCCC-...</InvoiceID><Amount>12.96</Amount></Payment>'
)

Colunas¶

Grupos de Contato¶

Crie, atualize e consultar grupos de contatos para uma organização Xero.

Informações Específicas da Tabela¶

A tabela ContactGroups permite que você gerencie grupos de contatos, bem como os membros desses grupos de contatos.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Ao inserir com um grupo de contatos, você pode inserir um novo grupo de contatos ou adicionar contatos a um grupo existente.

Para inserir um novo grupo de contatos, apenas o campo Nome deve ser fornecido:

INSERT INTO ContactGroups (Name) VALUES ('Contractors')

Para adicionar um contato a um grupo existente, tanto o ContactGroupId quanto o Contact_ContactId devem ser fornecidos. O valor do campo Contact_ContactId pode ser recuperado consultando a tabela de contatos.

INSERT INTO ContactGroups (ContactGroupId, Contact_ContactId) VALUES ('11111-11111-11111-11111', '22222-22222-22222-22222')

Vários contatos podem ser fornecidos usando o ContactAggregate:

INSERT INTO ContactGroups (ContactGroupId, ContactAggregate) VALUES (
  '11111-11111-11111-11111', 
'<Contact><ContactID>22222-22222-22222-22222</ContactID></Contact> <Contact><ContactID>33333-33333-33333-33333</ContactID></Contact>')

ATUALIZAÇÃO Ao atualizar um grupo de contatos, os únicos campos que podem ser alterados são o campo Nome e Status. Alterar o campo Status para EXCLUÍDO excluirá o grupo de contatos.

-- Renaming the group
UPDATE ContactGroup SET Name = 'External Contractors' WHERE ContactGroupId = '11111-11111-11111-1111'


-- Deleting the group
UPDATE ContactGroup SET Status = 'DELETED' WHERE ContactGroupId = '11111-11111-11111-1111'

EXCLUIR A exclusão de entradas de um grupo de contatos removerá contatos individuais do grupo.

DELETE FROM ContactGroups WHERE ID = '3|11111-11111-11111-11111'

Colunas¶

Contatos¶

Crie, atualize e consultar contatos para uma organização Xero.

Informações Específicas da Tabela¶

A tabela Contatos permite SELECIONAR, INSERIR e ATUALIZAR contatos para uma organização Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. O campo Nome é obrigatório para adicionar um novo contato.

INSERT INTO Contacts (Name) VALUES ('John Doe')

Atualizar

Você pode atualizar qualquer campo que não seja somente leitura.

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

Colunas¶

Notas de Credito¶

Crie, atualize, exclua e consultar notas de crédito para uma organização Xero.

Informações Específicas da Tabela¶

A tabela CreditNotes permite SELECIONAR, INSERIR, ATUALIZAR e EXCLUIR itens de linha de nota de crédito para uma organização Xero. A coluna ID é gerada pelo conector; o valor desse campo combina o índice do item de linha com o CreditNoteId exclusivo gerado pelo Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Para inserir uma nova nota de crédito, o campo Contact_Name é obrigatório. Para que uma nota de crédito seja aprovada, os seguintes campos devem ser definidos além de pelo menos um item de linha: Contact_Name, Date e LineAmountTypes.

Além de inserir uma única linha, as tabelas de itens de linha oferecem duas maneiras adicionais de inserção em uma tabela.

1. Você também pode inserir um novo objeto com vários itens de linha usando agregados XML. Os elementos suportados aqui são os mesmos que as colunas LineItem sem o prefixo "LineItem_", exceto ao atribuir categorias de rastreamento. Consulte a documentação Xero da API CreditNotes para obter mais detalhes.

   INSERT INTO CreditNotes (Type, Contact_Name, LineItemAggregate) VALUES (
     'ACCPAYCREDIT',
     'John Doe',
     '<LineItem><Description>LineItemDesc1</Description><Quantity>1</Quantity></LineItem> <LineItem><Description>LineItemDesc2</Description><Quantity>2</Quantity></LineItem>'
   )
   

2. Você pode inserir um novo item de linha em um objeto existente especificando o identificador gerado pelo Xero do registro existente. Por exemplo, para adicionar um item de linha a uma nota de crédito existente:

   INSERT INTO CreditNotes (CreditNoteId, LineItem_Description, LineItem_Quantity) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'New Line Item Desc', 1)
   

Observação: a inserção em registros existentes contará como duas operações na API do Xero. Um é necessário para recuperar o registro existente e outro para atualizar o registro com novos dados.

Atualizar

Você pode atualizar qualquer campo que não seja somente leitura.

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

Excluir

A API do Xero tem suporte limitado para excluir qualquer objeto. Para excluir objetos, você deve atualizar seu Status para um valor apropriado.

Os valores aplicáveis a este campo podem depender do estado. Por exemplo, as faturas só podem ter seu status definido como EXCLUÍDA quando o status da fatura é RASCUNHO ou ENVIADO.

Colunas¶

Funcionários¶

Crie, atualize e consultar funcionários de uma organização Xero.

Informações Específicas da Tabela¶

A tabela Funcionários permite SELECIONAR, INSERIR e ATUALIZAR funcionários de uma organização Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Para inserir um novo cadastro de funcionário, são necessários os seguintes campos: Nome e Sobrenome.

Atualizar

Você pode atualizar qualquer campo que não seja somente leitura.

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

Colunas¶

Reclamações de Despesas¶

Crie, atualize e consultar relatórios de despesas para uma organização Xero.

Informações Específicas da Tabela¶

A tabela ExpenseClaims permite SELECIONAR, INSERIR e ATUALIZAR relatórios de despesas para uma organização Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Para criar um novo registro de declaração de despesas, o campo UserId deve ser definido; além disso, pelo menos um ReceiptId deve ser especificado. Um pode ser fornecido por meio da coluna ReceiptId:

INSERT INTO ExpenseClaims(UserId, ReceiptId) VALUES (
  'XXXXX-XXXXX-XXXXX-XXXXX', 'YYYYY-YYYYY-YYYYY-YYYYY'
)

Vários também podem ser especificados incluindo-os no ReceiptAggregate:

INSERT INTO ExpenseClaims(UserId, ReceiptAggregate) VALUES (
  'XXXXX-XXXXX-XXXXX-XXXXX',
  '<Receipt><ReceiptID>YYYYY-YYYYY-YYYYY-YYYYY</ReceiptID></Receipt> <Receipt><ReceiptID>ZZZZZ-ZZZZZ-ZZZZZ-ZZZZZ</ReceiptID></Receipt>'
)

Atualizar

Você pode atualizar qualquer campo que não seja somente leitura.

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

Colunas¶

HistóricoBancoTransações¶

Crie e consultar o histórico e as notas do BankTransaction para uma organização Xero.

Informações Específicas da Tabela¶

A tabela HistoryBankTransactions permite que você leia as notas criadas em uma transação e o histórico de alterações nessa transação. Se um BankTransactionId não for fornecido, o histórico de todas as BankTransactions será recuperado.

Um BankTransactionId e detalhes são necessários para inserir uma nota:

INSERT INTO HistoryBankTransactions(BankTransactionId, Details) VALUES ('...', 'Refund for overpayment'), 

Colunas¶

HistóricoBatchPayments¶

Crie e consultar o histórico e as notas do BatchPayment para uma organização Xero.

Informações Específicas da Tabela¶

A tabela HistoryBatchPayments permite que você leia as notas criadas em um pagamento em lote e o histórico de alterações nesse pagamento em lote. Se um BatchPaymentId não for fornecido, o histórico de todos os pagamentos em lote será recuperado.

Um BatchPaymentId e detalhes são necessários para inserir uma nota:

INSERT INTO HistoryBatchPayments(BatchPaymentId, Details) VALUES ('...', 'Batch submitted on 3/1/2019')

Colunas¶

HistóricoContatos¶

Crie e consultar o histórico de contatos e notas de uma organização Xero.

Informações Específicas da Tabela¶

A tabela HistoryContacts permite que você leia as notas criadas em um contato e o histórico de alterações desse contato. Se um ContactId não for fornecido, o histórico de todos os contatos será recuperado.

Um ContactId e Detalhes são necessários para inserir uma nota:

INSERT INTO HistoryContacts(ContactId, Details) VALUES ('...', 'Reliable customer'), 

Colunas¶

HistóricoNotas de Crédito¶

Crie e consultar o histórico e as notas do CreditNote para uma organização Xero.

Informações Específicas da Tabela¶

A tabela HistoryCreditNotes permite que você leia as notas criadas em uma nota de crédito e o histórico de alterações nessa nota de crédito. Se um CreditNoteId não for fornecido, o histórico de todas as CreditNotes será recuperado.

SELECT * FROM HistoryCreditNotes WHERE CreditNoteId = '...'

Um CreditNoteId e Detalhes são necessários para inserir uma nota:

INSERT INTO HistoryCreditNotes(CreditNoteId, Details) VALUES ('...', 'Offered 12% discount'), 

Colunas¶

HistóricoFaturas¶

Crie e consultar o histórico e as notas da fatura para uma organização Xero.

Informações Específicas da Tabela¶

A tabela HistoryInvoices permite que você leia as notas criadas em uma fatura e o histórico de alterações nessa fatura. Se um InvoiceId não for fornecido, o histórico de todas as faturas será recuperado.

Um InvoiceId e Detalhes são necessários para inserir uma nota:

INSERT INTO HistoryInvoices(InvoiceId, Details) VALUES ('...', 'Payment expected on December 1st'), 

Colunas¶

HistóricoPedidos de Compra¶

Crie e consultar o histórico e as notas do PurchaseOrder para uma organização Xero.

Informações Específicas da Tabela¶

A tabela HistoryPurchaseOrders permite que você leia as notas criadas em um pedido de compra e o histórico de alterações nesse pedido de compra. Se um PurchaseOrderId não for fornecido, o histórico de todos os PurchaseOrders será recuperado.

Um PurchaseOrderId e detalhes são necessários para inserir uma nota:

INSERT INTO HistoryPurchaseOrders(PurchaseOrderId, Details) VALUES ('...', 'Rescheduled delivery for October 9th'), 

Colunas¶

Faturas¶

Crie, atualize, exclua e consultar faturas para uma organização Xero.

Informações Específicas da Tabela¶

A tabela Faturas permite SELECIONAR, INSERIR, ATUALIZAR e EXCLUIR itens de linha de fatura para uma organização Xero. A coluna ID é gerada pelo conector, esse valor combina o índice do item de linha com o InvoiceId exclusivo gerado pelo Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Para criar uma nova fatura, os campos Type e ContactName devem ser definidos além de pelo menos um item de linha. Observe que pelo menos LineItem_LineAmount ou LineItem_UnitAmount também são campos obrigatórios para o agregado LineItem.

Além de inserir uma única linha, as tabelas de itens de linha oferecem duas maneiras adicionais de inserção em uma tabela.

1. Você pode inserir um novo objeto com vários itens de linha usando agregados XML. Os elementos suportados aqui são os mesmos que as colunas LineItem sem o prefixo "LineItem_", exceto ao atribuir categorias de rastreamento. Consulte a documentação do Xero da API de faturas para obter mais detalhes.

   INSERT INTO Invoices (Type, ContactName, LineItemAggregate) VALUES (
     'ACCPAY',
     'Boom FM',
     '<LineItem><Description>LineItem1Desc</Description><Quantity>1</Quantity><UnitAmount>30</UnitAmount></LineItem> <LineItem><Description>LineItem2Desc</Description><Quantity>2</Quantity><UnitAmount>50</UnitAmount></LineItem>'
   )
   

2. Você também pode inserir um novo item de linha em um objeto existente especificando o valor gerado pelo Xero do registro existente. Por exemplo, adicionar um item de linha a uma fatura existente:

   INSERT INTO Invoices (InvoiceId, LineItem_Description, LineItem_Quantity, LineItem_UnitAmount) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'New Line Item Desc', 1, 10)
   

Observação: a inserção em registros existentes contará como duas operações na API do Xero. Um é necessário para recuperar o registro existente e outro para atualizar o registro com novos dados.

Atualizar

Você pode atualizar qualquer campo que não seja somente leitura.

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

Excluir

A API do Xero tem suporte limitado para excluir qualquer objeto. Para excluir objetos, você deve atualizar seu Status para um valor apropriado.

Os valores aplicáveis a este campo podem depender do estado. Por exemplo, as faturas só podem ter seu status definido como EXCLUÍDA quando o status da fatura é RASCUNHO ou ENVIADO.

Valores de desconto, taxas de desconto e valores de linha As faturas no Xero podem ser descontadas por meio de um valor fixo usando LineItem_DiscountAmount ou com uma porcentagem usando LineItem_DiscountRate. Esses dois métodos não são compatíveis porque os valores de desconto são mais precisos do que as taxas de desconto. Por exemplo, um item de linha com o valor de 2.000,00 e um valor de desconto de 99,99 não pode ser representado usando a taxa de desconto de 4,999 porque o Xero permite apenas dois dígitos de precisão nas taxas de desconto. Além disso, definir qualquer forma de desconto significa que LineItem_LineAmount é computado pelo Xero.

Isso significa que, dos três campos LIneItem_DiscountAmount, LineItem_DiscountAmount e LineItem_DiscountRate, apenas um pode ser usado como parte de uma consultar INSERT ou UDPATE. Por exemplo, nenhuma das consultas abaixo são válidas:

INSERT INTO Invoices(Invoice, LineItem_LineAmount, LineItem_DiscountRate) VALUES ('2bf5f07b-edf0-4b05-9200-cc2cd6b89b1e', 4999.99, 6.75)
UPDATE Invoices SET LineItem_DiscountRate = 12.50, LineItem_DiscountAmount = 99.99 WHERE ID = '1|2bf5f07b-edf0-4b05-9200-cc2cd6b89b1e'

Isso também significa que o conector removerá os dois outros valores ao atribuir qualquer um desses campos. Por exemplo, se você atribuir um LineItem_LineAmount a uma fatura, o conector removerá todos os valores de desconto anexados a essa fatura.

Colunas¶

Unid¶

Crie, atualize, exclua e consultar itens para uma organização Xero.

Informações Específicas da Tabela¶

A tabela Itens permite SELECIONAR, INSERIR e ATUALIZAR itens para uma organização Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Para inserir um novo registro de item, o campo Código deve ser definido.

Atualizar

Você pode atualizar qualquer campo que não seja somente leitura.

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

Colunas¶

Transações Vinculadas¶

Crie, atualize e consultar LinkedTransactions para uma organização Xero.

Colunas¶

Diários Manuais¶

Crie, atualize e consultar diários manuais para uma organização Xero.

Informações Específicas da Tabela¶

A tabela ManualJournals permite SELECIONAR, INSERIR e ATUALIZAR linhas de diário de diários manuais para uma organização Xero. A coluna ID é gerada pelo conector; ele combina o índice do item de linha com o ManualJournalId exclusivo gerado pelo Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Para inserir um novo registro de diário manual, o campo Narração é obrigatório, além de pelo menos dois itens de linha. Um registro de diário deve conter pelo menos um crédito e um débito, para que o registro como um todo seja balanceado.

1. Você pode inserir um novo objeto com vários itens de linha usando um agregado XML. Os elementos suportados aqui são os mesmos das colunas JournalLine sem o prefixo "JournalLine_", exceto ao atribuir categorias de rastreamento. Consulte a documentação Xero da API do ManualJournals para obter mais detalhes.

   INSERT INTO ManualJournals (Narration, JournalLineAggregate) VALUES (
     'Accrued expenses',
     '<JournalLine><LineAmount>55.00</LineAmount><AccountCode>200</AccountCode></JournalLine> <JournalLine><LineAmount>-55.00</LineAmount><AccountCode>201</AccountCode></JournalLine>'
   )
   

2. Você também pode inserir um novo item de linha em um objeto existente especificando o valor gerado pelo Xero do registro existente. Por exemplo, para adicionar um item de linha a uma fatura existente:

   INSERT INTO ManualJournals (ManualJournalId, JournalLine_LineAmount, JournalLine_AccountCode) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 55.00, '200')
   

Observação: a inserção em registros existentes contará como duas operações na API do Xero. Um é necessário para recuperar o registro existente e outro para atualizar o registro com novos dados.

Atualizar

Você pode atualizar qualquer campo que não seja somente leitura.

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

Colunas¶

Pagamentos¶

Crie e consultar pagamentos para uma organização Xero.

Informações Específicas da Tabela¶

A tabela Pagamentos permite SELECIONAR e INSERIR pagamentos para uma organização Xero.

Observe que esta tabela não inclui pagamentos em relatórios de despesas - para recuperá-los, você precisará ler a exibição ExpenseClaimPayments.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Para inserir um novo registro de pagamento, os campos InvoiceNumber e AccountCode são obrigatórios.

Colunas¶

Ordens de Compra¶

Crie, atualize, exclua e consultar ordens de compra para uma organização Xero.

Colunas¶

Recibos¶

Crie, atualize, exclua e consultar recibos para uma organização Xero.

Informações Específicas da Tabela¶

A tabela Recibos permite SELECIONAR, INSERIR, ATUALIZAR e EXCLUIR itens de linha de recebimento para uma organização Xero. A coluna ID é gerada pelo conector; ele combina o índice do item de linha com o ReceiptId exclusivo gerado pelo Xero.

Observe que esta tabela inclui apenas rascunhos de recibos - para recuperar recibos que já foram solicitados, você precisará ler a exibição ExpenseClaimReceipts.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Para inserir um registro de recebimento, os seguintes campos são obrigatórios, além de pelo menos um item de linha: Data, Contact_Name e User_UserId. Para adicionar um novo item de linha, os seguintes campos são obrigatórios: LineItem_Description, LineItem_UnitAmount e LineItem_AccountCode.

Além de inserir uma única linha, as tabelas de itens de linha oferecem duas maneiras adicionais de inserção em uma tabela.

1. Você pode inserir um novo objeto com vários itens de linha usando agregados XML. Os elementos suportados aqui são os mesmos que as colunas LineItem sem o prefixo "LineItem_", exceto ao atribuir categorias de rastreamento. Consulte a documentação Xero da API de recibos para obter mais detalhes.

   INSERT INTO Receipts (Date, Contact_Name, User_UserId, LineItemAggregate) VALUES (
     '4/19/2006 9:16:48 AM',
     'John Doe',
     'c81045b2-5740-4aea-bf8a-3956941af387',
     '<LineItem><Description>Coffee with client</Description><UnitAmount>13.00</UnitAmount><AccountCode>200</AccountCode></LineItem> <LineItem><Description>Bagel</Description><UnitAmount>2.00</UnitAmount><AccountCode>200</AccountCode></LineItem>'
   )
   

2. Você também pode inserir um novo item de linha em um objeto existente especificando o valor gerado pelo Xero do registro existente. Por exemplo, para adicionar um item de linha a uma fatura existente:

   INSERT INTO Receipts (ReceiptId, LineItem_Description, LineItem_UnitAmount) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'Coffee with client', 13.80)
   

Observação: a inserção em registros existentes contará como duas operações na API do Xero. Um é necessário para recuperar o registro existente e outro para atualizar o registro com novos dados.

Atualizar

Você pode atualizar qualquer campo que não seja somente leitura.

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

Excluir

A API do Xero tem suporte limitado para excluir qualquer objeto. Para excluir objetos, você deve atualizar seu Status para um valor apropriado.

Os valores aplicáveis a este campo podem depender do estado. Por exemplo, as faturas só podem ter seu status definido como EXCLUÍDO quando o status da fatura é RASCUNHO ou ENVIADO.

Colunas¶

Taxas de Imposto¶

Informações de uso para a operação TaxRates.rsd.

Informações Específicas da Tabela¶

A tabela TaxRates permite SELECIONAR, INSERIR e ATUALIZAR componentes de impostos para taxas de impostos em uma organização Xero. A coluna ID é gerada pelo conector, esse valor combina o índice do item de linha com o TaxType exclusivo gerado pelo Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

INSERIR

Inserir uma única linha é simples, mesmo com tabelas de itens de linha. Basta definir os campos obrigatórios e um novo objeto de tabela será criado como uma única entrada. Para criar uma nova taxa de imposto, o campo Nome deve ser definido além de pelo menos um componente de imposto; os campos TaxComponent_Name, TaxComponent_Rate e TaxComponent_IsCompound são necessários para inserir um novo item de linha.

Além de inserir uma única linha, esta tabela oferece duas maneiras adicionais de inserir em uma tabela.

1. Você pode inserir um novo objeto com vários itens de linha usando agregados XML. Os elementos suportados aqui são os mesmos das colunas TaxComponent sem o prefixo "TaxComponent_".

   INSERT INTO TaxRates (Name, TaxComponentAggregate) VALUES (
     'My Tax Rate',
     '<TaxComponent><Name>customTax1</Name><Rate>1.0000</Rate><IsCompound>false</IsCompound></TaxComponent> <TaxComponent><Name>customTax2</Name><Rate>2.0000</Rate><IsCompound>false</IsCompound></TaxComponent>'
   )
   

2. Você também pode inserir um novo componente de imposto em um objeto existente especificando o valor gerado pelo Xero para o registro existente. Por exemplo, adicionar um componente de imposto a uma taxa de imposto existente:

   INSERT INTO TaxRates (TaxType, TaxComponent_Name, TaxComponent_Rate, TaxComponent_IsCompound) VALUES ('TAX001', 'customTax2', '2.0000', 'False')
   

Observação: a inserção em registros existentes contará como duas operações na API do Xero. Um é necessário para recuperar o registro existente e outro para atualizar o registro com novos dados.

Atualizar

Você pode atualizar qualquer campo que não seja somente leitura.

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

Observação: você não pode atualizar taxas de imposto predefinidas por meio da API do Xero.

Excluir

A API do Xero tem suporte limitado para excluir qualquer objeto. Para excluir objetos, você deve atualizar seu Status para um valor apropriado.

Os valores aplicáveis a este campo podem depender do estado. Por exemplo, as faturas só podem ter seu status definido como EXCLUÍDO quando o status da fatura é RASCUNHO ou ENVIADO.

Colunas¶

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 Xero Views¶

IdososPagáveisPorContato¶

Retorna contas a pagar vencidas para um contato.

Informações Específicas da Tabela¶

Selecione

Se o ContactId não for fornecido, o relatório Aged Payables de todos os contatos será retornado, um após o outro.

Colunas¶

Pseudo-colunas¶

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

AgedReceivablesByContact¶

Retorna contas a receber vencidas para um contato.

Informações Específicas da Tabela¶

Selecione

Se o ContactId não for fornecido, o relatório Aged Payables de todos os contatos será retornado, um após o outro.

Colunas¶

Pseudo-colunas¶

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

Balanço Patrimonial¶

Retorna um Balanço Mensal.

Colunas¶

Pseudo-colunas¶

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

Extrato Bancário¶

Retorna as transações listadas na conta.

Informações Específicas da Tabela¶

Selecione

Um bankAccountId pode ser fornecido ao consultar esta exibição. Se não for fornecido, este relatório será executado para cada conta bancária armazenada no Xero.

Colunas¶

Pseudo-colunas¶

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

BankSummary¶

Retorna os saldos e movimentações de caixa de cada conta bancária.

Colunas¶

Pseudo-colunas¶

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

Temas de Marca¶

Retorna os temas de branding definidos para a organização Xero.

Informações Específicas da Tabela¶

A exibição BrandingThemes permite SELECIONAR temas de marca para uma organização Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

Colunas¶

Linhas Orçamentárias¶

Consultar itens de linha de orçamento para uma organização Xero

Colunas¶

Pseudo-colunas¶

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

Orçamentos¶

Orçamentos de consulta para uma organização Xero

Colunas¶

OrçamentoResumo¶

Retorna um resumo do orçamento mensal.

Colunas¶

Pseudo-colunas¶

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

Contato CISSettings¶

Consulte as configurações do CIS para contatos em uma organização Xero.

Colunas¶

Alocações de Notas de Crédito¶

Consulte alocações de notas de crédito para uma organização Xero.

Colunas¶

Moedas¶

Recupera as moedas para uma organização Xero.

Informações Específicas da Tabela¶

A tabela Moedas permite SELECIONAR moedas para uma organização Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

Colunas¶

Sumário Executivo¶

Retorna um resumo das alterações entre um mês e o mês anterior

Informações Específicas da Tabela¶

Selecione

Uma data pode ser fornecida ao consultar esta visualização. Se não for fornecido, esse relatório comparará o mês atual com o mês anterior.

Colunas¶

Pseudo-colunas¶

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

ExpenseClaimPayments¶

Crie e consultar pagamentos para uma organização Xero.

Ver Informações Específicas¶

A exibição ExpenseClaimPayments permite SELECIONAR pagamentos para diferentes declarações de despesas para uma organização Xero. A coluna ID é gerada pelo conector; ele combina o índice do item de linha com o ExpenseClaimID exclusivo gerado pelo Xero.

Observe que esta tabela não inclui outros tipos de Pagamentos - para recuperá-los, você precisará ler a tabela de Pagamentos.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

Colunas¶

Recibos de Reclamação de Despesas¶

Crie, atualize, exclua e consultar recibos reivindicados para uma organização Xero.

Ver Informações Específicas¶

A exibição ExpenseClaimReceipts permite SELECIONAR itens de linha de recebimento reivindicados para uma organização Xero. A coluna ID é gerada pelo conector; ele combina o índice do item de linha com o ExpenseClaimID exclusivo gerado pelo Xero.

Observe que esta tabela não inclui rascunhos de recibos - para recuperá-los, você precisará ler a tabela de recibos.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

Colunas¶

HistóricoTransferências Bancárias¶

Crie e consultar o histórico e as notas do BankTransfer para uma organização Xero.

Ver Informações Específicas¶

A exibição HistoryBankTransfers permite que você leia as notas criadas em uma transferência e o histórico de alterações nessa transferência. Se um BankTransferId não for fornecido, o histórico de todos os BankTransfers será recuperado.

Colunas¶

Histórico de Reivindicações de Despesas¶

Crie e consultar o histórico e as notas do ExpenseClaim para uma organização Xero.

Ver Informações Específicas¶

A exibição HistoryExpenseClaims permite que você leia as notas criadas em um relatório de despesas e o histórico de alterações nesse relatório de despesas. Se um ExpenseClaimId não for fornecido, o histórico de todos os ExpenseClaims será recuperado.

Colunas¶

Itens de Histórico¶

Crie e consultar o histórico e as notas do item para uma organização Xero.

Ver Informações Específicas¶

A exibição HistoryItems permite que você leia as notas criadas em um item e o histórico de alterações nesse item. Se um ItemId não for fornecido, o histórico de todos os itens será recuperado.

Colunas¶

HistóricoPagamento a Maior¶

Crie e consultar notas e histórico de pagamentos indevidos para uma organização Xero.

Ver Informações Específicas¶

A exibição HistoryOverpayments permite que você leia as notas criadas em um pagamento a maior e o histórico de alterações nesse pagamento a maior. Se um OverpaymentId não for fornecido, o histórico de todos os Overpayments será recuperado.

Colunas¶

HistóricoPagamentos¶

Crie e consultar notas e histórico de pagamentos para uma organização Xero.

Colunas¶

HistóricoPré-pagamentos¶

Crie e consultar notas e histórico de pré-pagamento para uma organização Xero.

Ver Informações Específicas¶

A exibição HistoryPrepayments permite que você leia as notas criadas em um pré-pagamento e o histórico de alterações nesse pré-pagamento. Se um PrepaymentId não for fornecido, o histórico de todos os pagamentos antecipados será recuperado.

Colunas¶

HistóricoRecibos¶

Crie e consultar notas e histórico de recebimentos para uma organização Xero.

Ver Informações Específicas¶

A exibição HistoryReceipts permite que você leia as notas criadas em um recibo e o histórico de alterações nesse recibo. Se um ReceiptId não for fornecido, o histórico de todos os recibos será recuperado.

Colunas¶

HistóricoRepetindoFaturas¶

Crie e consultar o histórico e as notas do RepeatingInvoice para uma organização Xero.

Ver Informações Específicas¶

A exibição HistoryRepeatingInvoices permite que você leia as notas criadas em uma fatura recorrente e o histórico de alterações nessa fatura recorrente. Se um RepeatingInvoiceId não for fornecido, o histórico de todas as RepeatingInvoices será recuperado.

Colunas¶

Diários¶

Consulte os itens de linha em diários para uma organização Xero.

Informações Específicas da Tabela¶

A visualização Diários permite SELECIONAR as linhas do diário em diários para uma organização Xero. A coluna ID é gerada pelo conector; esse valor combina o índice do item de linha com o JournalId exclusivo gerado pelo Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

Colunas¶

Pseudo-colunas¶

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

Organização¶

Consulte os dados da organização para uma organização Xero.

Informações Específicas da Tabela¶

A exibição da organização permite SELECIONAR os dados da organização para uma organização Xero.

SELECIONE

A API do Xero permite ampla filtragem e ordenação. Você pode definir as cláusulas WHERE e ORDER BY em uma consultar para filtrar e ordenar os resultados usando qualquer coluna que não seja de item de linha.

Observação: A API do Xero não oferece suporte à filtragem de itens de linha ou linhas de diário.

Colunas¶