Configuring Alterdata as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Alterdata option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
You’ll need to provide your Alterdata eContador API credentials. The following configurations are available:- API Key: Your Bearer token for the Alterdata eContador API. This is a JWT token generated in eContador under Configuracoes > ePlugin > Gerar.
- Start Date: (Optional) The earliest date from which records will be synced for incremental streams.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.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 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: 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 define some additional settings:- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
- Determine when to execute an 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.
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.Streams and Fields
Below you’ll find all available data streams from Alterdata eContador and their corresponding fields:Empresas (Companies)
Empresas (Companies)
Companies registered in the DP (HR/Payroll) module.Key Fields:
id- Internal company identifiernome- Company namecpfcnpj- CPF or CNPJ numberendereco- Addressexternoid- External identifier codeativa- Whether the company is activetipoMovimentoPermitido- Allowed movement typescontrolaTransferenciaTomadores- Whether contractor transfers are controlled
Funcionarios (Employees)
Funcionarios (Employees)
Employees registered in the DP module. Supports incremental sync.Key Fields:
id- Internal employee identifiercodigo- Employee codenome- Full namecpf- CPF numberemail- Email addressstatus- Employment status (e.g., Ativo)
nascimento- Date of birthtelefone- Phone numbertelefonecelular- Mobile phoneidentidade- ID document numberorgaoemissor- ID issuing authority
admissao- Admission datedemissao- Termination dateretorno- Return datenomefuncao- Job function namesalarioBase- Base salaryafastamento- Leave statusafastamentodescricao- Leave descriptionmatriculaESocial- eSocial registration number
rua- Streetnumero- Numbercomplemento- Address complementbairro- Neighborhoodcidade- Citycep- ZIP code
banco- Bank codenomeDoBanco- Bank nameagencia- Branch numberconta- Account numberchavePix- PIX keypis- PIS number
carteiradetrabalho- Work card numberserie- Work card seriesdataemissaocarteiradetrabalho- Work card issue datedatavencimentocontratoexperiencia- Experience contract expirationdataprorrogacaocontratoexperiencia- Experience contract extension
horarios- Work schedule (JSON with entry, lunch, exit times and weekly rest days)
externoid- External identifierdataAtualizacao- Last update timestamp (replication key)
dataAtualizacao)Documentos (Documents)
Documentos (Documents)
Documents shared through the eContador document module. Fetched per company. Supports incremental sync.Key Fields:
id- Document identifiertitulo- Document titledescricao- Descriptioncategoria- Category namevalor- Monetary valuestatus- Document status (e.g., Recebido)pago- Whether the document has been paidempresaId- Company CNPJdepartamento- Department
criacao- Creation date (replication key)vencimento- Due datepagamento- Payment dateexpiracao- Expiration date
criacao)Categoria Documento (Document Categories)
Categoria Documento (Document Categories)
Document categories available in the eContador platform. Fetched per user.Key Fields:
id- Category identifierdescricao- Category descriptionpersonalizada- Whether it is a custom categorypagavel- Whether documents in this category are payablelogin- Associated user login
Certidoes (Certifications)
Certidoes (Certifications)
CND (Certidao Negativa de Debito) certifications. Fetched per company. Supports incremental sync.Key Fields:
id- Certification identifierempresaId- Company CNPJabrangencia- Scope/coveragemimeType- File MIME typeemissao- Issue date (replication key)vencimento- Expiration datestatus- Certification statustipoCertidaoId- Reference to certification type
emissao)Tipo Certidao (Certification Types)
Tipo Certidao (Certification Types)
Reference table of certification types.Key Fields:
id- Type identifiernome- Type name
Usuarios (Users)
Usuarios (Users)
Users registered in the eContador identification module.Key Fields:
id- User identifier (CPF/CNPJ)nome- Full nameemail- Email addresstelefone- Phone number