Pular para o conteúdo principal

Referência do conector Xero

info

Beta

Este recurso está em Beta. Para usá-lo, um administrador de workspace deve habilitar o Lakeflow Connect for Xero na página Previews . Consulte Gerenciar prévias do Databricks.

O conector Xero gerenciado no Lakeflow Connect suporta 23 tabelas de origem no esquema default. Doze tabelas são sincronizadas de forma incremental usando o campo de cursor UpdatedDateUTC, e as outras 11 tabelas usam refresh completo em cada execução.

Tabelas de origem suportadas​

O conector Xero oferece suporte às seguintes tabelas de origem, todas sob o esquema de origem default:

Tabela de origem

Chave primária

Descrição

Modo de sincronização

Campo do cursor

accounts

AccountID

Contas no plano de contas.

Incremental

UpdatedDateUTC

bank_transactions

BankTransactionID

Transações de gastar dinheiro e receber dinheiro em account bancárias.

Incremental

UpdatedDateUTC

bank_transfers

BankTransferID

Transferências de dinheiro entre contas bancárias.

Apenas refresh completo

branding_themes

BrandingThemeID

Temas de marca aplicados a faturas e outros documentos.

Apenas refresh completo

budgets

BudgetID

Orçamentos gerais e de acompanhamento.

Apenas refresh completo

contacts

ContactID

Clientes e fornecedores, incluindo contatos arquivados.

Incremental

UpdatedDateUTC

contact_groups

ContactGroupID

Grupos de contatos e os contatos em cada grupo.

Apenas refresh completo

credit_notes

CreditNoteID

Notas de crédito para clientes e fornecedores.

Incremental

UpdatedDateUTC

currencies

Code

Moedas ativadas para a organização.

Apenas refresh completo

invoices

InvoiceID

Faturas de ventas e contas de compra.

Incremental

UpdatedDateUTC

items

ItemID

Produtos e serviços que a organização compra e vende.

Incremental

UpdatedDateUTC

linked_transactions

LinkedTransactionID

Links entre despesas faturáveis e as faturas de ventas em que são cobradas.

Apenas refresh completo

manual_journals

ManualJournalID

Diários manuais.

Incremental

UpdatedDateUTC

organisation

OrganisationID

Detalhes da organização conectada.

Apenas refresh completo

overpayments

OverpaymentID

Pagamentos em excesso feitos a fornecedores ou recebidos de clientes.

Incremental

UpdatedDateUTC

payments

PaymentID

Pagamentos aplicados a faturas, notas de crédito, pré-pagamentos e pagamentos a mais.

Incremental

UpdatedDateUTC

prepayments

PrepaymentID

Pré-pagamentos feitos a fornecedores ou recebidos de clientes.

Incremental

UpdatedDateUTC

purchase_orders

PurchaseOrderID

Pedidos de compra.

Incremental

UpdatedDateUTC

repeating_invoices

RepeatingInvoiceID

Padrões de faturas recorrentes.

Apenas refresh completo

tax_rates

TaxType

Taxas de imposto.

Apenas refresh completo

tracking_categories

TrackingCategoryID

Acompanhamento das categorias e suas opções, incluindo as arquivadas.

Apenas refresh completo

users

UserID

Usuários da organização.

Incremental

UpdatedDateUTC

projects

projectId

Projetos de Projetos do Xero.

Apenas refresh completo

Tabela de origem

Chave primária

Descrição

Modo de sincronização

Campo do cursor

accounts

AccountID

Contas no plano de contas.

Incremental

UpdatedDateUTC

bank_transactions

BankTransactionID

Transações de gastar dinheiro e receber dinheiro em account bancárias.

Incremental

UpdatedDateUTC

bank_transfers

BankTransferID

Transferências de dinheiro entre contas bancárias.

Apenas refresh completo

branding_themes

BrandingThemeID

Temas de marca aplicados a faturas e outros documentos.

Apenas refresh completo

budgets

BudgetID

Orçamentos gerais e de acompanhamento.

Apenas refresh completo

contacts

ContactID

Clientes e fornecedores, incluindo contatos arquivados.

Incremental

UpdatedDateUTC

contact_groups

ContactGroupID

Grupos de contatos e os contatos em cada grupo.

Apenas refresh completo

credit_notes

CreditNoteID

Notas de crédito para clientes e fornecedores.

Incremental

UpdatedDateUTC

currencies

Code

Moedas ativadas para a organização.

Apenas refresh completo

invoices

InvoiceID

Faturas de ventas e contas de compra.

Incremental

UpdatedDateUTC

items

ItemID

Produtos e serviços que a organização compra e vende.

Incremental

UpdatedDateUTC

linked_transactions

LinkedTransactionID

Links entre despesas faturáveis e as faturas de ventas em que são cobradas.

Apenas refresh completo

manual_journals

ManualJournalID

Diários manuais.

Incremental

UpdatedDateUTC

organisation

OrganisationID

Detalhes da organização conectada.

Apenas refresh completo

overpayments

OverpaymentID

Pagamentos em excesso feitos a fornecedores ou recebidos de clientes.

Incremental

UpdatedDateUTC

payments

PaymentID

Pagamentos aplicados a faturas, notas de crédito, pré-pagamentos e pagamentos a mais.

Incremental

UpdatedDateUTC

prepayments

PrepaymentID

Pré-pagamentos feitos a fornecedores ou recebidos de clientes.

Incremental

UpdatedDateUTC

purchase_orders

PurchaseOrderID

Pedidos de compra.

Incremental

UpdatedDateUTC

repeating_invoices

RepeatingInvoiceID

Padrões de faturas recorrentes.

Apenas refresh completo

tax_rates

TaxType

Taxas de imposto.

Apenas refresh completo

tracking_categories

TrackingCategoryID

Acompanhamento das categorias e suas opções, incluindo as arquivadas.

Apenas refresh completo

users

UserID

Usuários da organização.

Incremental

UpdatedDateUTC

projects

projectId

Projetos de Projetos do Xero.

Apenas refresh completo

Opções do conector​

Para uso, consulte Exemplos.

Opção

Tipo

Escopo

Obrigatório

Aplica-se a

Descrição

tenant_id

String

Pipeline

Sim

Todas as tabelas

O ID da organização Xero (tenant) da qual ingerir. Veja Encontrar o ID do tenant.

start_datetime

String

Pipeline

Não

Todas as tabelas incrementais

Data e hora mais antigas de modificação a serem ingeridas, no formato yyyy-MM-ddTHH:mm:ssZ (por exemplo, 2024-01-01T00:00:00Z). Aplica-se apenas à primeira sincronização de cada tabela. Sincronizações posteriores continuam a partir do cursor armazenado. Se você não definir isso, a primeira sincronização começará 730 dias atrás.

Opção

Tipo

Escopo

Obrigatório

Aplica-se a

Descrição

tenant_id

String

Pipeline

Sim

Todas as tabelas

O ID da organização Xero (tenant) da qual ingerir. Veja Encontrar o ID do tenant.

start_datetime

String

Pipeline

Não

Todas as tabelas incrementais

Data e hora mais antigas de modificação a serem ingeridas, no formato yyyy-MM-ddTHH:mm:ssZ (por exemplo, 2024-01-01T00:00:00Z). Aplica-se apenas à primeira sincronização de cada tabela. Sincronizações posteriores continuam a partir do cursor armazenado. Se você não definir isso, a primeira sincronização começará 730 dias atrás.

Esquemas de tabela de destino​

accounts​

Primary key: AccountID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

Code

STRING

Name

STRING

AccountID

STRING

Type

STRING

BankAccountNumber

STRING

Status

STRING

Description

STRING

BankAccountType

STRING

CurrencyCode

STRING

TaxType

STRING

EnablePaymentsToAccount

BOOLEAN

ShowInExpenseClaims

BOOLEAN

Class

STRING

SystemAccount

STRING

ReportingCode

STRING

ReportingCodeName

STRING

HasAttachments

BOOLEAN

UpdatedDateUTC

STRING

AddToWatchlist

BOOLEAN

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

IsDeleted

BOOLEAN

campo

Tipo de dados

Code

STRING

Name

STRING

AccountID

STRING

Type

STRING

BankAccountNumber

STRING

Status

STRING

Description

STRING

BankAccountType

STRING

CurrencyCode

STRING

TaxType

STRING

EnablePaymentsToAccount

BOOLEAN

ShowInExpenseClaims

BOOLEAN

Class

STRING

SystemAccount

STRING

ReportingCode

STRING

ReportingCodeName

STRING

HasAttachments

BOOLEAN

UpdatedDateUTC

STRING

AddToWatchlist

BOOLEAN

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

IsDeleted

BOOLEAN

bank_transactions​

Primary key: BankTransactionID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

BankTransactionID

STRING

Type

STRING

Status

STRING

StatusAttributeString

STRING

LineAmountTypes

STRING

Date

STRING

DateString

STRING

Reference

STRING

IsReconciled

BOOLEAN

HasAttachments

BOOLEAN

CurrencyCode

STRING

CurrencyRate

DOUBLE

Url

STRING

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

PrepaymentID

STRING

OverpaymentID

STRING

UpdatedDateUTC

STRING

Contact

STRUCT<ContactID: STRING, ContactNumber: STRING, ContactStatus: STRING, Name: STRING, FirstName: STRING, LastName: STRING, EmailAddress: STRING, BankAccountDetails: STRING, TaxNumber: STRING, AccountsReceivableTaxType: STRING, AccountsPayableTaxType: STRING, IsSupplier: BOOLEAN, IsCustomer: BOOLEAN, UpdatedDateUTC: STRING, Addresses: VARIANT, Phones: VARIANT, ContactGroups: VARIANT, ContactPersons: VARIANT, HasValidationErrors: BOOLEAN>

BankAccount

STRUCT<AccountID: STRING, Code: STRING, Name: STRING>

LineItems

ARRAY<STRUCT<LineItemID: STRING, Description: STRING, Quantity: DOUBLE, UnitAmount: DOUBLE, ItemCode: STRING, AccountCode: STRING, AccountID: STRING, TaxType: STRING, TaxAmount: DOUBLE, LineAmount: DOUBLE, DiscountRate: DOUBLE, DiscountAmount: DOUBLE, RepeatingInvoiceID: STRING, Taxability: STRING, SalesTaxCodeId: DOUBLE, Item: STRUCT<Code: STRING, Name: STRING, ItemID: STRING>, Tracking: ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>, TaxBreakdown: ARRAY<STRUCT<TaxComponentId: STRING, Type: STRING, Name: STRING, TaxPercentage: DOUBLE, TaxAmount: DOUBLE, TaxableAmount: DOUBLE, NonTaxableAmount: DOUBLE, ExemptAmount: DOUBLE, StateAssignedNo: STRING, JurisdictionRegion: STRING>>>>

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

IsDeleted

BOOLEAN

campo

Tipo de dados

BankTransactionID

STRING

Type

STRING

Status

STRING

StatusAttributeString

STRING

LineAmountTypes

STRING

Date

STRING

DateString

STRING

Reference

STRING

IsReconciled

BOOLEAN

HasAttachments

BOOLEAN

CurrencyCode

STRING

CurrencyRate

DOUBLE

Url

STRING

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

PrepaymentID

STRING

OverpaymentID

STRING

UpdatedDateUTC

STRING

Contact

STRUCT<ContactID: STRING, ContactNumber: STRING, ContactStatus: STRING, Name: STRING, FirstName: STRING, LastName: STRING, EmailAddress: STRING, BankAccountDetails: STRING, TaxNumber: STRING, AccountsReceivableTaxType: STRING, AccountsPayableTaxType: STRING, IsSupplier: BOOLEAN, IsCustomer: BOOLEAN, UpdatedDateUTC: STRING, Addresses: VARIANT, Phones: VARIANT, ContactGroups: VARIANT, ContactPersons: VARIANT, HasValidationErrors: BOOLEAN>

BankAccount

STRUCT<AccountID: STRING, Code: STRING, Name: STRING>

LineItems

ARRAY<STRUCT<LineItemID: STRING, Description: STRING, Quantity: DOUBLE, UnitAmount: DOUBLE, ItemCode: STRING, AccountCode: STRING, AccountID: STRING, TaxType: STRING, TaxAmount: DOUBLE, LineAmount: DOUBLE, DiscountRate: DOUBLE, DiscountAmount: DOUBLE, RepeatingInvoiceID: STRING, Taxability: STRING, SalesTaxCodeId: DOUBLE, Item: STRUCT<Code: STRING, Name: STRING, ItemID: STRING>, Tracking: ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>, TaxBreakdown: ARRAY<STRUCT<TaxComponentId: STRING, Type: STRING, Name: STRING, TaxPercentage: DOUBLE, TaxAmount: DOUBLE, TaxableAmount: DOUBLE, NonTaxableAmount: DOUBLE, ExemptAmount: DOUBLE, StateAssignedNo: STRING, JurisdictionRegion: STRING>>>>

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

IsDeleted

BOOLEAN

nota

Esta tabela não suporta dimensões que mudam lentamente (SCD) tipo 2 porque tem VARIANT colunas.

bank_transfers​

Primary key: BankTransferID

Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

FromBankAccount

STRUCT<Code: STRING, Name: STRING, AccountID: STRING, Type: STRING, BankAccountNumber: STRING, Status: STRING, Description: STRING, BankAccountType: STRING, CurrencyCode: STRING, TaxType: STRING, EnablePaymentsToAccount: BOOLEAN, ShowInExpenseClaims: BOOLEAN, Class: STRING, SystemAccount: STRING, ReportingCode: STRING, ReportingCodeName: STRING, HasAttachments: BOOLEAN, UpdatedDateUTC: STRING, AddToWatchlist: BOOLEAN>

ToBankAccount

STRUCT<Code: STRING, Name: STRING, AccountID: STRING, Type: STRING, BankAccountNumber: STRING, Status: STRING, Description: STRING, BankAccountType: STRING, CurrencyCode: STRING, TaxType: STRING, EnablePaymentsToAccount: BOOLEAN, ShowInExpenseClaims: BOOLEAN, Class: STRING, SystemAccount: STRING, ReportingCode: STRING, ReportingCodeName: STRING, HasAttachments: BOOLEAN, UpdatedDateUTC: STRING, AddToWatchlist: BOOLEAN>

Amount

DOUBLE

Date

STRING

DateString

STRING

BankTransferID

STRING

CurrencyRate

DOUBLE

FromBankTransactionID

STRING

ToBankTransactionID

STRING

FromIsReconciled

BOOLEAN

ToIsReconciled

BOOLEAN

Reference

STRING

HasAttachments

BOOLEAN

CreatedDateUTC

STRING

CreatedDateUTCString

STRING

Status

STRING

FromTracking

ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>

ToTracking

ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

campo

Tipo de dados

FromBankAccount

STRUCT<Code: STRING, Name: STRING, AccountID: STRING, Type: STRING, BankAccountNumber: STRING, Status: STRING, Description: STRING, BankAccountType: STRING, CurrencyCode: STRING, TaxType: STRING, EnablePaymentsToAccount: BOOLEAN, ShowInExpenseClaims: BOOLEAN, Class: STRING, SystemAccount: STRING, ReportingCode: STRING, ReportingCodeName: STRING, HasAttachments: BOOLEAN, UpdatedDateUTC: STRING, AddToWatchlist: BOOLEAN>

ToBankAccount

STRUCT<Code: STRING, Name: STRING, AccountID: STRING, Type: STRING, BankAccountNumber: STRING, Status: STRING, Description: STRING, BankAccountType: STRING, CurrencyCode: STRING, TaxType: STRING, EnablePaymentsToAccount: BOOLEAN, ShowInExpenseClaims: BOOLEAN, Class: STRING, SystemAccount: STRING, ReportingCode: STRING, ReportingCodeName: STRING, HasAttachments: BOOLEAN, UpdatedDateUTC: STRING, AddToWatchlist: BOOLEAN>

Amount

DOUBLE

Date

STRING

DateString

STRING

BankTransferID

STRING

CurrencyRate

DOUBLE

FromBankTransactionID

STRING

ToBankTransactionID

STRING

FromIsReconciled

BOOLEAN

ToIsReconciled

BOOLEAN

Reference

STRING

HasAttachments

BOOLEAN

CreatedDateUTC

STRING

CreatedDateUTCString

STRING

Status

STRING

FromTracking

ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>

ToTracking

ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

branding_themes​

Primary key: BrandingThemeID

Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

BrandingThemeID

STRING

Name

STRING

LogoUrl

STRING

Type

STRING

SortOrder

BIGINT

CreatedDateUTC

STRING

campo

Tipo de dados

BrandingThemeID

STRING

Name

STRING

LogoUrl

STRING

Type

STRING

SortOrder

BIGINT

CreatedDateUTC

STRING

budgets​

Primary key: BudgetID

Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

BudgetID

STRING

Type

STRING

Description

STRING

UpdatedDateUTC

STRING

Status

STRING

BudgetLines

ARRAY<STRUCT< AccountID STRING, AccountCode STRING, BudgetBalances ARRAY<STRUCT< Period STRING, Amount DOUBLE, UnitAmount DOUBLE, Notes STRING >> >>

Tracking

ARRAY<STRUCT< TrackingCategoryID STRING, TrackingOptionID STRING, Name STRING, Option STRING, Status STRING, Options ARRAY<STRUCT< TrackingOptionID STRING, Name STRING, Status STRING, TrackingCategoryID STRING >> >>

campo

Tipo de dados

BudgetID

STRING

Type

STRING

Description

STRING

UpdatedDateUTC

STRING

Status

STRING

BudgetLines

ARRAY<STRUCT< AccountID STRING, AccountCode STRING, BudgetBalances ARRAY<STRUCT< Period STRING, Amount DOUBLE, UnitAmount DOUBLE, Notes STRING >> >>

Tracking

ARRAY<STRUCT< TrackingCategoryID STRING, TrackingOptionID STRING, Name STRING, Option STRING, Status STRING, Options ARRAY<STRUCT< TrackingOptionID STRING, Name STRING, Status STRING, TrackingCategoryID STRING >> >>

contacts​

Primary key: ContactID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

ContactID

STRING

MergedToContactID

STRING

ContactNumber

STRING

AccountNumber

STRING

ContactStatus

STRING

Name

STRING

FirstName

STRING

LastName

STRING

CompanyNumber

STRING

EmailAddress

STRING

ContactPersons

ARRAY<STRUCT<FirstName: STRING, LastName: STRING, EmailAddress: STRING, IncludeInEmails: BOOLEAN>>

BankAccountDetails

STRING

TaxNumber

STRING

TaxNumberType

STRING

AccountsReceivableTaxType

STRING

AccountsPayableTaxType

STRING

Addresses

ARRAY<STRUCT<AddressType: STRING, AddressLine1: STRING, AddressLine2: STRING, AddressLine3: STRING, AddressLine4: STRING, City: STRING, Region: STRING, PostalCode: STRING, Country: STRING, AttentionTo: STRING>>

Phones

ARRAY<STRUCT<PhoneType: STRING, PhoneNumber: STRING, PhoneAreaCode: STRING, PhoneCountryCode: STRING>>

IsSupplier

BOOLEAN

IsCustomer

BOOLEAN

SalesDefaultLineAmountType

STRING

PurchasesDefaultLineAmountType

STRING

DefaultCurrency

STRING

XeroNetworkKey

STRING

SalesDefaultAccountCode

STRING

PurchasesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY<STRUCT<TrackingCategoryName: STRING, TrackingOptionName: STRING>>

PurchasesTrackingCategories

ARRAY<STRUCT<TrackingCategoryName: STRING, TrackingOptionName: STRING>>

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

PaymentTerms

STRUCT<Bills: STRUCT<Day: BIGINT, Type: STRING>, Sales: STRUCT<Day: BIGINT, Type: STRING>>

UpdatedDateUTC

STRING

ContactGroups

ARRAY<STRUCT<Name: STRING, Status: STRING, ContactGroupID: STRING>>

Website

STRING

BrandingTheme

STRUCT<BrandingThemeID: STRING, Name: STRING, LogoUrl: STRING, Type: STRING, SortOrder: BIGINT, CreatedDateUTC: STRING>

BatchPayments

STRUCT<BankAccountNumber: STRING, BankAccountName: STRING, Details: STRING, Code: STRING, Reference: STRING>

Discount

DOUBLE

Balances

STRUCT<AccountsReceivable: STRUCT<Outstanding: DOUBLE, Overdue: DOUBLE>, AccountsPayable: STRUCT<Outstanding: DOUBLE, Overdue: DOUBLE>>

Attachments

ARRAY<STRUCT<AttachmentID: STRING, FileName: STRING, Url: STRING, MimeType: STRING, ContentLength: BIGINT, IncludeOnline: BOOLEAN>>

HasAttachments

BOOLEAN

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

HasValidationErrors

BOOLEAN

StatusAttributeString

STRING

campo

Tipo de dados

ContactID

STRING

MergedToContactID

STRING

ContactNumber

STRING

AccountNumber

STRING

ContactStatus

STRING

Name

STRING

FirstName

STRING

LastName

STRING

CompanyNumber

STRING

EmailAddress

STRING

ContactPersons

ARRAY<STRUCT<FirstName: STRING, LastName: STRING, EmailAddress: STRING, IncludeInEmails: BOOLEAN>>

BankAccountDetails

STRING

TaxNumber

STRING

TaxNumberType

STRING

AccountsReceivableTaxType

STRING

AccountsPayableTaxType

STRING

Addresses

ARRAY<STRUCT<AddressType: STRING, AddressLine1: STRING, AddressLine2: STRING, AddressLine3: STRING, AddressLine4: STRING, City: STRING, Region: STRING, PostalCode: STRING, Country: STRING, AttentionTo: STRING>>

Phones

ARRAY<STRUCT<PhoneType: STRING, PhoneNumber: STRING, PhoneAreaCode: STRING, PhoneCountryCode: STRING>>

IsSupplier

BOOLEAN

IsCustomer

BOOLEAN

SalesDefaultLineAmountType

STRING

PurchasesDefaultLineAmountType

STRING

DefaultCurrency

STRING

XeroNetworkKey

STRING

SalesDefaultAccountCode

STRING

PurchasesDefaultAccountCode

STRING

SalesTrackingCategories

ARRAY<STRUCT<TrackingCategoryName: STRING, TrackingOptionName: STRING>>

PurchasesTrackingCategories

ARRAY<STRUCT<TrackingCategoryName: STRING, TrackingOptionName: STRING>>

TrackingCategoryName

STRING

TrackingCategoryOption

STRING

PaymentTerms

STRUCT<Bills: STRUCT<Day: BIGINT, Type: STRING>, Sales: STRUCT<Day: BIGINT, Type: STRING>>

UpdatedDateUTC

STRING

ContactGroups

ARRAY<STRUCT<Name: STRING, Status: STRING, ContactGroupID: STRING>>

Website

STRING

BrandingTheme

STRUCT<BrandingThemeID: STRING, Name: STRING, LogoUrl: STRING, Type: STRING, SortOrder: BIGINT, CreatedDateUTC: STRING>

BatchPayments

STRUCT<BankAccountNumber: STRING, BankAccountName: STRING, Details: STRING, Code: STRING, Reference: STRING>

Discount

DOUBLE

Balances

STRUCT<AccountsReceivable: STRUCT<Outstanding: DOUBLE, Overdue: DOUBLE>, AccountsPayable: STRUCT<Outstanding: DOUBLE, Overdue: DOUBLE>>

Attachments

ARRAY<STRUCT<AttachmentID: STRING, FileName: STRING, Url: STRING, MimeType: STRING, ContentLength: BIGINT, IncludeOnline: BOOLEAN>>

HasAttachments

BOOLEAN

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

HasValidationErrors

BOOLEAN

StatusAttributeString

STRING

contact_groups​

Primary key: ContactGroupID

Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

ContactGroupID

STRING

Name

STRING

Status

STRING

HasValidationErrors

BOOLEAN

Contacts

ARRAY<STRUCT<ContactID STRING, Name STRING>>

campo

Tipo de dados

ContactGroupID

STRING

Name

STRING

Status

STRING

HasValidationErrors

BOOLEAN

Contacts

ARRAY<STRUCT<ContactID STRING, Name STRING>>

credit_notes​

Primary key: CreditNoteID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

Type

STRING

Contact

STRUCT<ContactID: STRING, MergedToContactID: STRING, ContactNumber: STRING, AccountNumber: STRING, ContactStatus: STRING, Name: STRING, FirstName: STRING, LastName: STRING, CompanyNumber: STRING, EmailAddress: STRING, ContactPersons: VARIANT, BankAccountDetails: STRING, TaxNumber: STRING, TaxNumberType: STRING, AccountsReceivableTaxType: STRING, AccountsPayableTaxType: STRING, Addresses: VARIANT, Phones: VARIANT, IsSupplier: BOOLEAN, IsCustomer: BOOLEAN, SalesDefaultLineAmountType: STRING, PurchasesDefaultLineAmountType: STRING, DefaultCurrency: STRING, XeroNetworkKey: STRING, SalesDefaultAccountCode: STRING, PurchasesDefaultAccountCode: STRING, SalesTrackingCategories: VARIANT, PurchasesTrackingCategories: VARIANT, TrackingCategoryName: STRING, TrackingCategoryOption: STRING, PaymentTerms: VARIANT, UpdatedDateUTC: STRING, ContactGroups: VARIANT, Website: STRING, BrandingTheme: VARIANT, BatchPayments: VARIANT, Discount: DOUBLE, Balances: VARIANT, Attachments: VARIANT, HasAttachments: BOOLEAN, ValidationErrors: VARIANT, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING>

Date

STRING

DueDate

STRING

Status

STRING

LineAmountTypes

STRING

LineItems

ARRAY<STRUCT<LineItemID: STRING, Description: STRING, Quantity: DOUBLE, UnitAmount: DOUBLE, ItemCode: STRING, AccountCode: STRING, AccountID: STRING, TaxType: STRING, TaxAmount: DOUBLE, Item: STRUCT<Code: STRING, Name: STRING, ItemID: STRING>, LineAmount: DOUBLE, Tracking: ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>, DiscountRate: DOUBLE, DiscountAmount: DOUBLE, RepeatingInvoiceID: STRING, Taxability: STRING, SalesTaxCodeId: DOUBLE, TaxBreakdown: ARRAY<STRUCT<TaxComponentId: STRING, Type: STRING, Name: STRING, TaxPercentage: DOUBLE, TaxAmount: DOUBLE, TaxableAmount: DOUBLE, NonTaxableAmount: DOUBLE, ExemptAmount: DOUBLE, StateAssignedNo: STRING, JurisdictionRegion: STRING>>>>

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

CISDeduction

DOUBLE

CISRate

DOUBLE

UpdatedDateUTC

STRING

UpdatedDateUTCString

STRING

CurrencyCode

STRING

FullyPaidOnDate

STRING

CreditNoteID

STRING

CreditNoteNumber

STRING

Reference

STRING

SentToContact

BOOLEAN

CurrencyRate

DOUBLE

RemainingCredit

DOUBLE

Allocations

ARRAY<STRUCT<AllocationID: STRING, Invoice: STRUCT<InvoiceID: STRING, InvoiceNumber: STRING, CreditNotes: ARRAY<VARIANT>, HasErrors: BOOLEAN, InvoiceAddresses: ARRAY<VARIANT>, InvoicePaymentServices: ARRAY<VARIANT>, IsDiscounted: BOOLEAN, LineItems: ARRAY<VARIANT>, Overpayments: ARRAY<VARIANT>, Payments: ARRAY<VARIANT>, Prepayments: ARRAY<VARIANT>>, Overpayment: VARIANT, Prepayment: VARIANT, CreditNote: VARIANT, Amount: DOUBLE, Date: STRING, IsDeleted: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>>>

AppliedAmount

DOUBLE

Payments

ARRAY<STRUCT<Invoice: VARIANT, CreditNote: VARIANT, Prepayment: VARIANT, Overpayment: VARIANT, InvoiceNumber: STRING, CreditNoteNumber: STRING, BatchPayment: VARIANT, Account: VARIANT, Code: STRING, Date: STRING, CurrencyRate: DOUBLE, Amount: DOUBLE, BankAmount: DOUBLE, Reference: STRING, IsReconciled: BOOLEAN, Status: STRING, PaymentType: STRING, UpdatedDateUTC: STRING, UpdatedDateUTCString: STRING, PaymentID: STRING, BatchPaymentID: STRING, BankAccountNumber: STRING, Particulars: STRING, Details: STRING, HasAccount: BOOLEAN, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>, Warnings: ARRAY<STRUCT<Message: STRING>>>>

BrandingThemeID

STRING

StatusAttributeString

STRING

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

Warnings

ARRAY<STRUCT<Message: STRING>>

InvoiceAddresses

ARRAY<STRUCT<InvoiceAddressType: STRING, AddressLine1: STRING, AddressLine2: STRING, AddressLine3: STRING, AddressLine4: STRING, City: STRING, Region: STRING, PostalCode: STRING, Country: STRING>>

IsDeleted

BOOLEAN

campo

Tipo de dados

Type

STRING

Contact

STRUCT<ContactID: STRING, MergedToContactID: STRING, ContactNumber: STRING, AccountNumber: STRING, ContactStatus: STRING, Name: STRING, FirstName: STRING, LastName: STRING, CompanyNumber: STRING, EmailAddress: STRING, ContactPersons: VARIANT, BankAccountDetails: STRING, TaxNumber: STRING, TaxNumberType: STRING, AccountsReceivableTaxType: STRING, AccountsPayableTaxType: STRING, Addresses: VARIANT, Phones: VARIANT, IsSupplier: BOOLEAN, IsCustomer: BOOLEAN, SalesDefaultLineAmountType: STRING, PurchasesDefaultLineAmountType: STRING, DefaultCurrency: STRING, XeroNetworkKey: STRING, SalesDefaultAccountCode: STRING, PurchasesDefaultAccountCode: STRING, SalesTrackingCategories: VARIANT, PurchasesTrackingCategories: VARIANT, TrackingCategoryName: STRING, TrackingCategoryOption: STRING, PaymentTerms: VARIANT, UpdatedDateUTC: STRING, ContactGroups: VARIANT, Website: STRING, BrandingTheme: VARIANT, BatchPayments: VARIANT, Discount: DOUBLE, Balances: VARIANT, Attachments: VARIANT, HasAttachments: BOOLEAN, ValidationErrors: VARIANT, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING>

Date

STRING

DueDate

STRING

Status

STRING

LineAmountTypes

STRING

LineItems

ARRAY<STRUCT<LineItemID: STRING, Description: STRING, Quantity: DOUBLE, UnitAmount: DOUBLE, ItemCode: STRING, AccountCode: STRING, AccountID: STRING, TaxType: STRING, TaxAmount: DOUBLE, Item: STRUCT<Code: STRING, Name: STRING, ItemID: STRING>, LineAmount: DOUBLE, Tracking: ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>, DiscountRate: DOUBLE, DiscountAmount: DOUBLE, RepeatingInvoiceID: STRING, Taxability: STRING, SalesTaxCodeId: DOUBLE, TaxBreakdown: ARRAY<STRUCT<TaxComponentId: STRING, Type: STRING, Name: STRING, TaxPercentage: DOUBLE, TaxAmount: DOUBLE, TaxableAmount: DOUBLE, NonTaxableAmount: DOUBLE, ExemptAmount: DOUBLE, StateAssignedNo: STRING, JurisdictionRegion: STRING>>>>

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

CISDeduction

DOUBLE

CISRate

DOUBLE

UpdatedDateUTC

STRING

UpdatedDateUTCString

STRING

CurrencyCode

STRING

FullyPaidOnDate

STRING

CreditNoteID

STRING

CreditNoteNumber

STRING

Reference

STRING

SentToContact

BOOLEAN

CurrencyRate

DOUBLE

RemainingCredit

DOUBLE

Allocations

ARRAY<STRUCT<AllocationID: STRING, Invoice: STRUCT<InvoiceID: STRING, InvoiceNumber: STRING, CreditNotes: ARRAY<VARIANT>, HasErrors: BOOLEAN, InvoiceAddresses: ARRAY<VARIANT>, InvoicePaymentServices: ARRAY<VARIANT>, IsDiscounted: BOOLEAN, LineItems: ARRAY<VARIANT>, Overpayments: ARRAY<VARIANT>, Payments: ARRAY<VARIANT>, Prepayments: ARRAY<VARIANT>>, Overpayment: VARIANT, Prepayment: VARIANT, CreditNote: VARIANT, Amount: DOUBLE, Date: STRING, IsDeleted: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>>>

AppliedAmount

DOUBLE

Payments

ARRAY<STRUCT<Invoice: VARIANT, CreditNote: VARIANT, Prepayment: VARIANT, Overpayment: VARIANT, InvoiceNumber: STRING, CreditNoteNumber: STRING, BatchPayment: VARIANT, Account: VARIANT, Code: STRING, Date: STRING, CurrencyRate: DOUBLE, Amount: DOUBLE, BankAmount: DOUBLE, Reference: STRING, IsReconciled: BOOLEAN, Status: STRING, PaymentType: STRING, UpdatedDateUTC: STRING, UpdatedDateUTCString: STRING, PaymentID: STRING, BatchPaymentID: STRING, BankAccountNumber: STRING, Particulars: STRING, Details: STRING, HasAccount: BOOLEAN, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>, Warnings: ARRAY<STRUCT<Message: STRING>>>>

BrandingThemeID

STRING

StatusAttributeString

STRING

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

Warnings

ARRAY<STRUCT<Message: STRING>>

InvoiceAddresses

ARRAY<STRUCT<InvoiceAddressType: STRING, AddressLine1: STRING, AddressLine2: STRING, AddressLine3: STRING, AddressLine4: STRING, City: STRING, Region: STRING, PostalCode: STRING, Country: STRING>>

IsDeleted

BOOLEAN

nota

Esta tabela não suporta dimensões que mudam lentamente (SCD) tipo 2 porque tem VARIANT colunas.

currencies​

Primary key: Code

Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

Code

STRING

Description

STRING

campo

Tipo de dados

Code

STRING

Description

STRING

invoices​

Primary key: InvoiceID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

Type

STRING

Contact

STRUCT<ContactID:STRING,MergedToContactID:STRING,ContactNumber:STRING,AccountNumber:STRING,ContactStatus:STRING,Name:STRING,FirstName:STRING,LastName:STRING,CompanyNumber:STRING,EmailAddress:STRING,BankAccountDetails:STRING,TaxNumber:STRING,TaxNumberType:STRING,AccountsReceivableTaxType:STRING,AccountsPayableTaxType:STRING,IsSupplier:BOOLEAN,IsCustomer:BOOLEAN,DefaultCurrency:STRING,UpdatedDateUTC:STRING,Website:STRING,Discount:DOUBLE,HasAttachments:BOOLEAN,HasValidationErrors:BOOLEAN,ContactPersons:VARIANT,Addresses:VARIANT,Phones:VARIANT>

LineItems

ARRAY<STRUCT<LineItemID:STRING,Description:STRING,Quantity:DOUBLE,UnitAmount:DOUBLE,ItemCode:STRING,AccountCode:STRING,AccountID:STRING,TaxType:STRING,TaxAmount:DOUBLE,Item:STRUCT<Code:STRING,Name:STRING,ItemID:STRING>,LineAmount:DOUBLE,Tracking:ARRAY<STRUCT<TrackingCategoryID:STRING,TrackingOptionID:STRING,Name:STRING,Option:STRING>>,DiscountRate:DOUBLE,DiscountAmount:DOUBLE,RepeatingInvoiceID:STRING,Taxability:STRING,SalesTaxCodeId:DOUBLE,TaxBreakdown:ARRAY<STRUCT<TaxComponentId:STRING,Type:STRING,Name:STRING,TaxPercentage:DOUBLE,TaxAmount:DOUBLE,TaxableAmount:DOUBLE,NonTaxableAmount:DOUBLE,ExemptAmount:DOUBLE,StateAssignedNo:STRING,JurisdictionRegion:STRING>>>>

Date

STRING

DueDate

STRING

LineAmountTypes

STRING

InvoiceNumber

STRING

Reference

STRING

BrandingThemeID

STRING

Url

STRING

CurrencyCode

STRING

CurrencyRate

DOUBLE

Status

STRING

SentToContact

BOOLEAN

ExpectedPaymentDate

STRING

PlannedPaymentDate

STRING

CISDeduction

DOUBLE

CISRate

DOUBLE

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

TotalDiscount

DOUBLE

RoundingAmount

DOUBLE

EnteredTotal

DOUBLE

InvoiceID

STRING

RepeatingInvoiceID

STRING

HasAttachments

BOOLEAN

IsDiscounted

BOOLEAN

InvoicePaymentServices

ARRAY<VARIANT>

Payments

ARRAY<STRUCT<PaymentID:STRING,Date:STRING,Amount:DOUBLE,CurrencyRate:DOUBLE,Reference:STRING,HasAccount:BOOLEAN,HasValidationErrors:BOOLEAN>>

Prepayments

ARRAY<STRUCT<PrepaymentID:STRING,ID:STRING,Date:STRING,Reference:STRING,AppliedAmount:DOUBLE,Total:DOUBLE,CurrencyRate:DOUBLE>>

Overpayments

ARRAY<STRUCT<OverpaymentID:STRING,ID:STRING,Date:STRING,Reference:STRING,AppliedAmount:DOUBLE,Total:DOUBLE,CurrencyRate:DOUBLE>>

AmountDue

DOUBLE

AmountPaid

DOUBLE

FullyPaidOnDate

STRING

AmountCredited

DOUBLE

UpdatedDateUTC

STRING

UpdatedDateUTCString

STRING

CreditNotes

ARRAY<STRUCT<CreditNoteID:STRING,CreditNoteNumber:STRING,ID:STRING,AppliedAmount:DOUBLE,DateString:STRING,Date:STRING,Total:DOUBLE>>

Attachments

ARRAY<STRUCT<AttachmentID:STRING,FileName:STRING,Url:STRING,MimeType:STRING,ContentLength:BIGINT,IncludeOnline:BOOLEAN>>

HasErrors

BOOLEAN

StatusAttributeString

STRING

ValidationErrors

ARRAY<STRUCT<Message:STRING>>

Warnings

ARRAY<STRUCT<Message:STRING>>

InvoiceAddresses

ARRAY<STRUCT<InvoiceAddressType:STRING,AddressLine1:STRING,AddressLine2:STRING,AddressLine3:STRING,AddressLine4:STRING,City:STRING,Region:STRING,PostalCode:STRING,Country:STRING>>

IsDeleted

BOOLEAN

campo

Tipo de dados

Type

STRING

Contact

STRUCT<ContactID:STRING,MergedToContactID:STRING,ContactNumber:STRING,AccountNumber:STRING,ContactStatus:STRING,Name:STRING,FirstName:STRING,LastName:STRING,CompanyNumber:STRING,EmailAddress:STRING,BankAccountDetails:STRING,TaxNumber:STRING,TaxNumberType:STRING,AccountsReceivableTaxType:STRING,AccountsPayableTaxType:STRING,IsSupplier:BOOLEAN,IsCustomer:BOOLEAN,DefaultCurrency:STRING,UpdatedDateUTC:STRING,Website:STRING,Discount:DOUBLE,HasAttachments:BOOLEAN,HasValidationErrors:BOOLEAN,ContactPersons:VARIANT,Addresses:VARIANT,Phones:VARIANT>

LineItems

ARRAY<STRUCT<LineItemID:STRING,Description:STRING,Quantity:DOUBLE,UnitAmount:DOUBLE,ItemCode:STRING,AccountCode:STRING,AccountID:STRING,TaxType:STRING,TaxAmount:DOUBLE,Item:STRUCT<Code:STRING,Name:STRING,ItemID:STRING>,LineAmount:DOUBLE,Tracking:ARRAY<STRUCT<TrackingCategoryID:STRING,TrackingOptionID:STRING,Name:STRING,Option:STRING>>,DiscountRate:DOUBLE,DiscountAmount:DOUBLE,RepeatingInvoiceID:STRING,Taxability:STRING,SalesTaxCodeId:DOUBLE,TaxBreakdown:ARRAY<STRUCT<TaxComponentId:STRING,Type:STRING,Name:STRING,TaxPercentage:DOUBLE,TaxAmount:DOUBLE,TaxableAmount:DOUBLE,NonTaxableAmount:DOUBLE,ExemptAmount:DOUBLE,StateAssignedNo:STRING,JurisdictionRegion:STRING>>>>

Date

STRING

DueDate

STRING

LineAmountTypes

STRING

InvoiceNumber

STRING

Reference

STRING

BrandingThemeID

STRING

Url

STRING

CurrencyCode

STRING

CurrencyRate

DOUBLE

Status

STRING

SentToContact

BOOLEAN

ExpectedPaymentDate

STRING

PlannedPaymentDate

STRING

CISDeduction

DOUBLE

CISRate

DOUBLE

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

TotalDiscount

DOUBLE

RoundingAmount

DOUBLE

EnteredTotal

DOUBLE

InvoiceID

STRING

RepeatingInvoiceID

STRING

HasAttachments

BOOLEAN

IsDiscounted

BOOLEAN

InvoicePaymentServices

ARRAY<VARIANT>

Payments

ARRAY<STRUCT<PaymentID:STRING,Date:STRING,Amount:DOUBLE,CurrencyRate:DOUBLE,Reference:STRING,HasAccount:BOOLEAN,HasValidationErrors:BOOLEAN>>

Prepayments

ARRAY<STRUCT<PrepaymentID:STRING,ID:STRING,Date:STRING,Reference:STRING,AppliedAmount:DOUBLE,Total:DOUBLE,CurrencyRate:DOUBLE>>

Overpayments

ARRAY<STRUCT<OverpaymentID:STRING,ID:STRING,Date:STRING,Reference:STRING,AppliedAmount:DOUBLE,Total:DOUBLE,CurrencyRate:DOUBLE>>

AmountDue

DOUBLE

AmountPaid

DOUBLE

FullyPaidOnDate

STRING

AmountCredited

DOUBLE

UpdatedDateUTC

STRING

UpdatedDateUTCString

STRING

CreditNotes

ARRAY<STRUCT<CreditNoteID:STRING,CreditNoteNumber:STRING,ID:STRING,AppliedAmount:DOUBLE,DateString:STRING,Date:STRING,Total:DOUBLE>>

Attachments

ARRAY<STRUCT<AttachmentID:STRING,FileName:STRING,Url:STRING,MimeType:STRING,ContentLength:BIGINT,IncludeOnline:BOOLEAN>>

HasErrors

BOOLEAN

StatusAttributeString

STRING

ValidationErrors

ARRAY<STRUCT<Message:STRING>>

Warnings

ARRAY<STRUCT<Message:STRING>>

InvoiceAddresses

ARRAY<STRUCT<InvoiceAddressType:STRING,AddressLine1:STRING,AddressLine2:STRING,AddressLine3:STRING,AddressLine4:STRING,City:STRING,Region:STRING,PostalCode:STRING,Country:STRING>>

IsDeleted

BOOLEAN

nota

Esta tabela não suporta dimensões que mudam lentamente (SCD) tipo 2 porque tem VARIANT colunas.

items​

Primary key: ItemID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

ItemID

STRING

Code

STRING

Name

STRING

Description

STRING

PurchaseDescription

STRING

InventoryAssetAccountCode

STRING

IsSold

BOOLEAN

IsPurchased

BOOLEAN

IsTrackedAsInventory

BOOLEAN

PurchaseDetails

STRUCT<UnitPrice: DOUBLE, AccountCode: STRING, COGSAccountCode: STRING, TaxType: STRING>

SalesDetails

STRUCT<UnitPrice: DOUBLE, AccountCode: STRING, COGSAccountCode: STRING, TaxType: STRING>

TotalCostPool

DOUBLE

QuantityOnHand

DOUBLE

QuantityAvailable

DOUBLE

QuantityOnBackOrder

DOUBLE

StatusAttributeString

STRING

UpdatedDateUTC

STRING

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

campo

Tipo de dados

ItemID

STRING

Code

STRING

Name

STRING

Description

STRING

PurchaseDescription

STRING

InventoryAssetAccountCode

STRING

IsSold

BOOLEAN

IsPurchased

BOOLEAN

IsTrackedAsInventory

BOOLEAN

PurchaseDetails

STRUCT<UnitPrice: DOUBLE, AccountCode: STRING, COGSAccountCode: STRING, TaxType: STRING>

SalesDetails

STRUCT<UnitPrice: DOUBLE, AccountCode: STRING, COGSAccountCode: STRING, TaxType: STRING>

TotalCostPool

DOUBLE

QuantityOnHand

DOUBLE

QuantityAvailable

DOUBLE

QuantityOnBackOrder

DOUBLE

StatusAttributeString

STRING

UpdatedDateUTC

STRING

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

linked_transactions​

Primary key: LinkedTransactionID

Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

LinkedTransactionID

STRING

SourceTransactionID

STRING

SourceLineItemID

STRING

ContactID

STRING

TargetTransactionID

STRING

TargetLineItemID

STRING

Status

STRING

Type

STRING

UpdatedDateUTC

STRING

SourceTransactionTypeCode

STRING

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

campo

Tipo de dados

LinkedTransactionID

STRING

SourceTransactionID

STRING

SourceLineItemID

STRING

ContactID

STRING

TargetTransactionID

STRING

TargetLineItemID

STRING

Status

STRING

Type

STRING

UpdatedDateUTC

STRING

SourceTransactionTypeCode

STRING

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

manual_journals​

Primary key: ManualJournalID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

ManualJournalID

STRING

Narration

STRING

JournalLines

ARRAY<STRUCT< LineAmount DOUBLE, AccountCode STRING, AccountID STRING, Description STRING, TaxType STRING, Tracking ARRAY<STRUCT< TrackingCategoryID STRING, Name STRING, Option STRING, TrackingOptionID STRING, Status STRING >>, TaxAmount DOUBLE, IsBlank BOOLEAN >>

Date

STRING

LineAmountTypes

STRING

Status

STRING

Url

STRING

ShowOnCashBasisReports

BOOLEAN

HasAttachments

BOOLEAN

UpdatedDateUTC

STRING

StatusAttributeString

STRING

Warnings

ARRAY<STRUCT<Message STRING>>

ValidationErrors

ARRAY<STRUCT<Message STRING>>

Attachments

ARRAY<STRUCT< AttachmentID STRING, FileName STRING, Url STRING, MimeType STRING, ContentLength BIGINT, IncludeOnline BOOLEAN >>

IsDeleted

BOOLEAN

campo

Tipo de dados

ManualJournalID

STRING

Narration

STRING

JournalLines

ARRAY<STRUCT< LineAmount DOUBLE, AccountCode STRING, AccountID STRING, Description STRING, TaxType STRING, Tracking ARRAY<STRUCT< TrackingCategoryID STRING, Name STRING, Option STRING, TrackingOptionID STRING, Status STRING >>, TaxAmount DOUBLE, IsBlank BOOLEAN >>

Date

STRING

LineAmountTypes

STRING

Status

STRING

Url

STRING

ShowOnCashBasisReports

BOOLEAN

HasAttachments

BOOLEAN

UpdatedDateUTC

STRING

StatusAttributeString

STRING

Warnings

ARRAY<STRUCT<Message STRING>>

ValidationErrors

ARRAY<STRUCT<Message STRING>>

Attachments

ARRAY<STRUCT< AttachmentID STRING, FileName STRING, Url STRING, MimeType STRING, ContentLength BIGINT, IncludeOnline BOOLEAN >>

IsDeleted

BOOLEAN

organisation​

Primary key: OrganisationID

Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

OrganisationID

STRING

APIKey

STRING

Name

STRING

LegalName

STRING

PaysTax

BOOLEAN

Version

STRING

OrganisationType

STRING

BaseCurrency

STRING

CountryCode

STRING

IsDemoCompany

BOOLEAN

OrganisationStatus

STRING

RegistrationNumber

STRING

EmployerIdentificationNumber

STRING

TaxNumber

STRING

TaxNumberName

STRING

FinancialYearEndDay

BIGINT

FinancialYearEndMonth

BIGINT

SalesTaxBasis

STRING

SalesTaxPeriod

STRING

DefaultSalesTax

STRING

DefaultPurchasesTax

STRING

PeriodLockDate

STRING

EndOfYearLockDate

STRING

CreatedDateUTC

STRING

Timezone

STRING

OrganisationEntityType

STRING

ShortCode

STRING

Class

STRING

Edition

STRING

LineOfBusiness

STRING

Addresses

ARRAY<STRUCT<AddressType STRING, AddressLine1 STRING, AddressLine2 STRING, AddressLine3 STRING, AddressLine4 STRING, City STRING, Region STRING, PostalCode STRING, Country STRING, AttentionTo STRING>>

Phones

ARRAY<STRUCT<PhoneType STRING, PhoneNumber STRING, PhoneAreaCode STRING, PhoneCountryCode STRING>>

ExternalLinks

ARRAY<STRUCT<LinkType STRING, Url STRING, Description STRING>>

PaymentTerms

STRUCT<Bills STRUCT<Day BIGINT, Type STRING>, Sales STRUCT<Day BIGINT, Type STRING>>

campo

Tipo de dados

OrganisationID

STRING

APIKey

STRING

Name

STRING

LegalName

STRING

PaysTax

BOOLEAN

Version

STRING

OrganisationType

STRING

BaseCurrency

STRING

CountryCode

STRING

IsDemoCompany

BOOLEAN

OrganisationStatus

STRING

RegistrationNumber

STRING

EmployerIdentificationNumber

STRING

TaxNumber

STRING

TaxNumberName

STRING

FinancialYearEndDay

BIGINT

FinancialYearEndMonth

BIGINT

SalesTaxBasis

STRING

SalesTaxPeriod

STRING

DefaultSalesTax

STRING

DefaultPurchasesTax

STRING

PeriodLockDate

STRING

EndOfYearLockDate

STRING

CreatedDateUTC

STRING

Timezone

STRING

OrganisationEntityType

STRING

ShortCode

STRING

Class

STRING

Edition

STRING

LineOfBusiness

STRING

Addresses

ARRAY<STRUCT<AddressType STRING, AddressLine1 STRING, AddressLine2 STRING, AddressLine3 STRING, AddressLine4 STRING, City STRING, Region STRING, PostalCode STRING, Country STRING, AttentionTo STRING>>

Phones

ARRAY<STRUCT<PhoneType STRING, PhoneNumber STRING, PhoneAreaCode STRING, PhoneCountryCode STRING>>

ExternalLinks

ARRAY<STRUCT<LinkType STRING, Url STRING, Description STRING>>

PaymentTerms

STRUCT<Bills STRUCT<Day BIGINT, Type STRING>, Sales STRUCT<Day BIGINT, Type STRING>>

overpayments​

Primary key: OverpaymentID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

Type

STRING

Contact

STRUCT<ContactID: STRING, MergedToContactID: STRING, ContactNumber: STRING, AccountNumber: STRING, ContactStatus: STRING, Name: STRING, FirstName: STRING, LastName: STRING, CompanyNumber: STRING, EmailAddress: STRING, ContactPersons: VARIANT, BankAccountDetails: STRING, TaxNumber: STRING, TaxNumberType: STRING, AccountsReceivableTaxType: STRING, AccountsPayableTaxType: STRING, Addresses: VARIANT, Phones: VARIANT, IsSupplier: BOOLEAN, IsCustomer: BOOLEAN, SalesDefaultLineAmountType: STRING, PurchasesDefaultLineAmountType: STRING, DefaultCurrency: STRING, XeroNetworkKey: STRING, SalesDefaultAccountCode: STRING, PurchasesDefaultAccountCode: STRING, SalesTrackingCategories: VARIANT, PurchasesTrackingCategories: VARIANT, TrackingCategoryName: STRING, TrackingCategoryOption: STRING, PaymentTerms: VARIANT, UpdatedDateUTC: STRING, ContactGroups: VARIANT, Website: STRING, BrandingTheme: VARIANT, BatchPayments: VARIANT, Discount: DOUBLE, Balances: VARIANT, Attachments: VARIANT, HasAttachments: BOOLEAN, ValidationErrors: VARIANT, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING>

Date

STRING

DateString

STRING

Status

STRING

LineAmountTypes

STRING

LineItems

ARRAY<STRUCT<LineItemID: STRING, Description: STRING, Quantity: DOUBLE, UnitAmount: DOUBLE, ItemCode: STRING, AccountCode: STRING, AccountID: STRING, TaxType: STRING, TaxAmount: DOUBLE, Item: STRUCT<Code: STRING, Name: STRING, ItemID: STRING>, LineAmount: DOUBLE, Tracking: ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>, DiscountRate: DOUBLE, DiscountAmount: DOUBLE, RepeatingInvoiceID: STRING, Taxability: STRING, SalesTaxCodeId: DOUBLE, TaxBreakdown: ARRAY<STRUCT<TaxComponentId: STRING, Type: STRING, Name: STRING, TaxPercentage: DOUBLE, TaxAmount: DOUBLE, TaxableAmount: DOUBLE, NonTaxableAmount: DOUBLE, ExemptAmount: DOUBLE, StateAssignedNo: STRING, JurisdictionRegion: STRING>>>>

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

UpdatedDateUTC

STRING

UpdatedDateUTCString

STRING

CurrencyCode

STRING

OverpaymentID

STRING

CurrencyRate

DOUBLE

RemainingCredit

DOUBLE

Allocations

ARRAY<STRUCT<AllocationID: STRING, Invoice: VARIANT, Overpayment: VARIANT, Prepayment: VARIANT, CreditNote: VARIANT, Amount: DOUBLE, Date: STRING, IsDeleted: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>>>

AppliedAmount

DOUBLE

Payments

ARRAY<STRUCT<Invoice: VARIANT, CreditNote: VARIANT, Prepayment: VARIANT, Overpayment: VARIANT, InvoiceNumber: STRING, CreditNoteNumber: STRING, BatchPayment: VARIANT, Account: VARIANT, Code: STRING, Date: STRING, CurrencyRate: DOUBLE, Amount: DOUBLE, BankAmount: DOUBLE, Reference: STRING, IsReconciled: BOOLEAN, Status: STRING, PaymentType: STRING, UpdatedDateUTC: STRING, UpdatedDateUTCString: STRING, PaymentID: STRING, BatchPaymentID: STRING, BankAccountNumber: STRING, Particulars: STRING, Details: STRING, HasAccount: BOOLEAN, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>, Warnings: ARRAY<STRUCT<Message: STRING>>>>

HasAttachments

BOOLEAN

Reference

STRING

Attachments

ARRAY<STRUCT<AttachmentID: STRING, FileName: STRING, Url: STRING, MimeType: STRING, ContentLength: BIGINT, IncludeOnline: BOOLEAN>>

campo

Tipo de dados

Type

STRING

Contact

STRUCT<ContactID: STRING, MergedToContactID: STRING, ContactNumber: STRING, AccountNumber: STRING, ContactStatus: STRING, Name: STRING, FirstName: STRING, LastName: STRING, CompanyNumber: STRING, EmailAddress: STRING, ContactPersons: VARIANT, BankAccountDetails: STRING, TaxNumber: STRING, TaxNumberType: STRING, AccountsReceivableTaxType: STRING, AccountsPayableTaxType: STRING, Addresses: VARIANT, Phones: VARIANT, IsSupplier: BOOLEAN, IsCustomer: BOOLEAN, SalesDefaultLineAmountType: STRING, PurchasesDefaultLineAmountType: STRING, DefaultCurrency: STRING, XeroNetworkKey: STRING, SalesDefaultAccountCode: STRING, PurchasesDefaultAccountCode: STRING, SalesTrackingCategories: VARIANT, PurchasesTrackingCategories: VARIANT, TrackingCategoryName: STRING, TrackingCategoryOption: STRING, PaymentTerms: VARIANT, UpdatedDateUTC: STRING, ContactGroups: VARIANT, Website: STRING, BrandingTheme: VARIANT, BatchPayments: VARIANT, Discount: DOUBLE, Balances: VARIANT, Attachments: VARIANT, HasAttachments: BOOLEAN, ValidationErrors: VARIANT, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING>

Date

STRING

DateString

STRING

Status

STRING

LineAmountTypes

STRING

LineItems

ARRAY<STRUCT<LineItemID: STRING, Description: STRING, Quantity: DOUBLE, UnitAmount: DOUBLE, ItemCode: STRING, AccountCode: STRING, AccountID: STRING, TaxType: STRING, TaxAmount: DOUBLE, Item: STRUCT<Code: STRING, Name: STRING, ItemID: STRING>, LineAmount: DOUBLE, Tracking: ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>, DiscountRate: DOUBLE, DiscountAmount: DOUBLE, RepeatingInvoiceID: STRING, Taxability: STRING, SalesTaxCodeId: DOUBLE, TaxBreakdown: ARRAY<STRUCT<TaxComponentId: STRING, Type: STRING, Name: STRING, TaxPercentage: DOUBLE, TaxAmount: DOUBLE, TaxableAmount: DOUBLE, NonTaxableAmount: DOUBLE, ExemptAmount: DOUBLE, StateAssignedNo: STRING, JurisdictionRegion: STRING>>>>

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

UpdatedDateUTC

STRING

UpdatedDateUTCString

STRING

CurrencyCode

STRING

OverpaymentID

STRING

CurrencyRate

DOUBLE

RemainingCredit

DOUBLE

Allocations

ARRAY<STRUCT<AllocationID: STRING, Invoice: VARIANT, Overpayment: VARIANT, Prepayment: VARIANT, CreditNote: VARIANT, Amount: DOUBLE, Date: STRING, IsDeleted: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>>>

AppliedAmount

DOUBLE

Payments

ARRAY<STRUCT<Invoice: VARIANT, CreditNote: VARIANT, Prepayment: VARIANT, Overpayment: VARIANT, InvoiceNumber: STRING, CreditNoteNumber: STRING, BatchPayment: VARIANT, Account: VARIANT, Code: STRING, Date: STRING, CurrencyRate: DOUBLE, Amount: DOUBLE, BankAmount: DOUBLE, Reference: STRING, IsReconciled: BOOLEAN, Status: STRING, PaymentType: STRING, UpdatedDateUTC: STRING, UpdatedDateUTCString: STRING, PaymentID: STRING, BatchPaymentID: STRING, BankAccountNumber: STRING, Particulars: STRING, Details: STRING, HasAccount: BOOLEAN, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>, Warnings: ARRAY<STRUCT<Message: STRING>>>>

HasAttachments

BOOLEAN

Reference

STRING

Attachments

ARRAY<STRUCT<AttachmentID: STRING, FileName: STRING, Url: STRING, MimeType: STRING, ContentLength: BIGINT, IncludeOnline: BOOLEAN>>

nota

Esta tabela não suporta dimensões que mudam lentamente (SCD) tipo 2 porque tem VARIANT colunas.

payments​

Primary key: PaymentID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

Invoice

VARIANT

CreditNote

VARIANT

Prepayment

VARIANT

Overpayment

VARIANT

InvoiceNumber

STRING

CreditNoteNumber

STRING

BatchPayment

STRUCT<BatchPaymentID: STRING, Date: STRING, Amount: DOUBLE, Status: STRING, Type: STRING, Payments: ARRAY<VARIANT>, Account: STRUCT<AccountID: STRING, Code: STRING, Name: STRING>, Reference: STRING, Particulars: STRING, Code: STRING, Details: STRING, Narrative: STRING, DateString: STRING, TotalAmount: DOUBLE, UpdatedDateUTC: STRING, IsReconciled: BOOLEAN>

Account

VARIANT

Code

STRING

Date

STRING

CurrencyRate

DOUBLE

Amount

DOUBLE

BankAmount

DOUBLE

Reference

STRING

IsReconciled

BOOLEAN

Status

STRING

PaymentType

STRING

UpdatedDateUTC

STRING

UpdatedDateUTCString

STRING

PaymentID

STRING

BatchPaymentID

STRING

BankAccountNumber

STRING

Particulars

STRING

Details

STRING

HasAccount

BOOLEAN

HasValidationErrors

BOOLEAN

StatusAttributeString

STRING

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

Warnings

ARRAY<STRUCT<Message: STRING>>

IsDeleted

BOOLEAN

campo

Tipo de dados

Invoice

VARIANT

CreditNote

VARIANT

Prepayment

VARIANT

Overpayment

VARIANT

InvoiceNumber

STRING

CreditNoteNumber

STRING

BatchPayment

STRUCT<BatchPaymentID: STRING, Date: STRING, Amount: DOUBLE, Status: STRING, Type: STRING, Payments: ARRAY<VARIANT>, Account: STRUCT<AccountID: STRING, Code: STRING, Name: STRING>, Reference: STRING, Particulars: STRING, Code: STRING, Details: STRING, Narrative: STRING, DateString: STRING, TotalAmount: DOUBLE, UpdatedDateUTC: STRING, IsReconciled: BOOLEAN>

Account

VARIANT

Code

STRING

Date

STRING

CurrencyRate

DOUBLE

Amount

DOUBLE

BankAmount

DOUBLE

Reference

STRING

IsReconciled

BOOLEAN

Status

STRING

PaymentType

STRING

UpdatedDateUTC

STRING

UpdatedDateUTCString

STRING

PaymentID

STRING

BatchPaymentID

STRING

BankAccountNumber

STRING

Particulars

STRING

Details

STRING

HasAccount

BOOLEAN

HasValidationErrors

BOOLEAN

StatusAttributeString

STRING

ValidationErrors

ARRAY<STRUCT<Message: STRING>>

Warnings

ARRAY<STRUCT<Message: STRING>>

IsDeleted

BOOLEAN

nota

Esta tabela não suporta dimensões que mudam lentamente (SCD) tipo 2 porque tem VARIANT colunas.

prepayments​

Primary key: PrepaymentID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

Type

STRING

Contact

STRUCT<ContactID: STRING, MergedToContactID: STRING, ContactNumber: STRING, AccountNumber: STRING, ContactStatus: STRING, Name: STRING, FirstName: STRING, LastName: STRING, CompanyNumber: STRING, EmailAddress: STRING, ContactPersons: VARIANT, BankAccountDetails: STRING, TaxNumber: STRING, TaxNumberType: STRING, AccountsReceivableTaxType: STRING, AccountsPayableTaxType: STRING, Addresses: VARIANT, Phones: VARIANT, IsSupplier: BOOLEAN, IsCustomer: BOOLEAN, SalesDefaultLineAmountType: STRING, PurchasesDefaultLineAmountType: STRING, DefaultCurrency: STRING, XeroNetworkKey: STRING, SalesDefaultAccountCode: STRING, PurchasesDefaultAccountCode: STRING, SalesTrackingCategories: VARIANT, PurchasesTrackingCategories: VARIANT, TrackingCategoryName: STRING, TrackingCategoryOption: STRING, PaymentTerms: VARIANT, UpdatedDateUTC: STRING, ContactGroups: VARIANT, Website: STRING, BrandingTheme: VARIANT, BatchPayments: VARIANT, Discount: DOUBLE, Balances: VARIANT, Attachments: VARIANT, HasAttachments: BOOLEAN, ValidationErrors: VARIANT, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING>

Date

STRING

Status

STRING

LineAmountTypes

STRING

LineItems

ARRAY<STRUCT<LineItemID: STRING, Description: STRING, Quantity: DOUBLE, UnitAmount: DOUBLE, ItemCode: STRING, AccountCode: STRING, AccountID: STRING, TaxType: STRING, TaxAmount: DOUBLE, Item: STRUCT<Code: STRING, Name: STRING, ItemID: STRING>, LineAmount: DOUBLE, Tracking: ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>, DiscountRate: DOUBLE, DiscountAmount: DOUBLE, RepeatingInvoiceID: STRING, Taxability: STRING, SalesTaxCodeId: DOUBLE, TaxBreakdown: ARRAY<STRUCT<TaxComponentId: STRING, Type: STRING, Name: STRING, TaxPercentage: DOUBLE, TaxAmount: DOUBLE, TaxableAmount: DOUBLE, NonTaxableAmount: DOUBLE, ExemptAmount: DOUBLE, StateAssignedNo: STRING, JurisdictionRegion: STRING>>>>

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

Reference

STRING

InvoiceNumber

STRING

UpdatedDateUTC

STRING

UpdatedDateUTCString

STRING

CurrencyCode

STRING

PrepaymentID

STRING

BrandingThemeID

STRING

CurrencyRate

DOUBLE

RemainingCredit

DOUBLE

Allocations

ARRAY<STRUCT<AllocationID: STRING, Invoice: VARIANT, Overpayment: VARIANT, Prepayment: VARIANT, CreditNote: VARIANT, Amount: DOUBLE, Date: STRING, IsDeleted: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>>>

Payments

ARRAY<STRUCT<Invoice: VARIANT, CreditNote: VARIANT, Prepayment: VARIANT, Overpayment: VARIANT, InvoiceNumber: STRING, CreditNoteNumber: STRING, BatchPayment: VARIANT, Account: VARIANT, Code: STRING, Date: STRING, CurrencyRate: DOUBLE, Amount: DOUBLE, BankAmount: DOUBLE, Reference: STRING, IsReconciled: BOOLEAN, Status: STRING, PaymentType: STRING, UpdatedDateUTC: STRING, UpdatedDateUTCString: STRING, PaymentID: STRING, BatchPaymentID: STRING, BankAccountNumber: STRING, Particulars: STRING, Details: STRING, HasAccount: BOOLEAN, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>, Warnings: ARRAY<STRUCT<Message: STRING>>>>

AppliedAmount

DOUBLE

HasAttachments

BOOLEAN

Attachments

ARRAY<STRUCT<AttachmentID: STRING, FileName: STRING, Url: STRING, MimeType: STRING, ContentLength: BIGINT, IncludeOnline: BOOLEAN>>

campo

Tipo de dados

Type

STRING

Contact

STRUCT<ContactID: STRING, MergedToContactID: STRING, ContactNumber: STRING, AccountNumber: STRING, ContactStatus: STRING, Name: STRING, FirstName: STRING, LastName: STRING, CompanyNumber: STRING, EmailAddress: STRING, ContactPersons: VARIANT, BankAccountDetails: STRING, TaxNumber: STRING, TaxNumberType: STRING, AccountsReceivableTaxType: STRING, AccountsPayableTaxType: STRING, Addresses: VARIANT, Phones: VARIANT, IsSupplier: BOOLEAN, IsCustomer: BOOLEAN, SalesDefaultLineAmountType: STRING, PurchasesDefaultLineAmountType: STRING, DefaultCurrency: STRING, XeroNetworkKey: STRING, SalesDefaultAccountCode: STRING, PurchasesDefaultAccountCode: STRING, SalesTrackingCategories: VARIANT, PurchasesTrackingCategories: VARIANT, TrackingCategoryName: STRING, TrackingCategoryOption: STRING, PaymentTerms: VARIANT, UpdatedDateUTC: STRING, ContactGroups: VARIANT, Website: STRING, BrandingTheme: VARIANT, BatchPayments: VARIANT, Discount: DOUBLE, Balances: VARIANT, Attachments: VARIANT, HasAttachments: BOOLEAN, ValidationErrors: VARIANT, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING>

Date

STRING

Status

STRING

LineAmountTypes

STRING

LineItems

ARRAY<STRUCT<LineItemID: STRING, Description: STRING, Quantity: DOUBLE, UnitAmount: DOUBLE, ItemCode: STRING, AccountCode: STRING, AccountID: STRING, TaxType: STRING, TaxAmount: DOUBLE, Item: STRUCT<Code: STRING, Name: STRING, ItemID: STRING>, LineAmount: DOUBLE, Tracking: ARRAY<STRUCT<TrackingCategoryID: STRING, TrackingOptionID: STRING, Name: STRING, Option: STRING>>, DiscountRate: DOUBLE, DiscountAmount: DOUBLE, RepeatingInvoiceID: STRING, Taxability: STRING, SalesTaxCodeId: DOUBLE, TaxBreakdown: ARRAY<STRUCT<TaxComponentId: STRING, Type: STRING, Name: STRING, TaxPercentage: DOUBLE, TaxAmount: DOUBLE, TaxableAmount: DOUBLE, NonTaxableAmount: DOUBLE, ExemptAmount: DOUBLE, StateAssignedNo: STRING, JurisdictionRegion: STRING>>>>

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

Reference

STRING

InvoiceNumber

STRING

UpdatedDateUTC

STRING

UpdatedDateUTCString

STRING

CurrencyCode

STRING

PrepaymentID

STRING

BrandingThemeID

STRING

CurrencyRate

DOUBLE

RemainingCredit

DOUBLE

Allocations

ARRAY<STRUCT<AllocationID: STRING, Invoice: VARIANT, Overpayment: VARIANT, Prepayment: VARIANT, CreditNote: VARIANT, Amount: DOUBLE, Date: STRING, IsDeleted: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>>>

Payments

ARRAY<STRUCT<Invoice: VARIANT, CreditNote: VARIANT, Prepayment: VARIANT, Overpayment: VARIANT, InvoiceNumber: STRING, CreditNoteNumber: STRING, BatchPayment: VARIANT, Account: VARIANT, Code: STRING, Date: STRING, CurrencyRate: DOUBLE, Amount: DOUBLE, BankAmount: DOUBLE, Reference: STRING, IsReconciled: BOOLEAN, Status: STRING, PaymentType: STRING, UpdatedDateUTC: STRING, UpdatedDateUTCString: STRING, PaymentID: STRING, BatchPaymentID: STRING, BankAccountNumber: STRING, Particulars: STRING, Details: STRING, HasAccount: BOOLEAN, HasValidationErrors: BOOLEAN, StatusAttributeString: STRING, ValidationErrors: ARRAY<STRUCT<Message: STRING>>, Warnings: ARRAY<STRUCT<Message: STRING>>>>

AppliedAmount

DOUBLE

HasAttachments

BOOLEAN

Attachments

ARRAY<STRUCT<AttachmentID: STRING, FileName: STRING, Url: STRING, MimeType: STRING, ContentLength: BIGINT, IncludeOnline: BOOLEAN>>

nota

Esta tabela não suporta dimensões que mudam lentamente (SCD) tipo 2 porque tem VARIANT colunas.

purchase_orders​

Primary key: PurchaseOrderID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

Contact

STRUCT<ContactID:STRING,MergedToContactID:STRING,ContactNumber:STRING,AccountNumber:STRING,ContactStatus:STRING,Name:STRING,FirstName:STRING,LastName:STRING,CompanyNumber:STRING,EmailAddress:STRING,BankAccountDetails:STRING,TaxNumber:STRING,TaxNumberType:STRING,AccountsReceivableTaxType:STRING,AccountsPayableTaxType:STRING,IsSupplier:BOOLEAN,IsCustomer:BOOLEAN,DefaultCurrency:STRING,UpdatedDateUTC:STRING,Website:STRING,Discount:DOUBLE,HasAttachments:BOOLEAN,HasValidationErrors:BOOLEAN,ContactPersons:VARIANT,Addresses:VARIANT,Phones:VARIANT>

LineItems

ARRAY<STRUCT<LineItemID:STRING,Description:STRING,Quantity:DOUBLE,UnitAmount:DOUBLE,ItemCode:STRING,AccountCode:STRING,AccountID:STRING,TaxType:STRING,TaxAmount:DOUBLE,Item:STRUCT<Code:STRING,Name:STRING,ItemID:STRING>,LineAmount:DOUBLE,Tracking:ARRAY<STRUCT<TrackingCategoryID:STRING,TrackingOptionID:STRING,Name:STRING,Option:STRING>>,DiscountRate:DOUBLE,DiscountAmount:DOUBLE,RepeatingInvoiceID:STRING,Taxability:STRING,SalesTaxCodeId:DOUBLE,TaxBreakdown:ARRAY<STRUCT<TaxComponentId:STRING,Type:STRING,Name:STRING,TaxPercentage:DOUBLE,TaxAmount:DOUBLE,TaxableAmount:DOUBLE,NonTaxableAmount:DOUBLE,ExemptAmount:DOUBLE,StateAssignedNo:STRING,JurisdictionRegion:STRING>>>>

Type

STRING

Date

STRING

DateString

STRING

DeliveryDate

STRING

DeliveryDateString

STRING

LineAmountTypes

STRING

PurchaseOrderNumber

STRING

Reference

STRING

BrandingThemeID

STRING

CurrencyCode

STRING

Status

STRING

SentToContact

BOOLEAN

DeliveryAddress

STRING

AttentionTo

STRING

Telephone

STRING

DeliveryInstructions

STRING

ExpectedArrivalDate

STRING

ExpectedArrivalDateString

STRING

PurchaseOrderID

STRING

CurrencyRate

DOUBLE

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

TotalDiscount

DOUBLE

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

IsDiscounted

BOOLEAN

UpdatedDateUTC

STRING

StatusAttributeString

STRING

ValidationErrors

ARRAY<STRUCT<Message:STRING>>

Warnings

ARRAY<STRUCT<Message:STRING>>

Attachments

ARRAY<STRUCT<AttachmentID:STRING,FileName:STRING,Url:STRING,MimeType:STRING,ContentLength:BIGINT,IncludeOnline:BOOLEAN>>

IsDeleted

BOOLEAN

campo

Tipo de dados

Contact

STRUCT<ContactID:STRING,MergedToContactID:STRING,ContactNumber:STRING,AccountNumber:STRING,ContactStatus:STRING,Name:STRING,FirstName:STRING,LastName:STRING,CompanyNumber:STRING,EmailAddress:STRING,BankAccountDetails:STRING,TaxNumber:STRING,TaxNumberType:STRING,AccountsReceivableTaxType:STRING,AccountsPayableTaxType:STRING,IsSupplier:BOOLEAN,IsCustomer:BOOLEAN,DefaultCurrency:STRING,UpdatedDateUTC:STRING,Website:STRING,Discount:DOUBLE,HasAttachments:BOOLEAN,HasValidationErrors:BOOLEAN,ContactPersons:VARIANT,Addresses:VARIANT,Phones:VARIANT>

LineItems

ARRAY<STRUCT<LineItemID:STRING,Description:STRING,Quantity:DOUBLE,UnitAmount:DOUBLE,ItemCode:STRING,AccountCode:STRING,AccountID:STRING,TaxType:STRING,TaxAmount:DOUBLE,Item:STRUCT<Code:STRING,Name:STRING,ItemID:STRING>,LineAmount:DOUBLE,Tracking:ARRAY<STRUCT<TrackingCategoryID:STRING,TrackingOptionID:STRING,Name:STRING,Option:STRING>>,DiscountRate:DOUBLE,DiscountAmount:DOUBLE,RepeatingInvoiceID:STRING,Taxability:STRING,SalesTaxCodeId:DOUBLE,TaxBreakdown:ARRAY<STRUCT<TaxComponentId:STRING,Type:STRING,Name:STRING,TaxPercentage:DOUBLE,TaxAmount:DOUBLE,TaxableAmount:DOUBLE,NonTaxableAmount:DOUBLE,ExemptAmount:DOUBLE,StateAssignedNo:STRING,JurisdictionRegion:STRING>>>>

Type

STRING

Date

STRING

DateString

STRING

DeliveryDate

STRING

DeliveryDateString

STRING

LineAmountTypes

STRING

PurchaseOrderNumber

STRING

Reference

STRING

BrandingThemeID

STRING

CurrencyCode

STRING

Status

STRING

SentToContact

BOOLEAN

DeliveryAddress

STRING

AttentionTo

STRING

Telephone

STRING

DeliveryInstructions

STRING

ExpectedArrivalDate

STRING

ExpectedArrivalDateString

STRING

PurchaseOrderID

STRING

CurrencyRate

DOUBLE

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

TotalDiscount

DOUBLE

HasAttachments

BOOLEAN

HasErrors

BOOLEAN

IsDiscounted

BOOLEAN

UpdatedDateUTC

STRING

StatusAttributeString

STRING

ValidationErrors

ARRAY<STRUCT<Message:STRING>>

Warnings

ARRAY<STRUCT<Message:STRING>>

Attachments

ARRAY<STRUCT<AttachmentID:STRING,FileName:STRING,Url:STRING,MimeType:STRING,ContentLength:BIGINT,IncludeOnline:BOOLEAN>>

IsDeleted

BOOLEAN

nota

Esta tabela não suporta dimensões que mudam lentamente (SCD) tipo 2 porque tem VARIANT colunas.

repeating_invoices​

Primary key: RepeatingInvoiceID

Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

Type

STRING

Contact

STRUCT<ContactID:STRING,MergedToContactID:STRING,ContactNumber:STRING,AccountNumber:STRING,ContactStatus:STRING,Name:STRING,FirstName:STRING,LastName:STRING,CompanyNumber:STRING,EmailAddress:STRING,BankAccountDetails:STRING,TaxNumber:STRING,TaxNumberType:STRING,AccountsReceivableTaxType:STRING,AccountsPayableTaxType:STRING,IsSupplier:BOOLEAN,IsCustomer:BOOLEAN,DefaultCurrency:STRING,UpdatedDateUTC:STRING,Website:STRING,Discount:DOUBLE,HasAttachments:BOOLEAN,HasValidationErrors:BOOLEAN,ContactPersons:VARIANT,Addresses:VARIANT,Phones:VARIANT>

Schedule

STRUCT<Period:BIGINT,Unit:STRING,DueDate:BIGINT,DueDateType:STRING,StartDate:STRING,NextScheduledDate:STRING,NextScheduledDateString:STRING,EndDate:STRING>

LineItems

ARRAY<STRUCT<LineItemID:STRING,Description:STRING,Quantity:DOUBLE,UnitAmount:DOUBLE,ItemCode:STRING,AccountCode:STRING,AccountID:STRING,TaxType:STRING,TaxAmount:DOUBLE,Item:STRUCT<Code:STRING,Name:STRING,ItemID:STRING>,LineAmount:DOUBLE,Tracking:ARRAY<STRUCT<TrackingCategoryID:STRING,TrackingOptionID:STRING,Name:STRING,Option:STRING>>,DiscountRate:DOUBLE,DiscountAmount:DOUBLE,RepeatingInvoiceID:STRING,Taxability:STRING,SalesTaxCodeId:DOUBLE,TaxBreakdown:ARRAY<STRUCT<TaxComponentId:STRING,Type:STRING,Name:STRING,TaxPercentage:DOUBLE,TaxAmount:DOUBLE,TaxableAmount:DOUBLE,NonTaxableAmount:DOUBLE,ExemptAmount:DOUBLE,StateAssignedNo:STRING,JurisdictionRegion:STRING>>>>

LineAmountTypes

STRING

Reference

STRING

BrandingThemeID

STRING

CurrencyCode

STRING

Status

STRING

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

UpdatedDateUTC

STRING

RepeatingInvoiceID

STRING

ID

STRING

HasAttachments

BOOLEAN

Attachments

ARRAY<STRUCT<AttachmentID:STRING,FileName:STRING,Url:STRING,MimeType:STRING,ContentLength:BIGINT,IncludeOnline:BOOLEAN>>

ApprovedForSending

BOOLEAN

SendCopy

BOOLEAN

MarkAsSent

BOOLEAN

IncludePDF

BOOLEAN

campo

Tipo de dados

Type

STRING

Contact

STRUCT<ContactID:STRING,MergedToContactID:STRING,ContactNumber:STRING,AccountNumber:STRING,ContactStatus:STRING,Name:STRING,FirstName:STRING,LastName:STRING,CompanyNumber:STRING,EmailAddress:STRING,BankAccountDetails:STRING,TaxNumber:STRING,TaxNumberType:STRING,AccountsReceivableTaxType:STRING,AccountsPayableTaxType:STRING,IsSupplier:BOOLEAN,IsCustomer:BOOLEAN,DefaultCurrency:STRING,UpdatedDateUTC:STRING,Website:STRING,Discount:DOUBLE,HasAttachments:BOOLEAN,HasValidationErrors:BOOLEAN,ContactPersons:VARIANT,Addresses:VARIANT,Phones:VARIANT>

Schedule

STRUCT<Period:BIGINT,Unit:STRING,DueDate:BIGINT,DueDateType:STRING,StartDate:STRING,NextScheduledDate:STRING,NextScheduledDateString:STRING,EndDate:STRING>

LineItems

ARRAY<STRUCT<LineItemID:STRING,Description:STRING,Quantity:DOUBLE,UnitAmount:DOUBLE,ItemCode:STRING,AccountCode:STRING,AccountID:STRING,TaxType:STRING,TaxAmount:DOUBLE,Item:STRUCT<Code:STRING,Name:STRING,ItemID:STRING>,LineAmount:DOUBLE,Tracking:ARRAY<STRUCT<TrackingCategoryID:STRING,TrackingOptionID:STRING,Name:STRING,Option:STRING>>,DiscountRate:DOUBLE,DiscountAmount:DOUBLE,RepeatingInvoiceID:STRING,Taxability:STRING,SalesTaxCodeId:DOUBLE,TaxBreakdown:ARRAY<STRUCT<TaxComponentId:STRING,Type:STRING,Name:STRING,TaxPercentage:DOUBLE,TaxAmount:DOUBLE,TaxableAmount:DOUBLE,NonTaxableAmount:DOUBLE,ExemptAmount:DOUBLE,StateAssignedNo:STRING,JurisdictionRegion:STRING>>>>

LineAmountTypes

STRING

Reference

STRING

BrandingThemeID

STRING

CurrencyCode

STRING

Status

STRING

SubTotal

DOUBLE

TotalTax

DOUBLE

Total

DOUBLE

UpdatedDateUTC

STRING

RepeatingInvoiceID

STRING

ID

STRING

HasAttachments

BOOLEAN

Attachments

ARRAY<STRUCT<AttachmentID:STRING,FileName:STRING,Url:STRING,MimeType:STRING,ContentLength:BIGINT,IncludeOnline:BOOLEAN>>

ApprovedForSending

BOOLEAN

SendCopy

BOOLEAN

MarkAsSent

BOOLEAN

IncludePDF

BOOLEAN

nota

Esta tabela não suporta dimensões que mudam lentamente (SCD) tipo 2 porque tem VARIANT colunas.

tax_rates​

Primary key: TaxType

Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

Name

STRING

TaxType

STRING

TaxComponents

ARRAY<STRUCT<Name: STRING, Rate: DOUBLE, IsCompound: BOOLEAN, IsNonRecoverable: BOOLEAN>>

Status

STRING

ReportTaxType

STRING

CanApplyToAssets

BOOLEAN

CanApplyToEquity

BOOLEAN

CanApplyToExpenses

BOOLEAN

CanApplyToLiabilities

BOOLEAN

CanApplyToRevenue

BOOLEAN

DisplayTaxRate

DOUBLE

EffectiveRate

DOUBLE

campo

Tipo de dados

Name

STRING

TaxType

STRING

TaxComponents

ARRAY<STRUCT<Name: STRING, Rate: DOUBLE, IsCompound: BOOLEAN, IsNonRecoverable: BOOLEAN>>

Status

STRING

ReportTaxType

STRING

CanApplyToAssets

BOOLEAN

CanApplyToEquity

BOOLEAN

CanApplyToExpenses

BOOLEAN

CanApplyToLiabilities

BOOLEAN

CanApplyToRevenue

BOOLEAN

DisplayTaxRate

DOUBLE

EffectiveRate

DOUBLE

tracking_categories​

Primary key: TrackingCategoryID

Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

TrackingCategoryID

STRING

TrackingOptionID

STRING

Name

STRING

Option

STRING

Status

STRING

Options

ARRAY<STRUCT<TrackingOptionID STRING, Name STRING, Status STRING, TrackingCategoryID STRING, HasValidationErrors BOOLEAN, IsDeleted BOOLEAN, IsArchived BOOLEAN, IsActive BOOLEAN>>

campo

Tipo de dados

TrackingCategoryID

STRING

TrackingOptionID

STRING

Name

STRING

Option

STRING

Status

STRING

Options

ARRAY<STRUCT<TrackingOptionID STRING, Name STRING, Status STRING, TrackingCategoryID STRING, HasValidationErrors BOOLEAN, IsDeleted BOOLEAN, IsArchived BOOLEAN, IsActive BOOLEAN>>

users​

Primary key: UserID

Modo de sincronização: incremental

Campo do cursor: UpdatedDateUTC

campo

Tipo de dados

UserID

STRING

EmailAddress

STRING

FirstName

STRING

LastName

STRING

UpdatedDateUTC

STRING

IsSubscriber

BOOLEAN

OrganisationRole

STRING

GlobalUserID

STRING

campo

Tipo de dados

UserID

STRING

EmailAddress

STRING

FirstName

STRING

LastName

STRING

UpdatedDateUTC

STRING

IsSubscriber

BOOLEAN

OrganisationRole

STRING

GlobalUserID

STRING

projects​

Primary key: projectId

Modo de sincronização: Apenas refresh completo

campo

Tipo de dados

projectId

STRING

contactId

STRING

name

STRING

currencyCode

STRING

minutesLogged

BIGINT

totalTaskAmount

STRUCT<currency: STRING, value: DOUBLE>

totalExpenseAmount

STRUCT<currency: STRING, value: DOUBLE>

estimateAmount

STRUCT<currency: STRING, value: DOUBLE>

minutesToBeInvoiced

BIGINT

taskAmountToBeInvoiced

STRUCT<currency: STRING, value: DOUBLE>

taskAmountInvoiced

STRUCT<currency: STRING, value: DOUBLE>

expenseAmountToBeInvoiced

STRUCT<currency: STRING, value: DOUBLE>

expenseAmountInvoiced

STRUCT<currency: STRING, value: DOUBLE>

projectAmountInvoiced

STRUCT<currency: STRING, value: DOUBLE>

deposit

STRUCT<currency: STRING, value: DOUBLE>

depositApplied

STRUCT<currency: STRING, value: DOUBLE>

creditNoteAmount

STRUCT<currency: STRING, value: DOUBLE>

deadlineUtc

TIMESTAMP

totalInvoiced

STRUCT<currency: STRING, value: DOUBLE>

totalToBeInvoiced

STRUCT<currency: STRING, value: DOUBLE>

estimate

STRUCT<currency: STRING, value: DOUBLE>

status

STRING

campo

Tipo de dados

projectId

STRING

contactId

STRING

name

STRING

currencyCode

STRING

minutesLogged

BIGINT

totalTaskAmount

STRUCT<currency: STRING, value: DOUBLE>

totalExpenseAmount

STRUCT<currency: STRING, value: DOUBLE>

estimateAmount

STRUCT<currency: STRING, value: DOUBLE>

minutesToBeInvoiced

BIGINT

taskAmountToBeInvoiced

STRUCT<currency: STRING, value: DOUBLE>

taskAmountInvoiced

STRUCT<currency: STRING, value: DOUBLE>

expenseAmountToBeInvoiced

STRUCT<currency: STRING, value: DOUBLE>

expenseAmountInvoiced

STRUCT<currency: STRING, value: DOUBLE>

projectAmountInvoiced

STRUCT<currency: STRING, value: DOUBLE>

deposit

STRUCT<currency: STRING, value: DOUBLE>

depositApplied

STRUCT<currency: STRING, value: DOUBLE>

creditNoteAmount

STRUCT<currency: STRING, value: DOUBLE>

deadlineUtc

TIMESTAMP

totalInvoiced

STRUCT<currency: STRING, value: DOUBLE>

totalToBeInvoiced

STRUCT<currency: STRING, value: DOUBLE>

estimate

STRUCT<currency: STRING, value: DOUBLE>

status

STRING

Permissões OAuth necessárias​

Quando você faz login durante a configuração da conexão, o conector solicita os seguintes escopos OAuth somente leitura. Para saber o que cada escopo concede, consulte Escopos OAuth 2.0.

Escopo

Necessário para

openid, profile, email, offline_access

Acesso à linha de base. offline_access permite que o conector faça refresh do seu access token entre execuções.

accounting.settings.read

accounts, branding_themes, currencies, items, organisation, tax_rates, tracking_categories, users

accounting.contacts.read

contacts, contact_groups

accounting.invoices.read

credit_notes, invoices, linked_transactions, purchase_orders, repeating_invoices

accounting.payments.read

overpayments, payments, prepayments

accounting.banktransactions.read

bank_transactions, bank_transfers

accounting.manualjournals.read

manual_journals

accounting.budgets.read

budgets

projects.read

projects

Escopo

Necessário para

openid, profile, email, offline_access

Acesso à linha de base. offline_access permite que o conector faça refresh do seu access token entre execuções.

accounting.settings.read

accounts, branding_themes, currencies, items, organisation, tax_rates, tracking_categories, users

accounting.contacts.read

contacts, contact_groups

accounting.invoices.read

credit_notes, invoices, linked_transactions, purchase_orders, repeating_invoices

accounting.payments.read

overpayments, payments, prepayments

accounting.banktransactions.read

bank_transactions, bank_transfers

accounting.manualjournals.read

manual_journals

accounting.budgets.read

budgets

projects.read

projects