Configuring Colibri NCR as a Source
In the 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.
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.
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 Colibri NCR and their corresponding fields:Movimento Caixa
Movimento Caixa
Stream for managing cash register movements and transactions.Fields:
idMovimentoCaixaredeIdredelojaIdlojahoraidAtendentecodAtendentenomeAtendentevlDescontovlAcrescimovlTotalRecebervlTotalRecebidovlServicoRecebidovlConsumacaoRecebidovlTrocoContravalevlTrocoDinheirovlTrocoRepiquevlTaxaEntreganumPessoasoperacaoIdmaquinaIdnomeMaquinacaminhoMaquinamodoVendaIdmodoVendaNomemeiosPagamento(Array of Objects):idcodigonomeredeIdvalorbandeiratipoCartaoidAtendentecodAtendentenomeAtendenteautorizacaonsucredenciadoraturnoIdcliente(Object):idnomeidentificacaoemailcpfCnpj
turnoIdconsumidores(Array of Objects):documentotipo
canceladostatusComprovantedataContabiltipoIdtipoDescclientes(Array of Objects):ididPenduraPosvlTotalsaldooperacaoIdcanceladoobsidClientenomeClienteidentificacaoClienteemailClientecpfCnpjCliente
Item Venda
Item Venda
Stream for sold items in transactions.Fields:
idItemVendaredeIdredelojaIdlojaquantidadeidMaterialcodMaterialcodMaterialStrdescricaovalorTotalvalorUnitariocodGrupogrupoNomecomboIdcombooperacaoIdatendenteIdatendenteNomemodoVendaIdmodoVendaNomemotivoCancelamento(Object):idnomecodigo
consumidores(Array of Objects):documentotipo
canceladotimestampLancamentodtLancamentohoraLancamentotipoCancelamento
Comprovantes
Comprovantes
Stream for fiscal receipts and invoices.Fields:
denominacaovalormaquinaIdnfNumeronfSerienfSubserieserieEcfcontOrdemOperacaoEcfcontCupomFiscalEcfcontComprovanteDebCredEcfcontRelatorioGerencialEcfcontComprovanteNaoFiscalEcfconsumidordescontoacrescimochaveNfestatusNfeprotocoloNfedataContabildataEmissaoidOperacaotrocodataMovimentocanceladodetalhes(Array of Objects):ordemcodigodescricaoquantidadevalorvalorUnitarioaliquotabaseIcmscodNcmprodOrigemcfopctsIcmsaliquotaIcmsIssctsPisaliqPiscstCofinsaliquotaCofinsreducaoBcIcmsdescontoacrescimocanceladomotivoDesoneracaoIcmscodigoBeneficioFiscalvlDesoneracaoIcms
meios(Array of Objects):iddescricaovalornumAutorizacaocredenciadoracredenciadoraRede
Lojas
Lojas
Stream for managing stores.Fields:
idLojanome
Turnos
Turnos
Stream for managing work shifts.Fields:
idTurnoidFuncionariocodFuncionarionomeFuncionariodataAberturadataFechamentodataContabilidLojanomeLojaidRedenomeRedeconferencias(Array of Objects):idTurnoidMeioPagamentocodMeioPagamentonomeMeioPagamentovalorDigitado
Meio Pagamento
Meio Pagamento
Stream for managing payment methods.Fields:
idredesub_redelojacodigodescricaoimagemtroco_dinheirotroco_repiquetroco_contravalecartaotefmultiplocorordemsistema
Tabelas Preco
Tabelas Preco
Stream for managing price tables. This is a child stream of
Lojas.Fields:idativodt_altmodo_vendanomedt_vigencialoja
Item Preco
Item Preco
Stream for managing item prices within price tables. This is a child stream of
Tabelas Preco.Fields:idativodt_altprecotabelamaterial
Mapa ECF
Mapa ECF
Stream for ECF (Emissor de Cupom Fiscal) maps, related to fiscal printers in Brazil.Fields:
ididLojanomeLojaidRedenomeRededataContabilcnpjinscricaoEstadualinscricaoMunicipalnumeroEcfnumeroSerieEcfdataReducaoZcontOrdemOperacaocontComprovanteNaoFiscalEcfcontReinicioOperacaoEcfcontReducaoZEcfvalorGrandeEcfvalorVendaBrutadetalhes(Array of Objects):idMapaEcfcodTotalizadorbasepercentualvalornuSeriecontReducaoZEcfposicaodataContabiltipo
totalizadores(Array of Objects):idMapaEcfcontadorvaloroperacao
Modo Venda
Modo Venda
Stream for sales modes.Fields:
idnome
Motivo Cancelamento
Motivo Cancelamento
Stream for cancellation reasons.Fields:
idrede_lojaativodt_altdt_alt_timezonecodigonomebaixa_estoqueredesub_redeloja
Status Periodo
Status Periodo
Stream for the status of an accounting period for a store.Fields:
dataContabilredeIdlojaIdstatus