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 - which is good if, for example, you want to keep every record ever fetched.
    • Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
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. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can determine when to execute a full sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while. 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. Once executed, your data will appear in your Catalog.
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

StreamOmie Endpoint
clientsListarClientes
projectsListarProjetos
companiesListarEmpresas
departmentsListarDepartamentos
categoriesListarCategorias
checking_accountsListarContasCorrentes
checking_accounts_balanceListarExtrato
checking_accounts_transfersListarLancCC
banksListarBancos
financesListarMovimentos
quotesListarOrcamentos
finances_summaryObterResumoFinancas
billsListarContasPagar
receivablesListarContasReceber
nfseListarNFSEs

​
Available Streams and Fields

Stream containing customer and client information from your Omie account.Key Fields:
  • codigo_cliente_omie - Unique identifier for the client in Omie
  • codigo_cliente_integracao - Integration identifier for the client
  • razao_social - Company name
  • nome_fantasia - Trade name
  • cnpj_cpf - Tax identification number
  • email - Client email address
  • telefone1_ddd, telefone1_numero - Primary phone number
  • telefone2_ddd, telefone2_numero - Secondary phone number
  • endereco, endereco_numero, complemento - Address information
  • bairro - Neighborhood
  • cidade, estado, cep - Location details
  • codigo_pais - Country code
  • pessoa_fisica - Whether it’s an individual person
  • inativo - Whether the client is inactive
  • exterior - Whether it’s a foreign client
  • bloquear_faturamento - Whether billing is blocked
  • inscricao_estadual - State registration number
  • inscricao_municipal - Municipal registration number
  • cnae - Economic activity classification code
  • last_updated_at - When the record was last updated
Nested Objects:
  • dados_bancarios - Banking information including:
    • agencia - Bank branch
    • codigo_banco - Bank code
    • conta_corrente - Account number
    • nome_titular - Account holder name
    • doc_titular - Account holder document
    • cChavePix - PIX key
    • transf_padrao - Default transfer flag
  • info - Creation and modification metadata:
    • cImpAPI - API import flag
    • dAlt, hAlt, uAlt - Last modification date, time, and user
    • dInc, hInc, uInc - Creation date, time, and user
  • tags - Client tags and classifications (array):
    • tag - Tag name
    • tipo_assinante - Subscriber type
  • recomendacoes - Client recommendations:
    • gerar_boletos - Generate bank slips flag
Stream containing project information for tracking and management.Key Fields:
  • codigo - Unique identifier for the project
  • cod_int - Integration code for the project
  • nome - Project name
  • inativo - Whether the project is inactive
  • last_updated_at - When the record was last updated
Nested Objects:
  • info - Creation and modification metadata:
    • data_alt, hora_alt, user_alt - Last modification date, time, and user
    • data_inc, hora_inc, user_inc - Creation date, time, and user
Stream containing company and organization information.Key Fields:
  • codigo_empresa - Unique identifier for the company
  • cnpj - Company tax identification number
  • razao_social - Company legal name
  • nome_fantasia - Company trade name
  • endereco, endereco_numero, complemento - Address information
  • logradouro - Street type
  • bairro - Neighborhood
  • cidade, estado, cep - Location details
  • codigo_pais - Country code
  • email - Company email
  • website - Company website
  • telefone1_ddd, telefone1_numero - Primary phone
  • telefone2_ddd, telefone2_numero - Secondary phone
  • fax_ddd, fax_numero - Fax number
  • cnae - Economic activity classification code
  • cnae_municipal - Municipal activity code
  • inscricao_estadual - State registration number
  • inscricao_municipal - Municipal registration number
  • inscricao_suframa - SUFRAMA registration
  • inativa - Whether the company is inactive
  • gera_nfse - Whether it generates NFSE
  • regime_tributario - Tax regime
  • optante_simples_nacional - Whether it’s Simple Nacional
  • pdv_sincr_analitica - PDV analytical sync
Additional Fields:
  • CSC (Código de Segurança do Contribuinte) for homologation and production
  • ECD (Escrituração Contábil Digital) settings
  • EFD (Escrituração Fiscal Digital) settings
  • SPED (Sistema Público de Escrituração Digital) accounting information
Stream containing departmental organization structure.Key Fields:
  • codigo - Department code
  • descricao - Department description
  • estrutura - Department structure
  • inativo - Whether the department is inactive
Stream containing financial and operational categories.Key Fields:
  • codigo - Category code
  • descricao - Category description
  • descricao_padrao - Default description
  • categoria_superior - Parent category
  • natureza - Category nature
  • tipo_categoria - Category type
  • codigo_dre - DRE (Income Statement) code
  • conta_receita - Revenue account
  • conta_despesa - Expense account
  • conta_inativa - Whether account is inactive
  • id_conta_contabil - Accounting account ID
  • tag_conta_contabil - Accounting account tag
  • definida_pelo_usuario - Whether defined by user
  • nao_exibir - Whether to hide
  • totalizadora - Whether it’s a totalizer
  • transferencia - Whether it’s a transfer
Nested Objects:
  • dados_dre - Income Statement data:
    • codigoDRE - DRE code
    • descricaoDRE - DRE description
    • nivelDRE - DRE level
    • sinalDRE - DRE signal
    • totalizaDRE - Whether it totalizes in DRE
    • naoExibirDRE - Whether to hide in DRE
Stream containing bank account information and configurations.Key Fields:
  • n_cod_cc - Unique identifier for the checking account
  • c_cod_cc_int - Integration code for the account
  • descricao - Account description
  • codigo_banco - Bank code
  • codigo_agencia - Bank branch code
  • numero_conta_corrente - Account number
  • numero - Account number (alternative)
  • tipo - Account type
  • tipo_conta_corrente - Checking account type
  • modalidade - Account modality
  • bloqueado - Whether the account is blocked
  • inativo - Whether the account is inactive
  • saldo_inicial - Initial balance
  • saldo_data - Balance date
  • valor_limite - Credit limit
  • endereco, complemento - Account address
  • bairro, cidade, estado, cep - Location details
  • codigo_pais - Country code
  • email - Account email
  • ddd, telefone - Phone information
  • nome_gerente - Manager name
  • observacao - Observations
  • nao_fluxo - Whether to exclude from cash flow
  • nao_resumo - Whether to exclude from summary
  • importado_api - Whether imported via API
  • data_alt, hora_alt, user_alt - Last modification info
  • data_inc, hora_inc, user_inc - Creation info
  • last_updated_at - When the record was last updated
Bank Slip (Boleto) Fields:
  • bol_sn - Whether generates bank slips
  • bol_instr1 to bol_instr4 - Bank slip instructions
  • cancinstr - Cancellation instructions
  • cobr_sn - Whether generates collection
  • cobr_esp - Collection specification
  • cnab_esp - CNAB specification
  • dias_rcomp - Days for recomposition
  • per_juros - Interest percentage
  • per_multa - Fine percentage
PDV (Point of Sale) Fields:
  • pdv_* - Various PDV configuration fields for payment processing
PIX Fields:
  • pix_sn - Whether PIX is enabled
Stream containing account balance information and statements.Key Fields:
  • n_cod_cc - Checking account code
  • c_cod_int_cc - Integration account code
  • n_cod_agencia - Branch code
  • n_cod_banco - Bank code
  • n_num_conta - Account number
  • c_descricao - Account description
  • c_cod_tipo, c_des_tipo - Account type code and description
  • c_fluxo_caixa - Cash flow flag
  • c_resumo_executivo - Executive summary flag
  • d_periodo_inicial - Start date of the period
  • d_periodo_final - End date of the period
  • n_saldo_anterior - Previous balance
  • n_saldo_atual - Current balance
  • n_saldo_conciliado - Reconciled balance
  • n_saldo_provisorio - Provisional balance
  • n_limite_credito_total - Total credit limit
  • n_saldo_disponivel - Available balance
Nested Objects:
  • lista_movimentos - List of movements (array):
    • n_cod_lancamento - Transaction code
    • n_cod_lanc_relac - Related transaction code
    • c_situacao - Situation
    • d_data_lancamento - Transaction date
    • c_des_cliente - Client description
    • c_tipo_documento - Document type
    • c_numero - Document number
    • n_valor_documento - Document value
    • n_saldo - Balance
    • c_cod_categoria, c_des_categoria - Category code and description
    • c_documento_fiscal - Fiscal document
    • c_parcela - Installment
    • c_nosso_numero - Our number
    • c_origem - Origin
    • c_vendedor - Salesperson
    • c_projeto - Project
    • n_cod_cliente - Client code
    • c_raz_cliente - Client name
    • c_doc_cliente - Client document
    • c_observacoes - Observations
    • c_data_inclusao, c_hora_inclusao - Creation date and time
    • c_natureza - Nature (R/P)
    • c_bloqueado - Whether blocked
    • d_data_conciliacao - Reconciliation date
Stream containing account transfer and transaction information.Key Fields:
  • n_cod_lanc - Unique identifier for the transaction
  • c_cod_int_lanc - Integration code for the transaction
  • n_cod_agrup - Group code
  • last_updated_at - When the record was last updated
Nested Objects:
  • cabecalho - Transaction header:
    • d_dt_lanc - Transaction date
    • n_cod_cc - Checking account code
    • n_valor_lanc - Transaction value
  • detalhes - Transaction details:
    • c_cod_categ - Category code
    • a_cod_categ - Category codes array
    • c_num_doc - Document number
    • c_obs - Observations
    • c_tipo - Transaction type
    • n_cod_cliente - Client code
    • n_cod_projeto - Project code
  • diversos - Miscellaneous information:
    • c_natureza - Transaction nature
    • c_origem - Origin
    • c_ident_lanc - Transaction identifier
    • d_dt_conc, c_hr_conc, c_us_conc - Reconciliation date, time, and user
    • n_cod_comprador - Buyer code
    • n_cod_vendedor - Seller code
    • n_cod_lanc_cr - Receivable transaction code
    • n_cod_lanc_cp - Payable transaction code
  • departamentos - Department distribution (array):
    • c_cod_dep - Department code
    • n_per_dep - Department percentage
    • n_val_dep - Department value
  • info - Creation and modification metadata:
    • c_imp_api - API import flag
    • d_alt, h_alt, u_alt - Last modification date, time, and user
    • d_inc, h_inc, u_inc - Creation date, time, and user
  • transferencia - Transfer information:
    • n_cod_cc_destino - Destination account code
Stream containing bank information and configurations.Key Fields:
  • codigo - Bank code
  • nome - Bank name
  • tipo - Bank type
  • cod_compen - Compensation code
  • cod_ispb - ISPB code
  • entf_cnpj - Entity CNPJ
CNAB Configuration:
  • cnab_cob - Collection CNAB
  • cnab_pag - Payment CNAB
  • cnab_altve - CNAB alternative version
  • cnab_altvl - CNAB alternative layout
Crawler Configuration:
  • crawler_sn - Whether crawler is enabled
  • cwr_cobrem - Collection remittance crawler
  • cwr_cobret - Collection return crawler
  • cwr_pagrem - Payment remittance crawler
  • cwr_pagret - Payment return crawler
  • cwr_extr - Extract crawler
Open Banking Configuration:
  • obank_sn - Whether Open Banking is enabled
  • obank_cobr - Open Banking collection
  • obank_extr - Open Banking extract
  • obank_pagt - Open Banking payment
  • obank_pix - Open Banking PIX
Discount Configuration:
  • descond_sn - Whether discount is conditional
  • descond_qt - Discount quantity
Stream containing comprehensive financial movement data.Key Fields:
  • detalhes_n_cod_titulo - Unique identifier for the financial title
  • detalhes_c_grupo - Financial group classification
  • detalhes_c_cpfcnpj_cliente - Client tax ID
  • detalhes_c_cod_categ - Category code
  • detalhes_c_natureza - Transaction nature (R=Receivable, P=Payable)
  • detalhes_c_operacao - Operation type
  • detalhes_c_status - Transaction status
  • detalhes_c_tipo - Transaction type
  • detalhes_c_origem - Transaction origin
  • detalhes_n_valor_titulo - Transaction value
  • detalhes_d_dt_vencto - Due date
  • detalhes_d_dt_emissao - Issue date
  • detalhes_d_dt_previsao - Forecast date
  • detalhes_d_dt_pagamento - Payment date
  • detalhes_d_dt_registro - Registration date
  • detalhes_d_dt_credito - Credit date
  • detalhes_n_cod_cc - Checking account code
  • detalhes_n_cod_cliente - Client code
  • detalhes_n_cod_titulo - Title code
  • detalhes_c_num_titulo - Title number
  • detalhes_c_num_boleto - Bank slip number
  • detalhes_c_num_doc_fiscal - Fiscal document number
  • detalhes_c_codigo_barras - Barcode
  • detalhes_c_num_parcela - Installment number
  • detalhes_c_num_ctr - Contract number
  • detalhes_n_cod_ctr - Contract code
  • detalhes_c_num_os - Service order number
  • detalhes_n_cod_os - Service order code
  • detalhes_n_cod_nf - Invoice code
  • detalhes_c_cod_projeto - Project code
  • detalhes_observacao - Observations
  • last_updated_at - When the record was last updated
Tax Information:
  • detalhes_c_ret_ir, detalhes_n_valor_ir - IR (Income Tax) retention and value
  • detalhes_c_ret_iss, detalhes_n_valor_iss - ISS (Service Tax) retention and value
  • detalhes_c_ret_inss, detalhes_n_valor_inss - INSS (Social Security) retention and value
  • detalhes_c_ret_pis, detalhes_n_valor_pis - PIS retention and value
  • detalhes_c_ret_cofins, detalhes_n_valor_cofins - COFINS retention and value
  • detalhes_c_ret_csll, detalhes_n_valor_csll - CSLL retention and value
Financial Values:
  • detalhes_n_desconto - Discount amount
  • detalhes_n_multa - Fine amount
  • detalhes_n_juros - Interest amount
  • detalhes_n_valor_mov_cc - Checking account movement value
Control Information:
  • detalhes_n_cod_baixa - Settlement code
  • detalhes_n_cod_mov_cc - Checking account movement code
  • detalhes_n_cod_mov_cc_repet - Repeated movement code
  • detalhes_n_cod_tit_repet - Repeated title code
  • detalhes_c_cod_int_titulo - Integration title code
  • detalhes_d_dt_concilia, detalhes_c_hr_concilia, detalhes_c_us_concilia - Reconciliation info
  • detalhes_d_dt_alt, detalhes_c_hr_alt, detalhes_c_us_alt - Last modification info
  • detalhes_d_dt_inc, detalhes_c_hr_inc, detalhes_c_us_inc - Creation info
Summary Fields:
  • resumo_c_liquidado - Whether settled
  • resumo_n_val_aberto - Open amount
  • resumo_n_val_liquido - Net amount
  • resumo_n_val_pago - Paid amount
  • resumo_n_desconto - Total discount
  • resumo_n_juros - Total interest
  • resumo_n_multa - Total fine
Nested Objects:
  • departamentos - Department distribution (array):
    • c_cod_departamento - Department code
    • n_distr_percentual - Distribution percentage
    • n_distr_valor - Distribution value
    • n_valor_fixo - Fixed value flag
  • categorias - Category distribution (array):
    • c_cod_categ - Category code
    • n_distr_percentual - Distribution percentage
    • n_distr_valor - Distribution value
    • n_valor_fixo - Fixed value flag
Stream containing quote and budget information organized by month.Key Fields:
  • n_ano - Year
  • n_mes - Month
  • n_mes_ano - Month-year date
Nested Objects:
  • lista_orcamentos - List of budgets (array):
    • c_cod_categ - Category code
    • c_des_categ - Category description
    • n_valor_previsto - Forecasted value
    • n_valor_realizado - Realized value
Stream containing financial summary and overview data by day.Key Fields:
  • d_dia - Date
Nested Objects:
  • conta_corrente - Checking account summary:
    • c_cor - Color
    • c_icone - Icon
    • v_limite_credito - Credit limit
    • v_total - Total value
  • conta_pagar - Accounts payable summary:
    • c_cor - Color
    • c_icone - Icon
    • n_total - Total count
    • v_atraso - Overdue amount
    • v_total - Total amount
  • conta_receber - Accounts receivable summary:
    • c_cor - Color
    • c_icone - Icon
    • n_total - Total count
    • v_atraso - Overdue amount
    • v_total - Total amount
  • conta_pagar_categoria - Payable by category (array):
    • v_total - Total value
    • n_total - Total count
    • c_cod_categ - Category code
    • c_desc_categ - Category description
    • c_icone - Icon
    • c_cor - Color
  • conta_receber_categoria - Receivable by category (array):
    • Same structure as payable by category
  • conta_pagar_atraso - Overdue payables (array):
    • nIdTitulo - Title ID
    • nIdCliente - Client ID
    • cNomeCliente - Client name
    • vDoc - Document value
    • dVencimento - Due date
    • dEmissao - Issue date
    • cCodCateg - Category code
    • cDescCateg - Category description
    • nDiasAtraso - Days overdue
    • cIcone - Icon
    • cCor - Color
    • cUrlLogoBanco - Bank logo URL
  • conta_receber_atraso - Overdue receivables (array):
    • Similar structure with slightly different field names
  • fluxo_caixa - Cash flow (array):
    • d_dia - Date
    • v_pagar - Amount to pay
    • v_receber - Amount to receive
    • v_saldo - Balance
Stream containing accounts payable and bill information.Key Fields:
  • codigo_lancamento_omie - Unique identifier for the bill
  • codigo_lancamento_integracao - Integration code
  • codigo_cliente_fornecedor - Supplier/client code
  • codigo_cliente_fornecedor_integracao - Supplier integration code
  • data_vencimento - Due date
  • data_previsao - Forecast date
  • data_emissao - Issue date
  • data_entrada - Entry date
  • valor_documento - Document value
  • codigo_categoria - Category code
  • id_conta_corrente - Checking account ID
  • id_conta_corrente_integracao - Account integration code
  • numero_documento_fiscal - Fiscal document number
  • numero_documento - Document number
  • numero_parcela - Installment number
  • numero_pedido - Order number
  • codigo_projeto - Project code
  • codigo_vendedor - Seller code
  • observacao - Observations
  • operacao - Operation
  • status_titulo - Title status
  • nsu - NSU
  • acao - Action
  • bloqueado - Whether blocked
  • baixa_bloqueada - Whether settlement is blocked
  • importado_api - Whether imported via API
  • bloquear_exclusao - Whether to block deletion
  • codigo_cmc7_cheque - Check CMC7 code
  • codigo_tipo_documento - Document type code
  • chave_nfe - NFe key
  • codigo_barras_ficha_compensacao - Compensation slip barcode
  • id_origem - Origin ID
  • valor_pag - Payment value
  • aprendizado_rateio - Apportionment learning
  • data_alt, hora_alt - Last modification date and time
  • last_updated_at - When the record was last updated
Tax Information:
  • valor_pis, retem_pis - PIS value and retention
  • valor_cofins, retem_cofins - COFINS value and retention
  • valor_csll, retem_csll - CSLL value and retention
  • valor_ir, retem_ir - IR value and retention
  • valor_iss, retem_iss - ISS value and retention
  • valor_inss, retem_inss - INSS value and retention
Nested Objects:
  • categorias - Category breakdown (array):
    • codigo_categoria - Category code
    • valor - Value
    • percentual - Percentage
  • distribuicao - Department distribution (array):
    • c_cod_dep - Department code
    • c_des_dep - Department description
    • n_val_dep - Department value
    • n_per_dep - Department percentage
  • info - Creation and modification metadata:
    • d_inc, h_inc, u_inc - Creation date, time, and user
    • d_alt, h_alt, u_alt - Last modification date, time, and user
    • c_imp_api - API import flag
  • cnab_integracao_bancaria - Bank integration:
    • codigo_forma_pagamento - Payment method code
    • Bank transfer information (bank, branch, account, etc.)
    • Bank slip information (barcode, interest, fine)
    • pix_qrcode - PIX QR code
  • servico_tomado - Service taken information:
    • Invoice number and series
    • Service code and value
    • Tax information (PIS, COFINS with CST, base, rate, value)
Stream containing electronic service invoices (Nota Fiscal de Serviços Eletrônica).Key Fields:
  • _id - Unique identifier for the NFSE
  • last_updated_at - When the record was last updated
Nested Objects:
  • cabecalho - Invoice header:
    • n_numero_nf_se - NFSE number
    • c_serie_nf_se - NFSE series
    • n_valor_nf_se - NFSE value
    • c_status_nf_se - NFSE status
    • c_codigo_verif_nf_se - Verification code
    • n_cod_nf - Invoice code
    • n_chave_nfe - NFe key
    • c_ambiente_nf_se - Environment (production/test)
    • c_cidade_emissor - Issuer city
    • c_cnpj_emissor - Issuer CNPJ
    • c_im_emissor - Issuer municipal registration
    • c_cod_mun_emissor - Issuer municipality code
    • c_razao_emissor - Issuer company name
    • c_cnpj_destinatario - Recipient CNPJ
    • c_cpf_destinatario - Recipient CPF
    • c_im_destinatario - Recipient municipal registration
    • c_razao_destinatario - Recipient company name
    • c_cod_mun_destinatario - Recipient municipality code
    • n_codigo_cliente - Client code
  • ordem_servico - Service order:
    • n_codigo_os - Service order code
    • n_numero_os - Service order number
    • n_valor_os - Service order value
    • n_codigo_contrato - Contract code
    • c_numero_contrato - Contract number
    • c_pedido_cliente - Client order
    • departamentos - Department distribution (array)
    • categorias - Category distribution (array)
  • RPS - RPS (Recibo Provisório de Serviços) information:
    • n_numero_lote - Batch number
    • n_status_lote - Batch status
    • n_numero_rps - RPS number
    • c_status_rps - RPS status
    • c_serie_rps - RPS series
    • c_protocolo_rps - RPS protocol
    • c_data_rps - RPS date
  • adicionais - Additional information:
    • c_codigo_categoria - Category code
    • n_codigo_cc - Checking account code
    • n_codigo_projeto - Project code
    • n_codigo_vendedor - Seller code
  • servicos - Service information:
    • cidade_prestacao - Service city
    • codigo_lc116 - LC116 code
    • codigo_servico - Service code
    • c_codigo_obra - Construction code
    • c_codigo_art - ART code
    • c_codigo_encapsulamento - Encapsulation code
    • n_quantidade - Quantity
    • n_valor_unitario - Unit value
    • n_valor_servico - Service value
    • n_valor_total - Total value
    • n_valor_outras_despesas - Other expenses
    • n_desconto_valor - Discount value
    • Tax information (ISS, IR, PIS, COFINS, CSLL, INSS) with rates and values
    • c_ret_* - Tax retention flags
    • c_descricao - Service description
  • valores - Values summary:
    • n_valor_total_servicos - Total services value
    • n_valor_base_calculo - Calculation base value
    • n_valor_deducao - Deduction value
    • c_iss_retido - Whether ISS is retained
    • Tax values (ISS, PIS, COFINS, IR, INSS, CSLL)
    • n_valor_liquido - Net value
  • ibpt - IBPT (Tax Load) information:
    • codigo_nbs - NBS code
    • Federal, state, and municipal tax values and rates
    • c_fonte_ibpt - IBPT source
    • c_chave_ibpt - IBPT key
  • inclusao - Creation information:
    • c_data_inclusao - Creation date
    • c_hora_inclusao - Creation time
    • c_usuario_inclusao - Creator user
  • alteracao - Modification information:
    • c_data_alteracao - Modification date
    • c_hora_alteracao - Modification time
    • c_usuario_alteracao - Modifier user
  • emissao - Emission information:
    • c_data_emissao - Emission date
    • c_hora_emissao - Emission time
    • c_usuario_emissao - Emitter user
  • cancelamento - Cancellation information:
    • c_data_cancelamento - Cancellation date
    • c_hora_cancelamento - Cancellation time
    • c_usuario_cancelamento - Canceller user
    • c_motivo_cancelamento - Cancellation reason
  • lista_servicos - Service list (array):
    • Detailed service information similar to servicos object
Stream containing accounts receivable and customer invoice information.Key Fields:
  • codigo_lancamento_omie - Unique identifier for the receivable
  • codigo_lancamento_integracao - Integration code
  • codigo_cliente_fornecedor - Client/customer code
  • codigo_cliente_fornecedor_integracao - Client integration code
  • data_vencimento - Due date
  • valor_documento - Document value
  • codigo_categoria - Category code
  • data_previsao - Forecast date
  • data_emissao - Issue date
  • data_registro - Registration date
  • id_conta_corrente - Checking account ID
  • numero_documento - Document number
  • numero_parcela - Installment number
  • codigo_tipo_documento - Document type code
  • numero_documento_fiscal - Fiscal document number
  • numero_pedido - Order number
  • chave_nfe - NFe key
  • observacao - Observations
  • codigo_barras_ficha_compensacao - Compensation slip barcode
  • codigo_cmc7_cheque - Check CMC7 code
  • id_origem - Origin ID
  • operacao - Operation
  • codigo_vendedor - Seller code
  • codigo_projeto - Project code
  • codigo_pedido - Order code
  • codigo_os - Service order code
  • pedido_cliente - Client order
  • numero_contrato - Contract number
  • nsu - NSU
  • status_titulo - Title status
  • tipo_agrupamento - Grouping type
  • bloqueado - Whether blocked
  • bloquear_baixa - Whether to block settlement
  • importado_api - Whether imported via API
  • baixar_documento - Whether to settle document
  • conciliar_documento - Whether to reconcile document
  • bloquear_exclusao - Whether to block deletion
  • acao - Action
  • aprendizado_rateio - Apportionment learning
  • last_updated_at - When the record was last updated
Tax Information:
  • valor_pis, retem_pis - PIS value and retention
  • valor_cofins, retem_cofins - COFINS value and retention
  • valor_csll, retem_csll - CSLL value and retention
  • valor_ir, retem_ir - IR value and retention
  • valor_iss, retem_iss - ISS value and retention
  • valor_inss, retem_inss - INSS value and retention
Nested Objects:
  • categorias - Category breakdown (array):
    • codigo_categoria - Category code
    • valor - Value
    • percentual - Percentage
  • lancamento_detalhe - Transaction details (array):
    • codigo_integracao - Integration code
    • coo - COO (Cupom Fiscal counter)
    • ccf - CCF (Cupom Fiscal counter)
  • distribuicao - Department distribution (array):
    • c_cod_dep - Department code
    • c_des_dep - Department description
    • n_val_dep - Department value
    • n_per_dep - Department percentage
  • info - Creation and modification metadata:
    • d_inc, h_inc, u_inc - Creation date, time, and user
    • d_alt, h_alt, u_alt - Last modification date, time, and user
    • c_imp_api - API import flag
  • boleto - Bank slip information:
    • gerado - Whether generated
    • c_gerado - Generation flag
    • d_dt_em_bol - Bank slip emission date
    • c_num_boleto - Bank slip number
    • c_num_bancario - Bank number
    • n_per_juros - Interest percentage
    • n_per_multa - Fine percentage
  • recebimento - Payment information:
    • codigo_recebimento_integracao - Payment integration code
    • codigo_conta_corrente - Checking account code
    • valor - Payment value
    • desconto - Discount amount
    • juros - Interest amount
    • multa - Fine amount
    • data - Payment date
    • observacao - Payment observations
  • repeticao - Recurrence settings:
    • antecipar - Whether to anticipate
    • postergar - Whether to postpone
    • mensal - Monthly recurrence:
      • repetir_todo_dia - Repeat every day
      • repetir_por - Repeat for (months)
    • semanal - Weekly recurrence:
      • repetir_dia_semana - Repeat day of week
      • repetir_por - Repeat for (weeks)
    • especifico - Specific recurrence:
      • repetir_a_cada - Repeat every (days)
      • repetir_por - Repeat for (times)