UAU is self-hosted: each customer runs its own UAU Web API instance. You must provide the base URL of your installation (the “Caminho WebService” shown in the UAU portal) and it must be reachable from Nekt. There is no shared/public environment.
1. Add your UAU access
- In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the UAU option from the list of connectors.
-
Click Next and you’ll be prompted to fill the configuration.
- API Base URL: The base URL of your UAU Web API — for example
https://uauapi.yourcompany.com.br. This is the “Caminho WebService” available in the UAU portal under your user settings. Make sure it is reachable from the internet. - Integration Token: The integration/developer token, sent in the
X-INTEGRATION-Authorizationheader. It is obtained from the UAU developer registration and must be authorized by your company for this integration. - Login: The UAU user login used to authenticate against the API.
- Password: The password for that UAU user.
- UAU Site User (advanced): An optional UAUSite user, sent on login as
UsuarioUAUSite. - Start date (advanced): The earliest record date to sync (used by the incremental Vendas stream).
- Verify SSL Certificate (advanced): Verify the server’s TLS certificate. Disable only for trusted self-hosted UAU servers with an incomplete certificate chain.
- API Base URL: The base URL of your UAU Web API — for example
- Click Next.
2. Select your UAU streams
-
The next step is letting us know which streams you want to bring. You can select entire groups of streams or only a subset of them.
Tip: The stream can be found more easily by typing its name.
- Click Next.
3. Configure your UAU data streams
-
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: depending on the data you are bringing to the lake, you can choose between INCREMENTAL and FULL_TABLE. Read more about Sync Types here.
- Click Next.
4. Configure your UAU data source
- Describe your data source 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 often you want data to be extracted from this source.
- Optionally, you can define some additional settings (if available).
Check your new source!
- Click Next to finalize the setup. Once completed, you’ll receive confirmation that your new source is set up!
- You can view your new source on the Sources page. Now, for you to be able to see it on your Catalog, you have to wait for the pipeline to run. If needed, manually trigger the pipeline by clicking on the refresh icon.
If you encounter any issues, reach out to us, and we’ll gladly assist you!
Streams and Fields
Below you’ll find all available data streams from UAU.Empresas (Companies)
Empresas (Companies)
Active companies registered in UAU (
Empresa/ObterEmpresasAtivas). Synced as a full table.Fields:Codigo_emp:Integer- Unique company (empresa) codeDesc_emp:String- Company name / descriptionCGC_emp:String- Company CNPJ (federal tax ID)IE_emp:String- State registration (Inscrição Estadual)InscrMunic_emp:String- Municipal registration (Inscrição Municipal)Endereco_emp:String- Company addressFone_emp:String- Company phone number
Obras (Construction Projects)
Obras (Construction Projects)
Active construction projects registered in UAU (
Obras/ObterObrasAtivas). Synced as a full table.Fields:Cod_obr:String- Construction project (obra) codeEmpresa_obr:Integer- Company (empresa) code that owns the obraDescr_obr:String- Obra description / nameStatus_obr:Integer- Obra status codeEnder_obr:String- Obra addressFone_obr:String- Obra phone numberFisc_obr:String- Fiscal obra codeDtIni_obr:DateTime- Obra start dateDtfim_obr:DateTime- Obra end dateTipoObra_obr:Integer- Obra type codeEnderEntr_obr:String- Obra delivery addressCEI_obr:String- Obra CEI (INSS registration) codeDataCad_obr:DateTime- Obra registration timestampDataAlt_obr:DateTime- Obra last-change timestampUsrCad_obr:String- User who registered the obra
Vendas (Sales)
Vendas (Sales)
Keys of the sales inserted or changed within a period, fetched per obra (
Venda/RetornaChavesVendasPorPeriodo). Synced incrementally: each run queries the period since the previous sync.Fields:codigo_empresa:Integer- Company (empresa) code of the salecodigo_obra:String- Construction project (obra) code of the salenumero_venda:Integer- Sale (venda) number, unique within empresa + obradata_referencia:DateTime- Upper bound of the queried period (sync reference time), used as the incremental replication keyraw:String- Original key object returned by the API, serialized as a JSON string
Venda Resumo (Sale Financial Summary)
Venda Resumo (Sale Financial Summary)
Financial summary of each sale, computed as of the sync date, fetched per venda (
Venda/ConsultarResumoVenda).Fields:codigoEmpresa:Integer- Company code of the salecodigoObra:String- Obra code of the salenumeroVenda:Integer- Sale (venda) numberdataCalculo:DateTime- Date the summary was calculatedtotalParcelas:Integer- Total number of installmentstotalDesconto:Number- Total discounts of the saletotalAPagarComDesconto:Number- Total payable with discounts appliedparcelasportipo:Array of Objects- Installment totals broken down by installment typetipoParcela:String- Installment type codedescricaoTipoParcela:String- Installment type descriptionquantidadeParcelaAPagar:Integer- Number of installments still to paytotalParcelaAPagar:Number- Total amount of installments still to payquantidadeParcelaPaga:Integer- Number of installments already paidtotalParcelaPaga:Number- Total amount of installments already paid
totaisareceber:Array of Objects- Totals of amounts still to be received (outstanding balance, principal, interest, correction, penalty, late interest, overdue counts, etc.)totaisrecebido:Array of Objects- Totals of amounts already received (total received, principal, interest, correction, discounts, early/late counts, etc.)descontoantecipacao:Object- Anticipation-discount campaign applied to the sale (campaign code and description, discount percentage and type)