Omie as a destination

Omie is a cloud-based ERP platform for small and medium-sized businesses in Brazil. It offers a comprehensive suite of tools for managing finances, sales, inventory, and services, helping companies streamline their operations and ensure tax compliance.

1. Add your Omie access

In the Destinations tab, click on the “Add destination” 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:
- App Key: Your App Key for the Omie API.
- App Secret: Your App Secret for the Omie API.
- Endpoint: Select to which endpoint you want to send your data: Upsert Clientes, Upsert Contas a Receber, Upsert Contas a Pagar, Excluir Contas a Receber, Excluir Contas a Pagar, Upsert Projetos, Upsert Vendedores, Incluir Categorias, Associar Código Integração Cliente and Upsert Contratos. Please pay attention to the available fields on the Map your data fields section and whether they are mandatory or not.
- Enable partial success: Whether the connector should continue trying to sync records after one fails.
If you don’t know where to find your App Key & Secret, check this doc.
Click Next.

2. Select your data to send

The next step is letting us know which data you want to send. Select the layer and then the desired table.
Tip: The table can be found more easily by typing its name.
Click Next.

3. Map your data fields

Configure how the fields from your source table should be mapped to the fields in the selected endpoint. Below you can find the supported fields for each endpoint.

Clientes

This endpoint creates or updates clients (customers). Below are the fields you can map your data to:

Field	Type	Description
`codigo_cliente_omie`	Integer	Unique identifier for the client in Omie.
`codigo_cliente_integracao`	String(60)	External unique identifier for the client.
`razao_social`	String(60)	The legal name of the company.
`cnpj_cpf`	String(20)	The client’s tax identifier (CNPJ for companies, CPF for individuals).
`nome_fantasia`	String(100)	The trade name of the company.
`telefone1_ddd`	String(5)	The area code for the primary phone number.
`telefone1_numero`	String(15)	The primary phone number.
`contato`	String(100)	The name of the primary contact person.
`endereco`	String(60)	The street name.
`endereco_numero`	String(60)	The street number.
`bairro`	String(60)	The neighborhood.
`complemento`	String(60)	Additional address information.
`estado`	String(2)	The state abbreviation (e.g., SP).
`cidade`	String(40)	The city code.
`cep`	String(10)	The postal code.
`codigo_pais`	String(4)	The country code (e.g., `1058` for Brazil).
`separar_endereco`	String(1)	Separate address (`S` or `N`).
`pesquisar_cep`	String(1)	Search for address by postal code (`S` or `N`).
`telefone2_ddd`	String(5)	The area code for the secondary phone number.
`telefone2_numero`	String(15)	The secondary phone number.
`fax_ddd`	String(5)	The area code for the fax number.
`fax_numero`	String(15)	The fax number.
`email`	String(500)	The client’s email address.
`homepage`	String(100)	The client’s website URL.
`inscricao_estadual`	String(20)	The state registration number.
`inscricao_municipal`	String(20)	The municipal registration number.
`inscricao_suframa`	String(20)	The SUFRAMA registration number.
`optante_simples_nacional`	String(1)	Indicates if the client is part of the “Simples Nacional” tax regime (`S` or `N`).
`tipo_atividade`	String(1)	The type of activity.
`cnae`	String(7)	The CNAE code (National Classification of Economic Activities).
`produtor_rural`	String(1)	Indicates if the client is a rural producer (`S` or `N`).
`contribuinte`	String(1)	Indicates if the client is a taxpayer (`S` or `N`).
`observacao`	Text	Internal observations.
`obs_detalhadas`	Text	Detailed observations.
`recomendacao_atraso`	String(2)	The protest instruction code.
`tags`	Array	An array of tags associated with the client.
`pessoa_fisica`	String(1)	Indicates if the client is an individual (`S`) or a company (`N`).
`exterior`	String(1)	Indicates if the client is located abroad (`S` or `N`).
`cidade_ibge`	String(7)	The IBGE city code.
`valor_limite_credito`	Decimal	The total credit limit value.
`bloquear_faturamento`	String(1)	Block invoicing for the client (`S` or `N`).
`nif`	String(100)	The NIF (Tax Identification Number).
`enviar_anexos`	String(1)	Send attachments by email (`S` or `N`).
`logradouro`	String(6)	Deprecated.
`importado_api`	String(1)	Indicates if the record was imported via API (`S` or `N`).
`bloqueado`	String(1)	Deprecated.
`recomendacoes`	Object	An object containing client recommendations.
`enderecoEntrega`	Object	An object containing the delivery address details.
`documento_exterior`	String(20)	The client’s foreign document number.
`inativo`	String(1)	Indicates if the client is inactive (`S` or `N`).
`dadosBancarios`	Object	An object containing the client’s bank details.
`caracteristicas`	Array	An array of client characteristics.
`info`	Object	An object containing metadata about the record (read-only).
`bloquear_exclusao`	String(1)	Blocks the deletion of the record (`S` or `N`).

Contas a Pagar

This endpoint creates or updates accounts payable records. Below are the fields you can map your data to:

Field	Type	Description
`codigo_lancamento_omie`	Integer	Unique identifier for the accounts payable entry in Omie.
`codigo_lancamento_integracao`	String(60)	External unique identifier for the accounts payable entry.
`codigo_cliente_fornecedor`	Integer	The supplier’s unique identifier.
`codigo_cliente_fornecedor_integracao`	String(60)	The supplier’s external unique identifier.
`data_vencimento`	String(10)	The due date of the bill (YYYY-MM-DD).
`valor_documento`	Decimal	The total amount of the bill.
`codigo_categoria`	String(20)	The category code.
`categorias`	Array	An array for category allocation.
`data_previsao`	String(10)	The expected payment date (YYYY-MM-DD).
`id_conta_corrente`	Integer	The bank account ID.
`numero_documento_fiscal`	String(20)	The fiscal document number (e.g., invoice number).
`data_emissao`	String(10)	The emission date of the document (YYYY-MM-DD).
`data_entrada`	String(10)	The registration date of the document (YYYY-MM-DD).
`codigo_projeto`	Integer	The project code.
`observacao`	Text	Observations for the payment entry.
`valor_pis`	Decimal	The PIS tax amount.
`retem_pis`	String(1)	Indicates if PIS tax should be withheld (`S` or `N`).
`valor_cofins`	Decimal	The COFINS tax amount.
`retem_cofins`	String(1)	Indicates if COFINS tax should be withheld (`S` or `N`).
`valor_csll`	Decimal	The CSLL tax amount.
`retem_csll`	String(1)	Indicates if CSLL tax should be withheld (`S` or `N`).
`valor_ir`	Decimal	The IR tax amount.
`retem_ir`	String(1)	Indicates if IR tax should be withheld (`S` or `N`).
`valor_iss`	Decimal	The ISS tax amount.
`retem_iss`	String(1)	Indicates if ISS tax should be withheld (`S` or `N`).
`valor_inss`	Decimal	The INSS tax amount.
`retem_inss`	String(1)	Indicates if INSS tax should be withheld (`S` or `N`).
`distribuicao`	Array	An array for department allocation.
`numero_pedido`	String(15)	The purchase order number.
`codigo_tipo_documento`	String(5)	The document type code.
`numero_documento`	String(20)	The document number.
`numero_parcela`	String(7)	The installment number.
`chave_nfe`	String(44)	The electronic invoice key (NF-e).
`codigo_barras_ficha_compensacao`	String(70)	The barcode for the payment slip.
`codigo_vendedor`	Integer	The salesperson code.
`id_origem`	String(4)	The origin code.
`info`	Object	An object containing metadata about the record (read-only).
`operacao`	String(2)	The operation code.
`status_titulo`	String(3)	The status of the bill.
`importado_api`	String(1)	Indicates if the record was imported via API (`S` or `N`).
`bloquear_exclusao`	String(1)	Blocks the deletion of the record (`S` or `N`).
`cnab_integracao_bancaria`	Object	An object containing CNAB and bank integration data.
`servico_tomado`	Object	An object with information from the “Serviço Tomado” tab of the Service Order.
`valor_pag`	Decimal	The amount to be paid.
`aprendizado_rateio`	String(1)	Department allocation learning (`S` or `N`).
`baixar_documento`	String(1)	Automatically settles the document (`S` or `N`).
`conciliar_documento`	String(1)	Automatically reconciles the document (`S` or `N`).
`pagamento`	Object	An object containing payment (settlement) details.

Contas a Receber

This endpoint creates or updates accounts receivable records. Below are the fields you can map your data to:

Field	Type	Description
`codigo_lancamento_omie`	Integer	Unique identifier for the accounts receivable entry in Omie.
`codigo_lancamento_integracao`	String(60)	External unique identifier for the accounts receivable entry.
`codigo_cliente_fornecedor`	Integer	The client’s unique identifier.
`codigo_cliente_fornecedor_integracao`	String(60)	The client’s external unique identifier.
`data_vencimento`	String(10)	The due date of the invoice (YYYY-MM-DD).
`valor_documento`	Decimal	The total amount of the invoice.
`codigo_categoria`	String(20)	The category code.
`data_previsao`	String(10)	The expected receipt date (YYYY-MM-DD).
`categorias`	Array	An array for category allocation.
`id_conta_corrente`	Integer	The bank account ID.
`numero_documento`	String(20)	The document number.
`numero_parcela`	String(7)	The installment number (e.g., “001/003”).
`codigo_tipo_documento`	String(5)	The document type code.
`numero_documento_fiscal`	String(20)	The fiscal document number (e.g., invoice number).
`numero_pedido`	String(15)	The sales order number.
`chave_nfe`	String(44)	The electronic invoice key (NF-e).
`observacao`	Text	Observations for the receipt entry.
`codigo_barras_ficha_compensacao`	String(70)	The barcode for the payment slip.
`codigo_cmc7_cheque`	String(40)	The CMC7 code of the check.
`data_emissao`	String(10)	The emission date of the document (YYYY-MM-DD).
`id_origem`	String(4)	The origin code.
`operacao`	String(2)	The operation code.
`valor_pis`	Decimal	The PIS tax amount.
`retem_pis`	String(1)	Indicates if PIS tax should be withheld (`S` or `N`).
`valor_cofins`	Decimal	The COFINS tax amount.
`retem_cofins`	String(1)	Indicates if COFINS tax should be withheld (`S` or `N`).
`valor_csll`	Decimal	The CSLL tax amount.
`retem_csll`	String(1)	Indicates if CSLL tax should be withheld (`S` or `N`).
`valor_ir`	Decimal	The IR tax amount.
`retem_ir`	String(1)	Indicates if IR tax should be withheld (`S` or `N`).
`valor_iss`	Decimal	The ISS tax amount.
`retem_iss`	String(1)	Indicates if ISS tax should be withheld (`S` or `N`).
`valor_inss`	Decimal	The INSS tax amount.
`retem_inss`	String(1)	Indicates if INSS tax should be withheld (`S` or `N`).
`bloqueado`	String(1)	Blocks the entry (`S` or `N`).
`bloquear_baixa`	String(1)	Blocks the settlement of the entry (`S` or `N`).
`importado_api`	String(1)	Indicates if the record was imported via API (`S` or `N`).
`baixar_documento`	String(1)	Automatically settles the document (`S` or `N`).
`conciliar_documento`	String(1)	Automatically reconciles the document (`S` or `N`).
`acao`	Text	The action to be performed (`A`-Add, `S`-Subtract, `L`-Launch).
`lancamento_detalhe`	Array	An array of objects with entry details.
`distribuicao`	Array	An array for department allocation.
`status_titulo`	String(100)	The status of the invoice.
`codigo_vendedor`	Integer	The salesperson code.
`codigo_projeto`	Integer	The project code.
`nsu`	String(100)	The Unique Sequential Number (payment receipt).
`data_registro`	String(10)	The registration date (YYYY-MM-DD).
`tipo_agrupamento`	String(1)	The type of grouping (`C`-Consolidated, `I`-Individual).
`info`	Object	An object containing metadata about the record (read-only).
`boleto`	Object	An object containing bank slip (boleto) information.
`nCodPedido`	Integer	The Sales Order ID.
`bloquear_exclusao`	String(1)	Postpones the due date (`S` or `N`).
`nCodOS`	Integer	The Service Order ID.
`cPedidoCliente`	String(30)	The customer’s purchase order number.
`cNumeroContrato`	String(20)	The customer’s contract number.
`recebimento`	Object	An object containing receipt (settlement) details.
`repeticao`	Object	An object to configure recurring entries.
`aprendizado_rateio`	String(1)	Department allocation learning (`S` or `N`).

Projetos

This endpoint creates or updates projects. Below are the fields you can map your data to:

Field	Type	Description
`codigo`	Integer	Unique identifier for the project in Omie.
`codInt`	String(20)	External unique identifier for the project.
`nome`	String(70)	Name of the project.
`inativo`	String(1)	Indicates if the project is inactive (`S` or `N`).

Vendedores

This endpoint creates or updates sellers. Below are the fields you can map your data to:

Field	Type	Description
`codigo`	Integer	Código do Vendedor
`codInt`	String(30)	Código de Integração do Vendedor
`nome`	String(70)	Nome do Vendedor
`inativo`	String(1)	Indica se o vendedor está inativo [S/N]
`email`	String(100)	E-mail do vendedor.
`fatura_pedido`	String(1)	O vendedor pode faturar um pedido?
`visualiza_pedido`	String(1)	Visualiza apenas os pedidos em que é o vendedor. Informar “S” ou “N”.
`comissao`	Decimal	Percentual de Comissão.

Categorias

This endpoint creates categories. Below are the fields you can map your data to:

Field	Type	Description
`categoria_superior`	String	Code of the category group.
`descricao`	String(50)	Description of the category.
`natureza`	String(50)	Description of the account nature, equivalent to the “Observation” field of the category in the ERP.
`tipo_categoria`	String(3)	Type of expense/revenue made with this category.
`codigo_dre`	String(10)	Code in the Income Statement (DRE).

Associar Código de Integração Cliente

This endpoint associates an external integration code with an existing Omie client. Below are the fields you can map your data to:

Field	Type	Description
`codigo_cliente_omie`	Integer	Unique identifier for the client in Omie.
`codigo_cliente_integracao`	String(60)	External integration code for legacy systems.

Contratos

This endpoint creates or updates service contracts. The contract payload is structured in sections. Below are the fields you can map your data to:cabecalho (Contract Header)

Field	Type	Description
`nCodCtr`	Integer	Unique contract code in Omie.
`cCodIntCtr`	String(20)	External integration code for the contract.
`nCodCli`	Integer	Customer code. Required.
`cNumCtr`	String(60)	Contract number. Required.
`cCodSit`	String(2)	Contract status (`00` - Active, `10` - Suspended, `90` - Cancelled, `99` - Finished).
`dVigInicial`	String(10)	Start date of the contract. Required.
`dVigFinal`	String(10)	End date of the contract. Required.
`nDiaFat`	Integer	Billing day of the month. Required.
`nValTotMes`	Decimal	Monthly total value.
`cTipoFat`	String(2)	Billing frequency (`01` - Monthly, `02` - Bimonthly, `03` - Quarterly, `06` - Semiannual, `12` - Annual). Required.

itensContrato (Contract Items)Each item contains the following sub-sections:itemCabecalho

Field	Type	Description
`codItem`	Integer	Item ID in Omie.
`codIntItem`	String(30)	Item integration code.
`seq`	Integer	Item sequence number.
`codServico`	Integer	Service code.
`natOperacao`	String(2)	Operation nature/tax type. Required.
`codServMunic`	String(20)	Municipal service code. Required.
`codLC116`	String(10)	LC 116 service code. Required.
`quant`	Decimal	Quantity. Required.
`valorUnit`	Decimal	Unit value. Required.
`cTpDesconto`	String(1)	Discount type (`P` - Percentage, `V` - Value).
`valorDesconto`	Decimal	Discount value.
`aliqDesconto`	Decimal	Discount rate.
`valorOutrasRetencoes`	Decimal	Other retentions value.
`valorAcrescimo`	Decimal	Additions/fees value.
`codNBS`	String(9)	NBS code.
`cNaoGerarFinanceiro`	String(1)	Skip financial generation (`S` or `N`).
`cCodCategItem`	String(20)	Item category code.
`valorDed`	Decimal	Deduction value.
`valorTotal`	Decimal	Total item value.

itemDescrServ

Field	Type	Description
`descrCompleta`	Text	Complete service description. Required.

itemImpostos (Item Taxes)

Field	Type	Description
`aliqISS`	Decimal	ISS rate.
`valorISS`	Decimal	ISS value.
`retISS`	String(1)	Retain ISS (`S` or `N`).
`aliqIR`	Decimal	IR rate.
`valorIR`	Decimal	IR value.
`retIR`	String(1)	Retain IR (`S` or `N`).
`aliqPIS`	Decimal	PIS rate.
`valorPIS`	Decimal	PIS value.
`retPIS`	String(1)	Retain PIS (`S` or `N`).
`aliqCOFINS`	Decimal	COFINS rate.
`valorCOFINS`	Decimal	COFINS value.
`retCOFINS`	String(1)	Retain COFINS (`S` or `N`).
`aliqCSLL`	Decimal	CSLL rate.
`valorCSLL`	Decimal	CSLL value.
`retCSLL`	String(1)	Retain CSLL (`S` or `N`).
`aliqINSS`	Decimal	INSS rate.
`valorINSS`	Decimal	INSS value.
`retINSS`	String(1)	Retain INSS (`S` or `N`).

infAdic (Additional Information)

Field	Type	Description
`cCodCateg`	String(20)	Category code.
`nCodVend`	Integer	Vendor code.
`nCodProj`	Integer	Project code.
`nCodCC`	Integer	Cost center code.
`cContato`	String(100)	Contact name.
`cCidPrestServ`	String(40)	City/state where the service is provided.
`cCodObra`	String(15)	Work/construction code.
`cCodART`	String(20)	ART code.
`cDadosAdicNF`	Text	Additional NF data.
`nIdDestinatario`	Integer	Recipient client ID.

vencTextos (Maturity & NFS-e Texts)

Field	Type	Description
`cTpVenc`	String(3)	Maturity type (`001` - Days after billing, `002` - Fixed day). Required.
`nDias`	Integer	Days to maturity.
`nDiaFixo`	Integer	Fixed maturity day (1-31).
`cProxMes`	String(1)	Next month only (`S` or `N`).
`cAntecipar`	String(1)	Anticipate business days (`S` or `N`).
`cPostergar`	String(1)	Postpone weekends/holidays (`S` or `N`).
`cAdPeriodo`	String(1)	Add reference period to description (`S` or `N`).
`cAdContrato`	String(1)	Add contract number to description (`S` or `N`).
`cAdVenc`	String(1)	Add maturity to description (`S` or `N`).

departamentos (Department Distribution)

Field	Type	Description
`cCodDep`	String(40)	Department code.
`cDesDep`	String(50)	Department description.
`nValDep`	Decimal	Department allocation value.
`nPerDep`	Decimal	Department allocation percentage.

emailCliente (Client Email Settings)

Field	Type	Description
`cEnviarRecibo`	String(1)	Send service receipt (`S` or `N`).
`cEnviarLinkNfse`	String(1)	Send NFS-e link (`S` or `N`).
`cEnviarBoleto`	String(1)	Send billing slip (`S` or `N`).
`cEnviarPix`	String(1)	Send PIX payment (`S` or `N`).
`cUtilizarEmails`	Text	Override email addresses.

observacoes (Observations)

Field	Type	Description
`cObsContrato`	Text	Contract observations/notes.

For the Excluir endpoints, you should pass the Omie unique key associated with the record:

Contas a Pagar -> conta_pagar_cadastro_chave
Contas a Receber -> conta_receber_cadastro_chave

4. Configure your Omie data destination

Describe your destination for easy identification within your organization. You can inform things like what data it brings, to which team it belongs, etc.
To define your Trigger, consider how frequently you need to have the data updated on the destination (every day, once a week, only at specific times, etc.).
Click Done.

Check your new destination!

Once completed, you’ll receive confirmation that your new destination is set up!
You can view your new destination on the Destinations page. Now, for you to be able to see it on Omie, you have to wait for the pipeline to run. You can monitor it on the Destinations page to see its execution and completion. If needed, manually trigger the pipeline by clicking on the refresh icon. Once executed, your data should be seen on Omie.

If you encounter any issues, reach out to us via Slack, and we’ll gladly assist you!

Documentation

Get started

Using Nekt

Workspace

Resources

Omie as a destination

1. Add your Omie access

2. Select your data to send

3. Map your data fields

4. Configure your Omie data destination

Check your new destination!

​1. Add your Omie access

​2. Select your data to send

​3. Map your data fields

​4. Configure your Omie data destination

​Check your new destination!

1. Add your Omie access

2. Select your data to send

3. Map your data fields

4. Configure your Omie data destination

Check your new destination!