Omie is a comprehensive business management platform designed for Brazilian companies. It provides integrated tools for ERP, CRM, financial management, and business operations to help companies streamline their processes and improve efficiency.

Configuring Omie as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Omie option from the list of connectors. Click Next and you’ll be prompted to add your access.

1. Add account access

You’ll need your Omie App Key and App Secret for this connection. You can find these credentials in your Omie integrations settings. Check Omie’s documentation to discover where you can find the App Key and App Secret for the connection.

App Key: Your application key for the Omie API.
App Secret: Your application secret for the Omie API.
Start Date: The earliest record date to sync.

2. Select streams

Choose which data streams you want to sync - you can select all streams or pick specific ones that matter most to you. Omie provides comprehensive business data including clients, finances, projects, and more.

Tip: The stream can be found more easily by typing its name.

Select the streams and click Next.

3. Configure data streams

Customize how you want your data to appear in your catalog. Select a name for each table (which will contain the fetched data) and the type of sync.

Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix and make this process faster!
Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data.
- Full table: every time the extraction happens, we’ll get the current state of the data.

Once you are done configuring, click Next.

4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. Optionally, you can determine when to execute a full sync. Once you are ready, click Next to finalize the setup.

5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button.

For you to be able to see it on your Catalog, you need at least one successful source run.

Streams and Fields

Below you’ll find all available data streams from Omie, their corresponding endpoints and fields:

Stream to Endpoint Mapping

Stream	Omie Endpoint	Sync Type
activity_types	ListarTipoAtiv	Full Table
attachment_types	ListarTiposAnexos	Full Table
banks	ListarBancos	Full Table
bills	ListarContasPagar	Incremental
bills_attachments	ListarAnexo	Incremental
card_brands	ListarBandeiras	Full Table
categories	ListarCategorias	Full Table
checking_account_types	ListarTiposCC	Full Table
checking_accounts	ListarContasCorrentes	Incremental
checking_accounts_balance	ListarExtrato	Incremental
checking_accounts_transfers	ListarLancCC	Incremental
clients	ListarClientes	Incremental
cnae	ListarCNAE	Full Table
companies	ListarEmpresas	Full Table
countries	ListarPaises	Full Table
departments	ListarDepartamentos	Full Table
document_types	PesquisarTipoDocumento	Full Table
dre	ListarCadastroDRE	Full Table
finances	ListarMovimentos	Incremental
finances_summary	ObterResumoFinancas	Incremental
general_users	ListarUsuarios	Full Table
installments	ListarParcelas	Full Table
nfe	ListarNF	Incremental
nfse	ListarNFSEs	Incremental
nfse_documents	ObterNFSe	Incremental
order_services	ListarOS	Incremental
orders	ListarPedidos	Incremental
os_documents	ObterOS	Incremental
pix	ListarPix	Incremental
projects	ListarProjetos	Incremental
purchase_orders	PesquisarPedCompra	Incremental
quotes	ListarOrcamentos	Incremental
receipt_documents	ObterRecibo	Full Table
receivables	ListarContasReceber	Incremental
rps_documents	ObterRPS	Full Table
sellers	ListarVendedores	Full Table
services	ListarCadastroServico	Incremental
subscriber_types	ListarTipoAssinante	Full Table
task_types	ObterTiposTarefa	Full Table
tasks	ListarTarefas	Incremental
titles	PesquisarLancamentos	Incremental
transaction_origins	ListarOrigem	Full Table
transfer_purposes	ListarFinalTransf	Full Table
users	ListarUsuarios	Full Table

Available Streams and Fields

Reference Tables

Activity Types

Reference table containing activity types (Tipos de Atividade).

Field	Type	Description
_id	string	Unique identifier
c_codigo	string	Activity type code
c_descricao	string	Activity type description

Attachment Types

Reference table containing attachment file types (Tipos de Anexo).

Field	Type	Description
_id	string	Unique identifier
codigo	string	Attachment type code
descricao	string	Attachment type description

Banks

Reference table containing bank information and configurations.

Field	Type	Description
codigo	string	Bank code
nome	string	Bank name
tipo	string	Bank type
cod_compen	string	Compensation code
cod_ispb	string	ISPB code
entf_cnpj	string	Entity CNPJ
cnab_cob	string	Collection CNAB
cnab_pag	string	Payment CNAB
cnab_altve	string	CNAB alternative version
cnab_altvl	string	CNAB alternative layout
crawler_sn	string	Whether crawler is enabled
cwr_cobrem	string	Collection remittance crawler
cwr_cobret	string	Collection return crawler
cwr_pagrem	string	Payment remittance crawler
cwr_pagret	string	Payment return crawler
cwr_extr	string	Extract crawler
obank_sn	string	Whether Open Banking is enabled
obank_cobr	string	Open Banking collection
obank_extr	string	Open Banking extract
obank_pagt	string	Open Banking payment
obank_pix	string	Open Banking PIX
descond_sn	string	Whether discount is conditional
descond_qt	integer	Discount quantity

Card Brands

Reference table containing card brands (Bandeiras de Cartao).

Field	Type	Description
_id	string	Unique identifier
c_codigo	string	Card brand code
c_descricao	string	Card brand description

Field	Type	Description
codigo	string	Category code
descricao	string	Category description
descricao_padrao	string	Default description
categoria_superior	string	Parent category
natureza	string	Category nature
tipo_categoria	string	Category type
codigo_dre	string	DRE code
conta_receita	string	Revenue account
conta_despesa	string	Expense account
conta_inativa	string	Whether account is inactive
id_conta_contabil	string	Accounting account ID
tag_conta_contabil	string	Accounting account tag
definida_pelo_usuario	string	Whether defined by user
nao_exibir	string	Whether to hide
totalizadora	string	Whether it’s a totalizer
transferencia	string	Whether it’s a transfer
dados_dre.codigo_dre	string	DRE code
dados_dre.descricao_dre	string	DRE description
dados_dre.nao_exibir_dre	string	Whether to hide in DRE
dados_dre.nivel_dre	integer	DRE level
dados_dre.sinal_dre	string	DRE signal
dados_dre.totaliza_dre	string	Whether it totalizes in DRE

Field	Type	Description
codigo	string	Department code
descricao	string	Department description
estrutura	string	Department structure
inativo	string	Whether the department is inactive

Field	Type	Description
_id	string	Unique identifier (bank_code combination)
banco	string	Bank code
codigo	string	Transfer purpose code
descricao	string	Transfer purpose description

Users and Personnel

General Users

Stream containing general system users (Usuarios - Modulo Geral).

Field	Type	Description
_id	integer	Unique identifier
n_cod_usuario	integer	User code
c_nome	string	User name
c_nome_compl	string	Full name
c_email	string	User email

Users (CRM)

Stream containing CRM user information.

Field	Type	Description
n_codigo	integer	User code
c_nome	string	User name
c_email	string	User email
n_meta_anual	number	Annual goal
c_telefone	string	Phone number
c_celular	string	Mobile number

Sellers

Stream containing seller/salesperson information.

Field	Type	Description
codigo	integer	Seller code
cod_int	string	Integration code
nome	string	Seller name
inativo	string	Whether the seller is inactive
email	string	Seller email
fatura_pedido	string	Can invoice orders
visualiza_pedido	string	Can view orders
comissao	number	Commission percentage

Clients and Companies

Clients

Stream containing customer and client information from your Omie account.

Field	Type	Description
codigo_cliente_omie	integer	Unique identifier in Omie
codigo_cliente_integracao	string	Integration identifier
razao_social	string	Company name
nome_fantasia	string	Trade name
cnpj_cpf	string	Tax identification number
cnae	string	Economic activity code
email	string	Client email address
telefone1_ddd	string	Primary phone DDD
telefone1_numero	string	Primary phone number
telefone2_ddd	string	Secondary phone DDD
telefone2_numero	string	Secondary phone number
endereco	string	Street address
endereco_numero	string	Street number
complemento	string	Address complement
bairro	string	Neighborhood
cidade	string	City
estado	string	State
cep	string	Postal code
codigo_pais	string	Country code
pessoa_fisica	string	Whether it’s an individual
inativo	string	Whether inactive
exterior	string	Whether foreign
bloquear_faturamento	string	Whether billing is blocked
inscricao_estadual	string	State registration
inscricao_municipal	string	Municipal registration
last_updated_at	datetime	Last update timestamp
dados_bancarios.agencia	string	Bank branch
dados_bancarios.cChavePix	string	PIX key
dados_bancarios.codigo_banco	string	Bank code
dados_bancarios.conta_corrente	string	Account number
dados_bancarios.doc_titular	string	Account holder document
dados_bancarios.nome_titular	string	Account holder name
dados_bancarios.transf_padrao	string	Default transfer flag
info.cImpAPI	string	API import flag
info.dAlt	string	Last modification date
info.hAlt	string	Last modification time
info.uAlt	string	Last modification user
info.dInc	string	Creation date
info.hInc	string	Creation time
info.uInc	string	Creation user
tags[]	array	Client tags
recomendacoes.gerar_boletos	string	Generate bank slips flag

Companies

Stream containing company and organization information.

Field	Type	Description
codigo_empresa	string	Unique identifier
cnpj	string	Company tax ID
razao_social	string	Legal name
nome_fantasia	string	Trade name
endereco	string	Street address
endereco_numero	string	Street number
complemento	string	Address complement
logradouro	string	Street type
bairro	string	Neighborhood
cidade	string	City
estado	string	State
cep	string	Postal code
codigo_pais	string	Country code
email	string	Company email
website	string	Company website
telefone1_ddd	string	Primary phone DDD
telefone1_numero	string	Primary phone number
telefone2_ddd	string	Secondary phone DDD
telefone2_numero	string	Secondary phone number
fax_ddd	string	Fax DDD
fax_numero	string	Fax number
cnae	string	Economic activity code
cnae_municipal	string	Municipal activity code
inscricao_estadual	string	State registration
inscricao_municipal	string	Municipal registration
inscricao_suframa	string	SUFRAMA registration
inativa	string	Whether inactive
gera_nfse	string	Whether generates NFSE
regime_tributario	string	Tax regime
optante_simples_nacional	string	Simples Nacional flag
pdv_sincr_analitica	string	PDV analytical sync
csc_homologacao	string	CSC homologation
csc_id_homologacao	string	CSC ID homologation
csc_id_producao	string	CSC ID production
csc_producao	string	CSC production
ecd_codigo_cadastral	string	ECD cadastral code
ecd_codigo_instituicao_responsavel	string	ECD responsible institution code
efd_atividade_industrial	string	EFD industrial activity
efd_perfil_arquivo_fiscal	string	EFD fiscal file profile
sped_codigo_criterio_escrituracao	string	SPED bookkeeping criteria code
sped_codigo_incidencia_tributaria	string	SPED tax incidence code
sped_codigo_indicador_apropriacao_credito	string	SPED credit appropriation indicator
sped_codigo_tipo_atividade	string	SPED activity type code
sped_codigo_tipo_contribuicao	string	SPED contribution type code
sped_cpf_contador	string	SPED accountant CPF
sped_crc_contador	string	SPED accountant CRC
sped_email_contador	string	SPED accountant email
sped_junta_comercial	string	SPED commercial board
sped_matriz	string	SPED headquarters
sped_natureza_pessoa_juridica	string	SPED legal entity nature
sped_nome_contador	string	SPED accountant name
sped_registro_junta_comercial	string	SPED commercial board registration
sped_usa_contabilidade_terceirizada	string	SPED outsourced accounting

Projects

Stream containing project information for tracking and management.

Field	Type	Description
codigo	integer	Unique identifier
cod_int	string	Integration code
nome	string	Project name
inativo	string	Whether inactive
last_updated_at	datetime	Last update timestamp
info.data_alt	string	Last modification date
info.hora_alt	string	Last modification time
info.user_alt	string	Last modification user
info.data_inc	string	Creation date
info.hora_inc	string	Creation time
info.user_inc	string	Creation user

Financial Management

Checking Accounts

Stream containing bank account information and configurations.

Field	Type	Description
n_cod_cc	integer	Unique identifier
c_cod_cc_int	string	Integration code
descricao	string	Account description
codigo_banco	string	Bank code
codigo_agencia	string	Branch code
numero_conta_corrente	string	Account number
numero	string	Account number (alternative)
tipo	string	Account type
tipo_conta_corrente	string	Checking account type
modalidade	string	Account modality
bloqueado	string	Whether blocked
inativo	string	Whether inactive
saldo_inicial	number	Initial balance
saldo_data	string	Balance date
valor_limite	number	Credit limit
endereco	string	Address
complemento	string	Complement
bairro	string	Neighborhood
cidade	string	City
estado	string	State
cep	string	Postal code
codigo_pais	string	Country code
email	string	Account email
ddd	string	Phone DDD
telefone	string	Phone number
nome_gerente	string	Manager name
observacao	string	Observations
nao_fluxo	string	Exclude from cash flow
nao_resumo	string	Exclude from summary
importado_api	string	Imported via API
data_alt	string	Last modification date
hora_alt	string	Last modification time
user_alt	string	Last modification user
data_inc	string	Creation date
hora_inc	string	Creation time
user_inc	string	Creation user
bol_sn	string	Whether generates bank slips
bol_instr1	string	Bank slip instruction 1
bol_instr2	string	Bank slip instruction 2
bol_instr3	string	Bank slip instruction 3
bol_instr4	string	Bank slip instruction 4
cancinstr	string	Cancellation instructions
cobr_sn	string	Whether generates collection
cobr_esp	string	Collection specification
cnab_esp	string	CNAB specification
dias_rcomp	integer	Days for recomposition
per_juros	number	Interest percentage
per_multa	number	Fine percentage
pix_sn	string	Whether PIX is enabled
c_estabelecimento	string	Establishment
pdv_bandeira	string	PDV card brand
pdv_categoria	string	PDV category
pdv_cod_adm	integer	PDV admin code
pdv_dias_venc	integer	PDV days to due
pdv_enviar	string	PDV send flag
pdv_limite_pacelas	integer	PDV installment limit
pdv_num_parcelas	integer	PDV number of installments
pdv_sincr_analitica	string	PDV analytical sync
pdv_taxa_adm	number	PDV admin fee
pdv_taxa_loja	number	PDV store fee
pdv_tipo_tef	integer	PDV TEF type
last_updated_at	datetime	Last update timestamp

Checking Accounts Balance

Stream containing account balance information and statements.

Field	Type	Description
account_id	integer	Parent account ID
n_cod_cc	integer	Checking account code
c_cod_int_cc	string	Integration account code
n_cod_agencia	string	Branch code
n_cod_banco	string	Bank code
n_num_conta	string	Account number
c_descricao	string	Account description
c_cod_tipo	string	Account type code
c_des_tipo	string	Account type description
c_fluxo_caixa	string	Cash flow flag
c_resumo_executivo	string	Executive summary flag
d_periodo_inicial	datetime	Start date of the period
d_periodo_final	datetime	End date of the period
n_saldo_anterior	number	Previous balance
n_saldo_atual	number	Current balance
n_saldo_conciliado	number	Reconciled balance
n_saldo_provisorio	number	Provisional balance
n_limite_credito_total	number	Total credit limit
n_saldo_disponivel	number	Available balance
lista_movimentos[].n_cod_lancamento	integer	Transaction code
lista_movimentos[].n_cod_lanc_relac	integer	Related transaction code
lista_movimentos[].c_situacao	string	Situation
lista_movimentos[].d_data_lancamento	string	Transaction date
lista_movimentos[].c_des_cliente	string	Client description
lista_movimentos[].c_tipo_documento	string	Document type
lista_movimentos[].c_numero	string	Document number
lista_movimentos[].n_valor_documento	number	Document value
lista_movimentos[].n_saldo	number	Balance
lista_movimentos[].c_cod_categoria	string	Category code
lista_movimentos[].c_des_categoria	string	Category description
lista_movimentos[].c_documento_fiscal	string	Fiscal document
lista_movimentos[].c_parcela	string	Installment
lista_movimentos[].c_nosso_numero	string	Our number
lista_movimentos[].c_origem	string	Origin
lista_movimentos[].c_vendedor	string	Salesperson
lista_movimentos[].c_projeto	string	Project
lista_movimentos[].n_cod_cliente	integer	Client code
lista_movimentos[].c_raz_cliente	string	Client name
lista_movimentos[].c_doc_cliente	string	Client document
lista_movimentos[].c_observacoes	string	Observations
lista_movimentos[].c_data_inclusao	string	Creation date
lista_movimentos[].c_hora_inclusao	string	Creation time
lista_movimentos[].c_natureza	string	Nature (R/P)
lista_movimentos[].c_bloqueado	string	Whether blocked
lista_movimentos[].d_data_conciliacao	string	Reconciliation date

Checking Accounts Transfers

Stream containing account transfer and transaction information.

Field	Type	Description
n_cod_lanc	integer	Unique identifier
c_cod_int_lanc	string	Integration code
n_cod_agrup	integer	Group code
last_updated_at	datetime	Last update timestamp
cabecalho.d_dt_lanc	string	Transaction date
cabecalho.n_cod_cc	integer	Checking account code
cabecalho.n_valor_lanc	number	Transaction value
departamentos[].c_cod_dep	string	Department code
departamentos[].n_per_dep	number	Department percentage
departamentos[].n_val_dep	number	Department value
detalhes.a_cod_categ[]	array	Category distribution
detalhes.c_cod_categ	string	Category code
detalhes.c_num_doc	string	Document number
detalhes.c_obs	string	Observations
detalhes.c_tipo	string	Transaction type
detalhes.n_cod_cliente	integer	Client code
detalhes.n_cod_projeto	integer	Project code
diversos.c_hr_conc	string	Reconciliation time
diversos.c_ident_lanc	string	Transaction identifier
diversos.c_natureza	string	Transaction nature
diversos.c_origem	string	Origin
diversos.c_us_conc	string	Reconciliation user
diversos.d_dt_conc	string	Reconciliation date
diversos.n_cod_comprador	integer	Buyer code
diversos.n_cod_vendedor	integer	Seller code
diversos.n_cod_lanc_cr	integer	Receivable transaction code
diversos.n_cod_lanc_cp	integer	Payable transaction code
info.c_imp_api	string	API import flag
info.d_alt	string	Last modification date
info.h_alt	string	Last modification time
info.u_alt	string	Last modification user
info.d_inc	string	Creation date
info.h_inc	string	Creation time
info.u_inc	string	Creation user
transferencia.n_cod_cc_destino	integer	Destination account code

Bills (Accounts Payable)

Stream containing accounts payable and bill information.

Field	Type	Description
codigo_lancamento_omie	integer	Unique identifier
codigo_lancamento_integracao	string	Integration code
codigo_cliente_fornecedor	integer	Supplier code
codigo_cliente_fornecedor_integracao	string	Supplier integration code
data_vencimento	string	Due date
data_previsao	string	Forecast date
data_emissao	string	Issue date
data_entrada	string	Entry date
valor_documento	number	Document value
codigo_categoria	string	Category code
id_conta_corrente	integer	Checking account ID
id_conta_corrente_integracao	string	Account integration code
numero_documento_fiscal	string	Fiscal document number
numero_documento	string	Document number
numero_parcela	string	Installment number
numero_pedido	string	Order number
codigo_projeto	integer	Project code
codigo_vendedor	integer	Seller code
codigo_tipo_documento	string	Document type code
chave_nfe	string	NFe key
codigo_barras_ficha_compensacao	string	Compensation slip barcode
codigo_cmc7_cheque	string	Check CMC7 code
observacao	string	Observations
operacao	string	Operation
status_titulo	string	Title status
nsu	string	NSU
acao	string	Action
bloqueado	string	Whether blocked
baixa_bloqueada	string	Whether settlement is blocked
importado_api	string	Imported via API
bloquear_exclusao	string	Block deletion
id_origem	string	Origin ID
valor_pag	number	Payment value
aprendizado_rateio	string	Apportionment learning
data_alt	string	Last modification date
hora_alt	string	Last modification time
valor_pis	number	PIS value
retem_pis	string	PIS retention
valor_cofins	number	COFINS value
retem_cofins	string	COFINS retention
valor_csll	number	CSLL value
retem_csll	string	CSLL retention
valor_ir	number	IR value
retem_ir	string	IR retention
valor_iss	number	ISS value
retem_iss	string	ISS retention
valor_inss	number	INSS value
retem_inss	string	INSS retention
last_updated_at	datetime	Last update timestamp
categorias[]	array	Category breakdown
distribuicao[]	array	Department distribution
info.d_inc	string	Creation date
info.h_inc	string	Creation time
info.u_inc	string	Creation user
info.d_alt	string	Last modification date
info.h_alt	string	Last modification time
info.u_alt	string	Last modification user
info.c_imp_api	string	API import flag
cnab_integracao_bancaria.codigo_forma_pagamento	string	Payment method code
cnab_integracao_bancaria.banco_transferencia	string	Transfer bank
cnab_integracao_bancaria.agencia_transferencia	string	Transfer branch
cnab_integracao_bancaria.conta_corrente_transferencia	string	Transfer account
cnab_integracao_bancaria.finalidade_transferencia	string	Transfer purpose
cnab_integracao_bancaria.cpf_cnpj_transferencia	string	Transfer CPF/CNPJ
cnab_integracao_bancaria.nome_transferencia	string	Transfer name
cnab_integracao_bancaria.codigo_barras_boleto	string	Boleto barcode
cnab_integracao_bancaria.juros_boleto	number	Boleto interest
cnab_integracao_bancaria.multa_boleto	number	Boleto fine
cnab_integracao_bancaria.pix_qrcode	string	PIX QR code
servico_tomado.numero_nf	string	Invoice number
servico_tomado.serie_nf	string	Invoice series
servico_tomado.codigo_servico	string	Service code
servico_tomado.valor_nf	number	Invoice value

Bills Attachments

Child stream of Bills containing file attachments associated with accounts payable.

Field	Type	Description
n_id_anexo	integer	Unique identifier
c_cod_int_anexo	string	Integration code
c_tipo_arquivo	string	File type
n_id	string	Parent bill ID
c_nome_arquivo	string	File name
c_tabela	string	Source table reference
last_updated_at	datetime	Last update timestamp
info.d_inc	string	Creation date
info.h_inc	string	Creation time
info.u_inc	string	Creation user
info.d_alt	string	Last modification date
info.h_alt	string	Last modification time
info.u_alt	string	Last modification user
info.c_imp_api	string	API import flag

Receivables (Accounts Receivable)

Stream containing accounts receivable information.

Field	Type	Description
codigo_lancamento_omie	integer	Unique identifier
codigo_lancamento_integracao	string	Integration code
codigo_cliente_fornecedor	integer	Client code
codigo_cliente_fornecedor_integracao	string	Client integration code
data_vencimento	string	Due date
valor_documento	number	Document value
codigo_categoria	string	Category code
data_previsao	string	Forecast date
data_emissao	string	Issue date
data_registro	string	Registration date
id_conta_corrente	integer	Checking account ID
numero_documento	string	Document number
numero_parcela	string	Installment number
codigo_tipo_documento	string	Document type code
numero_documento_fiscal	string	Fiscal document number
numero_pedido	string	Order number
chave_nfe	string	NFe key
codigo_barras_ficha_compensacao	string	Compensation slip barcode
codigo_cmc7_cheque	string	Check CMC7 code
observacao	string	Observations
id_origem	string	Origin ID
operacao	string	Operation
codigo_vendedor	integer	Seller code
codigo_projeto	integer	Project code
codigo_pedido	integer	Order code
codigo_os	integer	Service order code
pedido_cliente	string	Client order
numero_contrato	string	Contract number
nsu	string	NSU
status_titulo	string	Title status
tipo_agrupamento	string	Grouping type
bloqueado	string	Whether blocked
bloquear_baixa	string	Block settlement
importado_api	string	Imported via API
baixar_documento	string	Settle document
conciliar_documento	string	Reconcile document
bloquear_exclusao	string	Block deletion
acao	string	Action
aprendizado_rateio	string	Apportionment learning
last_updated_at	datetime	Last update timestamp
valor_pis	number	PIS value
retem_pis	string	PIS retention
valor_cofins	number	COFINS value
retem_cofins	string	COFINS retention
valor_csll	number	CSLL value
retem_csll	string	CSLL retention
valor_ir	number	IR value
retem_ir	string	IR retention
valor_iss	number	ISS value
retem_iss	string	ISS retention
valor_inss	number	INSS value
retem_inss	string	INSS retention
categorias[]	array	Category breakdown
lancamento_detalhe[]	array	Transaction details
distribuicao[]	array	Department distribution
info	object	Creation and modification metadata
boleto	object	Bank slip information
recebimento	object	Payment information
repeticao	object	Recurrence settings

Titles

Stream containing financial titles with detailed payment information.

Field	Type	Description
_id	integer	Unique identifier (n_cod_titulo)
last_updated_at	datetime	Last update timestamp
cabec_titulo.n_cod_titulo	integer	Title code
cabec_titulo.c_cod_int_titulo	string	Integration title code
cabec_titulo.c_num_titulo	string	Title number
cabec_titulo.d_dt_emissao	string	Issue date
cabec_titulo.d_dt_venc	string	Due date
cabec_titulo.d_dt_previsao	string	Forecast date
cabec_titulo.d_dt_pagamento	string	Payment date
cabec_titulo.d_dt_canc	string	Cancellation date
cabec_titulo.n_cod_cliente	integer	Client code
cabec_titulo.c_cpfcnpj_cliente	string	Client tax ID
cabec_titulo.n_cod_ctr	integer	Contract code
cabec_titulo.c_num_ctr	string	Contract number
cabec_titulo.n_cod_os	integer	Service order code
cabec_titulo.c_num_os	string	Service order number
cabec_titulo.n_cod_cc	integer	Checking account code
cabec_titulo.c_cod_int_cc	string	Integration account code
cabec_titulo.n_cod_banco	integer	Bank code
cabec_titulo.c_cod_agencia	string	Branch code
cabec_titulo.c_num_conta	string	Account number
cabec_titulo.c_num_titulo_banco	string	Bank title number
cabec_titulo.c_num_boleto	string	Bank slip number
cabec_titulo.n_cod_nf	integer	Invoice code
cabec_titulo.n_valor_titulo	number	Title value
cabec_titulo.n_saldo	number	Balance
cabec_titulo.n_percentual	number	Percentage
cabec_titulo.n_valor_fixo	string	Fixed value flag
cabec_titulo.n_cod_projeto	integer	Project code
cabec_titulo.n_cod_vendedor	integer	Seller code
cabec_titulo.n_cod_comprador	integer	Buyer code
cabec_titulo.c_cod_categ	string	Category code
cabec_titulo.c_tipo	string	Type
cabec_titulo.c_status	string	Status
cabec_titulo.c_natureza	string	Nature (R=Receivable, P=Payable)
cabec_titulo.c_operacao	string	Operation
cabec_titulo.c_num_doc_fiscal	string	Fiscal document number
cabec_titulo.c_codigo_barras	string	Barcode
cabec_titulo.c_chave_nfe	string	NFe key
cabec_titulo.c_obs	string	Observations
cabec_titulo.c_cod_venc	string	Due code
cabec_titulo.n_parcela	integer	Installment number
cabec_titulo.n_tot_parc	integer	Total installments
cabec_titulo.c_origem	string	Origin
cabec_titulo.c_ret_cofins	string	COFINS retention
cabec_titulo.c_ret_csll	string	CSLL retention
cabec_titulo.c_ret_inss	string	INSS retention
cabec_titulo.c_ret_ir	string	IR retention
cabec_titulo.c_ret_iss	string	ISS retention
cabec_titulo.c_ret_pis	string	PIS retention
cabec_titulo.n_valor_cofins	number	COFINS value
cabec_titulo.n_valor_csll	number	CSLL value
cabec_titulo.n_valor_inss	number	INSS value
cabec_titulo.n_valor_ir	number	IR value
cabec_titulo.n_valor_iss	number	ISS value
cabec_titulo.n_valor_pis	number	PIS value
lancamentos[]	array	Payment entries
resumo.c_liquidado	string	Whether settled
resumo.n_val_pago	number	Paid amount
resumo.n_val_aberto	number	Open amount
resumo.n_desconto	number	Discount
resumo.n_juros	number	Interest
resumo.n_multa	number	Fine
resumo.n_val_liquido	number	Net value
departamentos[]	array	Department distribution
categorias[]	array	Category distribution

Finances

Stream containing comprehensive financial movement data.

Field	Type	Description
detalhes_n_cod_titulo	integer	Financial title ID
detalhes_c_grupo	string	Financial group
detalhes_c_cpfcnpj_cliente	string	Client tax ID
detalhes_c_cod_categ	string	Category code
detalhes_c_natureza	string	Nature (R=Receivable, P=Payable)
detalhes_c_operacao	string	Operation type
detalhes_c_status	string	Status
detalhes_c_tipo	string	Transaction type
detalhes_c_origem	string	Origin
detalhes_n_valor_titulo	number	Value
detalhes_d_dt_venc	string	Due date
detalhes_d_dt_emissao	string	Issue date
detalhes_d_dt_previsao	string	Forecast date
detalhes_d_dt_pagamento	string	Payment date
detalhes_d_dt_registro	string	Registration date
detalhes_d_dt_credito	string	Credit date
detalhes_n_cod_cc	integer	Checking account code
detalhes_n_cod_cliente	integer	Client code
detalhes_n_cod_titulo	integer	Title code
detalhes_c_num_titulo	string	Title number
detalhes_c_num_boleto	string	Bank slip number
detalhes_c_num_doc_fiscal	string	Fiscal document number
detalhes_c_codigo_barras	string	Barcode
detalhes_c_num_parcela	string	Installment number
detalhes_c_num_ctr	string	Contract number
detalhes_n_cod_ctr	integer	Contract code
detalhes_c_num_os	string	Service order number
detalhes_n_cod_os	integer	Service order code
detalhes_n_cod_nf	integer	Invoice code
detalhes_c_cod_projeto	integer	Project code
detalhes_observacao	string	Observations
detalhes_c_ret_ir	string	IR retention
detalhes_c_ret_iss	string	ISS retention
detalhes_c_ret_inss	string	INSS retention
detalhes_c_ret_pis	string	PIS retention
detalhes_c_ret_cofins	string	COFINS retention
detalhes_c_ret_csll	string	CSLL retention
detalhes_n_valor_ir	number	IR value
detalhes_n_valor_iss	number	ISS value
detalhes_n_valor_inss	number	INSS value
detalhes_n_valor_pis	number	PIS value
detalhes_n_valor_cofins	number	COFINS value
detalhes_n_valor_csll	number	CSLL value
detalhes_n_desconto	number	Discount
detalhes_n_multa	number	Fine
detalhes_n_juros	number	Interest
detalhes_n_valor_mov_cc	number	Account movement value
resumo_c_liquidado	string	Whether settled
resumo_n_val_aberto	number	Open amount
resumo_n_val_liquido	number	Net amount
resumo_n_val_pago	number	Paid amount
resumo_n_desconto	number	Total discount
resumo_n_juros	number	Total interest
resumo_n_multa	number	Total fine
departamentos[]	array	Department distribution
categorias[]	array	Category distribution
last_updated_at	datetime	Last update timestamp

Finances Summary

Stream containing financial summary by day.

Field	Type	Description
d_dia	datetime	Date
conta_corrente.c_cor	string	Color
conta_corrente.c_icone	string	Icon
conta_corrente.v_limite_credito	number	Credit limit
conta_corrente.v_total	number	Total value
conta_pagar.c_cor	string	Color
conta_pagar.c_icone	string	Icon
conta_pagar.n_total	number	Total count
conta_pagar.v_atraso	number	Overdue amount
conta_pagar.v_total	number	Total amount
conta_receber.c_cor	string	Color
conta_receber.c_icone	string	Icon
conta_receber.n_total	number	Total count
conta_receber.v_atraso	number	Overdue amount
conta_receber.v_total	number	Total amount
conta_pagar_categoria[]	array	Payable by category
conta_receber_categoria[]	array	Receivable by category
conta_pagar_atraso[]	array	Overdue payables
conta_receber_atraso[]	array	Overdue receivables
fluxo_caixa[].d_dia	string	Date
fluxo_caixa[].v_pagar	number	Amount to pay
fluxo_caixa[].v_receber	number	Amount to receive
fluxo_caixa[].v_saldo	number	Balance

Quotes

Stream containing quote and budget information by month.

Field	Type	Description
n_ano	integer	Year
n_mes	integer	Month
n_mes_ano	datetime	Month-year date
lista_orcamentos[].c_cod_categ	string	Category code
lista_orcamentos[].c_des_categ	string	Category description
lista_orcamentos[].n_valor_previsto	number	Forecasted value
lista_orcamentos[].n_valor_realizado	number	Realized value

PIX

Stream containing PIX payment information.

Field	Type	Description
_id	integer	Unique identifier
n_id_pix	integer	PIX ID
c_cod_int_pix	string	Integration code
c_cliente	integer	Client code
n_cod_titulo	integer	Title code
v_valor	number	Value
d_emissao	string	Issue date
d_vencimento	string	Due date
c_url_pix	string	PIX URL
c_copia_cola	string	PIX copy-paste code
c_status	string	Status
last_updated_at	datetime	Last update timestamp
c_info.d_inc	string	Creation date
c_info.h_inc	string	Creation time
c_info.u_inc	string	Creation user
c_info.d_alt	string	Modification date
c_info.h_alt	string	Modification time
c_info.u_alt	string	Modification user

Tasks

Stream containing tasks (Tarefas).

Field	Type	Description
_id	integer	Unique identifier
n_cod_tarefa	integer	Task code
c_cod_int_tarefa	string	Integration code
c_origem	string	Task origin
n_cod_doc	integer	Document code
c_desc_doc	string	Document description
c_descricao	string	Task description
d_data	string	Task date
h_hora	string	Task time
c_importante	string	Whether important
c_urgente	string	Whether urgent
n_cod_situacao	integer	Situation code
c_situacao	string	Situation description
n_cod_tipo_tarefa	integer	Task type code
c_desc_tipo_tarefa	string	Task type description
n_cod_notif	integer	Notification code
c_desc_notif	string	Notification description
n_cod_user_atb	integer	Assigned user code
c_nome_user_atb	string	Assigned user name
c_desc_origem	string	Origin description
last_updated_at	datetime	Last update timestamp

Orders and Services

Orders (Sales Orders)

Stream containing sales orders (Pedidos de Venda).

Field	Type	Description
_id	integer	Unique identifier (codigo_pedido)
last_updated_at	datetime	Last update timestamp
cabecalho	object	Order header
cabecalho.codigo_pedido	integer	Order code
cabecalho.codigo_pedido_integracao	string	Integration order code
cabecalho.codigo_cliente	integer	Client code
cabecalho.numero_pedido	string	Order number
cabecalho.data_previsao	string	Delivery forecast date
cabecalho.etapa	string	Order stage
cabecalho.quantidade_itens	integer	Number of items
cabecalho.codigo_parcela	string	Installment code
cabecalho.codigo_cenario_impostos	string	Tax scenario code
cabecalho.codigo_empresa	integer	Company code
cabecalho.sequencial	string	Sequential number
cabecalho.bloqueado	string	Whether blocked
cabecalho.importado_api	string	Imported via API
cabecalho.origem_pedido	string	Order origin
cabecalho.qtde_parcelas	integer	Number of installments
cabecalho.encerrado	string	Whether closed
cabecalho.enc_data	string	Closing date
cabecalho.enc_hora	string	Closing time
cabecalho.enc_motivo	string	Closing reason
cabecalho.enc_user	string	Closing user
det[]	array	Order item details
det[].ide.codigo_item	integer	Item code
det[].ide.codigo_item_integracao	string	Integration item code
det[].ide.simples_nacional	string	Simples Nacional flag
det[].produto.codigo_produto	integer	Product code
det[].produto.codigo	string	Product reference code
det[].produto.descricao	string	Product description
det[].produto.cfop	string	CFOP code
det[].produto.ncm	string	NCM code
det[].produto.ean	string	EAN barcode
det[].produto.unidade	string	Unit of measure
det[].produto.quantidade	number	Quantity
det[].produto.valor_unitario	number	Unit price
det[].produto.valor_mercadoria	number	Merchandise value
det[].produto.percentual_desconto	number	Discount percentage
det[].produto.valor_desconto	number	Discount value
det[].produto.valor_total	number	Total value
det[].imposto	object	Tax information
det[].inf_adic	object	Additional information
det[].rastreabilidade[]	array	Traceability data
det[].lote_validade[]	array	Batch validity data
frete	object	Shipping information
frete.codigo_transportadora	integer	Carrier code
frete.modalidade	string	Shipping modality
frete.placa	string	Vehicle plate
frete.placa_estado	string	Plate state
frete.quantidade_volumes	integer	Number of volumes
frete.peso_liquido	number	Net weight
frete.peso_bruto	number	Gross weight
frete.valor_frete	number	Freight value
frete.valor_seguro	number	Insurance value
frete.outras_despesas	number	Other expenses
frete.previsao_entrega	string	Delivery forecast
frete.codigo_rastreio	string	Tracking code
informacoes_adicionais	object	Additional information
informacoes_adicionais.codigo_categoria	string	Category code
informacoes_adicionais.codigo_conta_corrente	integer	Account code
informacoes_adicionais.numero_pedido_cliente	string	Client order number
informacoes_adicionais.numero_contrato	string	Contract number
informacoes_adicionais.contato	string	Contact
informacoes_adicionais.cod_vend	integer	Seller code
informacoes_adicionais.cod_proj	integer	Project code
informacoes_adicionais.nsu	string	NSU
lista_parcelas.parcela[]	array	Installment list
lista_parcelas.parcela[].numero_parcela	integer	Installment number
lista_parcelas.parcela[].valor	number	Installment value
lista_parcelas.parcela[].percentual	number	Installment percentage
lista_parcelas.parcela[].data_vencimento	string	Due date
lista_parcelas.parcela[].meio_pagamento	string	Payment method
total_pedido	object	Order totals
total_pedido.valor_mercadorias	number	Merchandise total
total_pedido.valor_total_pedido	number	Order total
total_pedido.valor_descontos	number	Total discounts
total_pedido.valor_icms	number	ICMS total
total_pedido.valor_pis	number	PIS total
total_pedido.valor_cofins	number	COFINS total
departamentos[]	array	Department distribution
info_cadastro	object	Registration info
info_cadastro.d_inc	string	Creation date
info_cadastro.h_inc	string	Creation time
info_cadastro.u_inc	string	Creation user
info_cadastro.d_alt	string	Modification date
info_cadastro.h_alt	string	Modification time
info_cadastro.u_alt	string	Modification user
info_cadastro.cancelado	string	Whether cancelled
info_cadastro.faturado	string	Whether invoiced
info_cadastro.devolvido	string	Whether returned

Purchase Orders

Stream containing purchase orders (Pedidos de Compra).

Field	Type	Description
_id	integer	Unique identifier (n_cod_ped)
last_updated_at	datetime	Last update timestamp
cabecalho_consulta	object	Order header
cabecalho_consulta.n_cod_ped	integer	Order code
cabecalho_consulta.c_cod_int_ped	string	Integration code
cabecalho_consulta.c_numero	string	Order number
cabecalho_consulta.d_dt_previsao	string	Forecast date
cabecalho_consulta.d_inc_data	string	Creation date
cabecalho_consulta.c_inc_hora	string	Creation time
cabecalho_consulta.c_cod_parc	string	Installment code
cabecalho_consulta.n_qtde_parc	integer	Number of installments
cabecalho_consulta.n_cod_for	integer	Supplier code
cabecalho_consulta.c_cod_int_for	string	Supplier integration code
cabecalho_consulta.c_cod_categ	string	Category code
cabecalho_consulta.n_cod_compr	integer	Buyer code
cabecalho_consulta.c_contato	string	Contact
cabecalho_consulta.c_contrato	string	Contract
cabecalho_consulta.n_cod_cc	integer	Account code
cabecalho_consulta.n_cod_int_cc	string	Integration account code
cabecalho_consulta.n_cod_proj	integer	Project code
cabecalho_consulta.c_obs	string	Observations
cabecalho_consulta.c_obs_int	string	Internal observations
cabecalho_consulta.c_etapa	string	Stage
cabecalho_consulta.c_num_pedido	string	Client order number
frete_consulta	object	Shipping info
frete_consulta.n_cod_transp	integer	Carrier code
frete_consulta.c_tp_frete	string	Freight type
frete_consulta.c_placa	string	Vehicle plate
frete_consulta.c_uf	string	State
frete_consulta.n_qtd_vol	integer	Number of volumes
frete_consulta.c_esp_vol	string	Volume species
frete_consulta.n_peso_liq	number	Net weight
frete_consulta.n_peso_bruto	number	Gross weight
frete_consulta.n_val_frete	number	Freight value
frete_consulta.n_val_seguro	number	Insurance value
frete_consulta.n_val_outras	number	Other values
departamentos_consulta[]	array	Departments
departamentos_consulta[].c_cod_depto	string	Department code
departamentos_consulta[].n_perc	number	Percentage
produtos_consulta[]	array	Products
produtos_consulta[].n_cod_item	integer	Item code
produtos_consulta[].n_cod_prod	integer	Product code
produtos_consulta[].c_produto	string	Product reference
produtos_consulta[].c_descricao	string	Description
produtos_consulta[].c_ncm	string	NCM code
produtos_consulta[].c_unidade	string	Unit
produtos_consulta[].n_qtde	number	Quantity
produtos_consulta[].n_qtde_rec	number	Received quantity
produtos_consulta[].n_val_unit	number	Unit value
produtos_consulta[].n_val_tot	number	Total value
parcelas_consulta[]	array	Installments
parcelas_consulta[].n_parcela	integer	Installment number
parcelas_consulta[].d_vencto	string	Due date
parcelas_consulta[].n_dias	integer	Days
parcelas_consulta[].n_percent	number	Percentage
parcelas_consulta[].n_valor	number	Value
parcelas_consulta[].c_tipo_doc	string	Document type

Order Services

Stream containing service orders.

Field	Type	Description
_id	integer	Unique identifier (n_cod_os)
last_updated_at	datetime	Last update timestamp
cabecalho	object	Header
cabecalho.n_cod_os	integer	Service order code
cabecalho.c_cod_int_os	string	Integration code
cabecalho.c_num_os	string	Service order number
cabecalho.c_cod_parc	string	Installment code
cabecalho.c_etapa	string	Stage
cabecalho.d_dt_previsao	string	Forecast date
cabecalho.n_cod_cli	integer	Client code
cabecalho.n_qtde_parc	integer	Number of installments
cabecalho.c_obs	string	Observations
cabecalho.c_num_pedido	string	Order number
cabecalho.c_cancelada	string	Whether cancelled
cabecalho.c_faturada	string	Whether invoiced
cabecalho.c_ambiente	string	Environment
cabecalho.n_valor_tot	number	Total value
cabecalho.n_valor_total	number	Grand total
cabecalho.n_valor_total_imp_ret	number	Total withheld taxes
cabecalho.c_url_pdf_recibo	string	Receipt PDF URL
departamentos[]	array	Departments
departamentos[].n_cod_dep	integer	Department code
departamentos[].c_nome_dep	string	Department name
departamentos[].c_cod_depto	string	Department code reference
departamentos[].n_perc	number	Percentage
departamentos[].n_valor	number	Value
email	object	Email settings
informacoes_adicionais	object	Additional info
informacoes_adicionais.c_cod_categ	string	Category code
informacoes_adicionais.n_cod_cc	integer	Account code
informacoes_adicionais.c_contato	string	Contact
servicos_prestados[]	array	Provided services
servicos_prestados[].n_cod_servico	integer	Service code
servicos_prestados[].c_desc_serv	string	Service description
servicos_prestados[].c_cod_serv_lc116	string	LC 116 service code
servicos_prestados[].c_cod_serv_mun	string	Municipal service code
servicos_prestados[].n_qtde	number	Quantity
servicos_prestados[].n_val_unit	number	Unit value
servicos_prestados[].impostos	object	Tax information
produtos_utilizados	object	Products used
via_unica	object	Single invoice settings
lista_rps_nfse[]	array	RPS and NFSe list
lista_rps_nfse[].n_num_rps	integer	RPS number
lista_rps_nfse[].d_emissao_rps	string	RPS issue date
lista_rps_nfse[].c_status_rps	string	RPS status
lista_rps_nfse[].c_link_nf_se	string	NFSE link
info_cadastro	object	Registration info
observacoes	object	Observations
parcelas[]	array	Installments
parcelas[].n_parcela	integer	Installment number
parcelas[].d_dt_venc	string	Due date
parcelas[].n_valor	number	Value
parcelas[].n_percentual	number	Percentage

Services

Stream containing service catalog.

Field	Type	Description
_id	integer	Service system ID
last_updated_at	datetime	Last update timestamp
int_listar	object	Internal listing
int_listar.c_cod_int_serv	string	Integration service code
int_listar.n_cod_serv	integer	Service code
cabecalho	object	Header
cabecalho.c_descricao	string	Service description
cabecalho.c_codigo	string	Service code reference
cabecalho.c_id_trib	string	Tax ID
cabecalho.c_cod_serv_mun	string	Municipal service code
cabecalho.c_cod_lc116	string	LC 116 code
cabecalho.n_id_nbs	string	NBS ID
cabecalho.n_preco_unit	number	Unit price
cabecalho.c_cod_categ	string	Category code
cabecalho.c_tipo_desc	string	Discount type
cabecalho.n_valor_desc	number	Discount value
cabecalho.n_aliq_desc	number	Discount rate
descricao	object	Description
descricao.c_descr_completa	string	Full description
impostos	object	Taxes
impostos.n_aliq_iss	number	ISS rate
impostos.c_ret_iss	string	ISS retention
impostos.n_aliq_pis	number	PIS rate
impostos.c_ret_pis	string	PIS retention
impostos.n_aliq_cofins	number	COFINS rate
impostos.c_ret_cofins	string	COFINS retention
impostos.n_aliq_csll	number	CSLL rate
impostos.c_ret_csll	string	CSLL retention
impostos.n_aliq_ir	number	IR rate
impostos.c_ret_ir	string	IR retention
impostos.n_aliq_inss	number	INSS rate
impostos.c_ret_inss	string	INSS retention
impostos.l_deduz_iss	boolean	ISS deduction flag
info	object	Registration info
info.c_imp_api	string	API import flag
info.d_alt	string	Modification date
info.h_alt	string	Modification time
info.u_alt	string	Modification user
info.d_inc	string	Creation date
info.h_inc	string	Creation time
info.u_inc	string	Creation user
info.c_cod_status	string	Status code
info.c_desc_status	string	Status description
info.inativo	string	Whether inactive
produtos_utilizados[]	array	Products used
produtos_utilizados[].c_cod_prod	string	Product code
produtos_utilizados[].n_qtde	number	Quantity
produtos_utilizados[].n_valor_unit	number	Unit value
produtos_utilizados[].n_valor_total	number	Total value
produtos_utilizados[].c_descricao	string	Description
via_unica	object	Single invoice settings

Invoices (NFe/NFSe)

NFE (Electronic Product Invoices)

Stream containing electronic invoices for products.

Field	Type	Description
_id	string	Unique identifier
last_updated_at	datetime	Last update timestamp
ide	object	Invoice identification
ide.mod	string	Model
ide.serie	string	Series
ide.nNF / ide.n_nf	string	Invoice number
ide.dEmi / ide.d_emi	string	Issue date
ide.hEmi / ide.h_emi	string	Issue time
ide.dSaiEnt / ide.d_sai_ent	string	Exit/entry date
ide.tpNF / ide.tp_nf	string	Invoice type
ide.tpAmb / ide.tp_amb	string	Environment
ide.finNFe / ide.fin_n_fe	string	Invoice purpose
ide.dReg / ide.d_reg	string	Registration date
ide.dCan / ide.d_can	string	Cancellation date
ide.cDeneg / ide.c_deneg	string	Denial code
compl	object	Complementary info
compl.nIdNF / compl.n_id_nf	integer	Invoice ID
compl.nIdPedido / compl.n_id_pedido	integer	Order ID
compl.cCodCateg / compl.c_cod_categ	string	Category code
compl.cChaveNFe / compl.c_chave_n_fe	string	NFe key
compl.nIdReceb / compl.n_id_receb	integer	Receivable ID
compl.nIdTransp / compl.n_id_transp	integer	Carrier ID
compl.cModFrete / compl.c_mod_frete	string	Freight modality
total	object	Invoice totals
total.ICMSTot.vBC	number	ICMS base
total.ICMSTot.vICMS	number	ICMS value
total.ICMSTot.vBCST	number	ST base
total.ICMSTot.vST	number	ST value
total.ICMSTot.vProd	number	Product value
total.ICMSTot.vFrete	number	Freight value
total.ICMSTot.vSeg	number	Insurance value
total.ICMSTot.vDesc	number	Discount value
total.ICMSTot.vIPI	number	IPI value
total.ICMSTot.vPIS	number	PIS value
total.ICMSTot.vCOFINS	number	COFINS value
total.ICMSTot.vNF	number	Invoice value
total.ICMSTot.vTotTrib	number	Total taxes
total.ISSQNtot	object	ISSQN totals
total.retTrib	object	Retained taxes
det[]	array	Invoice items
det[].prod.cProd	string	Product code
det[].prod.xProd	string	Product description
det[].prod.NCM	string	NCM code
det[].prod.CFOP	string	CFOP code
det[].prod.uCom	string	Commercial unit
det[].prod.qCom	number	Commercial quantity
det[].prod.vUnCom	number	Commercial unit price
det[].prod.vProd	number	Product value
det[].imposto	object	Item taxes
det[].rastreabilidade	object	Traceability
det[].nf_prod_int	object	Internal product reference
titulos[]	array	Financial titles
titulos[].nCodTitulo	integer	Title code
titulos[].cNumTitulo	string	Title number
titulos[].dDtEmissao	string	Issue date
titulos[].dDtVenc	string	Due date
titulos[].nValorTitulo	number	Title value
departamentos[]	array	Departments
categorias[]	array	Categories
info	object	Registration info
nf_emit_int	object	Issuer info
nf_dest_int	object	Recipient info
pedido	object	Order info

NFSE (Electronic Service Invoices)

Stream containing electronic service invoices.

Field	Type	Description
_id	integer	Unique identifier
last_updated_at	datetime	Last update timestamp
cabecalho	object	Header
cabecalho.n_numero_nf_se	string	NFSE number
cabecalho.c_serie_nf_se	string	NFSE series
cabecalho.n_valor_nf_se	number	NFSE value
cabecalho.c_status_nf_se	string	NFSE status
cabecalho.c_codigo_verif_nf_se	string	Verification code
cabecalho.n_cod_nf	integer	Invoice code
cabecalho.n_chave_nfe	string	NFe key
cabecalho.c_ambiente_nf_se	string	Environment
cabecalho.c_cidade_emissor	string	Issuer city
cabecalho.c_cnpj_emissor	string	Issuer CNPJ
cabecalho.c_im_emissor	string	Issuer municipal registration
cabecalho.c_cod_mun_emissor	string	Issuer municipality code
cabecalho.c_cnpj_destinatario	string	Recipient CNPJ
cabecalho.c_cpf_destinatario	string	Recipient CPF
cabecalho.c_razao_destinatario	string	Recipient name
cabecalho.n_codigo_cliente	integer	Client code
ordem_servico	object	Service order info
ordem_servico.n_codigo_os	integer	Service order code
ordem_servico.n_numero_os	string	Service order number
ordem_servico.n_valor_os	number	Service order value
ordem_servico.departamentos[]	array	Departments
ordem_servico.categorias[]	array	Categories
RPS	object	RPS info
RPS.n_numero_lote	integer	Batch number
RPS.n_status_lote	string	Batch status
RPS.n_numero_rps	string	RPS number
RPS.c_status_rps	string	RPS status
RPS.c_serie_rps	string	RPS series
RPS.c_protocolo_rps	string	RPS protocol
RPS.c_data_rps	string	RPS date
adicionais	object	Additional info
adicionais.c_codigo_categoria	string	Category code
adicionais.n_codigo_cc	integer	Account code
adicionais.n_codigo_projeto	integer	Project code
adicionais.n_codigo_vendedor	integer	Seller code
servicos	object	Services
servicos.cidade_prestacao	string	Service city
servicos.codigo_lc116	string	LC 116 code
servicos.codigo_servico	string	Service code
servicos.n_quantidade	number	Quantity
servicos.n_valor_unitario	number	Unit value
servicos.n_valor_servico	number	Service value
servicos.n_valor_total	number	Total value
servicos.n_aliquota_iss	number	ISS rate
servicos.n_valor_iss	number	ISS value
servicos.c_ret_iss	string	ISS retention
servicos.c_descricao	string	Description
valores	object	Values summary
valores.n_valor_total_servicos	number	Total services
valores.n_valor_base_calculo	number	Base calculation
valores.n_valor_deducao	number	Deduction
valores.n_valor_liquido	number	Net value
ibpt	object	IBPT info
ibpt.codigo_nbs	string	NBS code
ibpt.n_valor_estadual_ibpt	number	State tax value
ibpt.n_valor_federal_ibpt	number	Federal tax value
ibpt.n_valor_municipal_ibpt	number	Municipal tax value
inclusao	object	Creation info
alteracao	object	Modification info
emissao	object	Issue info
cancelamento	object	Cancellation info
lista_servicos[]	array	Service list

Documents

OS Documents

Stream containing service order document links.

Field	Type	Description
c_num_os	string	Service order number
c_pdf_os	string	PDF URL
c_link_portal	string	Portal link
c_cod_status	string	Status code
c_des_status	string	Status description
os_last_updated_at	datetime	Last update timestamp

NFSE Documents

Child stream containing NFSe document details.

Field	Type	Description
c_num_os	string	Service order number
c_num_nf_se	string	NFSE number
c_serie_nf_se	string	NFSE series
c_link_portal	string	Portal link
c_cod_verif	string	Verification code
c_url_nf_se	string	NFSE URL
c_pdf_nf_se	string	NFSE PDF URL
c_xml_nf_se	string	NFSE XML URL
c_cod_status	string	Status code
c_des_status	string	Status description
nfse_last_updated_at	datetime	Last update timestamp

Receipt Documents

Child stream containing receipt documents (Recibos).

Field	Type	Description
n_id_rec	integer	Receipt ID
c_num_os	string	Service order number
c_num_recibo	string	Receipt number
c_pdf_recibo	string	Receipt PDF URL
c_link_portal	string	Portal link
c_cod_status	string	Status code
c_des_status	string	Status description

RPS Documents

Child stream containing RPS documents.

Field	Type	Description
n_id_nf	integer	Invoice ID
c_num_os	string	Service order number
c_num_rps	string	RPS number
c_serie_rps	string	RPS series
c_pdf_rps	string	RPS PDF URL
c_link_portal	string	Portal link
c_cod_status	string	Status code
c_des_status	string	Status description

Introduction

Get started

Using Nekt

Workspace and access

MCP

SDK

Omie as a data source

Configuring Omie as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

Streams and Fields

Stream to Endpoint Mapping

Available Streams and Fields

Reference Tables

Users and Personnel

Clients and Companies

Financial Management

Tasks

Orders and Services

Invoices (NFe/NFSe)

Documents

Introduction

Get started

Using Nekt

Workspace and access

MCP

SDK

​Configuring Omie as a Source

​1. Add account access

​2. Select streams

​3. Configure data streams

​4. Configure data source

​5. Check your new source

​Streams and Fields

​Stream to Endpoint Mapping

​Available Streams and Fields

​Reference Tables

​Users and Personnel

​Clients and Companies

​Financial Management

​Tasks

​Orders and Services

​Invoices (NFe/NFSe)

​Documents

Configuring Omie as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

Streams and Fields

Stream to Endpoint Mapping

Available Streams and Fields

Reference Tables

Users and Personnel

Clients and Companies

Financial Management

Tasks

Orders and Services

Invoices (NFe/NFSe)

Documents