> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Colibri NCR as a data source

> Bring data from Colibri NCR to Nekt.

Colibri NCR is a comprehensive Point of Sale (POS) system designed for retail and food service businesses, widely used in Brazil. It helps manage sales, inventory, cash flow, and fiscal compliance. Integrating Colibri NCR data into your lakehouse provides valuable insights into your store's performance.

<img height="30" src="https://mintcdn.com/nekt/qL7sV_98VDA27Sa1/assets/logo/logo-colibri.png?fit=max&auto=format&n=qL7sV_98VDA27Sa1&q=85&s=98970c906d115ce25070198735e2b825" data-path="assets/logo/logo-colibri.png" />

## Configuring Colibri NCR as a Source

In the [Sources](https://app.nekt.ai/sources) tab, click on the "Add source" button located on the top right of your screen. Then, select the Colibri NCR 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 Colibri NCR credentials for this connection.

The following configurations are available:

* **Client ID**: The client ID to authenticate against the API service.
* **Rede ID**: The rede ID to sync data from. You can find it in the Colibri NCR dashboard.
* **Start Date**: The earliest date from which records will be synced. This should be in DD-MM-YYYY format.

Once you're done, click **Next**.

### 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.

> 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](https://docs.nekt.com/get-started/core-concepts/triggers), 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](https://docs.nekt.com/get-started/core-concepts/types-of-sync#additional-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](https://app.nekt.ai/sources) page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

<Warning>For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.</Warning>

# Streams and Fields

Below you'll find all available data streams from Colibri NCR and their corresponding fields:

<AccordionGroup>
  <Accordion title="Movimento Caixa">
    Stream for managing cash register movements and transactions.

    **Fields:**

    * `idMovimentoCaixa`
    * `redeId`
    * `rede`
    * `lojaId`
    * `loja`
    * `hora`
    * `idAtendente`
    * `codAtendente`
    * `nomeAtendente`
    * `vlDesconto`
    * `vlAcrescimo`
    * `vlTotalReceber`
    * `vlTotalRecebido`
    * `vlServicoRecebido`
    * `vlConsumacaoRecebido`
    * `vlTrocoContravale`
    * `vlTrocoDinheiro`
    * `vlTrocoRepique`
    * `vlTaxaEntrega`
    * `numPessoas`
    * `operacaoId`
    * `maquinaId`
    * `nomeMaquina`
    * `caminhoMaquina`
    * `modoVendaId`
    * `modoVendaNome`
    * `meiosPagamento` (Array of Objects):
      * `id`
      * `codigo`
      * `nome`
      * `redeId`
      * `valor`
      * `bandeira`
      * `tipoCartao`
      * `idAtendente`
      * `codAtendente`
      * `nomeAtendente`
      * `autorizacao`
      * `nsu`
      * `credenciadora`
      * `turnoId`
      * `cliente` (Object):
        * `id`
        * `nome`
        * `identificacao`
        * `email`
        * `cpfCnpj`
    * `turnoId`
    * `consumidores` (Array of Objects):
      * `documento`
      * `tipo`
    * `cancelado`
    * `statusComprovante`
    * `dataContabil`
    * `tipoId`
    * `tipoDesc`
    * `clientes` (Array of Objects):
      * `id`
      * `idPenduraPos`
      * `vlTotal`
      * `saldo`
      * `operacaoId`
      * `cancelado`
      * `obs`
      * `idCliente`
      * `nomeCliente`
      * `identificacaoCliente`
      * `emailCliente`
      * `cpfCnpjCliente`
  </Accordion>

  <Accordion title="Item Venda">
    Stream for sold items in transactions.

    **Fields:**

    * `idItemVenda`
    * `redeId`
    * `rede`
    * `lojaId`
    * `loja`
    * `quantidade`
    * `idMaterial`
    * `codMaterial`
    * `codMaterialStr`
    * `descricao`
    * `valorTotal`
    * `valorUnitario`
    * `codGrupo`
    * `grupoNome`
    * `comboId`
    * `combo`
    * `operacaoId`
    * `atendenteId`
    * `atendenteNome`
    * `modoVendaId`
    * `modoVendaNome`
    * `motivoCancelamento` (Object):
      * `id`
      * `nome`
      * `codigo`
    * `consumidores` (Array of Objects):
      * `documento`
      * `tipo`
    * `cancelado`
    * `timestampLancamento`
    * `dtLancamento`
    * `horaLancamento`
    * `tipoCancelamento`
  </Accordion>

  <Accordion title="Comprovantes">
    Stream for fiscal receipts and invoices.

    **Fields:**

    * `denominacao`
    * `valor`
    * `maquinaId`
    * `nfNumero`
    * `nfSerie`
    * `nfSubserie`
    * `serieEcf`
    * `contOrdemOperacaoEcf`
    * `contCupomFiscalEcf`
    * `contComprovanteDebCredEcf`
    * `contRelatorioGerencialEcf`
    * `contComprovanteNaoFiscalEcf`
    * `consumidor`
    * `desconto`
    * `acrescimo`
    * `chaveNfe`
    * `statusNfe`
    * `protocoloNfe`
    * `dataContabil`
    * `dataEmissao`
    * `idOperacao`
    * `troco`
    * `dataMovimento`
    * `cancelado`
    * `detalhes` (Array of Objects):
      * `ordem`
      * `codigo`
      * `descricao`
      * `quantidade`
      * `valor`
      * `valorUnitario`
      * `aliquota`
      * `baseIcms`
      * `codNcm`
      * `prodOrigem`
      * `cfop`
      * `ctsIcms`
      * `aliquotaIcmsIss`
      * `ctsPis`
      * `aliqPis`
      * `cstCofins`
      * `aliquotaCofins`
      * `reducaoBcIcms`
      * `desconto`
      * `acrescimo`
      * `cancelado`
      * `motivoDesoneracaoIcms`
      * `codigoBeneficioFiscal`
      * `vlDesoneracaoIcms`
    * `meios` (Array of Objects):
      * `id`
      * `descricao`
      * `valor`
      * `numAutorizacao`
      * `credenciadora`
      * `credenciadoraRede`
  </Accordion>

  <Accordion title="Lojas">
    Stream for managing stores.

    **Fields:**

    * `idLoja`
    * `nome`
  </Accordion>

  <Accordion title="Turnos">
    Stream for managing work shifts.

    **Fields:**

    * `idTurno`
    * `idFuncionario`
    * `codFuncionario`
    * `nomeFuncionario`
    * `dataAbertura`
    * `dataFechamento`
    * `dataContabil`
    * `idLoja`
    * `nomeLoja`
    * `idRede`
    * `nomeRede`
    * `conferencias` (Array of Objects):
      * `idTurno`
      * `idMeioPagamento`
      * `codMeioPagamento`
      * `nomeMeioPagamento`
      * `valorDigitado`
  </Accordion>

  <Accordion title="Meio Pagamento">
    Stream for managing payment methods.

    **Fields:**

    * `id`
    * `rede`
    * `sub_rede`
    * `loja`
    * `codigo`
    * `descricao`
    * `imagem`
    * `troco_dinheiro`
    * `troco_repique`
    * `troco_contravale`
    * `cartao`
    * `tef`
    * `multiplo`
    * `cor`
    * `ordem`
    * `sistema`
  </Accordion>

  <Accordion title="Tabelas Preco">
    Stream for managing price tables. This is a child stream of `Lojas`.

    **Fields:**

    * `id`
    * `ativo`
    * `dt_alt`
    * `modo_venda`
    * `nome`
    * `dt_vigencia`
    * `loja`
  </Accordion>

  <Accordion title="Item Preco">
    Stream for managing item prices within price tables. This is a child stream of `Tabelas Preco`.

    **Fields:**

    * `id`
    * `ativo`
    * `dt_alt`
    * `preco`
    * `tabela`
    * `material`
  </Accordion>

  <Accordion title="Mapa ECF">
    Stream for ECF (Emissor de Cupom Fiscal) maps, related to fiscal printers in Brazil.

    **Fields:**

    * `id`
    * `idLoja`
    * `nomeLoja`
    * `idRede`
    * `nomeRede`
    * `dataContabil`
    * `cnpj`
    * `inscricaoEstadual`
    * `inscricaoMunicipal`
    * `numeroEcf`
    * `numeroSerieEcf`
    * `dataReducaoZ`
    * `contOrdemOperacao`
    * `contComprovanteNaoFiscalEcf`
    * `contReinicioOperacaoEcf`
    * `contReducaoZEcf`
    * `valorGrandeEcf`
    * `valorVendaBruta`
    * `detalhes` (Array of Objects):
      * `idMapaEcf`
      * `codTotalizador`
      * `base`
      * `percentual`
      * `valor`
      * `nuSerie`
      * `contReducaoZEcf`
      * `posicao`
      * `dataContabil`
      * `tipo`
    * `totalizadores` (Array of Objects):
      * `idMapaEcf`
      * `contador`
      * `valor`
      * `operacao`
  </Accordion>

  <Accordion title="Modo Venda">
    Stream for sales modes.

    **Fields:**

    * `id`
    * `nome`
  </Accordion>

  <Accordion title="Motivo Cancelamento">
    Stream for cancellation reasons.

    **Fields:**

    * `id`
    * `rede_loja`
    * `ativo`
    * `dt_alt`
    * `dt_alt_timezone`
    * `codigo`
    * `nome`
    * `baixa_estoque`
    * `rede`
    * `sub_rede`
    * `loja`
  </Accordion>

  <Accordion title="Status Periodo">
    Stream for the status of an accounting period for a store.

    **Fields:**

    * `dataContabil`
    * `redeId`
    * `lojaId`
    * `status`
  </Accordion>
</AccordionGroup>

## Skills for agents

<Snippet file="agent-skills-intro.mdx" />

<Card title="Download Colibri NCR skills file" icon="wand-magic-sparkles" href="/sources/colibri-ncr.md">
  Colibri NCR connector documentation as plain markdown, for use in AI agent contexts.
</Card>
