Tabelas Folha

Documentação dicionário de dados Folha de Pagamento

Abaixo segue detalhamento de dados relacionados a rotina de contratos, objtivo é proporcionar um diciário de dados da folha.

Formato do Arquivo:

O arquivo pode conter informações de vários estabelecimentos (matriz e filiais);
O arquivo pode ser composto por vários tipos de registros, dependendo das configurações;
O arquivo deve conter um registro por linha. Cada registro deverá ser identificado por uma letra na primeira posição da linha, sucedido de ; (ponto e vírgula), conforme tabela;
Cada linha deve terminar com os caracteres de fim de linha ASC 13 + ASC 10
O arquivo deve estar formatado em JSON String quando enviado pelo método Post na API SYN.

Formato do Registro:

Os registros são formados por campos separados por ; (ponto e vírgula).
A quantidade de campos de um registro é fixa, conforme o tipo de registro. Deve ser respeitada a quantidade de ; (ponto e vírgula) no registro, caso contrário o mesmo será considerado incompleto.
Os registros terão seu tamanho variável, conforme o conteúdo de cada campo.

Tabela 1: Tipo de registro identificado por letra

Tipo	Tabela	Descrição	Instrução
A Importante: O identificador do registro não pode vir com aspas duplas	TipoContrato (nFpa)	Cadastro de Tipos de Contratos	Tipos de contratos disponíveis para utilização pelo cliente
B Importante: O identificador do registro não pode vir com aspas duplas	Sindicato (nFpa)	Sindicatos	Sindicatos cadastrados
C Importante: O identificador do registro não pode vir com aspas duplas	Cargo (nFpa)	Cargos	Lista de cargos disponíveis
D Importante: O identificador do registro não pode vir com aspas duplas	Logradouro (nGem)	Tipo Logradouro	Lista de tipos de logradouro disponíveis
E Importante: O identificador do registro não pode vir com aspas duplas	Estados (nGem)	Estados	Lista de estados disponíveis
F Importante: O identificador do registro não pode vir com aspas duplas	Municipio (nGem)	Municípios	Lista de municípios por estados
G Importante: O identificador do registro não pode vir com aspas duplas	Estab (nGem)	Filiais	Lista de estabelecimentos, matriz e filiais
H Importante: O identificador do registro não pode vir com aspas duplas	Organograma (nFpa)	Departamentos	Departamentos, setores dos estabelecimentos
I Importante: O identificador do registro não pode vir com aspas duplas	LocalContabil (nFpa)	Local Contábil	Locais contábeis, departamento de lançamento contábil
J Importante: O identificador do registro não pode vir com aspas duplas	Escala (nFpa)	Escalas	Escalas de horários de trabalho, detalhamento de cargas horárias mensais
K Importante: O identificador do registro não pode vir com aspas duplas	OrgaoEmissor (nGem)	Orgãos Emissores	Lista de órgãos emissores de documentos
L Importante: O identificador do registro não pode vir com aspas duplas	Situações Afastamento (nFpa)	Situações Afastamento	Lista de código das situações de afastamento

Formato do Campo:

Cada campo tem um tipo que determina o formato de seu conteúdo, conforme a tabela 2.
Cada campo possui um tamanho máximo para seu conteúdo. Os excessos serão desconsiderados.

Tabela 2: Formatação dos Campos do Arquivo

Tipo	Instrução
Inteiro	Formato Padrão: 1234 São aceitos números inteiros e positivos, apenas dígitos de 0 a 9.
Numérico	Padrão: 1234,56 São aceitos números reais e positivos, dígitos de 0 a 9, sempre com separador decimal, o separador decimal deve ser “,” (vírgula). A quantidade de casas decimais deve ser de duas casas após a virgula. O separador do milhar não deve constar nos números.
Data	Padrão: 31/01/2020 São aceitos datas compostas por (dia, mês e ano), dígitos de 0 a 9, com separador. O separador deve ser: “/”
Lógico	Padrão: 0;1 São aceitos 0, para representar Falso ou Não, e, 1, para representar Verdadeiro ou Sim. Obs: Outros formatos válidos, sem alteração no leiaute do importador variável são: N;S.
Texto	Padrão: “Nome Pessoa” São aceitos Caracteres como: letras, dígitos e símbolos. Não são aceitos dentro da Descrição da string, os seguintes Caracteres: ; - Ponto e Virgula \| - Pipe " - Aspas Duplas Obs: É importante ter o delimitador para não separar os campos indevidamente. Importante: É extremamente importante que os campos em texto venham com o identificador de string (“) – Aspas Duplas, para evitar que ocorram erros no processo de importação do arquivo

Importante: Ao final do Arquivo deixar uma linha em branco

LEIAUTE DOS REGISTROS (LEIAUTE VARIÁVEL)

DICIONÁRIO DADOS FOLHA:

Tipo Registro		A
Descrição		Cadastro de Tipos de Contrato. Lista de tipos de contrato possíveis.
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra A Importante: O identificador do registro não pode vir com aspas duplas
2	CODIGOTIPOCONTR		Tipo do Contrato	Inteiro	3	Sim	Código do Tipo do Contrato
3	DESCRTIPOCONTR		Descrição	Texto	50	Sim	Descrição do Tipo do Contrato
4	TIPOCONTR		Tipo	Inteiro	2	Sim	Tipo do Contrato, conforme segue: Prazo Determinado=01 Prazo Indeterminado=02 Tempo Parcial=03 Diretor=04 Estagiário=05 Doméstico=06 Trabalhador Rural=07 Diretor Aposentado=08 Cooperativado=09 Menor Aprendiz=10 Autônomo=11 MEI - Contribuinte Individual=12 Côngrua=99
5	CATEGESOCIAL		Categoria eSocial	Inteiro	3	Sim	Categoria eSocial, conforme eSocial Tabela 01 - Categorias de Trabalhadores
6	BOLSISTA		Bolsista	Lógico	1	Sim	Sim=1;Não=0;

Tipo Registro		B
Descrição		Cadastro de Sindicatos. Lista de sindicatos cadastrados
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra B Importante: O identificador do registro não pode vir com aspas duplas
2	CODIGOSIND		Sindicato	Inteiro	5	Sim	Código do Sindicato
3	NOMESIND		Nome	Texto	50	Sim	Nome do Sindicato
4	SIGLASIND		Sigla	Texto	20	Sim	Sigla do Sindicato
5	INSCRFEDERAL		CNPJ	Texto	18	Sim	Cadastro Nacional de Pessoa Jurídica
6	SIGLAESTADO		Estado	Texto	2	Sim	Sigla do Estado/País
7	CODIGOMUNIC		Município	Inteiro	8	Sim	Informe o código do Município
8	PATRONAL		Patronal	Lógico	1	Sim	Sindicato Patronal Sim=1;Não=0;

Tipo Registro		C
Descrição		Cargo. Lista de cargos cadastrados
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra C Importante: O identificador do registro não pode vir com aspas duplas
2	CODIGOCARGO		Cargo	Inteiro	7	Sim	Código do Cargo
3	DESCRCARGO		Descrição	Texto	100	Sim	Descrição do Cargo
4	CBO		CBO	Inteiro	6	Sim	Código CBO 2002

Tipo Registro		D
Descrição		Logradouro. Lista logradouros
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra D Importante: O identificador do registro não pode vir com aspas duplas
2	CODIGOTIPOLOGRAD		Tipo Logradouro	Inteiro	21	Sim	Código do tipo de logradouro
3	SIGLA		Sigla	Texto	4	Sim	Descrição sigla
4	DESCRTIPOLOGRAD		Descrição	Texto	30	Sim	Descrição do tipo de logradouro

Tipo Registro		E
Descrição		Estados. Lista de estados cadastrados, brasileiros ou não.
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra E Importante: O identificador do registro não pode vir com aspas duplas
2	SIGLAESTADO		Sigla Estado	Texto	2	Sim	Sigla do Estado/País
3	NOMEESTADO		Nome	Texto	30	Sim	Nome do Estado/País
4	ESTADOBRASIL		Estado Brasileiro	Lógico	1	Sim	Estado é Brasileiro, 1=Sim, 0=Não

Tipo Registro		F
Descrição		Municipios. Lista de municípios cadastrados, brasileiros ou não.
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra F Importante: O identificador do registro não pode vir com aspas duplas
2	SIGLAESTADO		Sigla Estado	Texto	2	Sim	Sigla do Estado/País
3	CODIGOMUNIC		Município	Inteiro	5	Sim	Código do Município
4	NOMEMUNIC		Nome	Texto	35	Sim	Nome do município
5	CODIGOFEDERAL		Código Federal	Inteiro	7	Sim	Código do município para União
6	CODIGORAIS		Código RAIS	Inteiro	8	Sim	Código do município para Rais

Tipo Registro		G
Descrição		Estabelecimentos. Lista de estabelecimentos da empresa.
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra G Importante: O identificador do registro não pode vir com aspas duplas
2	CODIGOEMPRESA		Empresa	Inteiro	4	Sim	Código da empresa
3	CODIGOESTAB		Filial	Inteiro	4	Sim	Código da matriz ou filial
4	NOMEESTAB		Razão Social	Texto	100	Sim	Razão social da matriz ou filial
5	TIPOINSCR		Tipo Inscrição	Inteiro	2	Sim	Tipo de inscrição: CPF=1;CNPJ=2;CNO=3;
6	INSCRFEDERAL		CNPJ/CPF/CNO	Texto	18	Sim	Cadastro Nacional de Pessoa Jurídica / Cadastro de Pessoa Física / Cadastro INSS
7	CEPENDERESTAB		Cep	Texto	10	Não	Código do endereçamento postal do estabelecimento
8	CODIGOTIPOLOGRAD		Tipo Logradouro	Inteiro	21	Não	Código do tipo de logradouro
9	ENDERECOESTAB		Endereço	Texto	40	Sim	Endereço do estabelecimento
10	NUMENDERESTAB		Número	Inteiro	7	Sim	Número do endereço
11	COMPLENDERESTAB		Complemento	Texto	50	Não	Complemento do endereço
12	BAIRROENDERESTAB		Bairro	Texto	30	Não	Bairro onde está localizado o estabelecimento
13	SIGLAESTADO		Estado	Texto	2	Sim	Sigla do Estado/País
14	CODIGOMUNIC		Município	Inteiro	8	Sim	Informe o código do Município

Tipo Registro		H
Descrição		Organograma. Lista de organogramas/departamentos dos estabelecimentos.
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra H Importante: O identificador do registro não pode vir com aspas duplas
2	CODIGOEMPRESA		Empresa	Inteiro	4	Sim	Código da empresa
3	CODIGOESTAB		Filial	Inteiro	4	Sim	Código da matriz ou filial
4	CLASSIFORGAN		Organograma	Texto	20	Sim	Classificação do Organograma
5	DESCRORGAN		Descrição	Texto	30	Sim	Descrição do Organograma
6	TIPOCONTA		Tipo	Inteiro	1	Sim	Tipo da Conta: Sintética=1;Analítica=2; Apenas sintéticos recebem vinculação de contratos.

Tipo Registro		I
Descrição		Local Contabil. Lista de departamentos das empresas para fins de alocação contábil.
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra I Importante: O identificador do registro não pode vir com aspas duplas
2	CODIGOEMPRESA		Empresa	Inteiro	4	Sim	Código da empresa
3	CODIGOLOCALCTB		Local Contábil	Inteiro	5	Sim	Código do Local Contábil
4	DESCRLOCALCTB		Descrição	Texto	50	Sim	Descrição do Local Contábil

Tipo Registro		J
Descrição		Escala. Lista de escalas de horários de trabalho, detalha a carga horária de trabalho, nesta também é possível detalhar a jornada de trabalho.
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra J Importante: O identificador do registro não pode vir com aspas duplas
2	CODIGOESCALA		Escala	Inteiro	6	Sim	Código da Escala
3	DESCRESCALA		Descrição	Texto	100	Sim	Descrição da Escala
4	TURNO		Descrição	Texto	2	Sim	Opção de Turno: Misto=1;Diurno=2;Noturno=3;
5	CARGAHORMENSAL		Carga Horária	Numérico	16	Sim	Carga Horária Mensal
6	OBSERVESCALA		Observação	Texto	50	Não	Observação da escala

Tipo Registro		K
Descrição		Orgão Emissor. Lista de orgãos emissores de documentos.
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra K Importante: O identificador do registro não pode vir com aspas duplas
2	CODIGOORGAOEMISSOR		Orgão Emissor	Inteiro	21	Sim	Código Orgão Emissor
3	SIGLAORGAOEMISSOR		Sigla	Texto	10	Sim	Sigla
4	DESCRORGAOEMISSOR		Descrição	Texto	50	Sim	Descrição do órgão emissor

Tipo Registro		L
Descrição		Situações Afastamento. Lista de código das situações de afastamento.
Ix	Nome do Campo		Nome Curto	Tipo	Tam.	Requerido	Observação
1			Identificador	Texto	1	Sim	Fixar letra L Importante: O identificador do registro não pode vir com aspas duplas
2	CODIGOSIT		Situação	Inteiro	4	Sim	Código da Situação de Afastamento
3	DESCRSIT		Descrição	Texto	30	Sim	Descrição da Situação de Afastamento