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_summary	ListarResumoContasCorrentes	Full Table
checking_accounts_transfers	ListarLancCC	Incremental
clients	ListarClientes	Incremental
cnae	ListarCNAE	Full Table
companies	ListarEmpresas	Full Table
countries	ListarPaises	Full Table
deleted_titles	PesquisarExcluidos	Incremental
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
products_summary	ListarProdutosResumido	Full Table
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
supplier_products	ListarProdutoFornecedor	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 Summary

Stream containing a summary list of checking accounts (ListarResumoContasCorrentes).

Field	Type	Description
_id	string	Unique identifier (from n_cod_cc)
n_cod_cc	integer	Checking account code
c_cod_cc_int	string	Integration code
descricao	string	Account description
codigo_banco	string	Bank code
codigo_agencia	string	Branch code
conta_corrente	string	Account number
nome_gerente	string	Manager name
tipo	string	Account type
tipo_comunicacao	string	Communication type
c_sincr_analitica	string	Analytical sync flag
n_tp_tef	integer	TEF type
n_taxa_adm	number	Admin fee
n_dias_venc	integer	Days to due
n_num_parc	integer	Number of installments
n_cod_adm	integer	Admin code
c_util_pdv	string	PDV usage flag
c_categoria	string	Category
c_modalidade	string	Modality
saldo_inicial	number	Initial balance
saldo_data	string	Balance date
valor_limite	number	Credit limit
c_tipo_cartao	string	Card type

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

Deleted Titles

Stream containing deleted financial titles (PesquisarExcluidos).

Field	Type	Description
deleted_at	datetime	Timestamp when the title was deleted.
n_cod_titulo	integer	Internal code of the deleted title.
d_data_exc	string	Deletion date (DD/MM/YYYY).
c_hora_exc	string	Deletion time (HH:mm:ss).
c_usuario_exc	string	User who deleted the title.
c_acao	string	Action type (e.g. ‘E’ for excluded).

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

Products and suppliers

Products Summary

Stream containing a summary list of registered products (ListarProdutosResumido).

Field	Type	Description
_id	string	Unique identifier (from codigo_produto)
codigo_produto	integer	Product code
codigo_produto_integracao	string	Integration code
codigo	string	Product reference code
descricao	string	Product description
valor_unitario	number	Unit price

Supplier Products

Stream containing products per supplier (ListarProdutoFornecedor — produtos por fornecedor).

Field	Type	Description
_id	string	Unique identifier (from n_cod_forn)
n_cod_forn	integer	Supplier code
c_cod_int_forn	string	Supplier integration code
c_cpf_cnpj	string	Supplier tax ID (CPF/CNPJ)
c_razao_social	string	Supplier legal name
c_nome_fantasia	string	Supplier trade name
produtos	array	List of products (n_cod_prod, c_cod_int_prod, c_codigo, c_descricao)

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 code

​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

​Products and suppliers

​Orders and Services

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

Products and suppliers

Orders and Services