Ir para o conteúdo

Detalhes da Conexão MYOB

Introdução

Versão do conector

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

Começando

Suporte à versão MYOB

O conector utiliza a API MYOB para habilitar o acesso bidirecional ao MYOB.

Estabelecendo uma Conexão

Conectando ao MYOB

Essas propriedades são necessárias ao se conectar a um arquivo da empresa (tanto para instâncias no local quanto na nuvem).

  • User: O nome de usuário associado ao arquivo da sua empresa.

  • CompanyFileId: O ID do arquivo da empresa. Se não for especificado, será usado o ID do primeiro arquivo da empresa retornado. Você pode encontrar isso consultando CompanyFiles visualizar:

    SELECT ID FROM CompanyFiles
    

Conectando-se a uma Instância Local

Ao conectar-se a uma instância local, você precisará definir as seguintes propriedades de conexão, além das acima:

  • InitiateOAuth: Defina como DESLIGADO.
  • URL: A URL da sua instância MYOB.
  • Password: A senha associada ao arquivo da sua empresa.

Conectando-se a uma Instância de Nuvem

Você pode se conectar depois de definir as propriedades de conexão necessárias para suas credenciais de usuário e obter os tokens de acesso necessários usando uma ferramenta como o Postman.

Consulte Usando autenticação OAuth para obter um guia de autenticação e detalhes do fluxo de autenticação OAuth.

Usando Autenticação OAuth

OAuth requer que o usuário autenticado interaja com o MYOB usando o navegador. 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

Em vez de se conectar com as credenciais incorporadas do conector, você pode registrar um aplicativo para obter o OAuthClientId e OAuthClientSecret.

Quando Criar um Aplicativo OAuth Personalizado

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no MYOB e você pode se conectar com suas credenciais incorporadas. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no endpoint MYOB OAuth para conceder permissões ao conector.

Criando um Aplicativo OAuth Personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

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 MYOB.

Visualizações definidas pelo usuário

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

Configuração SSL

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

Procurador

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

Visualizações Definidas pelo Usuário

O Jitterbit Connector for MYOB 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 visualização.
  • Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM Accounts 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 API disponíveis e fornece mais informações sobre como executar SQL para APIs MYOB.

Características principais

  • O conector modela entidades MYOB como contas, ordens de compra e ordens de venda como tabelas e exibições relacionais, permitindo que você escreva SQL para consultar dados MYOB.
  • Procedimentos armazenados* permitem executar operações para MYOB, incluindo recuperar o token de acesso e mantê-lo atualizado no OAuth 2.0.
  • A conectividade ao vivo com esses objetos significa que quaisquer alterações em sua conta MYOB são refletidas imediatamente ao usar o conector.

Mesas

Tabelas descreve as tabelas disponíveis. As tabelas são definidas estaticamente para modelar clientes, PurchaseOrders, SalesOrders e muito mais.

Visualizações

Visualizações estão disponíveis para acesso somente leitura aos dados do MYOB, incluindo AccountRegister e Currencies.

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 MYOB. Procedimentos armazenados* permitem que você execute operações para MYOB, incluindo download e upload de objetos.

Processamento de consulta colaborativa

O conector descarrega o máximo possível do processamento da instrução SELECT para MYOB 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 em MYOB em uma lista de tabelas que podem ser consultadas usando instruções SQL padrão.

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

Nome Descrição
AccountBudgets Retornar e atualizar os orçamentos da conta do razão geral.
Accounts Retorne, atualize, crie e exclua contas para um arquivo da empresa AccountRight.
Activities Retorne, atualize, crie e exclua uma lista de atividades de cobrança de tempo para um arquivo da empresa AccountRight.
Contacts Retorna todos os tipos de contato para um arquivo da empresa AccountRight.
CreditRefunds Devolva, crie e exclua notas de crédito reembolsadas aos clientes para um arquivo da empresa AccountRight.
CreditSettlements Devolva, crie e exclua créditos de clientes liquidados para um arquivo da empresa AccountRight.
CustomerPayments Retorne, crie e exclua pagamentos de clientes para um arquivo da empresa AccountRight.
DebitRefunds Retorne todos os tipos de fatura de compra para um arquivo da empresa AccountRight.
DebitSettlements Retorne, crie e exclua liquidações de débito para um arquivo da empresa AccountRight.
EmployeePaymentDetails Retorne e atualize os detalhes de pagamento do funcionário nos cartões de contato do funcionário para um arquivo da empresa AccountRight.
EmployeePayrollDetails Retorne e atualize os detalhes da folha de pagamento do funcionário nos cartões de contato do funcionário para um arquivo da empresa AccountRight.
EmployeeStandardPay Retorne e atualize os detalhes de pagamento padrão do funcionário nos cartões de contato do funcionário para um arquivo da empresa AccountRight.
InventoryAdjustment Retornar, atualizar, criar e excluir diários de ajuste de estoque
ItemPriceMatrices Retorne e atualize a matriz de preço do item para vários preços de venda do cliente.
Items Devolva, atualize, crie e exclua itens de estoque para um arquivo da empresa AccountRight.
JobBudgets Retornar e atualizar orçamentos de trabalho.
Jobs Devolva, atualize, crie e exclua um trabalho para um arquivo da empresa AccountRight.
Journals Retorne, atualize, crie e exclua transações de diário geral para um arquivo da empresa AccountRight.
PayrollWages Retorne, atualize, crie e exclua categorias de folha de pagamento do tipo salário para um arquivo da empresa AccountRight.
PurchaseBills Retorne todos os tipos de fatura de compra para um arquivo da empresa AccountRight.
PurchaseOrders Retorne todos os tipos de ordem de compra para um arquivo da empresa AccountRight.
ReceivingTransactions Retorne, atualize, crie e exclua transações de recebimento de dinheiro para um arquivo da empresa AccountRight.
SaleInvoices Retorne todos os tipos de fatura de venda para um arquivo da empresa AccountRight.
SaleOrders Retorna todos os tipos de pedidos de venda para um arquivo da empresa AccountRight.
SaleQuotes Retorna todos os tipos de cotação de venda para um arquivo da empresa AccountRight.
SpendingTransactions Devolva, atualize, crie e exclua transações de dinheiro gasto para um arquivo da empresa AccountRight.
SupplierPayments Retorne, crie e exclua pagamentos de fornecedores para um arquivo da empresa AccountRight.
TaxCodes Códigos de imposto para um arquivo da empresa AccountRight.
TimesheetLineEntries Retornar entradas de quadro de horários para um arquivo da empresa AccountRight
TimesheetLineItems Retornar entradas de quadro de horários para um arquivo da empresa AccountRight
Timesheets Retornar entradas de quadro de horários para um arquivo da empresa AccountRight
TransferringTransactions Retornar, atualizar, criar e excluir transações de transferência de dinheiro para um arquivo da empresa AccountRight.

Orçamentos da Conta

Retornar e atualizar os orçamentos da conta do razão geral.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: FinancialYear, LastMonthInFinancialYear. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM AccountBudgets WHERE FinancialYear = 13
SELECT * FROM AccountBudgets WHERE LastMonthInFinancialYear = 41
Colunas
Nome Tipo Somente leitura Descrição
FinancialYear Integer Falso O ano financeiro pode consistir apenas no ano fiscal atual ou no próximo ano fiscal.
LastMonthInFinancialYear Integer Verdadeiro Número que representa o último mês do exercício financeiro. Por exemplo, 3 indica março.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
Budgets String Falso Uma matriz de informações de orçamento da conta.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Contas

Retorne, atualize, crie e exclua contas para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Classification, CurrentBalance, Description, DisplayID, IsActive, IsHeader, Level, Name, Number, OpeningBalance, Type, LastReconciledDate, BankingBSBNumber, BankingAccountName, BankingAccountNumber, BankingCode, BankingCompanyTradingName, BankingCreateBankFiles, BankingDirectEntryUserId, BankingIncludeSelfBalancingTransaction, BankingStatementParticulares, ForeignCurrencyID, ForeignCurrencyCode, ForeignCurrencyCurrencyName, ParentAccountID, ParentAccountDisplayID, ParentAccountName, TaxCodeID, TaxCodeCode. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM Accounts WHERE ID = REPLACE
SELECT * FROM Accounts WHERE Classification = "criteria"
SELECT * FROM Accounts WHERE CurrentBalance = 40.72729281968018
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: Número, Tipo, TaxCodeID.

INSERT INTO Accounts(Number, Type, TaxCodeID) VALUES(101, "bank", "2619bed9-3750-45b5-b353-18f5651beb01")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Falso Identificador exclusivo na forma de um guid.
Classification String Falso A classificação da conta pode ser uma das seguintes: (1) Ativo, (2) Passivo, (3) Patrimônio líquido, (4) Receita, (5) Custo de vendas, (6) Despesa, (8) Outras receitas, (9) Outras despesas.
CurrentBalance Decimal Verdadeiro Saldo atual da conta. Observe que esse saldo incluirá todas as atividades com data futura.
Description String Falso Uma descrição da conta.
DisplayID String Falso O formato do código de conta inclui separador, por exemplo, 1-1100
IsActive Boolean Falso True indica que a conta está ativa. Falso indica que a conta está inativa. Um usuário marca uma conta como inativa quando não precisa mais registrar transações nela
IsHeader Boolean Falso Verdadeiro indica que a conta é uma conta cabeçalho. As contas principais são usadas para organizar, agrupar e subtotalizar contas na Lista de contas e relatórios. Falso indica que a conta é uma conta detalhada. Somente contas detalhadas podem ser atribuídas a transações.
Level Integer Falso O nível hierárquico da conta na Lista de contas. Os valores possíveis são 1, 2, 3, 4. As contas de nível mais alto são o nível 1, as mais baixas 4. Você só pode atribuir os níveis 2 a 4 a uma nova conta.
Name String Falso Nome da conta.
Number Integer Falso Número da conta, por exemplo, 1150. Deve ser um número exclusivo de quatro dígitos que não inclua o número de classificação do tipo de conta e o separador de conta.
OpeningBalance Decimal Falso Saldo da conta na data de conversão definida para o arquivo da empresa.
Type String Falso Dependendo da classificação da conta (por exemplo, ativo), você pode definir o tipo de conta, veja aqui mais informações sobre os tipos de conta.
LastReconciledDate Datetime Verdadeiro Mostra a data em que a Conta foi reconciliada pela última vez. Isso retornará como nulo se a conta nunca tiver sido reconciliada.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
BankingBSBNumber String Falso BSB conforme fornecido pela instituição financeira.
BankingAccountName String Falso Configuração do nome da conta bancária.
BankingAccountNumber Integer Falso Número da conta fornecido pela instituição financeira.
BankingCode String Falso Código do banco fornecido pela instituição financeira.
BankingCompanyTradingName String Falso Nome comercial da empresa, se aplicável para conta bancária.
BankingCreateBankFiles Boolean Falso True indica que a conta bancária será usada para criar arquivos bancários (ABA). Falso indica que a conta bancária não será usada para criar arquivos bancários.
BankingDirectEntryUserId String Falso ID de usuário de entrada direta conforme fornecido pela instituição financeira.
BankingIncludeSelfBalancingTransaction Boolean Falso Verdadeiro indica que a conta bancária requer uma transação de auto balanceamento. Falso indica que a conta bancária não requer uma transação de auto-balanceamento.
BankingStatementParticulars String Falso Detalhes do extrato atribuído à conta bancária.
ForeignCurrencyID Uuid Verdadeiro Identificador exclusivo na forma de um guid.
ForeignCurrencyCode String Verdadeiro O código da moeda.
ForeignCurrencyCurrencyName String Verdadeiro O nome completo da moeda.
ForeignCurrencyURI String Verdadeiro Identificador de recurso uniforme associado à compra.
ParentAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
ParentAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
ParentAccountName String Verdadeiro Nome da conta.
ParentAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
TaxCodeID Uuid Falso Identificador de guid exclusivo pertencente ao código de imposto atribuído.
TaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
TaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Atividades

Retorne, atualize, crie e exclua uma lista de atividades de cobrança de tempo para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Description, DisplayID, IsActive, Name, Status, Type, UnitOfMeasurement, IncomeAccountID, IncomeAccountDisplayID, IncomeAccountName, ChargeableRate, UseDescriptionOnSales, TaxCodeID, TaxCodeCode. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM Activities WHERE ID = REPLACE
SELECT * FROM Activities WHERE Description = "criteria"
SELECT * FROM Activities WHERE DisplayID = "criteria"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: DisplayID, IncomeAccountID, TaxCodeID, Type, Status.

INSERT INTO Activities(DisplayID, IncomeAccountID, TaxCodeID, Type, Status) values("test", "0b9b6098-1a9e-499d-bf41-b863a6daad9c", "2619bed9-3750-45b5-b353-18f5651beb01", "Hourly", "Chargeable"
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
Description String Falso Descrição do objeto.
DisplayID String Falso ID de exibição do objeto.
IsActive Boolean Falso Verdadeiro ou falso.
Name String Falso Nome do objeto.
Status String Falso Pode consistir no seguinte: Cobrável usado para incluir faturas de cobrança pontual. NonChargeable usado quando não cobra clientes, mas ainda deseja incluir no recibo de atividade.
Type String Falso Por hora ou não por hora.
UnitOfMeasurement String Falso Hourly - Se Type = Hourly então UnitOfMeasurement = Hour. NonHourly - especifique o tipo de medição
IncomeAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
IncomeAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
IncomeAccountName String Verdadeiro Nome da conta.
IncomeAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
ChargeableRate String Verdadeiro Taxa que pode consistir no seguinte: EmployeeBillingRate - proveniente do cartão de contato do funcionário. CustomerBillingRate - proveniente do cartão de contato do cliente. ActivityRate - inserido na atividade e sem impostos.
UseDescriptionOnSales Boolean Verdadeiro Verdadeiro ou falso.
TaxCodeID Uuid Falso Identificador de guid exclusivo pertencente ao código de imposto atribuído.
TaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
TaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Contatos

Retorna todos os tipos de contato para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor:

| | | | ------------------------ | ------------------------------------------------- | -------------------------------- | ---------------------- | | ABN | Filial ABNB | ComprarABN | CompraABNBranch | CompraCustoPorHora | | CompraFormulárioImpresso | CompraCompraComentário | CompraCompraLayout | CompraCompraPedidoEntrega | ComprarMétodo de Envio | | CompraFornecedorFaturamentoTaxa | Nome da empresa | CréditoDisponível | Limite de Crédito | CreditOnHold | | BuyingIsReportable | CompraPagamentoMemorando | Crédito Vencido | Saldo Atual | DisplayID | | EmployeePaymentDetailsID | EmployeePayrollDetailsID | EmployeeStandardPayID | ExpenseAccountDisplayID | ExpenseAccountID | | ExpenseAccountName | Nome | FreightTaxCodeCode | FreightTaxCodeID | HourlyBillingRate | | Identificação | FaturaEntrega | está ativo | éIndividual | Sobrenome | | Última modificação | Memorando | Notas | PaymentBankAccountName | PaymentBankAccountNumber | | PagamentoBSBNúmero | PagamentoÚltimoModificado | PaymentRefundCardNumber | PagamentoReembolsoNomeNoCartão | PagamentoReembolsoNotas | | PaymentRefundPaymentMethod | ExtratoPagamentoTexto | Formulário Impresso | ReceiptMemo | VendaComentário | | VendaLayout | Método de envio | TaxCodeCode | TaxCodeID | Termos Saldo Vencimento | | CondiçõesDescontoData | CondiçõesDescontoParaPagamento Antecipado | TermosMonthlyChargeForLatePayment | TermosPagamentoÉDevido | TermosVolumeDesconto | | TimeBillingDetailsCostPerHour | TimeBillingDetailsEmployeeBillingRateExcludingTax | UseCustomerTaxCode | |

Todas as outras colunas e operadores são processados no lado do cliente. O tipo oferece suporte apenas à comparação de igualdade.

SELECT * FROM Contacts WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM Contacts WHERE Type = "Customer"
SELECT * FROM Contacts WHERE FirstName = "James" OR FirstName = "John"
Atualizar

Para atualizar um contato existente, juntamente com os endereços, podemos passar uma string JSON para o valor de entrada agregado ou usar uma tabela temporária como abaixo.

INSERT INTO ContactAddressItems#TEMP(City, Country) VALUES ("Paris", "France")
UPDATE Contacts SET FirstName = "James", Addresses = "ContactAddressItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
Inserir

Os seguintes atributos são obrigatórios ao realizar uma inserção: Type, CompanyName (se IsIndividual = false), FirstName, LastName, IsIndividual. Além disso, para os tipos "Cliente" e "Fornecedor", são necessários "SellingTaxCodeID, SellingFreightTaxCodeID" e "BuyingTaxCodeID, BuyingFreightTaxCodeID", respectivamente.

INSERT INTO Contacts(Type, FirstName, LastName, IsIndividual, SellingTaxCodeID, SellingFreightTaxCodeID) VALUES ("Customer", "James", "Bond", true, "446d2226-254b-4821-acc2-7031842e0166", "446d2226-254b-4821-acc2-7031842e0166")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
CurrentBalance Decimal Falso Equilíbrio de contato.
FirstName String Falso Nome do contato.
LastName String Falso Sobrenome do contato.
CompanyName String Falso Nome da empresa de contato.
IsActive Boolean Falso True indica que o contato do funcionário está ativo. Falso indica que o contato do funcionário está inativo.
IsIndividual Boolean Falso True indica que o contato do funcionário representa um indivíduo. Falso indica que o contato do funcionário representa uma empresa.
LastModified String Falso Extrai a data da última modificação do recurso de contato.
Notes String Falso Notas para o contato.
PhotoURI String Falso Identificador de recurso uniforme associado a uma imagem fotográfica.
Type String Falso Tipo de Contato. Um de: Cliente, Fornecedor, Pessoal, Funcionário.
DisplayID String Falso Exibir ID para o cartão de contato.
SellingABN String Verdadeiro Número ABN (deve ter 11 dígitos e formatado como XX XXX XXX XXX).
SellingABNBranch String Verdadeiro Número da agência ABN.
SellingCreditAvailable Integer Verdadeiro Crédito disponível.
SellingCreditLimit Integer Verdadeiro Limite de crédito.
SellingCreditOnHold Boolean Verdadeiro Crédito em espera.
SellingCreditPastDue Integer Verdadeiro Saldo vencido.
SellingFreightTaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
SellingFreightTaxCodeID Uuid Verdadeiro Identificador de guid exclusivo pertencente ao código de imposto atribuído.
SellingFreightTaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
SellingHourlyBillingRate Double Verdadeiro A taxa de cobrança por hora dos clientes.
SellingInvoiceDelivery String Verdadeiro Status de entrega de fatura padrão atribuído.
SellingItemPriceLevel String Verdadeiro O nível de preço do item pode consistir no seguinte: Preço de venda base, Nível A, Nível B, Nível C, Nível D, Nível E, Nível F.
SellingMemo String Verdadeiro Texto de memorando padrão.
SellingPrintedForm String Verdadeiro Formulário nomeado selecionado como formulário impresso padrão.
SellingReceiptMemo String Verdadeiro Memorando de recebimento padrão.
SellingSaleComment String Verdadeiro Comentário de venda selecionado padrão.
SellingSaleLayout String Verdadeiro Tipo de venda do registro que contém a definição completa do layout de venda padrão: NoDefault, Service, Item, Professional, TimeBilling, Miscellaneous.
SellingShippingMethod String Verdadeiro Texto do método de envio.
SellingTaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
SellingTaxCodeID Uuid Verdadeiro Identificador de guid exclusivo pertencente ao código de imposto atribuído.
SellingTaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
SellingTermsBalanceDueDate Integer Verdadeiro A data da entrada.
SellingTermsDiscountDate Integer Verdadeiro A data da entrada.
SellingTermsDiscountForEarlyPayment Double Verdadeiro % de desconto para pagamento antecipado.
SellingTermsMonthlyChargeForLatePayment Double Verdadeiro % de cobrança mensal por atraso no pagamento.
SellingTermsPaymentIsDue String Verdadeiro Definições de termos de pagamento padrão: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
SellingTermsVolumeDiscount Integer Verdadeiro Desconto de fornecedores por volume.
SellingUseCustomerTaxCode Boolean Verdadeiro True indica o uso do código de imposto do cliente. False indica não usar o código de imposto do cliente.
BuyingABN String Verdadeiro Número ABN (deve ter 11 dígitos e formatado como XX XXX XXX XXX).
BuyingABNBranch String Verdadeiro Número da agência ABN.
BuyingCostPerHour Double Verdadeiro Custo por hora de prestação de serviços dos fornecedores ao gerar um deslizamento de atividade.
BuyingCreditAvailable Double Verdadeiro Crédito disponível.
BuyingCreditLimit Double Verdadeiro Limite de crédito.
BuyingCreditPastDue Double Verdadeiro Saldo vencido.
BuyingExpenseAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
BuyingExpenseAccountID Uuid Verdadeiro Identificador exclusivo da conta na forma de um guid.
BuyingExpenseAccountName String Verdadeiro Nome da conta.
BuyingExpenseAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
BuyingFreightTaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
BuyingFreightTaxCodeID Uuid Verdadeiro Identificador de guid exclusivo pertencente ao código de imposto atribuído.
BuyingFreightTaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
BuyingIsReportable Boolean Verdadeiro Verdadeiro indica que o contato do fornecedor está configurado para pagamentos tributáveis reportáveis. Falso indica que o contato do fornecedor não está configurado para pagamentos tributáveis reportáveis.
BuyingPaymentMemo String Verdadeiro Memorando de pagamento padrão.
BuyingPrintedForm String Verdadeiro Formulário nomeado selecionado como formulário impresso padrão.
BuyingPurchaseComment String Verdadeiro Comentário de compra selecionado padrão.
BuyingPurchaseLayout String Verdadeiro Tipo de compra do registro que contém a definição completa do layout de compra padrão: NoDefault, Service, Item, Professional, Miscellaneous.
BuyingPurchaseOrderDelivery String Verdadeiro Status de entrega do fornecedor padrão.
BuyingShippingMethod String Verdadeiro Texto do método de envio.
BuyingSupplierBillingRate Double Verdadeiro A taxa de faturamento por hora dos fornecedores sem impostos.
BuyingTaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
BuyingTaxCodeID Uuid Verdadeiro Identificador de guid exclusivo pertencente ao código de imposto atribuído.
BuyingTaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
BuyingTermsBalanceDueDate Integer Verdadeiro Se PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber ou NumberOfDaysAfterEOM, defina o número de dias em que os pagamentos devem ser feitos. Se PaymentIsDue = OnADayOfTheMonth ou DayOfMonthAfterEOM, defina o dia do mês em que os pagamentos devem ser feitos.
BuyingTermsDiscountDate Integer Verdadeiro Se PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber ou NumberOfDaysAfterEOM, defina o número de dias em que os pagamentos devem ser feitos para receber descontos. Se PaymentIsDue = OnADayOfTheMonth ou DayOfMonthAfterEOM, defina o dia do mês em que o pagamento deve ser feito para receber descontos.
BuyingTermsDiscountForEarlyPayment Double Verdadeiro % de desconto para pagamento antecipado.
BuyingTermsPaymentIsDue String Verdadeiro Definições de termos de pagamento padrão: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
BuyingTermsVolumeDiscount Double Verdadeiro Desconto de volume.
BuyingUseSupplierTaxCode Boolean Verdadeiro Verdadeiro ou falso.
PaymentBSBNumber String Verdadeiro Número bsb da conta bancária padrão.
PaymentBankAccountName String Verdadeiro Nome da conta bancária padrão.
PaymentBankAccountNumber String Verdadeiro formatado (XX-XXXX-XXXXXXX-XX).
PaymentLastModified String Verdadeiro Extrai a data da última modificação do recurso de contato.
PaymentPhotoURI String Verdadeiro Identificador de recurso uniforme associado a uma imagem fotográfica.
PaymentRefundCardNumber String Verdadeiro Apenas os últimos 4 dígitos.
PaymentRefundNameOnCard String Verdadeiro Nome padrão no cartão.
PaymentRefundNotes String Verdadeiro Notas de pagamento de reembolso padrão.
PaymentRefundPaymentMethod String Verdadeiro O método de pagamento no reembolso deve existir no arquivo da empresa, os métodos padrão consistem no seguinte: American Express, Cartão bancário, Cartão de troca, Dinheiro, Cheque, Diners Club, EFTPOS, MasterCard, Ordem de pagamento, Outro, Visa.
PaymentRowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
PaymentStatementText String Verdadeiro Texto de instrução padrão.
PaymentURI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
EmployeePaymentDetailsID Uuid Verdadeiro Identificador exclusivo na forma de um guid.
EmployeePaymentDetailsURI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
EmployeePayrollDetailsID Uuid Verdadeiro Identificador exclusivo na forma de um guid.
EmployeePayrollDetailsURI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
EmployeeStandardPayID Uuid Verdadeiro Identificador exclusivo na forma de um guid.
EmployeeStandardPayURI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
TimeBillingDetailsCostPerHour Double Verdadeiro Custo por hora do funcionário para a empresa.
TimeBillingDetailsEmployeeBillingRateExcludingTax Double Verdadeiro Taxa de cobrança por hora de serviços prestados por funcionário
Identifiers String Verdadeiro Detalhes dos identificadores de contato.
CustomField1Label String Verdadeiro Rótulo personalizado do Campo 1.
CustomField1Value String Verdadeiro Valor do campo personalizado 1.
CustomField2Label String Verdadeiro Rótulo de campo personalizado 2.
CustomField2Value String Verdadeiro Valor do campo personalizado 2.
CustomField3Label String Verdadeiro Rótulo de campo personalizado 3.
CustomField3Value String Verdadeiro Valor do campo personalizado 3.
CustomList1Label String Verdadeiro Rótulo personalizado da Lista 1.
CustomList1Value String Verdadeiro Valor personalizado da Lista 1.
CustomList2Label String Verdadeiro Rótulo personalizado da Lista 2.
CustomList2Value String Verdadeiro Valor personalizado da Lista 2.
CustomList3Label String Verdadeiro Rótulo personalizado da Lista 3.
CustomList3Value String Verdadeiro Valor personalizado da lista 3.
Addresses String Falso O conjunto de informações a seguir extrai detalhes de um endereço de contato.
RowVersion String Falso Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

CreditReembolsos

Devolva, crie e exclua notas de crédito reembolsadas aos clientes para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Data, DeliveryStatus, Memo, Number, Payee, Amount, ChequePrinted, AccountID, AccountDisplayID, AccountName, CustomerID, CustomerDisplayID, CustomerName, InvoiceID, InvoiceNumber. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM CreditRefunds WHERE ID = "6d35e53a-5070-432d-b9ec-f4791e353352
SELECT * FROM CreditRefunds WHERE AccountName = "AccountName"
SELECT * FROM CreditRefunds WHERE Amount = 340.44
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: Data, Valor, AccountID, CustomerID, InvoiceID.

INSERT INTO CreditRefunds(Date, Amount, AccountID, CustomerID, InvoiceID) VALUES("01/02/2019", 54, "3a35e83a-5070-432d-b6ec-f4791f353352", "2619bed9-3750-45b5-b353-18f5651beb01", "f6703af2-7494-4ecc-b0f6-b2bb9c813782")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
Date Datetime Falso Data da transação.
DeliveryStatus String Falso Status de entrega do aviso de remessa atribuído à nota de crédito: Print = ToBePrinted, E-mail = ToBeEmailed, PrintAndEmail = ToBePrintedAndEmailed, Nothing = YetPrintedOrSent.
Memo String Falso Texto do memorando descrevendo o reembolso do crédito.
Number String Falso Número da fatura de venda
Payee String Falso Endereço do beneficiário na nota de crédito pertencente ao contato do cliente.
Amount Decimal Falso O valor total do crédito a ser reembolsado pode ser igual ou inferior ao valor da fatura.
ChequePrinted Boolean Falso Verdadeiro ou falso.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
AccountID Uuid Verdadeiro Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Verdadeiro Nome da conta.
AccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
CustomerID Uuid Verdadeiro Identificador de guid exclusivo pertencente ao contato do cliente atribuído.
CustomerDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do cliente.
CustomerName String Verdadeiro Nome do contato do cliente.
CustomerURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do cliente.
InvoiceID Uuid Falso Identificador exclusivo na forma de um guid.
InvoiceNumber String Verdadeiro Número da fatura.
InvoiceURI String Verdadeiro Identificador de recurso uniforme associado à fatura.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Liquidações de Crédito

Devolva, crie e exclua créditos de clientes liquidados para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Data, Memorando, Número, CreditAmount, CreditFromInvoiceID, CreditFromInvoiceNumber, CustomerID, CustomerDisplayID, CustomerName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM CreditSettlements WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM CreditSettlements WHERE CustomerID = "07763f97-43cc-4149-8c00-d92feb4e1404"
SELECT * FROM CreditSettlements WHERE Memo = "memo"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: Date, CreditFromInvoiceID, CustomerID.

Para inserir os valores Lines em CreditSettlements, podemos passar os dados JSON como uma string ou usar uma tabela temporária como abaixo.

INSERT INTO CreditSettlementItems#TEMP(AmountApplied, Type, SaleId) VALUES(444.21, "Invoice", "0229a075-f93a-4b6c-85d7-0ffd5ba43982")
INSERT INTO CreditSettlements(Date, CreditFromInvoiceID, CustomerID, Lines) VALUES("01/01/2019", "07763f97-43cc-4149-8c00-d92feb4e1404", "6aaccbbf-2a21-44eb-8462-dfff3117dd5a", "CreditSettlementItems#TEMP")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
Date Datetime Falso Data da transação.
Memo String Falso Texto memorando descrevendo o crédito liquidado.
Number String Falso Verifique o número de crédito, opcional no POST, pois será incrementado automaticamente com base no último registro, se deixado em branco.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
CreditAmount Decimal Verdadeiro O valor total do crédito a ser aplicado só pode ser menor ou igual ao valor do CreditFromInvoice.
CreditFromInvoiceID Uuid Falso Identificador exclusivo na forma de um guid.
CreditFromInvoiceNumber String Verdadeiro Número da fatura.
CreditFromInvoiceURI String Verdadeiro Identificador de recurso uniforme associado à fatura.
CustomerID Uuid Falso Identificador de guid exclusivo pertencente ao contato do cliente atribuído.
CustomerDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do cliente.
CustomerName String Verdadeiro Nome do contato do cliente.
CustomerURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do cliente.
Lines String Falso O conjunto de informações a seguir extrai os detalhes da linha para a liquidação de crédito.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Pagamentos do Cliente

Retorne, crie e exclua pagamentos de clientes para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Date, DepositTo, AmountReceived, Memo, PaymentMethod, ReceiptNumber, AccountID, AccountDisplayID, AccountName, CustomerID, CustomerDisplayID, CustomerName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM CustomerPayments WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM CustomerPayments WHERE CustomerID = "0229a075-f93a-4b6c-85d7-0ffd5ba43982"
SELECT * FROM CustomerPayments WHERE AmountReceived = 1399.99
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: DepositTo, AccountID, CustomerID, Invoices.

Para inserir os valores de Invoices em CustomerPayments, podemos passar os dados JSON como uma string ou usar uma tabela temporária como abaixo.

INSERT INTO CustomerPaymentInvoices#TEMP(AmountApplied, ID, Type) VALUES (444.21, " 0229a075-f93a-4b6c-85d7-0ffd5ba43982", "Order")
INSERT INTO CustomerPayments(DepositTo, AccountID, CustomerID, Invoices) VALUES("Account", "ee9824a1-26d7-4501-8c19-83bc1fd84167", "ee9824a1-26d7-4501-8c19-83bc1fd84167", "CustomerPaymentInvoices#TEMP")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
Date Datetime Falso A data da entrada.
DepositTo String Falso Se alocar uma conta bancária para o pagamento, especifique Conta. Se estiver usando fundos não depositados, especifique UndepositedFunds.
AmountReceived Double Falso A quantia recebida.
Memo String Falso Texto de memorando para o objeto.
PaymentMethod String Falso Um dos seguintes: American Express, Bank Card, Barter Card, Cash, Cheque, Diners Club, EFTPOS, MasterCard, Money Order, Other, Visa.
ReceiptNumber String Falso ID Nº da transação de pagamento.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
AccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Verdadeiro Nome da conta.
AccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
CustomerID Uuid Falso Identificador de guid exclusivo pertencente ao contato do cliente atribuído.
CustomerDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do cliente.
CustomerName String Verdadeiro Nome do contato do cliente.
CustomerURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do cliente.
Invoices String Falso Uma matriz de informações de fatura de linha.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

DébitoReembolsos

Retorne todos os tipos de fatura de compra para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Amount, Date, DepositTo, Memo, Number, PaymentMethod, BillID, BillNumber, AccountID, AccountDisplayID, AccountName, SupplierID, SupplierDisplayID, SupplierName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM DebitRefunds WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM DebitRefunds WHERE Amount = 1600.00
SELECT * FROM DebitRefunds WHERE AccountName = "Processing account"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: Amount, Date, DepositTo, BillID, AccountID.

INSERT INTO DebitRefunds(Date, Amount, AccountID, DepositTo, BillID) VALUES("01/02/2019", 54, "3a35e83a-5070-432d-b6ec-f4791f353352", "Account", "f6703af2-7494-4ecc-b0f6-b2bb9c813782")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
Amount Double Falso Valor total do débito a ser reembolsado, podendo ser igual ou inferior ao valor da fatura.
Date Datetime Falso A data da entrada.
DepositTo String Falso Se alocar uma conta bancária para o pagamento, especifique Conta. Se estiver usando fundos não depositados, especifique UndepositedFunds.
Memo String Falso Texto de memorando para o objeto.
Number String Falso Número da fatura de compra.
PaymentMethod String Falso Texto da forma de pagamento.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
BillID Uuid Falso Identificador exclusivo na forma de um guid.
BillNumber String Verdadeiro Número da conta.
BillURI String Verdadeiro Identificador de recurso uniforme associado à fatura.
AccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Verdadeiro Nome da conta.
AccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
SupplierID Uuid Falso Identificador de guid exclusivo pertencente ao contato do fornecedor atribuído.
SupplierDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do fornecedor.
SupplierName String Verdadeiro Nome do contato do fornecedor.
SupplierURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do fornecedor.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Liquidações de Débito

Retorne, crie e exclua liquidações de débito para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Data, Memorando, Número, DebitAmount, DebitFromBillID, DebitFromBillNumber, SupplierID, SupplierDisplayID, SupplierName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM DebitSettlements WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM DebitSettlements WHERE DebitAmount = 2600
SELECT * FROM DebitSettlements WHERE Memo = "memo"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: Date, DebitFromBillID, Lines.

Para inserir os valores Lines em DebitSettlements, podemos passar os dados JSON como uma string ou usar uma tabela temporária como abaixo.

INSERT INTO DebitSettlementItems#TEMP(AmountApplied, Type, Purchaseid) VALUES (444.21, "Order", "0229a075-f93a-4b6c-85d7-0ffd5ba43982")
INSERT INTO DebitSettlements(Date, DebitFromBillID, Lines) VALUES ("01/01/2019", "07763f97-43cc-4149-8c00-d92feb4e1404", "6aaccbbf-2a21-44eb-8462-dfff3117dd5a", "DebitSettlementItems#TEMP")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
Date Datetime Falso A data da entrada.
Memo String Falso Texto de memorando para o objeto.
Number String Falso O número da transação de ID, se deixado em branco no POST, será incrementado automaticamente com base no último registro.
DebitAmount Double Falso O valor total do débito a ser aplicado só pode ser menor ou igual ao valor DebitFromBill.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
DebitFromBillID Uuid Falso Identificador exclusivo na forma de um guid.
DebitFromBillNumber String Verdadeiro Número da conta.
DebitFromBillURI String Verdadeiro Identificador de recurso uniforme associado à fatura.
SupplierID Uuid Falso Identificador de guid exclusivo pertencente ao contato do fornecedor atribuído.
SupplierDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do fornecedor.
SupplierName String Verdadeiro Nome do contato do fornecedor.
SupplierURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do fornecedor.
Lines String Falso O conjunto de informações a seguir extrai os detalhes da linha para a liquidação do débito.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Dados de Pagamento do Empregado

Retorne e atualize os detalhes de pagamento do funcionário nos cartões de contato do funcionário para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, BankStatementText, PaymentMethod, EmployeeID, EmployeeDisplayID, EmployeeName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM EmployeePaymentDetails WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM EmployeePaymentDetails WHERE EmployeeID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
Atualizar

Para atualizar os detalhes de pagamento de um funcionário existente, juntamente com suas BankAccounts, podemos passar uma string JSON para o valor BankAccounts ou usar uma tabela temporária como abaixo. Observação: isso substituirá todas as contas bancárias atuais pelas abaixo.

INSERT INTO EmployeeBankAccountItems#TEMP(BSBNumber, BankAccountName, BankAccountNumber, Unit, Value) VALUES ("341-241", "123412341", "Mr A Long", 100, "Percent")
UPDATE EmployeePaymentDetails SET BankAccounts = "EmployeeBankAccountItems#TEMP" WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
BankStatementText String Falso Texto a ser exibido no extrato bancário do funcionário em que PaymentMethod = Electronic.
PaymentMethod String Falso O método de pagamento pode consistir nos seguintes valores Enum: Dinheiro, Cheque, Eletrônico.
EmployeeID Uuid Falso Identificador de guid exclusivo pertencente ao contato do funcionário atribuído.
EmployeeDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do funcionário.
EmployeeName String Verdadeiro Nome do contato do funcionário.
EmployeeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do funcionário.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
BankAccounts String Falso Uma matriz de informações da conta bancária do funcionário em que PaymentMethod = Electronic.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Detalhes da Folha de Pagamento do Funcionário

Retorne e atualize os detalhes da folha de pagamento do funcionário nos cartões de contato do funcionário para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, DateOfBirth, Gender, PaySlipDelivery, PaySlipEmail, StartDate, TimeBillingCostPerHour, TimeBillingEmployeeBillingRateExcludingTax, EmploymentBasis, EmploymentCategory, EmploymentStatus, EmployeeID, EmployeeDisplayID, EmployeeName, EmploymentClassificationID, EmploymentClassificationName, TaxCatego ryID, TaxCategoryName, TaxCategoryType, TaxTableID, TaxTableName, TaxFileNumber, TaxTotalRebatesPerYear, TaxWithholdingVariationRate, TaxExtraTaxPerPay, WageAnnualSalary, WageHourlyRate, WageHoursInWeeklyPayPeriod, WagePayBasis, WagePayFrequency, WagesExpenseAccountID, WagesExpenseAccountDisplayID, WagesExpenseAccountName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM EmployeePayrollDetails WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM EmployeePayrollDetails WHERE TaxTableID = "a3ed306d-2da1-49b3-9023-353c3dffb2e9"
SELECT * FROM EmployeePayrollDetails WHERE StartDate = "01/02/2019"
Atualizar

Para atualizar uma lista agregada de detalhes de folha de pagamento existente, podemos passar uma string JSON para o valor de entrada agregado ou usar uma tabela temporária como abaixo.

INSERT INTO EmployeePayrollDeductionItems#TEMP(ID) VALUES ("a7ld306u-2da1-49b2-90f3-111c3dffb2e2)
UPDATE EmployeePayrollDetails SET Deductions = "EmployeePayrollDeductionItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
DateOfBirth Datetime Falso A data de nascimento do empregado.
Gender String Falso Gênero do contato do funcionário.
PaySlipDelivery String Falso Os métodos pelos quais o contracheque pode ser enviado: ToBePrinted (Padrões a serem impressos em PUT se não for especificado), ToBeEmailed, ToBePrintedAndEmailed, YetPrintedOrSent.
PaySlipEmail String Falso Endereço E-mail para o qual os recibos de vencimento devem ser enviados.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
StartDate Datetime Falso Data final do período.
TimeBillingCostPerHour Double Verdadeiro Custo por hora.
TimeBillingEmployeeBillingRateExcludingTax Double Verdadeiro Taxa de cobrança por hora para serviços prestados pelo funcionário.
EmploymentBasis String Falso A base de emprego pode consistir no seguinte: Individual (Padrão para individual em PUT, se não especificado), Contratação de mão de obra, Outro.
EmploymentCategory String Falso A categoria de emprego pode consistir no seguinte: Permanente (Padrão para permanente em PUT se não for especificado), Temporário.
EmploymentStatus String Falso O status de emprego pode consistir no seguinte: FullTime (Padrão para full time em PUT se não for especificado), PartTime, Other, Casual.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
EmployeeID Uuid Falso Identificador de guid exclusivo pertencente ao contato do funcionário atribuído.
EmployeeDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do funcionário.
EmployeeName String Verdadeiro Nome do contato do funcionário.
EmployeeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do funcionário.
EmploymentClassificationID Uuid Falso Identificador exclusivo da conta na forma de um guid.
EmploymentClassificationName String Verdadeiro Nome da classificação do emprego.
EmploymentClassificationURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de classificação de emprego.
TaxCategoryID Uuid Falso Identificador de categoria exclusivo na forma de um guid.
TaxCategoryName String Verdadeiro Nome da categoria.
TaxCategoryType String Verdadeiro Indica o tipo de categoria da folha de pagamento, ou seja: Salário, Dedução, Aposentadoria.
TaxCategoryURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de categoria.
TaxTableID Uuid Falso Identificador exclusivo da conta na forma de um guid.
TaxTableName String Verdadeiro Nome da tabela de impostos.
TaxTableURI String Verdadeiro Identificador de recurso uniforme associado ao objeto da tabela de impostos.
TaxFileNumber String Falso Número de contribuinte do funcionário (deve ter 9 dígitos e formatado como XXX XXX XXX).
TaxTotalRebatesPerYear Double Falso O valor total de compensação de descontos do funcionário.
TaxWithholdingVariationRate Double Falso Taxa de % que se aplica se a tabela de impostos selecionada = Variação de Retenção.
TaxExtraTaxPerPay Double Verdadeiro Os funcionários pagam o imposto extra retido na fonte.
WageAnnualSalary Decimal Verdadeiro Valor do salário anual do funcionário.
WageHourlyRate Decimal Verdadeiro Taxa horária do empregado.
WageHoursInWeeklyPayPeriod Decimal Verdadeiro Horas trabalhadas em um período de pagamento. O padrão é 40 em PUT, se não for especificado.
WagePayBasis String Verdadeiro PayBasis pode consistir no seguinte: Salário (Padrão para salário em PUT se não for especificado), Por hora.
WagePayFrequency String Verdadeiro A frequência de pagamento pode consistir no seguinte: Semanal (o padrão é semanal em PUT, se não for especificado), Quinzenalmente, Duas vezes por mês, Mensalmente.
WagesExpenseAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
WagesExpenseAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
WagesExpenseAccountName String Verdadeiro Nome da conta.
WagesExpenseAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
WageCategories String Falso Uma matriz de categorias salariais às quais o funcionário está vinculado.
Entitlements String Falso O conjunto de informações a seguir extrai os detalhes de cada categoria de direito vinculada.
Deductions String Falso O conjunto de informações a seguir extrai detalhes de cada categoria de deduções vinculadas.
EmployerExpenses String Falso O conjunto de informações a seguir extrai os detalhes de cada categoria vinculada de despesas do empregador.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

EmpregadoPagamentoPadrão

Retorne e atualize os detalhes de pagamento padrão do funcionário nos cartões de contato do funcionário para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Memo, HoursPerPayFrequency, PayFrequency, CategoryID, CategoryDisplayID, CategoryName, EmployeeID, EmployeeDisplayID, EmployeeName, PayrollDetailsID. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM EmployeeStandardPay WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM EmployeeStandardPay WHERE EmployeeID = "2aed306d-2da3-49b1-9023-153c3dc5b2ef"
SELECT * FROM EmployeeStandardPay WHERE HoursPerPayFrequency = 11
Atualizar

Para atualizar um funcionário existente, juntamente com suas PayrollCategories, podemos passar uma string JSON para o valor PayrollCategories ou usar uma tabela temporária como abaixo. Observação: isso substituirá todas as PayrollCategories atuais pelas abaixo.

INSERT INTO EmployeePayrollCategoryItems#TEMP(payrollcategoryid) VALUES ("2ced306d-1da3-49b1-2223-153c3dc5b2ef")
UPDATE EmployeeStandardPay SET PayrollCategories = "EmployeePayrollCategoryItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
Memo String Falso Texto de memorando para o objeto.
HoursPerPayFrequency Decimal Verdadeiro Horas trabalhadas em um período de pagamento.
PayFrequency String Verdadeiro A frequência de pagamento pode consistir no seguinte: semanalmente, quinzenalmente, duas vezes por mês, mensalmente.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
CategoryID Uuid Falso Identificador de categoria exclusivo na forma de um guid.
CategoryDisplayID String Verdadeiro ID de exibição para a categoria.
CategoryName String Verdadeiro Nome da categoria.
CategoryURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de categoria.
EmployeeID Uuid Falso Identificador de guid exclusivo pertencente ao contato do funcionário atribuído.
EmployeeDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do funcionário.
EmployeeName String Verdadeiro Nome do contato do funcionário.
EmployeeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do funcionário.
PayrollDetailsID Uuid Verdadeiro Identificador exclusivo na forma de um guid.
PayrollDetailsURI String Verdadeiro Identificador de recurso uniforme associado ao objeto.
PayrollCategories String Falso Todas as categorias de folha de pagamento vinculadas ao contato do funcionário incluem todas as categorias de folha de pagamento do tipo Salário.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Ajuste de Estoques

Retornar, atualizar, criar e excluir diários de ajuste de estoque

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID. Todas as colunas e operadores são processados no lado do cliente.

SELECT * FROM InventoryAdjustment Where ID = '10f623a6-1638-4970-afd5-0394191bf015'
Inserir

Os seguintes atributos são necessários ao realizar uma inserção:InventoryJournalNumber

INSERT INTO InventoryAdjustment (InventoryJournalNumber) values('1234567')
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
DisplayID String Falso ID de exibição para a categoria
Name String Falso Nome da categoria
CategoryUID String Falso Identificador de guid exclusivo pertencente à categoria atribuída ao diário de estoque
CategoryURI String Falso Identificador de recurso uniforme associado ao objeto de categoria
Date Datetime Falso Data da transação
InventoryJournalNumber String Falso Número diário de inventário
IsYearEndAdjustment Boolean Falso Indica que a transação é um YearEndAdjustment ou não
Lines String Falso Uma matriz de informações de itens de linha
Memo String Falso Texto do memorando atribuído ao ajuste do diário de estoque
RowVersion String Falso RowVersão
URI String Falso Identificador uniforme de recursos

ItemPriceMatrices

Retorne e atualize a matriz de preço do item para vários preços de venda do cliente.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, ItemID, ItemName, ItemNumber. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM ItemPriceMatrices WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM ItemPriceMatrices WHERE ItemName = "item name"
Atualizar

Para atualizar uma matriz de preço de item existente, juntamente com seus SellingPrices, podemos passar uma string JSON para o valor SellingPrices ou usar uma tabela temporária como abaixo. Observação: isso substituirá todos os SellingPrices atuais pelos abaixo.

INSERT INTO ItemSellingPrices#TEMP(quantityover, levelA, LevelB) VALUES (10, 11.5, 12.7)
UPDATE ItemPriceMatrices SET SellingPrices = "ItemSellingPrices#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
ItemID Uuid Verdadeiro Identificador exclusivo na forma de um guid.
ItemName String Verdadeiro Nome do item.
ItemNumber String Verdadeiro O número atribuído ao item.
ItemURI String Verdadeiro Identificador de recurso uniforme associado ao item.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
SellingPrices String Falso Uma matriz de informações sobre preços de venda.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Unid

Devolva, atualize, crie e exclua itens de estoque para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, AverageCost, BaseSellingPrice, IsActive, IsBought, IsInventoryed, IsSold, Name, Number, CurrentValue, Description, UseDescription, AssetAccountID, AssetAccountDisplayID, AssetAccountName, BuyingUnitOfMeasure, BuyingItemsPerBuyingUnit, BuyingLastPurchasePrice, BuyingStandardCost, RestockingSupplierID, RestockingSupplierDisplayID, RestockingSupplierItemNumber, RestockingSupplierName, RestockingDefaultOrderQuantity, RestockingMinimumLevelForRestockingAlert, BuyingTaxCodeID, BuyingTaxCodeCode, CostOfSalesAccountID, CostOfSalesAccountDisplayID, CostOfSalesAccountName, IncomeAccountID, IncomeAccountDis playID, IncomeAccountName, ExpenseAccountID, ExpenseAccountDisplayID, ExpenseAccountName, QuantityAvailable, QuantityCommitted, QuantityOnHand, QuantityOnOrder, SellingBaseSellingPrice, SellingCalculateSalesTaxOn, SellingIsTaxInclusive, SellingItemsPerSellingUnit, SellingUnitOfMeasure, SellingTaxCodeID, SellingTaxCodeCode. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM Items WHERE ID = "d5ab0fd1-3bf4-4230-bbaf-90b26ea9afda" OR ID = "59aa54c8-6793-4a63-bda9-55451fa3976e"
SELECT * FROM Items WHERE AverageCost = 21.38 OR BaseSellingPrice = 11.95
SELECT * FROM Items WHERE IsActive = true
Inserir

O seguinte atributo é necessário ao realizar uma inserção: Número.

INSERT INTO Items(Number) VALUES ("429")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
AverageCost Decimal Verdadeiro Custo médio do item quando a quantidade disponível é igual ou maior que zero.
BaseSellingPrice Decimal Verdadeiro Preço de venda base do item, incluindo impostos.
IsActive Boolean Falso Observação: o padrão é true se deixado em branco no POST. True indica que o item está ativo. Falso indica que o item está inativo.
IsBought Boolean Falso True indica que o item foi comprado. Falso indica que o item não foi comprado.
IsInventoried Boolean Falso True indica que o item está inventariado. Falso indica que o item não está inventariado.
IsSold Boolean Falso True indica que o item foi vendido. False indica que o item não foi vendido.
Name String Falso Nome do objeto.
Number String Falso Número de item.
PhotoURI String Falso Identificador de recurso uniforme associado a uma imagem fotográfica.
PriceMatrixURI String Falso Observação: Disponível apenas se Item IsSold = true.
CurrentValue Decimal Verdadeiro Valor em dólares das unidades mantidas em estoque.
Description String Falso Descrição do objeto.
UseDescription Boolean Falso True indica o uso do texto de descrição em vez do nome do item em faturas de venda e ordens de compra. False indica não usar a descrição do item em vendas e compras.
AssetAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
AssetAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
AssetAccountName String Verdadeiro Nome da conta.
AssetAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
BuyingUnitOfMeasure String Falso Descrição do tipo de unidade com a qual o item é comprado, ou seja: kg, hora.
BuyingItemsPerBuyingUnit Decimal Falso Número de itens por unidade de compra. Nota: se for IsInventoriado = false null é retornado.
BuyingLastPurchasePrice Decimal Verdadeiro O preço com impostos incluídos do item por unidade na última compra.
BuyingStandardCost Decimal Falso Preço de compra padrão para uma unidade de compra deste item.
RestockingSupplierID Uuid Falso Identificador de guid exclusivo pertencente ao contato do fornecedor atribuído.
RestockingSupplierDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do fornecedor.
RestockingSupplierItemNumber String Falso Número ou código que o fornecedor atribuiu ao item.
RestockingSupplierName String Verdadeiro Nome do contato do fornecedor.
RestockingSupplierURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do fornecedor.
RestockingDefaultOrderQuantity Integer Verdadeiro Número padrão de unidades a serem compradas no pedido automático.
RestockingMinimumLevelForRestockingAlert Integer Verdadeiro O número mínimo de itens disponíveis antes de precisar fazer um novo pedido.
BuyingTaxCodeID Uuid Falso Identificador de guid exclusivo pertencente ao código de imposto atribuído.
BuyingTaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
BuyingTaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
CostOfSalesAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
CostOfSalesAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
CostOfSalesAccountName String Verdadeiro Nome da conta.
CostOfSalesAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
IncomeAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
IncomeAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
IncomeAccountName String Verdadeiro Nome da conta.
IncomeAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
ExpenseAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
ExpenseAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
ExpenseAccountName String Verdadeiro Nome da conta.
ExpenseAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
QuantityAvailable Decimal Verdadeiro Quantidade calculada do item disponível para venda.
QuantityCommitted Decimal Verdadeiro Quantidade do item retida em notas fiscais de venda pendentes.
QuantityOnHand Decimal Verdadeiro Quantidade de unidades mantidas em estoque.
QuantityOnOrder Decimal Verdadeiro Quantidade do item mantida em ordens de compra pendentes.
SellingBaseSellingPrice Decimal Verdadeiro Preço de venda padrão para uma unidade de venda deste item.
SellingCalculateSalesTaxOn String Verdadeiro APLICÁVEL APENAS PARA A REGIÃO AU. O imposto sobre vendas pode ser calculado em qualquer um dos seguintes valores Enum: ActualSellingPrice, BaseSellingPrice, LevelA, LevelB, LevelC, LevelD, LevelE, LevelF.
SellingIsTaxInclusive Boolean Verdadeiro Verdadeiro indica que os preços de venda incluem impostos. Falso indica que os preços de venda não incluem impostos.
SellingItemsPerSellingUnit Integer Verdadeiro Número de itens por unidade de venda. Nota: se for IsInventoriado = false null é retornado.
SellingUnitOfMeasure String Verdadeiro Descrição do tipo de unidade com a qual o item é vendido, ou seja: kg, hora.
SellingTaxCodeID Uuid Falso Identificador de guid exclusivo pertencente ao código de imposto atribuído.
SellingTaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
SellingTaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
CustomField1Label String Verdadeiro Rótulo personalizado do Campo 1.
CustomField1Value String Verdadeiro Valor do campo personalizado 1.
CustomField2Label String Verdadeiro Rótulo de campo personalizado 2.
CustomField2Value String Verdadeiro Valor do campo personalizado 2.
CustomField3Label String Verdadeiro Rótulo de campo personalizado 3.
CustomField3Value String Verdadeiro Valor do campo personalizado 3.
CustomList1Label String Verdadeiro Rótulo personalizado da Lista 1.
CustomList1Value String Verdadeiro Valor personalizado da Lista 1.
CustomList2Label String Verdadeiro Rótulo personalizado da Lista 2.
CustomList2Value String Verdadeiro Valor personalizado da Lista 2.
CustomList3Label String Verdadeiro Rótulo personalizado da Lista 3.
CustomList3Value String Verdadeiro Valor personalizado da lista 3.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Job Budgets

Retornar e atualizar orçamentos de trabalho.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, JobID, JobName, JobNumber. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM JobBudgets WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM JobBudgets WHERE JobName = "job name"
Atualizar

Para atualizar um JobBudget existente, juntamente com seus Orçamentos, podemos passar uma string JSON para o valor de Orçamentos ou usar uma tabela temporária como abaixo. Observação: isso substituirá todos os orçamentos atuais pelos abaixo.

INSERT INTO JobBudgetItems#TEMP(Amount, AccountID) VALUES (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f")
UPDATE JobBudgets SET Budgets = "JobBudgetItems#TEMP" WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Falso Identificador exclusivo na forma de um guid.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
JobID Uuid Falso Identificador de trabalho exclusivo na forma de um guid.
JobName String Verdadeiro Nome atribuído ao trabalho.
JobNumber String Verdadeiro Número atribuído ao trabalho.
JobURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de trabalho.
Budgets String Falso Uma matriz de informações de orçamento de trabalho.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Empregos

Devolva, atualize, crie e exclua um trabalho para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Contact, Description, StartDate, FinishDate, IsActive, IsHeader, Manager, Name, Number, PercentComplete, StartDate, TrackReimbursables, LinkedCustomerID, LinkedCustomerDisplayID, LinkedCustomerName, LinkedCustomerUri, ParentJobID, ParentJobName, ParentJobNumber, ParentJobUri. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM Jobs WHERE ID = "797755431-e8d1-411f-9859-5ff2a54f97d9"
SELECT * FROM Jobs WHERE Number = "125" OR Name = "Supply of Coolers FH"
SELECT * FROM Jobs WHERE ParentJobNumber = "120"
Inserir

O seguinte atributo é necessário ao realizar uma inserção: Número.

INSERT INTO Jobs(Number) VALUES ("429")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
Contact String Falso Contato para o trabalho.
Description String Falso Descrição do objeto.
StartDate Datetime Falso Data em que o trabalho foi iniciado.
FinishDate Datetime Falso Data em que o trabalho foi concluído.
IsActive Boolean Falso O padrão é true se deixado em branco no POST.
IsHeader Boolean Falso O padrão é true se deixado em branco no POST.
Manager String Falso Gerente do trabalho.
Name String Falso Nome do objeto.
Number String Falso Número atribuído ao trabalho.
PercentComplete Double Falso % do trabalho concluído.
LastModified Datetime Verdadeiro Data em que o trabalho foi modificado.
TrackReimbursables Boolean Falso True indica que um trabalho é usado para rastrear despesas reembolsáveis. Falso indica que um trabalho não é usado para rastrear despesas reembolsáveis.
LinkedCustomerID Uuid Falso Identificador de guid exclusivo pertencente ao contato do cliente atribuído.
LinkedCustomerDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do cliente.
LinkedCustomerName String Verdadeiro Nome do contato do cliente.
LinkedCustomerUri String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do cliente.
ParentJobID Uuid Falso Identificador de trabalho exclusivo na forma de um guid.
ParentJobName String Verdadeiro Nome atribuído ao trabalho.
ParentJobNumber String Verdadeiro Número atribuído ao trabalho.
ParentJobUri String Verdadeiro Identificador de recurso uniforme associado ao objeto de trabalho.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Diários

Retorne, atualize, crie e exclua transações de diário geral para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, DateOccurred, DisplayID, GSTReportingMethod, IsTaxInclusive, IsYearEndAdjustment, Memo, CategoryID, CategoryDisplayID, CategoryName, Uri. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM Journals WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM Journals WHERE CategoryID = "6cbbea25-6256-4df4-bb37-17eb2d21f803
SELECT * FROM Journals WHERE GSTReportingMethod = "Purchase"
Inserir

O seguinte atributo é necessário ao executar uma inserção: DateOccurred, Lines.

Para inserir um diário existente, junto com suas linhas, podemos passar uma string JSON para o valor de linhas ou usar uma tabela temporária como abaixo.

INSERT INTO JournalItems#TEMP(AccountID, TaxcodeID, Amount, IsCredit) VALUES ("d3f55ef1-ce77-4ef2-a415-61d04db2c5fc", "e1e27d8e-f89d-451d-97c8-e0c3c1716a91", 11.23, true)
INSERT INTO JournalItems#TEMP(AccountID, TaxcodeID, Amount, IsCredit) VALUES ("d3f55ef1-ce77-4ef2-a415-61d04db2c5fc", "e1e27d8e-f89d-451d-97c8-e0c3c1716a91", 11.23, false)
INSERT INTO Journals(DateOccurred, Lines) VALUES ("2018-03-04", "JournalItems#TEMP")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
DateOccurred Datetime Falso Entrada da data da transação.
DisplayID String Falso ID de exibição do objeto.
GSTReportingMethod String Falso Método de relatório usado na transação do diário geral que aceita o seguinte: venda (fornecimento), compra (aquisição).
IsTaxInclusive Boolean Falso True indica que o status padrão da transação está definido como imposto inclusivo. e False indica que o status da transação não inclui impostos.
IsYearEndAdjustment Boolean Falso True indica que a transação é um YearEndAdjustmen.t False indica que a transação não é um YearEndAdjustment.
Memo String Falso Memorando de cabeçalho do lançamento do diário geral.
CategoryID Uuid Falso Identificador de categoria exclusivo na forma de um guid.
CategoryDisplayID String Verdadeiro ID de exibição para a categoria.
CategoryName String Verdadeiro Nome da categoria.
CategoryURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de categoria.
ForeignCurrencyID Uuid Falso Identificador uniforme para a moeda na forma do guid.
ForeignCurrencyCode String Verdadeiro O código da moeda.
ForeignCurrencyName String Verdadeiro O nome completo da moeda.
ForeignCurrencyURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de moeda.
Uri String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
Lines String Falso Uma matriz de informações de itens de linha.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Folha de Pagamento Salários

Retorne, atualize, crie e exclua categorias de folha de pagamento do tipo salário para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Name, StpCategory, Type, WageType, PayRate, FixedHourlyRate, AutomaticallyAdjustBaseAmounts, RegularRateMultiplier, OverriddenWagesExpenseAccountID, OverriddenWagesExpenseAccountName, OverriddenWagesExpenseAccountNumber. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM PayrollWages WHERE ID = "e57725b2-c4f0-47ce-8103-299c7a675112"
SELECT * FROM PayrollWages WHERE Name = "Base Hourly"
SELECT * FROM PayrollWages WHERE StpCategory = "NotReportable" OR Type = "Wage"
Inserir

O seguinte atributo é necessário ao realizar uma inserção: WageType, Name.

INSERT INTO PayrollWages(WageType, Name) VALUES ("Salary", "Example salary")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
Name String Falso Nome da categoria salarial.
StpCategory String Falso Categoria STP para esta categoria de folha de pagamento. Consulte a ajuda do MYOB para obter mais informações. Os valores válidos são: NotReportable (padrão), GrossPayments, PAYGWithholding, IsentoForeignIncome, CDEPPayments, AllowanceCar, AllowanceTransport, AllowanceTravel, AllowanceMeals, AllowanceLaundry, AllowanceOther, DeductionUnionProfAssocFees, DeductionWorkPlaceGiving, ReportableFringeBenefitsExemptAmount, ReportableFringeBenefitsTaxableAmount, ETPTaxableComponent, ETPTaxFreeComponent, ETPTaxWithholding, LumpSumPaymentATermination, LumpSumPaymentARedundancy, LumpSumPaymentB, LumpSumPaymentD, LumpSumPaymentE, SuperGuarantee, OrdinaryTimesEarnings, ReportableEmployerSuperContributions.
Type String Verdadeiro Indica o tipo de categoria da folha de pagamento, ou seja: Salário, Despesa, Dedução.
WageType String Verdadeiro Indica se a categoria salarial é um tipo de salário ou por hora. Use por hora ou salário
PayRate String Verdadeiro Como calcular a taxa, pode ser RegularRate ou FixedHourly.
FixedHourlyRate Decimal Falso Taxa horária fixa para todos os funcionários vinculados a esta categoria salarial se PayRate = FixedHourly, caso contrário nulo.
AutomaticallyAdjustBaseAmounts Boolean Falso Ao inserir os valores de licença em um pagamento, o valor da hora base ou do salário base será ajustado automaticamente se definido como True.
RegularRateMultiplier Decimal Falso Calcule como um múltiplo da configuração de taxa horária no cartão de cada funcionário se PayRate = RegularRate, caso contrário nulo.
OverriddenWagesExpenseAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
OverriddenWagesExpenseAccountName String Verdadeiro Nome da conta.
OverriddenWagesExpenseAccountNumber String Verdadeiro Nome da conta pertencente ao registro da conta.
OverriddenWagesExpenseAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
Exemptions String Falso Uma série de impostos e deduções de que esta categoria salarial está isenta.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Notas de Compra

Retorne todos os tipos de fatura de compra para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, AppliedToDate, BalanceDueAmount, BillDeliveryStatus, Comment, Date, Freight, IsReportable, IsTaxInclusive, JournalMemo, Number, ShipToAddress, ShippingMethod, Status, Subtotal, TotalAmount, TotalTax, SupplierInvoiceNumber, CategoryID, CategoryDisplayID, CategoryName, FreightTaxCodeID, FreightTaxCodeCode, OrderID, OrderNumber, SupplierID, SupplierDisplayID, SupplierName, TermsBalanceDueDate, TermsDiscount, TermsDiscountDate, TermsDiscountExpiryDate, TermsDiscountForEarlyPayment, TermsDueDate, TermsPaymentIsDue, TermsMonthlyChargeForLatePayment. Todas as outras colunas e operadores são processados no lado do cliente. BillType suporta apenas comparação de igualdade.

SELECT * FROM PurchaseBills WHERE ID = REPLACE
SELECT * FROM PurchaseBills WHERE AppliedToDate = 20
SELECT * FROM PurchaseBills WHERE BalanceDueAmount = 45.86163291317715
Atualizar

Para atualizar uma fatura existente, junto com suas linhas, podemos passar uma string JSON para o valor de linhas ou usar uma tabela temporária como abaixo. Observação: isso substituirá todas as linhas atuais pelas abaixo.

INSERT INTO PurchaseBillItems#TEMP(Total, AccountID, TaxCodeID) values (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b")
UPDATE PurchaseBills SET BillType = "Service", Lines = "PurchaseBillItems#TEMP" WHERE ID = "f979f0e7-1cd8-4fb9-b2c2-9d4546440cf7"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: BillType, Date, FreightTaxCodeID, SupplierID.

INSERT INTO PurchaseBills(BillType, Date, FreightTaxCodeID, SupplierID) VALUES ("Item", "01/01/2019", "446d2226-254b-4821-acc2-7031842e0166", "9421b774-20fa-4c5f-bced-fbb6ecd42ebd")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
AppliedToDate Decimal Verdadeiro Valor atualmente aplicado à fatura de compra.
BalanceDueAmount Decimal Verdadeiro Valor ainda a pagar na fatura de compra.
BillDeliveryStatus String Falso Status de entrega de fatura atribuído: Print = ToBePrinted, E-mail = ToBeEmailed, PrintAndEmail = ToBePrintedAndEmailed, Nothing = YetPrintedOrSent.
BillType String Falso Tipo da fatura. Um de: Item, Serviço, Profissional, Diversos.
Comment String Falso Comentário da fatura de compra.
Date Datetime Falso A data da entrada.
Freight Decimal Falso Valor do frete com imposto incluído aplicável à nota fiscal de compra.
IsReportable Boolean Falso APENAS aplicável para a região da UA. True indica que a transação é um pagamento tributável reportável. Falso indica que a transação não é um pagamento tributável reportável.
IsTaxInclusive Boolean Falso True indica que a transação está definida para incluir impostos. Falso indica que a transação não inclui impostos.
JournalMemo String Falso Texto de memorando para o objeto.
Number String Falso Número da fatura de compra.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
ShipToAddress String Falso Endereço ShipTo da fatura de compra.
ShippingMethod String Falso Texto do método de envio.
Status String Verdadeiro Status da fatura: Aberto, Fechado, Débito.
Subtotal Decimal Verdadeiro Se IsTaxInclusive = false, a soma de todos os valores de linhas exclusivas de impostos. Se IsTaxInclusive = true, a soma de todos os valores de linha com impostos incluídos.
TotalAmount Decimal Verdadeiro Valor total da fatura de compra.
TotalTax Decimal Verdadeiro Total de todos os valores de impostos aplicáveis à fatura de compra.
SupplierInvoiceNumber String Falso Número da fatura do fornecedor.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
CategoryID Uuid Falso Identificador de categoria exclusivo na forma de um guid.
CategoryDisplayID String Verdadeiro ID de exibição para a categoria.
CategoryName String Verdadeiro Nome da categoria.
CategoryURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de categoria.
FreightTaxCodeID Uuid Falso Identificador de guid exclusivo pertencente ao código de imposto atribuído.
FreightTaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
FreightTaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
OrderID Uuid Falso Identificador exclusivo na forma de um guid.
OrderNumber String Verdadeiro O número do pedido.
OrderURI String Verdadeiro Identificador de recurso uniforme associado ao pedido.
SupplierID Uuid Falso Identificador de guid exclusivo pertencente ao contato do fornecedor atribuído.
SupplierDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do fornecedor.
SupplierName String Verdadeiro Nome do contato do fornecedor.
SupplierURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do fornecedor.
TermsBalanceDueDate Integer Falso Se PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber ou NumberOfDaysAfterEOM, defina o número de dias em que o cliente deve pagar as faturas. Se PaymentIsDue = OnADayOfTheMonth ou DayOfMonthAfterEOM, defina o dia do mês em que o pagamento deve ser feito para pagar as faturas.
TermsDiscount Decimal Verdadeiro Valor do desconto que será aplicado se o pagamento for feito integralmente até a data do desconto.
TermsDiscountDate Integer Verdadeiro Se PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber ou NumberOfDaysAfterEOM, defina o número de dias em que o cliente deve pagar para receber descontos. Se PaymentIsDue = OnADayOfTheMonth ou DayOfMonthAfterEOM, defina o dia do mês em que o pagamento deve ser feito para receber descontos.
TermsDiscountExpiryDate Datetime Verdadeiro Data em que o pagamento deve ser pago integralmente na cotação para receber o desconto.
TermsDiscountForEarlyPayment Double Verdadeiro % de desconto para pagamento antecipado.
TermsDueDate Datetime Verdadeiro Data em que o pagamento é devido.
TermsPaymentIsDue String Falso Definições de termos de pagamento padrão: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
TermsMonthlyChargeForLatePayment Double Falso % de cobrança mensal por atraso no pagamento.
Lines String Falso Uma matriz de informações da conta de linha.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.
PromisedDate Datetime Falso Data Prometida da Transação.

Ordens de Compra

Retorne todos os tipos de ordem de compra para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, AppliedToDate, Date, Freight, BalanceDueAmount, IsReportable, IsTaxInclusive, JournalMemo, Number, ShipToAddress, Status, SupplierInvoiceNumber, Subtotal, TotalAmount, TotalTax, CategoryID, CategoryDisplayID, CategoryName, FreightTaxCodeID, FreightTaxCodeCode, SupplierID, SupplierDisplayID, SupplierName, TermsBalanceDueDate, TermsDiscount, TermsDiscountDate, TermsDiscountExpiryDate, TermsDiscountForEarlyPayment, TermsDueDate, TermsPaymentIsDue. Todas as outras colunas e operadores são processados no lado do cliente. OrderType dá suporte apenas à comparação de igualdade.

SELECT * FROM PurchaseOrders WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"
SELECT * FROM PurchaseOrders WHERE AppliedToDate = 40
SELECT * FROM PurchaseOrders WHERE OrderType = "Service"
Atualizar

Para atualizar um pedido existente, junto com suas linhas, podemos passar uma string JSON para o valor de linhas ou usar uma tabela temporária como abaixo. Observação: isso substituirá todas as linhas atuais pelas abaixo.

INSERT INTO PurchaseOrderItems#TEMP(Total, AccountID, TaxCodeID) values (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b")
UPDATE PurchaseOrders SET OrderType = "Service", Lines = "PurchaseOrderItems#TEMP" WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: OrderType, Date, FreightTaxCodeID, SupplierID.

INSERT INTO PurchaseOrders(OrderType, Date, FreightTaxCodeID, SupplierID) VALUES ("Service", "01/01/2019", "446d2226-254b-4821-acc2-7031842e0166", "9421b774-20fa-4c5f-bced-fbb6ecd42ebd")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
AppliedToDate Double Verdadeiro Valor atualmente aplicado ao pedido de compra.
Date Datetime Falso A data da entrada.
Freight Decimal Falso Valor do frete com imposto incluído aplicável ao pedido de compra.
BalanceDueAmount Decimal Verdadeiro Valor ainda a pagar no pedido de compra.
IsReportable Boolean Falso APENAS aplicável para a região da UA. True indica que a transação é um pagamento tributável reportável. Falso indica que a transação não é um pagamento tributável reportável.
IsTaxInclusive Boolean Falso True indica que a transação está definida para incluir impostos. Falso indica que a transação não inclui impostos.
JournalMemo String Falso Texto de memorando para o objeto.
Number String Falso Número do pedido de compra.
OrderType String Falso Tipo do pedido. Um de: Item, Serviço, Profissional, Diversos
ShipToAddress String Falso Endereço ShipTo do pedido de compra.
Status String Verdadeiro Status do pedido de compra: Aberto, ConvertedToBill.
SupplierInvoiceNumber String Falso Número da fatura do fornecedor.
Subtotal Decimal Verdadeiro Se IsTaxInclusive = false, a soma de todos os valores de linhas exclusivas de impostos. Se IsTaxInclusive = true, a soma de todos os valores de linha com impostos incluídos.
TotalAmount Decimal Verdadeiro Valor total do pedido de compra.
TotalTax Decimal Verdadeiro Total de todos os valores de impostos aplicáveis ao pedido de compra.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
CategoryID Uuid Verdadeiro Identificador de categoria exclusivo na forma de um guid.
CategoryDisplayID String Falso ID de exibição para a categoria.
CategoryName String Verdadeiro Nome da categoria.
CategoryURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de categoria.
FreightTaxCodeID Uuid Verdadeiro Identificador de guid exclusivo pertencente ao código de imposto atribuído.
FreightTaxCodeCode String Falso Código fiscal de 3 dígitos.
FreightTaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
Comment String Falso Comentário da Ordem de Compra
ShippingMethod String Falso Método de envio
PromisedDate Datetime Falso Data Prometida da Transação.
SupplierID Uuid Falso Identificador de guid exclusivo pertencente ao contato do fornecedor atribuído.
SupplierDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do fornecedor.
SupplierName String Verdadeiro Nome do contato do fornecedor.
SupplierURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do fornecedor.
TermsBalanceDueDate Integer Falso Se PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber ou NumberOfDaysAfterEOM, defina o número de dias em que o cliente deve pagar as faturas. Se PaymentIsDue = OnADayOfTheMonth ou DayOfMonthAfterEOM, defina o dia do mês em que o pagamento deve ser feito para pagar as faturas.
TermsDiscount Decimal Verdadeiro Valor do desconto que será aplicado se o pagamento for feito integralmente até a data do desconto.
TermsDiscountDate Integer Verdadeiro Se PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber ou NumberOfDaysAfterEOM, defina o número de dias em que o cliente deve pagar para receber descontos. Se PaymentIsDue = OnADayOfTheMonth ou DayOfMonthAfterEOM, defina o dia do mês em que o pagamento deve ser feito para receber descontos.
TermsDiscountExpiryDate Datetime Verdadeiro Data em que o pagamento deve ser pago integralmente na cotação para receber o desconto.
TermsDiscountForEarlyPayment Double Verdadeiro % de desconto para pagamento antecipado.
TermsDueDate Datetime Verdadeiro Data em que o pagamento é devido.
TermsPaymentIsDue String Falso Definições de termos de pagamento padrão: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
Lines String Falso Uma matriz de informações de ordem de linha.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Recebendo Transações

Retorne, atualize, crie e exclua transações de recebimento de dinheiro para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, AmountReceived, ContactDisplayID, Date, DepositTo, IsTaxInclusive, Memo, PaymentMethod, ReceiptNumber, TotalTax, AccountID, AccountDisplayID, AccountName, CategoryID, CategoryDisplayID, CategoryName, ContactID, ContactName, ContactType. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM ReceivingTransactions WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM ReceivingTransactions WHERE AmountReceived = 12.45
SELECT * FROM ReceivingTransactions WHERE Memo = "memo"
Atualizar

Para atualizar uma transação existente, juntamente com suas linhas, podemos passar uma string JSON para o valor de linhas ou usar uma tabela temporária como abaixo. Observação: isso substituirá todas as linhas atuais pelas abaixo.

INSERT INTO ReceivingTransactionItems#TEMP(Amount, AccountID, TaxCodeID, RowID, RowVersion) VALUES (22.3, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b", 656, "8733325201913151488")
UPDATE ReceivingTransactions SET PaymentMethod = "Cash", Lines = "ReceivingTransactionItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: Date, DepositTo, Memo, AccountID, ContactID.

INSERT INTO ReceivingTransactions(Date, DepositTo, Memo, AccountID, ContactID) VALUES ("01/01/2019", "Account", "memo", "91e0769a-bdd1-4402-8e4f-95b7743bd733", "4635fd9e-82a7-4612-ae15-32c464ef7c48")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
AmountReceived Double Verdadeiro A quantia recebida.
ContactDisplayID String Verdadeiro O ID do cartão de contato também pode ser usado como um identificador de contato exclusivo.
Date Datetime Falso A data da entrada.
DepositTo String Falso Se alocar uma conta bancária para o pagamento, especifique Conta. Se estiver usando fundos não depositados, especifique UndepositedFunds.
IsTaxInclusive Boolean Falso True indica que a transação está definida para incluir impostos com o Valor incluindo impostos. Falso indica que a transação não inclui impostos com o Valor do valor sem impostos.
Memo String Falso Texto de memorando para o objeto.
PaymentMethod String Falso Os métodos de pagamento devem existir no arquivo da empresa, os métodos padrão consistem no seguinte: American Express, Bank Card, Barter Card, Cash, Cheque, Diners Club, EFTPOS, MasterCard, Money Order, Other, Visa.
ReceiptNumber String Falso Nº do ID da transação de pagamento, se deixado em branco no POST, será incrementado automaticamente com base no último # registrado.
TotalTax Double Verdadeiro Total de todos os valores de impostos aplicáveis ao dinheiro recebido.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
AccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Verdadeiro Nome da conta.
AccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
CategoryID Uuid Falso Identificador de categoria exclusivo na forma de um guid.
CategoryDisplayID String Verdadeiro ID de exibição para a categoria.
CategoryName String Verdadeiro Nome da categoria.
CategoryURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de categoria.
ContactID Uuid Falso Identificador exclusivo na forma de um guid.
ContactName String Verdadeiro Nome do registro do contato.
ContactType String Verdadeiro O tipo de cartão do registro do contato pode ser Cliente, Fornecedor, Funcionário ou Pessoal.
ContactURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato.
Lines String Falso Uma matriz de receber informações de linha de dinheiro.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Faturas de Venda

Retorne todos os tipos de fatura de venda para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, BalanceDueAmount, Comment, Date, InvoiceDeliveryStatus, IsTaxInclusive, JournalMemo, LastPaymentDate, Number, PromisedDate, ReferralSource, ShipToAddress, ShippingMethod, Status, Subtotal, Freight, TotalTax, TotalAmount, CustomerPurchaseOrderNumber, CategoryID, CategoryDisplayID, CategoryName, SalespersonID, SalespersonDisplayID, SalespersonName, CustomerID, CustomerDisplayID, CustomerName, FreightTaxCodeID, FreightTaxCodeCode, OrderID, OrderNumber, TermsBalanceDueDate, TermsDiscount, TermsDiscountDate, TermsDiscountExpiryDate, TermsDiscountForEarlyPayment, TermsDueDate, TermsFinanceCharge, TermsMonthlyChargeForLatePa yment, TermsPaymentIsDue. Todas as outras colunas e operadores são processados no lado do cliente. InvoiceType suporta apenas comparação de igualdade.

SELECT * FROM SaleInvoices WHERE ID = "fa024423-e61a-44cd-8a8b-4d52a2f9fc04"
SELECT * FROM SaleInvoices WHERE BalanceDueAmount = 24.3766206457717
SELECT * FROM SaleInvoices WHERE Comment = "commect"
SELECT * FROM SaleInvoices WHERE InvoiceType = "Service"
Atualizar

Para atualizar uma fatura existente, juntamente com suas linhas, podemos passar uma string JSON para o valor de linhas ou usar uma tabela temporária como abaixo. Observação: isso substituirá todas as linhas atuais pelas abaixo.

INSERT INTO PurchaseOrderItems#TEMP(Total, AccountID, TaxCodeID) VALUES (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b")
UPDATE PurchaseOrders SET InvoiceType = "Service", Lines = "PurchaseOrderItems#TEMP" WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: InvoiceType, Date, CustomerID.

INSERT INTO SaleInvoices(InvoiceType, Date, CustomerID) VALUES ("item", "01/01/2019", "4635fd9e-82a7-4612-ae15-32c464ef7c48")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
BalanceDueAmount Decimal Verdadeiro Valor ainda a pagar na fatura de venda.
Comment String Falso Comentário da fatura de venda.
Date Datetime Falso A data da entrada.
InvoiceDeliveryStatus String Falso Status de entrega da fatura atribuído: Print = ToBePrinted, E-mail = ToBeEmailed, PrintAndEmail = ToBePrintedAndEmailed, Nothing = YetPrintedOrSent.
InvoiceType String Falso Tipo da fatura. Um de: Item, Serviço, Profissional, TimeBilling, Diversos.
IsTaxInclusive Boolean Falso True indica que a transação inclui impostos com valores totais a serem digitados com impostos incluídos. Falso indica que a transação não inclui impostos com valores totais a serem inseridos sem impostos.
JournalMemo String Falso Texto de memorando para o objeto.
LastPaymentDate Datetime Verdadeiro A data da entrada.
LastModified Datetime Verdadeiro Data da última modificação da entrada.
Number String Falso Número da fatura de venda.
PromisedDate Datetime Falso A data da entrada.
ReferralSource String Falso Fonte de referência selecionada na nota fiscal de venda.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
ShipToAddress String Falso Endereço ShipTo da fatura de venda.
ShippingMethod String Falso Texto do método de envio.
Status String Verdadeiro Status da fatura: Aberta, Fechada, Crédito.
Subtotal Decimal Verdadeiro Se IsTaxInclusive = false, a soma de todos os valores de linhas exclusivas de impostos. Se IsTaxInclusive = true, a soma de todos os valores de linha com impostos incluídos.
Freight Decimal Verdadeiro Frete aplicável na nota fiscal de venda.
TotalTax Decimal Verdadeiro Total de todos os valores de impostos aplicáveis à nota fiscal de venda.
TotalAmount Decimal Verdadeiro Valor total da fatura de venda.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
CustomerPurchaseOrderNumber String Falso Número do pedido do cliente.
CategoryID Uuid Falso Identificador de categoria exclusivo na forma de um guid.
CategoryDisplayID String Verdadeiro ID de exibição para a categoria.
CategoryName String Verdadeiro Nome da categoria.
CategoryURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de categoria.
SalespersonID Uuid Falso Identificador exclusivo na forma de um guid.
SalespersonDisplayID String Verdadeiro Identificação do cartão de contato do funcionário.
SalespersonName String Verdadeiro Nome de contato do funcionário selecionado.
SalespersonURI String Verdadeiro Identificador de recurso uniforme associado ao funcionário.
CustomerID Uuid Falso Identificador de guid exclusivo pertencente ao contato do cliente atribuído.
CustomerDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do cliente.
CustomerName String Verdadeiro Nome do contato do cliente.
CustomerURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do cliente.
FreightTaxCodeID Uuid Falso Identificador de guid exclusivo pertencente ao código de imposto atribuído.
FreightTaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
FreightTaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
OrderID Uuid Falso Identificador exclusivo na forma de um guid.
OrderNumber String Verdadeiro O número do pedido.
OrderURI String Verdadeiro Identificador de recurso uniforme associado ao pedido.
TermsBalanceDueDate Integer Falso A data da entrada.
TermsDiscount Decimal Verdadeiro Valor do desconto que será aplicado se o pagamento for feito integralmente até a data do desconto.
TermsDiscountDate Integer Verdadeiro A data da entrada.
TermsDiscountExpiryDate Datetime Verdadeiro A data da entrada.
TermsDiscountForEarlyPayment Double Falso % de desconto para pagamento antecipado.
TermsDueDate Datetime Verdadeiro A data da entrada.
TermsFinanceCharge Decimal Falso Taxa de atraso de pagamento a ser cobrada se o pagamento não for feito integralmente até a data de vencimento.
TermsMonthlyChargeForLatePayment Double Falso % de cobrança mensal por atraso no pagamento.
TermsPaymentIsDue String Falso Definições de termos de pagamento padrão: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
Lines String Falso Uma matriz de informações de fatura de linha.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Pedidos de Venda

Retorna todos os tipos de pedidos de venda para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, AppliedToDate, BalanceDueAmount, Date, IsTaxInclusive, JournalMemo, Number, ReferralSource, Status, Subtotal, TotalAmount, TotalTax, LastPaymentDate, CustomerID, CustomerDisplayID, CustomerName, Freight, FreightTaxCodeCode, FreightTaxCodeID, CategoryID, CategoryDisplayID, CategoryName, SalespersonID, SalespersonDisplayID, SalespersonName, TermsBalanceDueDate, TermsDiscount, TermsDiscountDate, TermsDiscountExpiryDate, TermsDiscountForEarlyPayment, TermsDueDate, TermsFinanceCharge, TermsMonthlyChargeForLatePayment, TermsPaymentIsDue. Todas as outras colunas e operadores são processados no lado do cliente. OrderType dá suporte apenas à comparação de igualdade.

SELECT * FROM SaleOrders WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"
SELECT * FROM SaleOrders WHERE BalanceDueAmount = 13
SELECT * FROM SaleOrders WHERE IsTaxInclusive = true
Atualizar

Para atualizar um pedido existente, junto com suas linhas, podemos passar uma string JSON para o valor de linhas ou usar uma tabela temporária como abaixo. Observação: isso substituirá todas as linhas atuais pelas abaixo.

INSERT INTO SaleOrderItems#TEMP(Total, AccountID, TaxCodeID) VALUES (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b")
UPDATE SaleOrders SET OrderType = "Service", Lines = "SaleOrderItems#TEMP" WHERE ID = "992163e5-f46d-4b45-9296-965aa89a2a71"
Inserir

O seguinte atributo é necessário ao executar uma inserção: OrderType, CustomerID.

INSERT INTO SaleOrders(OrderType, CustomerID) VALUES ("item", "4635fd9e-82a7-4612-ae15-32c464ef7c48")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
AppliedToDate Decimal Verdadeiro A data da entrada.
BalanceDueAmount Decimal Verdadeiro Valor ainda a pagar no pedido de venda.
Date Datetime Verdadeiro A data da entrada.
IsTaxInclusive Boolean Falso True indica que a transação está definida para incluir impostos. Falso indica que a transação não inclui impostos.
JournalMemo String Falso Texto de memorando para o objeto.
Number String Falso Número do Pedido de Venda.
OrderType String Falso Tipo do pedido. Um de: Item, Serviço, Profissional, TimeBilling, Diversos.
ReferralSource String Falso Fonte de referência selecionada no pedido de venda.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
Status String Verdadeiro O status do pedido pode consistir no seguinte: Aberto, ConvertedToInvoice.
Subtotal Decimal Verdadeiro Se IsTaxInclusive = false, a soma de todos os valores de linhas exclusivas de impostos. Se IsTaxInclusive = true, a soma de todos os valores de linha com impostos incluídos.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
TotalAmount Decimal Verdadeiro Valor total do pedido de venda.
TotalTax Decimal Verdadeiro Total de todos os valores de impostos aplicáveis ao pedido de venda.
LastPaymentDate String Verdadeiro A data da entrada.
CustomerID Uuid Falso Identificador de guid exclusivo pertencente ao contato do cliente atribuído.
CustomerDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do cliente.
CustomerName String Verdadeiro Nome do contato do cliente.
CustomerURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do cliente.
Freight Decimal Falso Valor do frete com imposto incluído aplicável ao pedido de venda.
FreightTaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
FreightTaxCodeID Uuid Verdadeiro Identificador de guid exclusivo pertencente ao código de imposto atribuído.
FreightTaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
CategoryID Uuid Falso Identificador de categoria exclusivo na forma de um guid.
CategoryDisplayID String Verdadeiro ID de exibição para a categoria.
CategoryName String Verdadeiro Nome da categoria.
CategoryURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de categoria.
SalespersonID Uuid Falso Identificador exclusivo na forma de um guid.
SalespersonDisplayID String Verdadeiro Identificação do cartão de contato do funcionário.
SalespersonName String Verdadeiro Nome de contato do funcionário selecionado.
SalespersonURI String Verdadeiro Identificador de recurso uniforme associado ao funcionário.
TermsBalanceDueDate Integer Falso Se PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber ou NumberOfDaysAfterEOM, defina o número de dias em que o cliente deve pagar as faturas. Se PaymentIsDue = OnADayOfTheMonth ou DayOfMonthAfterEOM, defina o dia do mês em que o pagamento deve ser feito para pagar as faturas.
TermsDiscount Decimal Verdadeiro Valor do desconto que será aplicado se o pagamento for feito integralmente até a data do desconto.
TermsDiscountDate Integer Verdadeiro Se PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber ou NumberOfDaysAfterEOM, defina o número de dias em que o cliente deve pagar para receber descontos. Se PaymentIsDue = OnADayOfTheMonth ou DayOfMonthAfterEOM, defina o dia do mês em que o pagamento deve ser feito para receber descontos.
TermsDiscountExpiryDate Datetime Verdadeiro Data em que o pagamento deve ser pago integralmente na cotação para receber o desconto.
TermsDiscountForEarlyPayment Double Falso % de desconto para pagamento antecipado.
TermsDueDate Datetime Verdadeiro Data em que o pagamento é devido.
TermsFinanceCharge Decimal Falso Taxa de atraso de pagamento a ser cobrada se o pagamento não for feito integralmente até a data de vencimento.
TermsMonthlyChargeForLatePayment Double Falso % de cobrança mensal por atraso no pagamento.
TermsPaymentIsDue String Falso Definições de termos de pagamento padrão: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
Lines String Falso Uma matriz de informações de pedidos de linha de venda.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.
CustomerPurchaseOrderNumber String Falso Número do pedido do cliente.

Cotações de Venda

Retorna todos os tipos de cotação de venda para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, BalanceDueAmount, Date, IsTaxInclusive, JournalMemo, Number, ReferralSource, Subtotal, TotalAmount, TotalTax, CustomerPurchaseOrderNumber, CustomerID, CustomerDisplayID, CustomerName, Freight, FreightTaxCodeID, FreightTaxCodeCode, CategoryID, CategoryDisplayID, CategoryName, SalespersonID, SalespersonDisplayID, SalespersonName, TermsDiscount, TermsDiscountDate, TermsDiscountExpiryDate, TermsDiscountForEarlyPayment, TermsDueDate, TermsFinanceCharge, TermsMonthlyChargeForLatePayment, TermsPaymentIsDue, TermsBalanceDueDate. Todas as outras colunas e operadores são processados no lado do cliente. QuoteType dá suporte apenas à comparação de igualdade.

SELECT * FROM SaleQuotes WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM SaleQuotes WHERE BalanceDueAmount = 13
SELECT * FROM SaleQuotes WHERE QuoteType = "Service"
Atualizar

Para atualizar uma fatura existente, junto com suas linhas, podemos passar uma string JSON para o valor de linhas ou usar uma tabela temporária como abaixo. Observação: isso substituirá todas as linhas atuais pelas abaixo.

INSERT INTO SaleQuoteItems#TEMP(Total, AccountID, TaxCodeID) VALUES (444.21, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b")
UPDATE PurchaseBills SET QuoteType = "Service", Lines = "SaleQuoteItems#TEMP" WHERE ID = "f979f0e7-1cd8-4fb9-b2c2-9d4546440cf7"
Inserir

O seguinte atributo é necessário ao executar uma inserção: QuoteType, CustomerID.

INSERT INTO SaleQuotes(QuoteType, CustomerID) VALUES ("item", "4635fd9e-82a7-4612-ae15-32c464ef7c48")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
BalanceDueAmount Decimal Verdadeiro Valor ainda a pagar na cotação de venda.
Date Datetime Verdadeiro A data da entrada.
IsTaxInclusive Boolean Falso True indica que a transação está definida para incluir impostos. Falso indica que a transação não inclui impostos.
JournalMemo String Falso Texto do memorando do diário descrevendo a venda.
Number String Falso Número da cotação de vendas.
QuoteType String Falso Tipo da cotação. Um de: Item, Serviço, Profissional, TimeBilling, Diversos.
ReferralSource String Falso Fonte de referência selecionada na cotação de venda.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
Subtotal Decimal Verdadeiro Se IsTaxInclusive = false, a soma de todos os valores de linhas exclusivas de impostos. Se IsTaxInclusive = true, a soma de todos os valores de linha com impostos incluídos.
TotalAmount Decimal Verdadeiro Valor total da cotação de venda.
TotalTax Decimal Verdadeiro Total de todos os valores de impostos aplicáveis à cotação de venda.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
CustomerPurchaseOrderNumber String Falso Número do pedido do cliente.
CustomerID Uuid Falso Identificador de guid exclusivo pertencente ao contato do cliente atribuído.
CustomerDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do cliente.
CustomerName String Verdadeiro Nome do contato do cliente.
CustomerURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do cliente.
Freight Decimal Falso Valor do frete com imposto incluído aplicável à cotação de venda.
FreightTaxCodeID Uuid Verdadeiro Identificador de guid exclusivo pertencente ao código de imposto atribuído.
FreightTaxCodeCode String Verdadeiro Código fiscal de 3 dígitos.
FreightTaxCodeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de código de imposto.
CategoryID Uuid Falso Identificador de categoria exclusivo na forma de um guid.
CategoryDisplayID String Verdadeiro ID de exibição para a categoria.
CategoryName String Verdadeiro Nome da categoria.
CategoryURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de categoria.
SalespersonID Uuid Falso Identificador exclusivo na forma de um guid.
SalespersonDisplayID String Verdadeiro Identificação do cartão de contato do funcionário.
SalespersonName String Verdadeiro Nome de contato do funcionário selecionado.
SalespersonURI String Verdadeiro Identificador de recurso uniforme associado ao funcionário.
TermsDiscount Decimal Verdadeiro Valor do desconto que será aplicado se o pagamento for feito integralmente até a data do desconto.
TermsDiscountDate Integer Falso Se PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber ou NumberOfDaysAfterEOM, defina o número de dias em que o cliente deve pagar para receber descontos. Se PaymentIsDue = OnADayOfTheMonth ou DayOfMonthAfterEOM, defina o dia do mês em que o pagamento deve ser feito para receber descontos.
TermsDiscountExpiryDate Datetime Verdadeiro Data em que o pagamento deve ser pago integralmente na cotação para receber o desconto.
TermsDiscountForEarlyPayment Double Falso % de desconto para pagamento antecipado.
TermsDueDate Datetime Verdadeiro Data em que o pagamento é devido.
TermsFinanceCharge Decimal Verdadeiro Taxa de atraso de pagamento a ser cobrada se o pagamento não for feito integralmente até a data de vencimento.
TermsMonthlyChargeForLatePayment Double Falso % de cobrança mensal por atraso no pagamento.
TermsPaymentIsDue String Falso Definições de termos de pagamento padrão: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
TermsBalanceDueDate Integer Verdadeiro Se PaymentIsDue = CashOnDelivery, PrePaid, InAGivenNumberOfDaysNumber ou NumberOfDaysAfterEOM, defina o número de dias em que o cliente deve pagar as faturas. Se PaymentIsDue = OnADayOfTheMonth ou DayOfMonthAfterEOM, defina o dia do mês em que o pagamento deve ser feito para pagar as faturas.
Lines String Falso Uma matriz de informações de cotação de linha de venda.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.
Comment String Falso Cotações de Vendas Comentário
ShippingMethod String Falso Método de envio
PromisedDate Datetime Falso Data Prometida da Transação.

Gastando Transações

Devolva, atualize, crie e exclua transações de dinheiro gasto para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, AmountPaid, ChequePrinted, Date, DeliveryStatus, IsTaxInclusive, Memo, PayFrom, PayeeAddress, PaymentNumber, StatementParticulars, TotalTax, AccountID, AccountDisplayID, AccountName, CategoryID, CategoryDisplayID, CategoryName, ContactID, ContactDisplayID, ContactName, ContactType. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM SpendingTransactions WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM SpendingTransactions WHERE AmountPaid = 120.45
SELECT * FROM SpendingTransactions WHERE AccountID = "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f"
Atualizar

Para atualizar uma transação existente, juntamente com suas linhas, podemos passar uma string JSON para o valor de linhas ou usar uma tabela temporária como abaixo. Observação: isso substituirá todas as linhas atuais pelas abaixo.

INSERT INTO SpendingTransactionItems#TEMP(Amount, AccountID, TaxCodeID, RowID, RowVersion) VALUES (22.3, "44a7b2bc-0a0e-4381-86fc-9b2c7a479f8f", "bd0f9821-4437-4ec2-9c95-c1bdbdd26c7b", 656, "8733325201913151488")
UPDATE ReceivingTransactions SET PaymentMethod = "Cash", Lines = "SpendingTransactionItems#TEMP" WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: Date, PayFrom, AccountID, ContactID.

INSERT INTO SpendingTransactions(Date, PayFrom, AccountId, ContactId) VALUES ("01/01/2019", "Account", "c195ee7d-2954-42a6-8a19-6f362442bf89", "4635fd9e-82a7-4612-ae15-32c464ef7c48")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
AmountPaid Double Verdadeiro Total de todos os valores pagos.
ChequePrinted Boolean Falso Verdadeiro indica que você não precisa imprimir um cheque para esse dinheiro gasto. Falso indica que você pode imprimir um cheque para gastar dinheiro.
Date Datetime Falso A data da entrada.
DeliveryStatus String Falso Status de entrega atribuído ao pagamento: ToBePrinted, ToBeEmailed, ToBePrintedAndEmailed, YetPrintedOrSent.
IsTaxInclusive Boolean Falso True indica que a transação está definida para incluir impostos com o Valor incluindo impostos. Falso indica que a transação não inclui impostos com o Valor do valor sem impostos.
Memo String Falso Texto de memorando para o objeto.
PayFrom String Falso Se alocar uma conta bancária para o pagamento, especifique Conta. Se estiver usando pagamentos eletrônicos, especifique ElectronicPayments.
PayeeAddress String Falso Nome e endereço do beneficiário, se um contato for fornecido no POST e PayeeAddress for deixado em branco, o endereço 1 do contato será o padrão. Se nem Contact nem PayAddress forem atribuídos no POST, o padrão será nulo.
PaymentNumber String Falso Nº do ID da transação de pagamento, se deixado em branco no POST, será incrementado automaticamente com base no último # registrado.
StatementParticulars String Falso APENAS aplicável para pagamentos eletrônicos. Detalhes anexados ao pagamento eletrônico.
TotalTax Double Verdadeiro Total de todos os valores de impostos aplicáveis ao dinheiro gasto.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
AccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Verdadeiro Nome da conta.
AccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
CategoryID Uuid Falso Identificador de categoria exclusivo na forma de um guid.
CategoryDisplayID String Verdadeiro ID de exibição para a categoria.
CategoryName String Verdadeiro Nome da categoria.
CategoryURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de categoria.
ContactID Uuid Falso Identificador exclusivo na forma de um guid.
ContactDisplayID String Verdadeiro O ID do cartão de contato também pode ser usado como um identificador de contato exclusivo.
ContactName String Verdadeiro Nome do registro do contato.
ContactType String Verdadeiro O tipo de cartão do registro do contato pode ser Cliente, Fornecedor, Funcionário ou Pessoal.
ContactURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato.
Lines String Falso Uma matriz de informações sobre a linha de dinheiro gasto.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

FornecedorPagamentos

Retorne, crie e exclua pagamentos de fornecedores para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, AmountPaid, Date, DeliveryStatus, Memo, PayFrom, PayeeAddress, PaymentNumber, StatementParticulars, AccountID, AccountDisplayID, AccountName, SupplierID, SupplierDisplayID, SupplierName, ForeignCurrencyID, ForeignCurrencyCode, ForeignCurrencyName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM SupplierPayments WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM SupplierPayments WHERE Memo = "memo"
SELECT * FROM SupplierPayments WHERE AmountPaid = 46.502
SELECT * FROM SupplierPayments WHERE PayeeAddress = "WLJ Real Estate 555 High Street Chatswood NSW 2067 Australia"
Atualizar

Para atualizar um pagamento existente, juntamente com suas linhas, podemos passar uma string JSON para o valor de linhas ou usar uma tabela temporária como abaixo. Observação: isso substituirá todas as linhas atuais pelas abaixo.

INSERT INTO SupplierPaymentItems#TEMP(AmountApplied, PurchaseID) VALUES (444.21, " 0229a075-f93a-4b6c-85d7-0ffd5ba43982")
UPDATE SupplierPayments SET Lines = "supplierpaymentitems#TEMP" WHERE ID = "c3d2350b-733a-4140-8dda-ffa0f34d4297"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: PayFrom, AccountID, SupplierID, Lines.

INSERT INTO SupplierPaymentItems#TEMP(amountapplied, purchaseid) VALUES (444.21, "415ffd17-9fb7-45b4-aeb1-3af0db11ff84")
INSERT INTO SupplierPayments(PayFrom, AccountId, SupplierId, Lines) VALUES ("Account", "c195ee7d-2954-42a6-8a19-6f362442bf89", "9421b774-20fa-4c5f-bced-fbb6ecd42ebd", "SupplierPaymentItems#TEMP")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
AmountPaid Double Falso Total de todos os valores pagos na(s) fatura(s) de compra.
Date Datetime Falso A data da entrada.
DeliveryStatus String Falso Status de entrega atribuído ao pagamento: Print = ToBePrinted, E-mail = ToBeEmailed, PrintAndEmail = ToBePrintedAndEmailed, Nothing = YetPrintedOrSent.
Memo String Falso Texto de memorando para o objeto.
PayFrom String Falso Se alocar uma conta bancária para o pagamento, especifique Conta. Se estiver usando pagamentos eletrônicos, especifique ElectronicPayments.
PayeeAddress String Falso Nome do beneficiário e endereço do contato do fornecedor.
PaymentNumber String Falso ID Nº da transação de pagamento.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
StatementParticulars String Falso APENAS aplicável para pagamentos eletrônicos. Detalhes anexados ao pagamento eletrônico.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
AccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Verdadeiro Nome da conta.
AccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
SupplierID Uuid Falso Identificador de guid exclusivo pertencente ao contato do fornecedor atribuído.
SupplierDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do fornecedor.
SupplierName String Verdadeiro Nome do contato do fornecedor.
SupplierURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do fornecedor.
ForeignCurrencyID Uuid Verdadeiro Identificador exclusivo na forma de um guid.
ForeignCurrencyCode String Verdadeiro O código da moeda.
ForeignCurrencyName String Verdadeiro O nome completo da moeda.
ForeignCurrencyURI String Verdadeiro Identificador de recurso uniforme associado à compra.
Lines String Falso Uma matriz de informações de linha de ordem/fatura de compra
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Códigos de Impostos

Códigos de imposto para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Code, Description, IsRateNegative, LuxuryCarTaxThreshold, Rate, Type, TaxCollectedAccountID, TaxCollectedAccountDisplayID, TaxCollectedAccountName, TaxPaidAccountID, TaxPaidAccountDisplayID, TaxPaidAccountName, WithholdingCreditAccountID, WithholdingCreditAccountDisplayID, WithholdingCreditAccountName, Reter ingPayableAccountID, WithholdingPayableAccountDisplayID, WithholdingPayableAccountName, ImportDutyPayableAccountID, ImportDutyPayableAccountDisplayID, ImportDutyPayableAccountName, LinkedSupplierID, LinkedSupplierDisplayID, LinkedSupplierName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM TaxCodes WHERE WithholdingPayableAccountID = "e1b278bb-9ba3-4d2a-8dda-a49d09dcc471"
SELECT * FROM TaxCodes WHERE Rate = 46.5
SELECT * FROM TaxCodes WHERE Description = "No ABN Withholding" AND Code = "ABN"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: Código, Descrição, Tipo, TaxCollectedAccountID, TaxPaidAccountID.

INSERT INTO TaxCodes(Code, Description, Type, TaxCollectedAccountID, TaxPaidAccountID) VALUES ("CDE", "Example tax code", "NoABN_TFN", "446d2226-254b-4821-acc2-7031842e0166", "9421b774-20fa-4c5f-bced-fbb6ecd42ebd")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
Code String Falso Código de 3 dígitos atribuído ao código de imposto.
Description String Falso Descrição dada ao código tributário.
IsRateNegative Boolean Falso True indica que a taxa de imposto é um valor negativo. Falso indica que a taxa de imposto é um valor positivo.
LuxuryCarTaxThreshold Decimal Falso Valor em dólares que deve ser excedido antes que o imposto seja calculado usando este código de imposto.
Rate Decimal Falso Taxa de imposto atribuída.
Type String Falso Os tipos de imposto consistem no seguinte: ImportDuty, SalesTax GST_VAT (imposto sobre bens e serviços), InputTaxed, Consolidated, LuxuryCarTax, WithholdingsTax, NoABN_TFN.
TaxCollectedAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
TaxCollectedAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
TaxCollectedAccountName String Verdadeiro Nome da conta.
TaxCollectedAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
TaxPaidAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
TaxPaidAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
TaxPaidAccountName String Verdadeiro Nome da conta.
TaxPaidAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
WithholdingCreditAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
WithholdingCreditAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
WithholdingCreditAccountName String Verdadeiro Nome da conta.
WithholdingCreditAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
WithholdingPayableAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
WithholdingPayableAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
WithholdingPayableAccountName String Verdadeiro Nome da conta.
WithholdingPayableAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
ImportDutyPayableAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
ImportDutyPayableAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
ImportDutyPayableAccountName String Verdadeiro Nome da conta.
ImportDutyPayableAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
LinkedSupplierID Uuid Falso Identificador de guid exclusivo pertencente ao contato do fornecedor atribuído.
LinkedSupplierDisplayID String Verdadeiro O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do fornecedor.
LinkedSupplierName String Verdadeiro Nome do contato do fornecedor.
LinkedSupplierURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de contato do fornecedor.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

TimesheetLineEntries

Retornar entradas do quadro de horários para um arquivo da empresa AccountRight

Colunas
Nome Tipo Somente leitura Descrição
TimeSheetId [KEY] Uuid Verdadeiro Identificador de categoria exclusivo na forma de um guid.
EntryId Uuid Verdadeiro Identificador de guid exclusivo pertencente à entrada de linha.
EntryDate Datetime Falso Data da entrada, formato AAAA-MM-DD HH:MM:SS
EntryHours Double Falso Número de horas atribuídas para o dia de entrada.
EntryProcessed Boolean Verdadeiro indica que a entrada do quadro de horários foi processada ou não como parte da folha de pagamento
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

TimesheetLineItems

Retornar entradas do quadro de horários para um arquivo da empresa AccountRight

Colunas
Nome Tipo Somente leitura Descrição
TimeSheetId [KEY] Uuid Verdadeiro Identificador de categoria exclusivo na forma de um guid.
PayrollCategoryId Uuid Falso Identificador exclusivo da categoria salarial da folha de pagamento na forma de um guid.
PayrollCategoryName String Verdadeiro Nome da categoria salarial da folha de pagamento.
PayrollCategoryType String Verdadeiro Indica o tipo de categoria da folha de pagamento, ou seja: Salário, Dedução, Imposto.
PayrollCategoryURI String Verdadeiro Identificador uniforme de recurso associado ao objeto categoria salarial folha de pagamento.
JobId Uuid Verdadeiro Identificador de guid exclusivo pertencente ao trabalho para esta linha da entrada do quadro de horários.
JobNumber String Verdadeiro Número atribuído ao trabalho.
JobName String Verdadeiro Nome atribuído ao trabalho.
JobURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de trabalho.
ActivityId Uuid Verdadeiro Identificador de guid exclusivo pertencente à atividade atribuída a esta linha da entrada do quadro de horários.
ActivityName String Verdadeiro Nome da atividade.
ActivityURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de atividade.
CustomerId Uuid Verdadeiro Identificador de guid exclusivo pertencente ao cliente atribuído para esta linha da entrada do quadro de horários.
CustomerName String Verdadeiro Nome do cliente.
CustomerDisplayID String Falso O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do cliente.
CustomerURI String Verdadeiro Identificador de recurso uniforme associado ao objeto cliente.
Notes String Verdadeiro Notas anexadas à entrada do quadro de horários.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Quadros de Horários

Retornar entradas do quadro de horários para um arquivo da empresa AccountRight

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com o operador =. Além disso, as consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam o tipo de comparação acima para filtragem do lado do servidor: ID, EmployeeName, EmployeeDisplayId, StartDate, EndDate. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM Categories WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM Timesheets WHERE EmployeeName = "Mary Jones"
SELECT * FROM Timesheets WHERE EmployeeDisplayId = "EMP00001"
SELECT * FROM Timesheets WHERE StartDate = "2019-10-28"
SELECT * FROM Timesheets WHERE EndDate = "2019-11-03"
Colunas
Nome Tipo Somente leitura Descrição
Id [KEY] Uuid Verdadeiro Identificador de categoria exclusivo na forma de um guid.
EmployeeName String Verdadeiro Nome do funcionário.
EmployeeDisplayId String Verdadeiro O ID do cartão de contato do funcionário também pode ser usado como um identificador exclusivo de contato do funcionário.
EmployeeURI String Verdadeiro Identificador de recurso uniforme associado ao objeto empregado.
StartDate Datetime Falso Data de início do período do quadro de horários, formato AAAA-MM-DD HH:MM:SS
EndDate Datetime Falso Data em que o período do quadro de horários termina, formato AAAA-MM-DD HH:MM:SS
URI String Verdadeiro Identificador de recurso uniforme associado ao objeto empregado.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

TransferindoTransações

Devolva, atualize, crie e exclua transações de transferência de dinheiro para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Amount, TransferNumber, Memo, Date, ToAccountID, ToAccountDisplayID, ToAccountName, FromAccountID, FromAccountDisplayID, FromAccountName, CategoryID, CategoryDisplayID, CategoryName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM TransferringTransactions WHERE ID = "bfaade84-1adf-4e2d-acfd-629e95d09de7"
SELECT * FROM TransferringTransactions WHERE Amount = 3300
SELECT * FROM TransferringTransactions WHERE TransferNumber = "TR000007" OR TransferNumber = "TR000008"
Inserir

Os seguintes atributos são necessários ao realizar uma inserção: Data, Valor, ToAccountID, FromAccountID.

INSERT INTO TransferringTransactions(Date, Amount, ToAccountID, FromAccountID) VALUES ("01/01/2019", 6700.0, "446d2226-254b-4821-acc2-7031842e0166", "9421b774-20fa-4c5f-bced-fbb6ecd42ebd")
Colunas
Nome Tipo Somente leitura Descrição
ID [KEY] Uuid Verdadeiro Identificador exclusivo na forma de um guid.
Amount Double Falso Valor a ser alocado na conta, deve ser diferente de zero.
TransferNumber String Falso Nº do ID da transação de pagamento, se deixado em branco no POST, será incrementado automaticamente com base no último # registrado.
Memo String Falso Texto de memorando descrevendo a transação de transferência de dinheiro.
Date Datetime Falso Entrada da data da transação.
RowVersion String Verdadeiro Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String Verdadeiro O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
ToAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
ToAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
ToAccountName String Verdadeiro Nome da conta.
ToAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
FromAccountID Uuid Falso Identificador exclusivo da conta na forma de um guid.
FromAccountDisplayID String Verdadeiro Código de conta. O formato inclui separador, ou seja, 4-1100
FromAccountName String Verdadeiro Nome da conta.
FromAccountURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de conta.
CategoryID Uuid Verdadeiro Identificador de categoria exclusivo na forma de um guid.
CategoryDisplayID String Verdadeiro ID de exibição para a categoria.
CategoryName String Verdadeiro Nome da categoria.
CategoryURI String Verdadeiro Identificador de recurso uniforme associado ao objeto de categoria.
CompanyFileId String Verdadeiro A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Visualizações

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

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

Conector Jitterbit para Exibições MYOB

Nome Descrição
AccountBudgetItems Retornar e atualizar itens de orçamento da conta do razão geral
AccountingProperties Retorna Informações sobre os detalhes do exercício.
AccountRegister Retorna a atividade da conta do razão geral.
BalanceSheetSummaryReport Retorna um Resumo do Balanço.
BankingTransactions Retorna uma lista de transações de extrato bancário para um arquivo da empresa AccountRight.
Categories Categorias de retorno para rastreamento de centro de custo
CategoryRegisters Transações de retorno agrupadas com categorias
Company Retorna os detalhes das informações da empresa.
CompanyFiles Retorna uma lista de arquivos da empresa.
CompanyPreferences Retorna as preferências de arquivo de dados da empresa para um arquivo da empresa AccountRight.
ContactAddressItems Itens de endereço de contato.
CreditSettlementItems Itens de liquidação de crédito.
Currencies Veja as moedas em um arquivo da empresa Accountright Live.
CustomerPaymentInvoices Itens de pagamento do cliente para um arquivo da empresa AccountRight.
DebitSettlementItems Itens de liquidação de débito.
EmployeeBankAccountItems Itens da conta bancária do funcionário.
EmployeePayrollAdviceReport Retorne um relatório de aviso de pagamento mostrando os detalhes do contracheque do funcionário para um arquivo da empresa AccountRight.
EmployeePayrollCategoryItems Itens de categoria da folha de pagamento do empregado.
EmployeePayrollDeductionItems Itens de desconto em folha de pagamento de funcionários.
EmployeePayrollEntitlementItems Itens de direito da folha de pagamento do empregado.
EmployeePayrollExpenseItems Itens de despesas com folha de pagamento de funcionários.
EmployeePayrollWageCategoryItems Itens da categoria salarial do empregado.
InventoryAdjustmentLines Retornar e atualizar Linhas de Ajuste de Estoque
ItemLocations Retornar informações de localização de um item inventariado
ItemSellingPrices Retorne e atualize a matriz de preço do item para vários preços de venda do cliente.
JobBudgetItems Itens de orçamento de trabalho.
JournalItems Itens de linha do diário.
JournalTransactionItems Informações de uso para a operação JournalTransactionItems.rsd.
JournalTransactions Informações de uso para a operação JournalTransactions.rsd.
Locations Retornar informações de localização de um item inventariado.
NZGSTReport Retorna um relatório GST para arquivos AccountRight da Nova Zelândia.
PayrollCategories Retorna informações genéricas sobre todos os tipos de categoria de folha de pagamento para um arquivo da empresa AccountRight.
PayrollCategorySummaryReport Retorna um relatório Resumo de categoria de folha de pagamento para um arquivo AccountRight.
PayrollDeductions Retornar categorias de folha de pagamento do tipo dedução para um arquivo da empresa AccountRight
PayrollEntitlements Retornar categorias de folha de pagamento do tipo direito para um arquivo da empresa AccountRight.
PayrollExpenses Retornar categorias de folha de pagamento do tipo despesa para um arquivo da empresa AccountRight.
PayrollSuperannuations Retornar categorias de folha de pagamento do tipo aposentadoria para um arquivo da empresa AccountRight.
PayrollTaxes Retornar categorias de folha de pagamento do tipo imposto para um arquivo da empresa AccountRight.
PayrollTaxTables Retornar tabelas de impostos sobre a folha de pagamento carregadas em um arquivo da empresa AccountRight.
ProfitAndLossSummaryReport Retorna um resumo de lucros e perdas para um arquivo AccountRight.
PurchaseBillItems Retorne todos os tipos de fatura de compra para um arquivo da empresa AccountRight.
PurchaseOrderItems Retorne todos os tipos de ordem de compra para um arquivo da empresa AccountRight.
ReceivingTransactionItems Receba transações de dinheiro para um arquivo da empresa AccountRight.
SaleInvoiceItems Retorne todos os tipos de fatura de venda para um arquivo da empresa AccountRight.
SaleOrderItems Retorna todos os tipos de pedidos de venda para um arquivo da empresa AccountRight.
SaleQuoteItems Retorna todos os tipos de cotação de venda para um arquivo da empresa AccountRight.
SpendingTransactionItems Gastar itens de transação de dinheiro para um arquivo da empresa AccountRight.
SuperannuationFunds Detalhes do fundo de aposentadoria para um arquivo da empresa AccountRight.
SupplierPaymentItems Itens de pagamento do fornecedor para um arquivo da empresa AccountRight.
TaxCodeSummaryReport Retorna um relatório de resumo de código de imposto para arquivos AccountRight.
TransactionCodingSummaryReport Retorna um relatório do número total de transações codificadas e não codificadas em um arquivo AccountRight.

AccountBudgetItems

Retornar e atualizar itens de orçamento da conta do razão geral

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
FinancialYear Integer O ano financeiro pode consistir apenas no ano fiscal atual ou no próximo ano fiscal.
LastMonthInFinancialYear Integer Número que representa o último mês do exercício financeiro. Por exemplo, 3 indica março.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountName String Nome da conta.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
MonthlyBudgets String Uma matriz de informações mensais do orçamento da conta.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Propriedades Contábeis

Retorna Informações sobre os detalhes do exercício.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
ConversionDate Datetime Nome da empresa inserido na janela Informações da empresa.
CurrentFinancialYear Integer O número de série do produto AccountRight exclusivo para sua assinatura.
LastMonthFinancialYear Integer Endereço conforme inserido na janela Informações da empresa.
RowVersion String Número de incremento que pode ser usado para controle de alterações, mas não preserva uma data ou hora.

Conta Registrar

Retorna a atividade da conta do razão geral.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Activity, Adjustment, Month, Year, YearEndActivity, YearEndAdjustment, AccountID, AccountDisplayID, AccountName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM AccountRegister WHERE AccountID = "d3f55ef1-ce77-4ef2-a415-61d04db2c5fc"
SELECT * FROM AccountRegister WHERE AccountName = "AccountName"
SELECT * FROM AccountRegister WHERE Month = 6
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
Activity Decimal Atividade líquida na conta de lucros e perdas ou movimento líquido nas contas do balanço.
Adjustment Decimal Ajustes.
Month Integer Mês em que a atividade foi gerada, ou seja, dezembro = 12.
Year Integer Ano em que a atividade foi gerada, ou seja, 2014.
YearEndActivity Decimal Atividade líquida na conta de lucros e perdas ou movimento líquido nas contas do balanço para ajustes de final de ano.
YearEndAdjustment Decimal Entradas do Diário Geral registradas fora do ano fiscal de 12 meses.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
UnitCount Decimal Quantidade saldo da conta.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

BalançoRelatórioResumo

Retorna um Resumo do Balanço.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: AsOfDate, YearEndAdjust. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM BalanceSheetSummaryReport WHERE AsOfDate = '2021-05-31 00:00:00' AND YearEndAdjust = false
Colunas
Nome Tipo Descrição
AccountTotal Decimal Valor total da conta para o intervalo de datas especificado.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
AsOfDate Date Data do período, formato AAAA-MM-DD HH:MM:SS
YearEndAdjust Boolean Se você estiver incluindo ajustes de final de ano. Este é um valor verdadeiro ou falso.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Transações Bancárias

Retorna uma lista de transações de extrato bancário para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Data, Descrição, IsCredit, StatementDate, Status, Valor, AccountID, AccountDisplayID, AccountName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM BankingTransactions WHERE ID = "6d35e53a-5070-432d-b9ec-f4791e353352"
SELECT * FROM BankingTransactions WHERE IsCredit = true
SELECT * FROM BankingTransactions WHERE Amount = 1400 OR Amount = 1800
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
Date Datetime Data da transação.
Description String Texto descritivo da transação.
IsCredit Boolean Verdadeiro ou falso.
StatementDate Datetime Data em que BankStatement foi puxado para AccountRight.
Status String Um de: Não codificado, codificado, oculto.
Amount Decimal Valor em dólares do saque ou depósito.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Categorias

Categorias de retorno para rastreamento de centro de custo

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com o operador =. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam o tipo de comparação acima para filtragem do lado do servidor: ID, DisplayID, Nome, Descrição, IsActive. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM Categories WHERE ID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM Categories WHERE DisplayID = "TestDisplayID"
SELECT * FROM Categories WHERE Name = "Category 1" OR Description = "Test description"
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador de categoria exclusivo na forma de um guid.
DisplayId String ID de exibição atribuído à categoria.
Name String Nome atribuído à categoria.
Description String Texto descritivo para a categoria.
IsActive Boolean True indica que a categoria está ativa. Falso indica que a categoria está inativa.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

CategoriaRegistros

Transações de retorno agrupadas com categorias

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com o operador =. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam o tipo de comparação acima para filtragem do lado do servidor: CategoryID, AccountID, Year, Month, Activity, YearEndActivity. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM CategoryRegisters WHERE CategoryID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM CategoryRegisters WHERE AccountID = "1bed306d-2da4-49b3-9023-153c3dc5b2e9"
SELECT * FROM CategoryRegisters WHERE Year = "2019"
SELECT * FROM CategoryRegisters WHERE Month = "09"
Colunas
Nome Tipo Descrição
CategoryID Uuid Identificador de categoria exclusivo na forma de um guid para a categoria.
AccountID Uuid Identificador de categoria exclusivo na forma de um guid para a conta.
Year Integer Exercício financeiro em que a atividade foi gerada, ou seja, 2014.
Month Integer Mês em que a atividade foi gerada, ou seja, dezembro = 12.
Activity Decimal Atividade líquida na conta de lucros e perdas ou movimento líquido nas contas do balanço.
YearEndActivity Decimal Atividade líquida na conta de lucros e perdas ou movimento líquido nas contas do balanço para ajustes de final de ano.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Empresa

Retorna os detalhes das informações da empresa.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
CompanyName String Nome da empresa inserido na janela Informações da empresa.
SerialNumber Integer O número de série do produto AccountRight exclusivo para sua assinatura.
Address String Endereço conforme inserido na janela Informações da empresa.
PhoneNumber String Número de telefone inserido na janela Informações da empresa.
FaxNumber String Número de fax inserido na janela Informações da empresa.
EmailAddress String Endereço E-mail inserido na janela Informações da empresa.
ABNOrTFN String ABN ou TFN conforme inserido na janela Informações da empresa.
ABNBranch String Filial do ABN conforme inserido na janela Informações da empresa.
ACN String ACN conforme inserido na janela Informações da empresa.
SalesTaxNumber String SalesTaxNumber conforme inserido na janela Informações da empresa
PayeeNumber String Número do beneficiário conforme inserido na janela Informações da empresa.
ReadOnly Boolean Indica se a licença do arquivo da empresa expirou ou se o arquivo online foi retirado.
RowVersion String Número de incremento que pode ser usado para controle de alterações, mas não preserva uma data ou hora.

Arquivos da Empresa

Retorna uma lista de arquivos da empresa.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM CompanyFiles WHERE ID = "68556195-8f87-4e1a-85e9-069f5fc52497"
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
CheckedOutBy String meu. Usuário MYOB que fez check-out do arquivo offline.
CheckedOutDate Datetime Data em que o arquivo online foi retirado offline.
Country String O código do país de 2 caracteres. EX.: AU ou NZ
LibraryPath String Nome do caminho para o arquivo da empresa.s
Name String Nome do objeto.
ProductVersion String MYOB AccountRight Live versão com a qual este arquivo da empresa foi criado. EX: 2013.3.
ProductLevelCode Integer Código do produto AccountRight Live.
ProductLevelName String Nome do produto AccountRight Live, ou seja, Basics, Standard, Plus.
SerialNumber String O número de série de 12 dígitos do arquivo AccountRight.
UiAccessFlags Integer O identificador de tipo de produto acessível por arquivo. 0-LocalAccountRight, 1-OnlineAccountRight, 2-New Essentials, 3-AccountRight e NewEssentials
Uri String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.

Preferências da Empresa

Retorna as preferências de arquivo de dados da empresa para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
PreferToReceiveMoneyIntoUndepositedFunds Boolean Verdadeiro indica que a preferência Quando recebo dinheiro, prefiro Agrupar com Outros fundos não depositados está ativada. Falso indica que a preferência Quando recebo dinheiro, prefiro Grupo com Outros fundos não depositados está desativada.
PurchasesTermsBalanceDueDate Integer A data de vencimento do saldo que inclui EOM (final do mês).
PurchasesTermsCreditLimit Decimal Limite de crédito de contato do cliente padrão.
PurchasesTermsDiscountDate Integer A data de desconto que inclui EOM (fim do mês).
PurchasesTermsDiscountForEarlyPayment Double % de desconto para pagamento antecipado.
PurchasesTermsMonthlyChargeForLatePayment Double % de cobrança mensal por atraso no pagamento.
PurchasesTermsPaymentIsDue String Definições de termos de pagamento padrão: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
PurchasesTermsPriceLevel String Nível de preço padrão.
PurchasesTermsUseCustomerTaxCode Boolean Verdadeiro ou falso.
PurchasesTermsUseSupplierTaxCode Boolean Verdadeiro ou falso.
PurchasesTermsFreightTaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
PurchasesTermsFreightTaxCodeCode String Código fiscal de 3 dígitos.
PurchasesTermsFreightTaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
PurchasesTermsTaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
PurchasesTermsTaxCodeCode String Código fiscal de 3 dígitos.
PurchasesTermsTaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
ReportsAndFormsReportTaxablePayments Boolean True indica que o relatório de pagamentos tributáveis feitos aos contratados está ativado. Falso indica que o relatório de pagamentos tributáveis feitos aos contratados está desativado.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
SalesTermsBalanceDueDate Integer A data de vencimento do saldo que inclui EOM (final do mês).
SalesTermsCreditLimit Decimal Limite de crédito de contato do cliente padrão.
SalesTermsDiscountDate Integer A data de desconto que inclui EOM (fim do mês).
SalesTermsDiscountForEarlyPayment Double % de desconto para pagamento antecipado.
SalesTermsMonthlyChargeForLatePayment Double % de cobrança mensal por atraso no pagamento.
SalesTermsPaymentIsDue String Definições de termos de pagamento padrão: CashOnDelivery, PrePaid, InAGivenNumberOfDays, OnADayOfTheMonth, NumberOfDaysAfterEOM, DayOfMonthAfterEOM.
SalesTermsPriceLevel String Nível de preço padrão.
SalesTermsUseCustomerTaxCode Boolean Verdadeiro ou falso.
SalesTermsUseSupplierTaxCode Boolean Verdadeiro ou falso.
SalesTermsFreightTaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
SalesTermsFreightTaxCodeCode String Código fiscal de 3 dígitos.
SalesTermsFreightTaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
SalesTermsTaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
SalesTermsTaxCodeCode String Código fiscal de 3 dígitos.
SalesTermsTaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
SystemCategoryTracking String Pode consistir nos seguintes valores: Off, OnAndNotRequired, OnAndRequired.
SystemLockPeriodPriorTo String Período de bloqueio desativando entradas antes de uma determinada data.
SystemTransactionsCannotBeChangedMustBeReversed Boolean True indica que as transações não podem ser alteradas ou excluídas, elas devem ser revertidas. Falso indica que as transações podem ser alteradas ou excluídas.
TimesheetsUseTimesheetsFor String Pode consistir em TimeBillingAndPayroll ou Payroll.
TimesheetsWeekStartsOn String Dia em que a semana começa, ou seja: segunda-feira, terça-feira, quarta-feira.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

ContactAddressItems

Itens de endereço de contato.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
ContactID [KEY] Uuid Identificador exclusivo na forma de um guid.
City String Cidade do registro de endereço.
ContactName String Nome do contato no registro de endereço.
Country String País de localização para registro de endereço.
Email String Contato E-mail do registro de endereço.
Fax String Número de fax do registro de endereço.
Location Integer Um contato pode ter até cinco registros de endereço.
Phone1 String Número de telefone 1 do registro de endereço.
Phone2 String Número de telefone 2 do registro de endereço.
Phone3 String Número de telefone 3 do registro de endereço.
PostCode String Código postal do registro do endereço.
Salutation String Texto de saudação para registro de endereço.
State String Registro do estado do endereço. Atualizado em 2018.1, este campo é obrigatório para endereços com país em branco ou Austrália. Onde necessário, os valores válidos são: AAT, ACT, NSW, NT, QLD, SA, TAS, VIC, WA.
Street String Conteúdo completo do campo Endereço.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Itens de Liquidação de Crédito

Itens de liquidação de crédito.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
CreditSettlementID [KEY] Uuid Identificador exclusivo na forma de um guid.
AmountApplied Decimal Valor do crédito aplicado a transações de vendas, o valor deve ser maior que 0.
Type String Tipo de venda que pode consistir no seguinte: Fatura, Pedido.
SaleID Uuid Identificador exclusivo na forma de um guid.
SaleNumber String Número de venda.
SaleURI String Identificador de recurso uniforme associado à fatura.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Moedas

Visualize as moedas em um arquivo da empresa Accountright Live.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Código, CurrencyName, CurrencyRate. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM Currencies WHERE Code = "AED"
SELECT * FROM Currencies WHERE CurrencyName = "Emirati Dirham"
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
Code String Código ISO 4217 de três letras para esta moeda.
CurrencyName String Nome completo da moeda.
CurrencyRate Decimal Taxa de conversão da moeda local.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

ClientePagamentoFaturas

Itens de pagamento do cliente para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
CustomerPaymentID [KEY] Uuid Identificador exclusivo na forma de um guid.
ID Uuid Identificador de guid exclusivo pertencente à fatura.
AmountApplied Double Valor aplicado à fatura.
Number String Número da fatura.
RowID Integer Sequência da entrada dentro do conjunto de pagamento do cliente.
Type String Tipo de fatura: Fatura, Pedido.
URI String Identificador de recurso uniforme associado ao objeto de fatura.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Itens de Liquidação de Débito

Itens de liquidação de débito.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
DebitSettlementID [KEY] Uuid Identificador exclusivo na forma de um guid.
Type String Tipo de compra que pode consistir no seguinte: Bill, Order.
AmountApplied Double Valor de débito aplicado a transações de compras, o valor deve ser maior que 0. Voltar para o início
PurchaseID Uuid Identificador exclusivo na forma de um guid.
PurchaseNumber String Número de Compra.
PurchaseURI String Identificador de recurso uniforme associado à compra.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

EmployeeBankAccountItems

Itens da conta bancária do funcionário.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
EmployeeID [KEY] Uuid Identificador exclusivo na forma de um guid.
BSBNumber String Necessário apenas: para atualizar os detalhes de pagamento de um funcionário existente em que PaymentMethod = Electronic. O formato parece
BankAccountName String Necessário apenas: para atualizar os detalhes de pagamento de um funcionário existente em que PaymentMethod = Electronic.
BankAccountNumber String Necessário apenas: para atualizar os detalhes de pagamento de um funcionário existente em que PaymentMethod = Electronic.
Unit String As unidades podem consistir nos seguintes valores Enum: Percent, Dollars, RemainingAmount (somente leitura para a última conta na coleção).
Value Integer Valor do pagamento líquido a ser transferido para a conta do funcionário usando dólares (13,6) ou por cento (0,00 - 100,00)
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

FuncionárioPagamentoPagamentoConselhoRelatório

Retorne um relatório de aviso de pagamento mostrando os detalhes do contracheque do funcionário para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
AnnualSalary Decimal Valor do salário anual do funcionário (no momento da chamada da API).
ChequeNumber String Verifique o número ou o tipo de referência.
DateOfBirth Datetime Data de nascimento dos empregados.
EmployerABNOrTFN String ABN ou TFN conforme inserido na janela Informações da empresa ou no endpoint da empresa.
EmployerCompanyName String Nome da empresa conforme inserido na janela Informações da empresa ou endpoint da empresa.
EmployerURI String Identificador uniforme de recurso associado ao arquivo da empresa.
GrossPay Decimal Salários brutos por período de pagamento (valor total em dinheiro antes das deduções) do funcionário.
HourlyRate Decimal Taxa horária do empregado.
NetPay Decimal Salário líquido do período de pagamento (valor total em dinheiro após as deduções) do funcionário.
PayFrequency String A frequência de pagamento pode consistir no seguinte: semanalmente, quinzenalmente, duas vezes por mês, mensalmente.
PayPeriodEndDate Datetime Data de término do período de pagamento.
PayPeriodStartDate Datetime Data de início do período de pagamento.
PaymentDate Datetime Data em que o contracheque foi processado e pago,.
SuperannuationFundID Uuid Identificador guid exclusivo pertencente ao fundo de pensões.
SuperannuationFundName String Nome do fundo de pensões.
SuperannuationFundURI String Identificador de recurso uniforme associado ao fundo de pensões.
EmployeeID Uuid Identificador de guid exclusivo pertencente ao contato do funcionário atribuído.
EmployeeDisplayID String O ID do cartão de contato do cliente também pode ser usado como um identificador exclusivo de contato do funcionário.
EmployeeName String Nome do contato do funcionário.
EmployeeURI String Identificador de recurso uniforme associado ao objeto de contato do funcionário.
Amount Decimal Valor processado para categoria de folha de pagamento, ou seja, valores em $ para salários, aposentadoria, deduções e horas para direitos.
PayrollCategoryID Uuid Identificador de categoria exclusivo na forma de um guid.
PayrollCategoryName String Nome da categoria.
PayrollCategoryType String Indica o tipo de categoria da folha de pagamento, ou seja, Salário, Dedução, Despesa, Imposto.
PayrollCategoryURI String Identificador de recurso uniforme associado ao objeto de categoria.
Hours Integer Número de horas pagas na categoria folha de pagamento por hora ou acumuladas para direitos. Observação: se a categoria da folha de pagamento for do tipo salário, será retornado nulo.
CalculationRate Decimal A taxa de uma categoria de salário por hora é calculada. Observação: se o salário for do tipo salário, será retornado nulo.
YearToDate Decimal Valores acumulados no acumulado do ano acumulados neste ano da folha de pagamento com base nos pagamentos registrados.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

EmployeePayrollCategoryItems

Itens de categoria da folha de pagamento do empregado.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
EmployeeID [KEY] Uuid Identificador exclusivo na forma de um guid.
Amount Double A quantidade total.
IsCalculated Boolean Verdadeiro ou falso.
PayrollCategoryID Uuid Identificador de categoria exclusivo na forma de um guid.
PayrollCategoryName String Nome da categoria.
PayrollCategoryType String Tipo da categoria da folha de pagamento.
PayrollCategoryURI String Identificador de recurso uniforme associado ao objeto de categoria.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

EmpregadoPayrollDeductionItems

Itens de desconto em folha de pagamento de funcionários.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
PayrollDetailsID [KEY] Uuid Identificador exclusivo na forma de um guid.
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
Name String Nome da dedução.
Type String Tipo da dedução.
URI String Identificador de recurso uniforme associado à dedução de despesas.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

EmployeePayrollEntitlementItems

Itens de direito da folha de pagamento do empregado.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
PayrollDetailsID [KEY] Uuid Identificador exclusivo na forma de um guid.
CarryOver Decimal O número de horas transferidas do ano anterior da folha de pagamento.
EntitlementCategoryID Uuid Identificador de categoria exclusivo na forma de um guid.
EntitlementCategoryName String Nome da categoria.
EntitlementCategoryType String Indica o tipo de categoria da folha de pagamento, ou seja: Salário, Dedução, Aposentadoria.
EntitlementCategoryURI String Identificador de recurso uniforme associado ao objeto de categoria.
IsAssigned Boolean Verdadeiro ou falso.
Total Decimal O número de horas disponíveis no direito (Total = CarryOver + YearToDate).
YearToDate Decimal Número líquido de horas acumuladas neste ano da folha de pagamento.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

EmpregadoPayrollExpenseItems

Itens de despesas com folha de pagamento de funcionários.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
PayrollDetailsID [KEY] Uuid Identificador exclusivo na forma de um guid.
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
Name String Nome da despesa.
Type String Tipo da despesa.
URI String Identificador de recurso uniforme associado ao objeto de despesa.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

FuncionárioFolha de Pagamentosaláriocategoryitems

Itens da categoria salarial do empregado.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
PayrollDetailsID [KEY] Uuid Identificador exclusivo na forma de um guid.
ID [KEY] Uuid Identificador de categoria exclusivo na forma de um guid.
Name String Nome da categoria.
Type String Tipo da categoria.
URI String Identificador de recurso uniforme associado ao objeto de categoria.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Linhas de Ajuste de Estoque

Retornar e atualizar linhas de ajuste de estoque

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
Amount Double Valor em dólares atribuído ao item
Job String O conjunto de informações a seguir extrai os detalhes das tarefas
Memo String Texto do memorando descrevendo a linha de transação
Quantity Integer A quantidade de itens a serem ajustados
RowID Integer Sequência da entrada no conjunto diário de inventário
RowVersion String RowVersão
UnitCost Double Custo unitário atribuído ao item

Localização dos Itens

Retornar informações de localização de um item inventariado

Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo para localização na forma de um guid.
ItemID Uuid Identificador exclusivo na forma de um guid.
Identifier String Identificador atribuído ao local.
QuantityOnHand Decimal Quantidade de unidades mantidas em estoque
Name String Nome atribuído ao local.
URI String Identificador de recurso uniforme associado ao objeto de localização.

Preços de Venda do Item

Retorne e atualize a matriz de preço do item para vários preços de venda do cliente.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ItemPriceMatrixID. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM ItemSellingPrices WHERE ItemPriceMatrixID = "3a35e83a-5070-432d-b6ec-f4791f353352"
Colunas
Nome Tipo Descrição
ItemPriceMatrixID [KEY] Uuid Identificador exclusivo na forma de um guid.
QuantityOver Integer O primeiro QuantityOver deve ser sempre 0, para cada quebra de quantidade adicional, especifique a quantidade do item.
LevelA Double Preço do item Nível a, o padrão é o Preço de venda base dos itens.
LevelB Double Preço do item Nível b, o padrão é o Preço de venda base dos itens.
LevelC Double Preço do item Nível c, o padrão é o Preço de venda base dos itens.
LevelD Double Preço do item Nível d, o padrão é o Preço de venda base dos itens.
LevelE Double Preço do item Nível e, padrão para o Preço de venda base dos itens.
LevelF Double Preço do item Nível f, o padrão é o Preço de venda base dos itens.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

JobBudgetItems

Itens de orçamento de trabalho.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
JobBudgetID Uuid Identificador exclusivo na forma de um guid.
Amount Decimal Valor do orçamento para o trabalho.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

JournalItems

Itens de linha do diário.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
JournalID [KEY] Uuid Identificador exclusivo na forma de um guid.
Amount Double Valor em dólares lançado na linha da transação.
IsCredit Boolean True indica o valor lançado na conta como crédito. Falso indica o valor lançado na conta como débito.
IsOverriddenTaxAmount Boolean True indica que o valor do imposto foi alterado. Falso indica que o valor do imposto não foi alterado.
Memo String Texto de memorando aplicado à linha da transação.
RowID Integer Sequência da entrada dentro do conjunto diário geral.
TaxAmount Double Valor do imposto para a linha do diário se estiver usando um TaxCode aplicável.
RowVersion String Versão da linha para o item. Necessário para atualizar uma linha existente.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
JobID Uuid Identificador de trabalho exclusivo na forma de um guid.
JobNumber String Número atribuído ao trabalho.
JobName String Nome atribuído ao trabalho.
JobURI String Identificador de recurso uniforme associado ao objeto de trabalho.
TaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
TaxCodeCode String Código fiscal de 3 dígitos.
TaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

JournalTransactionItems

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

Informações Específicas da Tabela
Selecione

Somente a coluna JournalTransactionID, ao usar a comparação de igualdade, tem suporte para filtragem do lado do servidor.

Colunas
Nome Tipo Descrição
JournalTransactionID [KEY] Uuid Identificador exclusivo na forma de um guid.
AccountID Uuid
AccountDisplayID String
AccountName String
AccountURI String
Amount Decimal
IsCredit Boolean
JobID Uuid
JobName String
JobNumber String
JobUri String
LineDescription String
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

JournalTransactions

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

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, DisplayID, Description, DateOccurred, DatePosted, JournalType, SourceTransactionID, SourceTransactionTransactionType. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM JournalTransactions WHERE ID = "7cabea25-6250-4df5-bb37-77eb2d38f803"
SELECT * FROM JournalTransactions WHERE Description = "description" AND SourceTransactionTransactionType = "type"
Colunas
Nome Tipo Descrição
ID [KEY] Uuid
DisplayID String
Description String
DateOccurred Datetime
DatePosted Datetime
JournalType String
RowVersion String
SourceTransactionID Uuid
SourceTransactionTransactionType String
SourceTransactionURI String
URI String
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Localizações

Retornar informações de localização de um item inventariado.

Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador de local exclusivo na forma de um guid.
AddressCity String Cidade do endereço Cadastro.
AddressContactName String ContactName no registro de endereço.
AddressCountry String País do local para registro de endereço.
AddressEmail String Contato E-mail do registro de endereço.
AddressFax String Número de fax do registro de endereço.
AddressLocation Integer Um local pode ter um endereço.
AddressPhone1 String Número de telefone 1 do registro de endereço.
AddressPhone2 String Número de telefone 2 do registro de endereço.
AddressPhone3 String Número de telefone 3 do registro de endereço.
AddressPostCode String Código postal do registro do endereço.
AddressSalutation String Texto de saudação para registro de endereço.
AddressState String Registro do estado de endereço.
AddressStreet String Conteúdo completo do campo de endereço.
AddressWebsite String Endereço da Web mundial para contato.
CanSell Boolean Verdadeiro indica que os itens inventariados no local podem ser vendidos, Falso indica que os itens inventariados no local não podem ser vendidos
DisplayID String
Identifier String Identificador do local.
IsActive Boolean True indica que a localização está ativa, False indica que a localização está inativa.
IsIndividual Boolean
Name String Nome para um local individual.
Notes String Notas para o local.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.

Relatório NZGST

Retorna um relatório GST para arquivos AccountRight da Nova Zelândia.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: EndDate, ReportingPeriod, ReportingBasis, YearEndAdjust. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM PayrollCategorySummaryReport WHERE EndDate = "01/04/2019" AND ReportingBasis = "Cash"  AND ReportingPeriod = "6m" AND YearEndAdjust = false
Colunas
Nome Tipo Descrição
Address String O endereço da empresa.
CompanyName String O nome do negócio.
CreditAdjustments Decimal O valor dos ajustes de crédito para o intervalo de datas fornecido.
DebitAdjustments Decimal O valor dos ajustes de débito para o intervalo de datas fornecido.
IrdNumber String O número IRD da Empresa, formato xxx-xxx-xxx.
NetGSTSales Decimal O valor das vendas líquidas de GST para o intervalo de datas especificado.
PaymentAmount Decimal Valor total do pagamento para o intervalo de datas especificado.
PhoneNumber String O número de telefone da empresa.
TotalGSTCollected Decimal Total GST coletado para o intervalo de datas fornecido.
TotalGSTCollectedOnPurchases Decimal Total de GST coletado em compras para o intervalo de datas fornecido.
TotalGSTCollectedOnSales Decimal GST total coletado em vendas para o intervalo de datas especificado.
TotalGSTCredit Decimal Crédito total de GST para o intervalo de datas fornecido.
TotalPurchases Decimal Quantidade total de compras para o intervalo de datas fornecido.
TotalSales Decimal Quantidade total de vendas para o intervalo de datas fornecido.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
ZeroRatedSupplies Decimal Suprimentos com classificação zero total para o intervalo de datas fornecido.
EndDate Date Data de início do período.
ReportingPeriod String Período do relatório para o relatório. Isso será 1m, 2m ou 6m.
ReportingBasis String A base de relatório para o período será em dinheiro ou precisão.
YearEndAdjust Boolean Se você estiver incluindo ajustes de final de ano. Este é um valor verdadeiro ou falso.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Folha de PagamentoCategorias

Retorna informações genéricas sobre todos os tipos de categoria de folha de pagamento para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Nome, Tipo. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM PayrollCategories WHERE ID = "3a35e83a-5070-432d-b6ec-f4791f353352"
SELECT * FROM PayrollCategories WHERE Name = "criteria"
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
Name String Nome da categoria da folha de pagamento.
Type String Indica o tipo de categoria da folha de pagamento, por exemplo: Salário, Despesa, Dedução, Imposto, Aposentadoria, Direito.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Folha de PagamentoCategoriaResumoRelatório

Retorna um relatório Resumo de categoria de folha de pagamento para um arquivo AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: EndDate, StartDate, ReportingBasis, YearEndAdjust. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM PayrollCategorySummaryReport WHERE StartDate = "12/01/2018" AND EndDate = "01/04/2019" AND ReportingBasis = "Cash" AND YearEndAdjust = false
Colunas
Nome Tipo Descrição
Amount Decimal Valor total para a categoria de folha de pagamento para esse intervalo de datas.
Hours Decimal Horas totais para a categoria de folha de pagamento para esse intervalo de datas.
PayrollCategoryID Uuid Identificador de categoria exclusivo na forma de um guid.
PayrollCategoryName String Nome da categoria.
PayrollCategoryType String Tipo de categoria de folha de pagamento.
PayrollCategoryURI String Identificador de recurso uniforme associado ao objeto de categoria.
EndDate Date Data de início do período.
StartDate Date Data final do período.
ReportingBasis String A base de relatório para o período será em dinheiro ou precisão.
YearEndAdjust Boolean Se você estiver incluindo ajustes de final de ano. Este é um valor verdadeiro ou falso.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Deduções da Folha de Pagamento

Retornar categorias de folha de pagamento do tipo dedução para um arquivo da empresa AccountRight

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, CalculationBasisPercentageOf, CalculationBasisType, CalculationFixedDollarsOf, LimitAccrualPeriod, LimitFixedDollarsOf, LimitType, Name, StpCategory, Type, PayableAccountID, PayableAccountDisplayID, PayableAccountName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM PayrollDeductions WHERE ID = "PayrollEntitlements"
SELECT * FROM PayrollDeductions WHERE CalculationBasisPercentageOf = 28
SELECT * FROM PayrollDeductions WHERE PayableAccountName = "PayableAccountName"
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
CalculationBasisPercentageOf Decimal Porcentagem de super para calcular se CalculationBasis.Type = PercentageOfPayrollCategory.
CalculationBasisType String O tipo de cálculo a ser usado pode ser qualquer um dos 3 a seguir: UserEntered - use o valor do pagamento padrão dos funcionários ao processar. PercentageOfPayrollCategory - É igual a x percentual, calculado como uma % dos salários brutos ou outra categoria da folha de pagamento. FixedDollars - É igual a x dólar a contribuir para todos os funcionários vinculados.
CalculationFixedDollarsOf Decimal Valor de dedução nomeado CalculationBasis.Type = FixedDollars.
LimitAccrualPeriod String Como a despesa máxima é calculada se Limit.Type = FixedDollars. Pode consistir em qualquer um dos seguintes: PayPeriod, Month, Year, Hour.
LimitFixedDollarsOf Decimal Valor máximo da despesa se Limit.Type = FixedDollars.
LimitType String O tipo de cálculo a ser usado pode ser qualquer um dos 3 a seguir: NoLimit - sem limites para cálculos de despesas. PercentageOfPayrollCategory - É igual a x percentual, o limite é calculado como uma % dos salários brutos ou outra categoria da folha de pagamento. FixedDollars - É igual ao limite x dólar definido.
Name String Nome do objeto.
StpCategory String Categoria STP para esta categoria de folha de pagamento. Consulte a ajuda do MYOB para obter mais informações. Os valores válidos são: NotReportable (padrão), GrossPayments, PAYGWithholding, IsentoForeignIncome, CDEPPayments, AllowanceCar, AllowanceTransport, AllowanceTravel, AllowanceMeals, AllowanceLaundry, AllowanceOther, DeductionUnionProfAssocFees, DeductionWorkPlaceGiving, ReportableFringeBenefitsExemptAmount, ReportableFringeBenefitsTaxableAmount, ETPTaxableComponent, ETPTaxFreeComponent, ETPTaxWithholding, LumpSumPaymentATermination, LumpSumPaymentARedundancy, LumpSumPaymentB, LumpSumPaymentD, LumpSumPaymentE, SuperGuarantee, OrdinaryTimesEarnings, ReportableEmployerSuperContributions.
Type String Indica o tipo de categoria da folha de pagamento, ou seja: Salário, Despesa, Dedução.
PayableAccountID Uuid Identificador exclusivo da conta na forma de um guid.
PayableAccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
PayableAccountName String Nome da conta.
PayableAccountURI String Identificador de recurso uniforme associado ao objeto de conta.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Folha de PagamentoDireitos

Retornar categorias de folha de pagamento do tipo direito para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Name, PrintOnPayAdvice, StpCategory, Type, CalculationAccrualPeriod, CalculationFixedHoursOf, CalculationBasisType, CarryEntitlementOverToNextYear. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM PayrollEntitlements WHERE ID = "3a35e83a-5070-432d-b6ec-f4791f353352"
SELECT * FROM PayrollEntitlements WHERE Name = "criteria"
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
Name String Nome do objeto.
PrintOnPayAdvice Boolean Verdadeiro indica que as horas de licença acumuladas serão exibidas nos avisos de pagamento. Falso indica que as horas de licença acumuladas não serão exibidas nos avisos de pagamento.
StpCategory String Categoria STP para esta categoria de folha de pagamento. Consulte a ajuda do MYOB para obter mais informações. Os valores válidos são: NotReportable (padrão), GrossPayments, PAYGWithholding, IsentoForeignIncome, CDEPPayments, AllowanceCar, AllowanceTransport, AllowanceTravel, AllowanceMeals, AllowanceLaundry, AllowanceOther, DeductionUnionProfAssocFees, DeductionWorkPlaceGiving, ReportableFringeBenefitsExemptAmount, ReportableFringeBenefitsTaxableAmount, ETPTaxableComponent, ETPTaxFreeComponent, ETPTaxWithholding, LumpSumPaymentATermination, LumpSumPaymentARedundancy, LumpSumPaymentB, LumpSumPaymentD, LumpSumPaymentE, SuperGuarantee, OrdinaryTimesEarnings, ReportableEmployerSuperContributions.
Type String Indica o tipo de categoria da folha de pagamento, ou seja: Salário, Despesa, Dedução.
CalculationAccrualPeriod String Como as horas especificadas são acumuladas se CalculationBasis.Type = FixedHours. Pode consistir em qualquer um dos seguintes: PayPeriod, Month, Year, Hour.
CalculationFixedHoursOf Decimal Número de horas a acumular se CalculationBasis.Type = FixedHours.
CalculationBasisType String O tipo de cálculo a ser usado pode ser qualquer um dos 3 a seguir: UserEntered - use o valor do pagamento padrão dos funcionários ao processar. PercentageOfPayrollCategory - É igual a x percentual, calculado como uma % dos salários brutos ou outra categoria da folha de pagamento. FixedDollars - É igual a x dólar a contribuir para todos os funcionários vinculados.
CarryEntitlementOverToNextYear Boolean Verdadeiro indica a transferência de quaisquer horas de licença não utilizadas ao iniciar um novo ano de folha de pagamento. Falso indica não transferir horas de licença não utilizadas ao iniciar um novo ano de folha de pagamento.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
PayrollWages String Uma matriz de informações de categoria salarial vinculada, ao registrar as horas para o salário vinculado selecionado no pagamento de um funcionário, o saldo do direito será reduzido de acordo.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Despesas com Funcionários

Retornar categorias de folha de pagamento do tipo despesa para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, LimitAccrualPeriod, LimitFixedDollarsOf, LimitType, PrintOnPayAdvice, Threshold, Name, StpCategory, Type, PayrollCategoryID, PayrollCategoryName, PayrollCategoryType, CalculationBasisPercentageOf, CalculationBasisType, ExpenseAccountID, ExpenseAccountDisplayID, ExpenseAccountName, PayableAccount ID, PayableAccountDisplayID, PayableAccountName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM PayrollExpenses WHERE PrintOnPayAdvice = true
SELECT * FROM PayrollExpenses WHERE LimitFixedDollarsOf = 350
SELECT * FROM PayrollExpenses WHERE StpCategory = "NotReportable"
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
LimitAccrualPeriod String Como a despesa máxima é calculada se Limit.Type = FixedDollars. Pode consistir em qualquer um dos seguintes: PayPeriod, Month, Year, Hour.
LimitFixedDollarsOf Decimal Valor máximo da despesa se Limit.Type = FixedDollars.
LimitType String O tipo de cálculo a ser usado pode ser qualquer um dos 3 a seguir: NoLimit - sem limites para cálculos de despesas. PercentageOfPayrollCategory - É igual a x percentual, o limite é calculado como uma % dos salários brutos ou outra categoria da folha de pagamento. FixedDollars - É igual ao limite x dólar definido.
PrintOnPayAdvice Boolean Verdadeiro indica que as despesas acumuladas serão exibidas nos avisos de pagamento. Falso indica que as despesas acumuladas não serão mostradas nos avisos de pagamento.
Threshold Decimal Valor se a despesa só for paga quando os salários excederem um determinado $$ por mês.
Name String Nome da categoria salarial.
StpCategory String Categoria STP para esta categoria de folha de pagamento. Consulte a ajuda do MYOB para obter mais informações. Os valores válidos são: NotReportable (padrão), GrossPayments, PAYGWithholding, IsentoForeignIncome, CDEPPayments, AllowanceCar, AllowanceTransport, AllowanceTravel, AllowanceMeals, AllowanceLaundry, AllowanceOther, DeductionUnionProfAssocFees, DeductionWorkPlaceGiving, ReportableFringeBenefitsExemptAmount, ReportableFringeBenefitsTaxableAmount, ETPTaxableComponent, ETPTaxFreeComponent, ETPTaxWithholding, LumpSumPaymentATermination, LumpSumPaymentARedundancy, LumpSumPaymentB, LumpSumPaymentD, LumpSumPaymentE, SuperGuarantee, OrdinaryTimesEarnings, ReportableEmployerSuperContributions.
Type String Indica o tipo de categoria da folha de pagamento, ou seja: Salário, Despesa, Dedução.
PayrollCategoryID Uuid Identificador de categoria exclusivo na forma de um guid.
PayrollCategoryName String Nome da categoria.
PayrollCategoryType String Indica o tipo de categoria da folha de pagamento, ou seja: Salário, Despesa, Dedução.
PayrollCategoryURI String Identificador de recurso uniforme associado ao objeto de categoria.
CalculationBasisPercentageOf Decimal Porcentagem de super para calcular se CalculationBasis.Type = PercentageOfPayrollCategory.
CalculationBasisType String O tipo de cálculo a ser usado pode ser qualquer um dos 3 a seguir: UserEntered - use o valor do pagamento padrão dos funcionários ao processar. PercentageOfPayrollCategory - é igual a x percentual, calculado como uma % dos salários brutos ou outra categoria da folha de pagamento. FixedDollars - É igual a x dólar a contribuir para todos os funcionários vinculados.
ExpenseAccountID Uuid Identificador exclusivo da conta na forma de um guid.
ExpenseAccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
ExpenseAccountName String Nome da conta.
ExpenseAccountURI String Identificador de recurso uniforme associado ao objeto de conta.
PayableAccountID Uuid Identificador exclusivo da conta na forma de um guid.
PayableAccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
PayableAccountName String Nome da conta.
PayableAccountURI String Identificador de recurso uniforme associado ao objeto de conta.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Folha de Pagamentoaposentadorias

Retornar categorias de folha de pagamento do tipo aposentadoria para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, ContributionType, Exclusion, PrintOnPayAdvice, Threshold, Type, LimitType, Name, PayrollCategoryID, PayrollCategoryName, PayrollCategoryType, CalculationBasisPercentageOf, CalculationBasisType, ExpenseAccountID, ExpenseAccountDisplayID, ExpenseAccountName, PayableAccountID, PayableAccountDisplayID, PayableAccountName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM PayrollSuperannuations WHERE Threshold = 450
SELECT * FROM PayrollSuperannuations WHERE LimitType = "NoLimit"
SELECT * FROM PayrollSuperannuations WHERE Exclusion = 23
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
ContributionType String O tipo de base de contribuição consiste no seguinte: SuperannuationGuarantee, EmployeeAdditional, EmployerAdditional, Productivity, Redundancy, SalaySacrifice, Cônjuge.
Exclusion Decimal Valor para reduzir o salário de um funcionário antes de calcular a aposentadoria.
PrintOnPayAdvice Boolean Verdadeiro indica que a aposentadoria acumulada será exibida nos avisos de pagamento. Falso indica que a aposentadoria acumulada não será exibida nos avisos de pagamento.
Threshold Decimal Valor se a aposentadoria só for paga quando os salários excederem um determinado $$ por mês.
Type String Indica o tipo de categoria da folha de pagamento, ou seja: Salário, Despesa, Dedução.
LimitType String O tipo de cálculo a ser usado pode ser qualquer um dos 3 a seguir: NoLimit - sem limites nos cálculos de contribuição. PercentageOfPayrollCategory - É igual a x percentual, o limite é calculado como uma % dos salários brutos ou outra categoria da folha de pagamento. FixedDollars - É igual ao limite x dólar definido.
Name String Nome do objeto.
PayrollCategoryID Uuid Identificador de categoria exclusivo na forma de um guid.
PayrollCategoryName String Nome da categoria.
PayrollCategoryType String Indica o tipo de categoria da folha de pagamento, ou seja: Salário, Despesa, Dedução.
PayrollCategoryURI String Identificador de recurso uniforme associado ao objeto de categoria.
CalculationBasisPercentageOf Decimal Porcentagem de super para calcular se CalculationBasis.Type = PercentageOfPayrollCategory.
CalculationBasisType String O tipo de cálculo a ser usado pode ser qualquer um dos 3 a seguir: UserEntered - use o valor do pagamento padrão dos funcionários ao processar. PercentageOfPayrollCategory - É igual a x percentual, calculado como uma % dos salários brutos ou outra categoria da folha de pagamento. FixedDollars - É igual a x dólar a contribuir para todos os funcionários vinculados.
ExpenseAccountID Uuid Identificador exclusivo da conta na forma de um guid.
ExpenseAccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
ExpenseAccountName String Nome da conta.
ExpenseAccountURI String Identificador de recurso uniforme associado ao objeto de conta.
PayableAccountID Uuid Identificador exclusivo da conta na forma de um guid.
PayableAccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
PayableAccountName String Nome da conta.
PayableAccountURI String Identificador de recurso uniforme associado ao objeto de conta.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
Exemptions String Uma matriz de categorias salariais das quais a categoria de aposentadoria está isenta.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Impostos Sobre os Salários

Retornar categorias de folha de pagamento do tipo imposto para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Name, StpCategory, Type, TaxTableRevisionDate, PayableAccountID, PayableAccountDisplayID, PayableAccountName. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM PayrollTaxes WHERE PayableAccountID = "02c3f70b-2570-4f2b-bd51-560c65ecb1df"
SELECT * FROM PayrollTaxes WHERE Name = "PAYG Withholding"
SELECT * FROM PayrollTaxes WHERE StpCategory = "PAYGWitholding"
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
Name String Nome da categoria salarial.
StpCategory String Categoria STP para esta categoria de folha de pagamento. Consulte a ajuda do MYOB para obter mais informações. Os valores válidos são: NotReportable (padrão), GrossPayments, PAYGWithholding, IsentoForeignIncome, CDEPPayments, AllowanceCar, AllowanceTransport, AllowanceTravel, AllowanceMeals, AllowanceLaundry, AllowanceOther, DeductionUnionProfAssocFees, DeductionWorkPlaceGiving, ReportableFringeBenefitsExemptAmount, ReportableFringeBenefitsTaxableAmount, ETPTaxableComponent, ETPTaxFreeComponent, ETPTaxWithholding, LumpSumPaymentATermination, LumpSumPaymentARedundancy, LumpSumPaymentB, LumpSumPaymentD, LumpSumPaymentE, SuperGuarantee, OrdinaryTimesEarnings, ReportableEmployerSuperContributions.
Type String Indica o tipo de categoria da folha de pagamento, ou seja: Salário, Despesa, Dedução.
TaxTableRevisionDate Datetime A data em que as tabelas de impostos sobre a folha de pagamento carregadas em AccountRight foram atualizadas pela última vez.
PayableAccountID Uuid Identificador exclusivo da conta na forma de um guid.
PayableAccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
PayableAccountName String Nome da conta.
PayableAccountURI String Identificador de recurso uniforme associado ao objeto de conta.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Tabelas de Impostos da Folha de Pagamento

Retornar tabelas de impostos sobre a folha de pagamento carregadas em um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, Nome. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM PayrollTaxTables WHERE ID = "3a35e83a-5070-432d-b6ec-f4791f353352"
SELECT * FROM PayrollTaxTables WHERE Name = "criteria"
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
Name String Nome da tabela de impostos sobre a folha de pagamento.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Relatório de Resumos de Lucros e Perdas

Retorna um resumo de lucros e perdas para um arquivo AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: EndDate, StartDate, ReportingBasis, YearEndAdjust. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM ProfitAndLossSummaryReport WHERE StartDate = "12/01/2018" AND EndDate = "01/04/2019" AND ReportingBasis = "Cash" AND YearEndAdjust = false
Colunas
Nome Tipo Descrição
AccountTotal Decimal Valor total da conta para o intervalo de datas fornecido.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
EndDate Date Data de início do período.
StartDate Date Data final do período.
ReportingBasis String A base de relatório para o período será em dinheiro ou precisão.
YearEndAdjust Boolean Se você estiver incluindo ajustes de final de ano. Este é um valor verdadeiro ou falso.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

PurchaseBillItems

Retorne todos os tipos de fatura de compra para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

Somente as colunas PurchaseBillId e BillType, ao usar a comparação de igualdade, têm suporte para filtragem do lado do servidor. Se não for especificado, a coluna BillType será padronizada como 'Item'.

Colunas
Nome Tipo Descrição
PurchaseBillId Uuid Identificador exclusivo na forma de um guid.
Date Datetime Entrada da data da transação.
Description String Texto descritivo para a linha.
Total Decimal Valor total apenas para o item de linha.
Type String Tipo de linha de cobrança, pode consistir no seguinte: Transação - Todos os campos detalhados na matriz Linhas são consumíveis. Cabeçalho - Só permite POST no elemento Descrição. Subtotal - Valor calculado que é somente leitura.
BillQuantity Decimal A quantidade de mercadorias embarcadas.
ReceivedQuantity Decimal A quantidade de mercadorias recebidas.
BackorderQuantity Decimal Observação: A ser implementado quando a funcionalidade Pedido de compra estiver disponível.
UnitPrice Decimal Preço por unidade.
DiscountPercent Double Taxa de desconto aplicável ao item de linha.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
JobID Uuid Identificador de trabalho exclusivo na forma de um guid.
JobName String Nome atribuído ao trabalho.
JobNumber String Número atribuído ao trabalho.
JobURI String Identificador de recurso uniforme associado ao objeto de trabalho.
TaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
TaxCodeCode String Código fiscal de 3 dígitos.
TaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
ItemID Uuid Identificador exclusivo na forma de um guid.
ItemName String Nome do item.
ItemNumber String O número atribuído ao item.
ItemURI String Identificador de recurso uniforme associado ao item.
RowID Integer Sequência da entrada dentro do item.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
BillType String Tipo da fatura. Um de: Item, Serviço, Profissional, Diversos.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Itens de Pedido de Compra

Retorne todos os tipos de ordem de compra para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

Somente as colunas PurchaseOrderId e OrderType, ao usar a comparação de igualdade, têm suporte para filtragem do lado do servidor. Se não for especificado, a coluna OrderType será padronizada como 'Item'.

Colunas
Nome Tipo Descrição
PurchaseOrderId Uuid Identificador exclusivo na forma de um guid.
BillQuantity Decimal A quantidade de mercadorias embarcadas.
Description String Texto descritivo para a linha.
DiscountPercent Double Taxa de desconto aplicável ao item de linha.
ReceivedQuantity Decimal Quantidade recebida.
Total Decimal Valor total apenas para o item de linha.
Type String Tipo de linha, pode consistir no seguinte: Transação - Todos os campos detalhados na matriz Linhas são consumíveis. Cabeçalho - Só permite POST no elemento Descrição. Subtotal - Valor calculado que é somente leitura.
UnitPrice Decimal Preço por unidade.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
JobID Uuid Identificador de trabalho exclusivo na forma de um guid.
JobName String Nome atribuído ao trabalho.
JobNumber String Número atribuído ao trabalho.
JobURI String Identificador de recurso uniforme associado ao objeto de trabalho.
TaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
TaxCodeCode String Código fiscal de 3 dígitos.
TaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
ItemID Uuid Identificador exclusivo na forma de um guid.
ItemName String Nome do item.
ItemNumber String O número atribuído ao item.
ItemURI String Identificador de recurso uniforme associado ao item.
RowID Integer Sequência da entrada dentro do item.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
OrderType String Tipo do pedido. Um de: Item, Serviço, Profissional, Diversos.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Recebendo Itens de Transação

Receba transações de dinheiro para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
TransactionID Uuid Identificador exclusivo na forma de um guid.
Amount Double Valor a ser alocado na conta.
Memo String Texto de memorando descrevendo a linha de transação.
RowID Integer Sequência da entrada dentro do conjunto de dinheiro gasto.
RowVersion String RowVersion. Obrigatório durante a atualização para identificar o item de linha.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
JobID Uuid Identificador de trabalho exclusivo na forma de um guid.
JobName String Nome atribuído ao trabalho.
JobNumber String Número atribuído ao trabalho.
JobURI String Identificador de recurso uniforme associado ao objeto de trabalho.
TaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
TaxCodeCode String Código fiscal de 3 dígitos.
TaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

VendaInvoiceItems

Retorne todos os tipos de fatura de venda para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

Somente as colunas SaleInvoiceId e InvoiceType, ao usar a comparação de igualdade, têm suporte para filtragem do lado do servidor. Se não for especificado, a coluna InvoiceType será padronizada como 'Item'.

Colunas
Nome Tipo Descrição
SaleInvoiceId Uuid Identificador exclusivo na forma de um guid.
DiscountPercent Double Taxa de desconto aplicável à linha da fatura de venda.
Description String Texto descritivo para a linha de venda.
CostOfGoodsSold Decimal Custo das Mercadorias Vendidas
RowID Integer Sequência da entrada dentro do conjunto de nota fiscal de venda do item.
RowVersion String A RowVersion ou o item de linha.
ShipQuantity Decimal A quantidade de mercadorias embarcadas.
Total Decimal Tipo de linha da fatura, pode consistir no seguinte: Transação - Todos os campos detalhados na matriz Linhas são consumíveis. Cabeçalho - Só permite POST no elemento Descrição. Subtotal - Valor calculado que é somente leitura.
Type String O tipo da fatura.
UnitPrice Decimal Preço por unidade.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
ItemID Uuid Identificador exclusivo na forma de um guid.
ItemName String Nome do item.
ItemNumber String O número atribuído ao item.
ItemURI String Identificador de recurso uniforme associado ao item.
TaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
TaxCodeCode String Código fiscal de 3 dígitos.
TaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
JobID Uuid Identificador de guid exclusivo pertencente ao trabalho para a linha de venda do item.
JobNumber String Número atribuído ao trabalho.
JobName String Nome atribuído ao trabalho.
JobURI String Identificador de recurso uniforme associado ao objeto de trabalho.
LocationID Uuid Identificador exclusivo para localização na forma de um guid.
LocationIdentifier String Identificador atribuído ao local.
LocationName String Nome atribuído ao local.
LocationURI String Identificador de recurso uniforme associado ao objeto de localização.
InvoiceType String O tipo da fatura. Um de: Item, Serviço, Profissional, Diversos.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

SaleOrderItems

Retorna todos os tipos de pedidos de venda para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

Somente as colunas SaleOrderId e OrderType, ao usar a comparação de igualdade, têm suporte para filtragem do lado do servidor. Se não for especificado, a coluna OrderType será padronizada como 'Item'.

Colunas
Nome Tipo Descrição
SaleOrderId Uuid Identificador exclusivo na forma de um guid.
DiscountPercent Double Taxa de desconto aplicável à linha do pedido de venda.
Description String Texto descritivo para a linha de venda.
RowID Integer Sequência da entrada dentro do conjunto de ordem de venda do item.
RowVersion String A RowVersion ou o item de linha.
ShipQuantity Decimal A quantidade de mercadorias embarcadas.
Total Decimal O tipo de linha do pedido pode consistir no seguinte: Transação - Todos os campos detalhados na matriz Linhas são consumíveis. Cabeçalho - Só permite POST no elemento Descrição. Subtotal - Valor calculado que é somente leitura.
Type String Tipo de linha, pode consistir no seguinte: Transação - Todos os campos detalhados na matriz Linhas são consumíveis. Cabeçalho - Só permite POST no elemento Descrição. Subtotal - Valor calculado que é somente leitura.
UnitPrice Decimal Preço por unidade.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
ItemID Uuid Identificador exclusivo na forma de um guid.
ItemName String Nome do item.
ItemNumber String O número atribuído ao item.
ItemURI String Identificador de recurso uniforme associado ao item.
TaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
TaxCodeCode String Código fiscal de 3 dígitos.
TaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
OrderType String Tipo do pedido. Um de: Item, Serviço, Profissional, TimeBilling, Diversos.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.
Comment String Comentário da Ordem de Venda
ShippingMethod String Método de envio
PromisedDate Datetime Data Prometida da Transação.

Itens de Cotação de Venda

Retorna todos os tipos de cotação de venda para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

Somente as colunas SaleQuoteId e QuoteType, ao usar a comparação de igualdade, têm suporte para filtragem do lado do servidor. Se não for especificado, a coluna QuoteType será padronizada como 'Item'.

Colunas
Nome Tipo Descrição
SaleQuoteId Uuid Identificador exclusivo na forma de um guid.
DiscountPercent Double Taxa de desconto aplicável à linha da cotação de venda.
Description String Texto descritivo para a linha de venda.
RowID Integer Sequência da entrada dentro do conjunto de cotação de venda do item.
RowVersion String A RowVersion ou o item de linha.
ShipQuantity Decimal A quantidade de mercadorias embarcadas.
Total Decimal Valor total apenas para o item de linha.
Type String Tipo de linha de cotação, pode consistir no seguinte: Transação - Todos os campos detalhados na matriz Linhas são consumíveis. Cabeçalho - Só permite POST no elemento Descrição. Subtotal - Valor calculado que é somente leitura.
UnitPrice Decimal Preço por unidade.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
ItemID Uuid Identificador exclusivo na forma de um guid.
ItemName String Nome do item.
ItemNumber String O número atribuído ao item.
ItemURI String Identificador de recurso uniforme associado ao item.
TaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
TaxCodeCode String Código fiscal de 3 dígitos.
TaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
QuoteType String O tipo da cotação. Um de: Item, Serviço, Profissional, TimeBilling, Diversos.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Gastando Itens de Transação

Gastar itens de transação de dinheiro para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
TransactionID Uuid Identificador exclusivo na forma de um guid.
Amount Double Valor a ser alocado na conta.
Memo String Texto de memorando descrevendo a linha de transação.
RowID Integer Sequência da entrada dentro do conjunto de dinheiro gasto.
RowVersion String RowVersion. Obrigatório durante a atualização para identificar o item de linha.
AccountID Uuid Identificador exclusivo da conta na forma de um guid.
AccountDisplayID String Código de conta. O formato inclui separador, ou seja, 4-1100
AccountName String Nome da conta.
AccountURI String Identificador de recurso uniforme associado ao objeto de conta.
JobID Uuid Identificador de trabalho exclusivo na forma de um guid.
JobName String Nome atribuído ao trabalho.
JobNumber String Número atribuído ao trabalho.
JobURI String Identificador de recurso uniforme associado ao objeto de trabalho.
TaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
TaxCodeCode String Código fiscal de 3 dígitos.
TaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Fundos de Pensão

Detalhes do fundo de aposentadoria para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: ID, EmployerMembershipNumber, Name, PhoneNumber, Website. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM SuperannuationFunds WHERE ID = "a05b34e5-5d10-465a-98ae-aa2a7eb65a35"
SELECT * FROM SuperannuationFunds WHERE Name = "AMP Life"
Colunas
Nome Tipo Descrição
ID [KEY] Uuid Identificador exclusivo na forma de um guid.
EmployerMembershipNumber String Número de inscrição do empregador.
Name String Nome do fundo de pensões.
PhoneNumber String Número de telefone de contato do fundo de pensões.
Website String Endereço da World Wide Web para fundos de pensões.
RowVersion String Valor numérico que muda após uma atualização de registro, pode ser usado para controle de alterações, mas não preserva uma data ou hora.
URI String O identificador de recurso uniforme engloba todos os tipos de nomes e endereços que se referem a objetos na web.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Itens de Pagamento do Fornecedor

Itens de pagamento do fornecedor para um arquivo da empresa AccountRight.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
SupplierPaymentID [KEY] Uuid Identificador exclusivo na forma de um guid.
AmountApplied Double Valor aplicado à fatura ou pedido de compra.
Type String Tipo de compra, pode consistir no seguinte: Bill, Order.
PurchaseID Uuid Identificador de guid exclusivo pertencente à fatura ou pedido de compra do fornecedor.
PurchaseNumber String Número da fatura/pedido de compra.
PurchaseURI String Identificador de recurso uniforme associado ao objeto de nota/pedido de compra.
RowID Integer Sequência da entrada dentro do conjunto de pagamento do fornecedor.
RowVersion String Número de incremento que pode ser usado para controle de alterações, mas não preserva uma data ou hora.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

TaxCodeResumoRelatório

Retorna um relatório de resumo de código de imposto para arquivos AccountRight.

Informações Específicas da Tabela
Selecione

MYOB permite que um subconjunto de colunas seja usado na cláusula WHERE de uma consultar SELECT. Essas colunas podem ser usadas com os seguintes operadores: =, !=, >, <, >=, <=. Além disso, consultas com vários critérios podem ser executadas combinando os critérios com os operadores AND e OR. Essas colunas suportam os tipos de comparação acima para filtragem do lado do servidor: EndDate, StartDate, ReportingBasis, YearEndAdjust. Todas as outras colunas e operadores são processados no lado do cliente.

SELECT * FROM TaxCodeSummaryReport WHERE StartDate = "12/01/2018" AND EndDate = "01/04/2019" AND ReportingBasis = "Cash" AND YearEndAdjust = false
Colunas
Nome Tipo Descrição
PurchasesTotal Decimal Valor total de compras para um código tributário.
SalesTotal Decimal Valor total do imposto recolhido para um código tributário.
TaxCodeCode String Código fiscal de 3 dígitos.
TaxCodeID Uuid Identificador de guid exclusivo pertencente ao código de imposto atribuído.
TaxCodeURI String Identificador de recurso uniforme associado ao objeto de código de imposto.
TaxCollected Decimal Valor total do imposto recolhido para um código tributário.
TaxPaid Decimal Valor total do imposto pago para um código tributário.
TaxRate Decimal Taxa de imposto para o Código Tributário.
StartDate Date Data final do período.
EndDate Date Data de início do período.
ReportingBasis String A base de relatório para o período será em dinheiro ou precisão.
YearEndAdjust Boolean Se você estiver incluindo ajustes de final de ano. Este é um valor verdadeiro ou falso.
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

Relatório de Resumo de Codificação da Transação

Retorna um relatório do número total de transações codificadas e não codificadas em um arquivo AccountRight.

Informações Específicas da Tabela
Selecione

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

Colunas
Nome Tipo Descrição
Year Integer O ano civil.
Month Integer Número que representa o mês do ano. Por exemplo: 5 indica maio.
TotalReceived Integer Número total de transações de bankfeed recebidas.
AutoCoded Integer Número total de transações que foram codificadas usando as Regras do BankFeed.
Uncoded Integer Número total de transações bankfeed não codificadas
CompanyFileId String A ID do arquivo da empresa. Tem precedência sobre a propriedade de conexão CompanyFileId.

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 MYOB

Nome Descrição
GetOAuthAccessToken Obtém um token de autenticação de MYOB.
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.
RefreshOAuthAccessToken Atualiza o token de acesso OAuth usado para autenticação com MYOB.

GetOAuthAccessToken

Obtém um token de autenticação de MYOB.

Entrada
Nome Tipo Obrigatório Descrição
AuthMode String Falso 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 Falso Uma lista separada por vírgulas de permissões a serem solicitadas ao usuário. Verifique a API MYOB para obter uma lista de permissões disponíveis.
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Este valor deve corresponder ao URL de redirecionamento que você especificou nas configurações do aplicativo MYOB. Necessário apenas quando o parâmetro Authmode for Web.
Verifier String Falso O verificador retornou do MYOB 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 Falso 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 MYOB. 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 MYOB.
OAuthRefreshToken String O token de atualização OAuth. É o mesmo que o token de acesso no caso de MYOB.
ExpiresIn String O tempo de vida restante no token de acesso. Um -1 denota que não irá expirar.

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 Obrigatório Descrição
CallbackUrl String Falso 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 MYOB.
Scope String Falso Uma lista separada por vírgulas de escopos a serem solicitados ao usuário. Verifique a documentação da API MYOB para obter uma lista de permissões disponíveis.
State String Falso 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 MYOB. 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.

RefreshOAuthAccessToken

Atualiza o token de acesso OAuth usado para autenticação com MYOB.

Entrada
Nome Tipo Obrigatório Descrição
OAuthRefreshToken String Verdade Defina isso para o valor do token que expirou.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de autenticação retornado de MYOB. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico.
OAuthRefreshToken String É o mesmo que o token de acesso.
ExpiresIn String O tempo de vida restante no token de acesso.

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 MYOB:

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 exibição.
TableType String O tipo de tabela (tabela ou exibição).
Description String Uma descrição da tabela ou exibiçã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 Accounts:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Accounts' 
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 SelectEntries:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' 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 Accounts:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Accounts'
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:myob: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 está 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.

Autenticação

Propriedade Descrição
User A conta de usuário MYOB usada para autenticação.
Password A senha usada para autenticar o usuário.

Conexão

Propriedade Descrição
CompanyFileId A ID do arquivo da empresa. Se não for especificado, será usado o ID do primeiro arquivo da empresa retornado.
URL A URL da instância MYOB.

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.
CallbackURL O URL de retorno de chamada OAuth para o qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno de chamada 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.

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.
Pagesize O número máximo de resultados a serem retornados por página de MYOB.
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.

Autenticação

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

Propriedade Descrição
User A conta de usuário MYOB usada para autenticação.
Password A senha usada para autenticar o usuário.

Do Utilizador

A conta de usuário MYOB usada para autenticação.

Tipo de Dados

string

Valor Padrão

""

Observações

Juntamente com Senha, este campo é usado para autenticação no servidor MYOB.

Senha

A senha usada para autenticar o usuário.

Tipo de Dados

string

Valor Padrão

""

Observações

O usuário e Password são usados juntos para autenticar com o servidor.

Conexão

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

Propriedade Descrição
CompanyFileId A ID do arquivo da empresa. Se não for especificado, será usado o ID do primeiro arquivo da empresa retornado.
URL A URL da instância MYOB.

CompanyFileId

A ID do arquivo da empresa. Se não for especificado, será usado o ID do primeiro arquivo da empresa retornado.

Tipo de Dados

string

Valor Padrão

""

Observações

A ID do arquivo da empresa. Se não for especificado, será usado o ID do primeiro arquivo da empresa retornado.

Você pode encontrar isso consultando CompanyFiles visualizar:

SELECT ID FROM CompanyFiles

URL

A URL da instância MYOB.

Tipo de Dados

string

Valor Padrão

""

Observações

A URL da instância MYOB.

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.
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.

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 em que 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. Definir 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%\\\MYOB 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%\\ MYOB 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.

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.
Pagesize O número máximo de resultados a serem retornados por página de MYOB.
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. Os casos de uso e a funcionalidade normais do driver 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.

Tamanho da Página

O número máximo de resultados a serem retornados por página de MYOB.

Tipo de Dados

int

Valor Padrão

400

Observações

O Pagesize propriedade afeta o número máximo de resultados a serem retornados por página de MYOB. Definir um valor mais alto pode resultar em melhor desempenho ao custo de memória adicional alocada por página consumida.

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.