Pular para o conteúdo
TAI TAI Desenvolvedores

Atualizar documento

PUT
/ged/documento

Atualiza metadados (título, descrição, código, tipo, tags, validade, requer aprovação) — requer ESCRITA. Pasta: /{id}/mover. Visibilidade: PATCH /ged/permissao/documento/{id}/publico. Status: workflow.

Autorização
Módulo contratado: GESTAO_DOCUMENTOS
Permissão: DOCUMENTO

Authorizations

Seção intitulada “Authorizations ”

Request Body required

Seção intitulada “Request Body required ”

Updated entity data

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
titulo
string
descricao
string
codigo
string
pasta

Entity data

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
nome
string
descricao
string
pastaPaiId
integer format: int64
pastaPaiNome
string
path
string
nivel
integer format: int32
herdarPermissoes
boolean
publico
boolean
pastaId
integer format: int64
tipoDocumento
string
Allowed values: RG CPF CNH CTPS TITULO_ELEITOR CERTIFICADO_RESERVISTA PASSAPORTE CONTRATO_TRABALHO ADITIVO_CONTRATO ATESTADO CERTIFICADO DIPLOMA CURRICULUM AVISO_FERIAS RECIBO_FERIAS CARTA_PROPOSTA PROPOSTA_COMERCIAL CONTRATO_CLIENTE NDA POLITICA_EMPRESA PROCEDIMENTO MANUAL REGULAMENTO ASO FICHA_EPI TREINAMENTO_SST COMPROVANTE_RESIDENCIA COMPROVANTE_BANCARIO FOTO OUTROS
status
string
Allowed values: RASCUNHO ATIVO PENDENTE_APROVACAO APROVADO REJEITADO ARQUIVADO EXPIRADO
tags
string
tipoEntidadeVinculo
string
Allowed values: COLABORADOR FERIAS PROJETO CLIENTE VAGA CANDIDATO INCIDENTE PDI OBJETIVO TAREFA TENANT DEPARTAMENTO SETOR BPM_CARD_FIELD BPM_CARD_ANEXO PATRIMONIO MBORGES_RELATORIO AVALIACAO_LAUDO HONORARIO_CONTRATO HONORARIO_FECHAMENTO ATD_CHAMADO IPTU_GUIA NENHUM
idEntidadeVinculo
integer format: int64
versaoAtual

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
documentoId
integer format: int64
numeroVersao
integer format: int32
urlArquivo
string
nomeArquivoOriginal
string
tamanhoBytes
integer format: int64
hashArquivo
string
conteudoOcr
string
comentarioVersao
string
dataUpload
string format: date-time
versaoNumero
integer format: int32
conteudoOcr
string
ocrProcessado
boolean
ocrPorIa
boolean
criador

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
nome
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
dataNascimento
string format: date-time
genero
string
Allowed values: MASCULINO FEMININO NAO_BINARIO OUTRO PREFIRO_NAO_INFORMAR
nacionalidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cpf
string
/^(\d{11}|\d{3}\.\d{3}\.\d{3}-\d{2})$/
rg
string
0 <= 20 characters /^[\d.\-A-Za-z]+$/
estadoCivil
string
Allowed values: SOLTEIRO CASADO DIVORCIADO VIUVO UNIAO_ESTAVEL
telefone
string
0 <= 20 characters /^[\d\s\-().+]+$/
emailPessoal
string format: email
0 <= 255 characters
emailCorporativo
string format: email
0 <= 255 characters
linkedin
string
0 <= 500 characters /^(https?://)?[\w\-.]+(:\d+)?(/[\w\-./?%&=@#]*)?$/
endereco
string
0 <= 500 characters /^[\p{L}\p{N}\s\-.,;:/°ºª()]+$/
codigoFuncionario
string
0 <= 50 characters /^[a-zA-Z0-9\-_]+$/
codigoPosicao
string
0 <= 50 characters /^[a-zA-Z0-9\-_]+$/
tipoContrato
string
Allowed values: CLT PJ ESTAGIO TEMPORARIO TERCEIRIZADO APRENDIZ INTERMITENTE SOCIO_SERVICO AUTONOMO
dataAdmissao
string format: date-time
nivelHierarquico
string
Allowed values: ESTAGIARIO TREINEE JUNIOR PLENO SENIOR COORDENADOR GERENTE ESPECIALISTA SUPERINTENDENTE DIRETOR VICE_PRESIDENTE C_LEVEL
regimeTrabalho
string
Allowed values: INTEGRAL PARCIAL PRESENCIAL REMOTO HIBRIDO
horarioTrabalho
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
beneficios
string
0 <= 1000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
pis
string
/^\d{11}$/
ctps
string
0 <= 30 characters /^[\d.\-/]+$/
nis
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
informacoesSaude
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
fotoUrl
string
0 <= 500 characters /^(https?://)?[\w\-.]+(:\d+)?(/[\w\-./?%&=@#]*)?$/
idiomas
Array<string>
enviarEmail
boolean
nomeSocial
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
apelido
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
naturalidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
estadoNatal
string
0 <= 2 characters /^[A-Z]{2}$/
fumante
boolean
corRaca
string
Allowed values: BRANCA PRETA PARDA AMARELA INDIGENA NAO_INFORMADO
tipoSanguineo
string
Allowed values: A_POSITIVO A_NEGATIVO B_POSITIVO B_NEGATIVO AB_POSITIVO AB_NEGATIVO O_POSITIVO O_NEGATIVO
grauInstrucao
string
Allowed values: ANALFABETO FUNDAMENTAL_ATE_5_ANO_INCOMPLETO FUNDAMENTAL_5_ANO_COMPLETO FUNDAMENTAL_6_AO_9_ANO FUNDAMENTAL_COMPLETO MEDIO_INCOMPLETO MEDIO_COMPLETO SUPERIOR_INCOMPLETO SUPERIOR_COMPLETO POS_GRADUACAO_INCOMPLETA POS_GRADUACAO_COMPLETA MESTRADO_INCOMPLETO MESTRADO_COMPLETO DOUTORADO_INCOMPLETO DOUTORADO_COMPLETO POS_DOUTORADO_INCOMPLETO POS_DOUTORADO_COMPLETO
cep
string
0 <= 9 characters /^(\d{8}|\d{5}-\d{3})$/
logradouro
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,;:/°ºª()]+$/
enderecoNumero
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
complemento
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
bairro
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
enderecoUf
string
0 <= 2 characters /^[A-Z]{2}$/
pais
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
telefone2
string
0 <= 20 characters /^[\d\s\-().+]+$/
telefone3
string
0 <= 20 characters /^[\d\s\-().+]+$/
ramal
string
0 <= 10 characters /^$|^\d+$/
rgOrgaoEmissor
string
0 <= 20 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
rgUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
rgDataEmissao
string format: date-time
tituloEleitor
string
0 <= 12 characters /^\d{12}$/
tituloEleitorZona
string
0 <= 10 characters /^[a-zA-Z0-9]+$/
tituloEleitorSecao
string
0 <= 10 characters /^[a-zA-Z0-9]+$/
tituloEleitorDataEmissao
string format: date-time
tituloEleitorUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
ctpsSerie
string
0 <= 20 characters /^[\d.\-/]+$/
ctpsDataEmissao
string format: date-time
ctpsUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
ctpsDigital
boolean
cnh
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
cnhCategoria
string
Allowed values: A B C D E AB AC AD AE
cnhDataEmissao
string format: date-time
cnhDataVencimento
string format: date-time
cnhOrgaoEmissor
string
0 <= 20 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cnhDataPrimeira
string format: date-time
cnhUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
certReservista
string
0 <= 30 characters /^[a-zA-Z0-9]+$/
categoriaMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
circunscricaoMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
regiaoMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
certReservistaDataEmissao
string format: date-time
certReservistaOrgaoExpedicao
string
0 <= 50 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
situacaoMilitar
string
Allowed values: RESERVISTA DISPENSADO ALISTADO NAO_SE_APLICA EXCESSO_CONTINGENTE REFORMADO
matriculaEsocial
string
0 <= 30 characters
codCategoria
string
tipoRegimeTrabalhista
string
tipoRegimePrevidenciario
string
tipoAdmissao
string
indicativoAdmissao
string
naturezaAtividade
string
tipoRegimeJornada
string
defFisica
boolean
defVisual
boolean
defAuditiva
boolean
defMental
boolean
defIntelectual
boolean
reabilitadoReadaptado
boolean
preencheCotaPcd
boolean
observacaoDeficiencia
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
municipioId
integer format: int64
municipioDescricao
string
tipoLogradouro
string
sexoEsocial
string
grauInstrucaoEsocial
string
paisNascimento
string
paisNacionalidade
string
tipoContratoPrazo
string
dataTerminoContrato
string format: date-time
clausulaAssecuratoria
boolean
objetoDeterminante
string
0 <= 255 characters
tipoJornadaEsocial
string
tempoParcial
string
horasSemanais
number
horarioNoturno
boolean
descricaoJornada
string
0 <= 999 characters
dataOpcaoFgts
string format: date-time
esocialReciboAdmissao
string
0 <= 40 characters
tipoRua
string
tipoBairro
string
tipoFuncionarioTotvs
string
fichaRegistroTotvs
string
tipoAdmissaoTotvs
string
motivoAdmissaoTotvs
string
motivoMudancaTotvs
string
tipoRecebimentoTotvs
string
situacaoTotvs
string
jornadaMensalTotvs
string
horarioTotvs
string
letraHorarioTotvs
string
sindicatoTotvs
string
contribuicaoSindicalTotvs
string
ocorrenciaSefipTotvs
string
categoriaSefipTotvs
string
situacaoFgtsTotvs
string
situacaoRaisTotvs
string
calculaInssTotvs
boolean
calculaIrrfTotvs
boolean
percentualAdiantamentoTotvs
number
desligado
boolean
dataDesligamento
string format: date-time
motivoDesligamento
string
Allowed values: DEMISSAO_SEM_JUSTA_CAUSA DEMISSAO_COM_JUSTA_CAUSA PEDIDO_DEMISSAO ACORDO_MUTUO TERMINO_CONTRATO APOSENTADORIA FALECIMENTO TRANSFERENCIA_EMPRESA OUTRO
observacaoDesligamento
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
dataValidade
string format: date-time
requerAprovacao
boolean
publico
boolean
versoes
Array<object>

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
documentoId
integer format: int64
numeroVersao
integer format: int32
urlArquivo
string
nomeArquivoOriginal
string
tamanhoBytes
integer format: int64
hashArquivo
string
conteudoOcr
string
comentarioVersao
string
dataUpload
string format: date-time

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

OK

Updated entity data

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
titulo
string
descricao
string
codigo
string
pasta

Entity data

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
nome
string
descricao
string
pastaPaiId
integer format: int64
pastaPaiNome
string
path
string
nivel
integer format: int32
herdarPermissoes
boolean
publico
boolean
pastaId
integer format: int64
tipoDocumento
string
Allowed values: RG CPF CNH CTPS TITULO_ELEITOR CERTIFICADO_RESERVISTA PASSAPORTE CONTRATO_TRABALHO ADITIVO_CONTRATO ATESTADO CERTIFICADO DIPLOMA CURRICULUM AVISO_FERIAS RECIBO_FERIAS CARTA_PROPOSTA PROPOSTA_COMERCIAL CONTRATO_CLIENTE NDA POLITICA_EMPRESA PROCEDIMENTO MANUAL REGULAMENTO ASO FICHA_EPI TREINAMENTO_SST COMPROVANTE_RESIDENCIA COMPROVANTE_BANCARIO FOTO OUTROS
status
string
Allowed values: RASCUNHO ATIVO PENDENTE_APROVACAO APROVADO REJEITADO ARQUIVADO EXPIRADO
tags
string
tipoEntidadeVinculo
string
Allowed values: COLABORADOR FERIAS PROJETO CLIENTE VAGA CANDIDATO INCIDENTE PDI OBJETIVO TAREFA TENANT DEPARTAMENTO SETOR BPM_CARD_FIELD BPM_CARD_ANEXO PATRIMONIO MBORGES_RELATORIO AVALIACAO_LAUDO HONORARIO_CONTRATO HONORARIO_FECHAMENTO ATD_CHAMADO IPTU_GUIA NENHUM
idEntidadeVinculo
integer format: int64
versaoAtual

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
documentoId
integer format: int64
numeroVersao
integer format: int32
urlArquivo
string
nomeArquivoOriginal
string
tamanhoBytes
integer format: int64
hashArquivo
string
conteudoOcr
string
comentarioVersao
string
dataUpload
string format: date-time
versaoNumero
integer format: int32
conteudoOcr
string
ocrProcessado
boolean
ocrPorIa
boolean
criador

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
nome
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
dataNascimento
string format: date-time
genero
string
Allowed values: MASCULINO FEMININO NAO_BINARIO OUTRO PREFIRO_NAO_INFORMAR
nacionalidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cpf
string
/^(\d{11}|\d{3}\.\d{3}\.\d{3}-\d{2})$/
rg
string
0 <= 20 characters /^[\d.\-A-Za-z]+$/
estadoCivil
string
Allowed values: SOLTEIRO CASADO DIVORCIADO VIUVO UNIAO_ESTAVEL
telefone
string
0 <= 20 characters /^[\d\s\-().+]+$/
emailPessoal
string format: email
0 <= 255 characters
emailCorporativo
string format: email
0 <= 255 characters
linkedin
string
0 <= 500 characters /^(https?://)?[\w\-.]+(:\d+)?(/[\w\-./?%&=@#]*)?$/
endereco
string
0 <= 500 characters /^[\p{L}\p{N}\s\-.,;:/°ºª()]+$/
codigoFuncionario
string
0 <= 50 characters /^[a-zA-Z0-9\-_]+$/
codigoPosicao
string
0 <= 50 characters /^[a-zA-Z0-9\-_]+$/
tipoContrato
string
Allowed values: CLT PJ ESTAGIO TEMPORARIO TERCEIRIZADO APRENDIZ INTERMITENTE SOCIO_SERVICO AUTONOMO
dataAdmissao
string format: date-time
nivelHierarquico
string
Allowed values: ESTAGIARIO TREINEE JUNIOR PLENO SENIOR COORDENADOR GERENTE ESPECIALISTA SUPERINTENDENTE DIRETOR VICE_PRESIDENTE C_LEVEL
regimeTrabalho
string
Allowed values: INTEGRAL PARCIAL PRESENCIAL REMOTO HIBRIDO
horarioTrabalho
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
beneficios
string
0 <= 1000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
pis
string
/^\d{11}$/
ctps
string
0 <= 30 characters /^[\d.\-/]+$/
nis
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
informacoesSaude
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
fotoUrl
string
0 <= 500 characters /^(https?://)?[\w\-.]+(:\d+)?(/[\w\-./?%&=@#]*)?$/
idiomas
Array<string>
enviarEmail
boolean
nomeSocial
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
apelido
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
naturalidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
estadoNatal
string
0 <= 2 characters /^[A-Z]{2}$/
fumante
boolean
corRaca
string
Allowed values: BRANCA PRETA PARDA AMARELA INDIGENA NAO_INFORMADO
tipoSanguineo
string
Allowed values: A_POSITIVO A_NEGATIVO B_POSITIVO B_NEGATIVO AB_POSITIVO AB_NEGATIVO O_POSITIVO O_NEGATIVO
grauInstrucao
string
Allowed values: ANALFABETO FUNDAMENTAL_ATE_5_ANO_INCOMPLETO FUNDAMENTAL_5_ANO_COMPLETO FUNDAMENTAL_6_AO_9_ANO FUNDAMENTAL_COMPLETO MEDIO_INCOMPLETO MEDIO_COMPLETO SUPERIOR_INCOMPLETO SUPERIOR_COMPLETO POS_GRADUACAO_INCOMPLETA POS_GRADUACAO_COMPLETA MESTRADO_INCOMPLETO MESTRADO_COMPLETO DOUTORADO_INCOMPLETO DOUTORADO_COMPLETO POS_DOUTORADO_INCOMPLETO POS_DOUTORADO_COMPLETO
cep
string
0 <= 9 characters /^(\d{8}|\d{5}-\d{3})$/
logradouro
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,;:/°ºª()]+$/
enderecoNumero
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
complemento
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
bairro
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
enderecoUf
string
0 <= 2 characters /^[A-Z]{2}$/
pais
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
telefone2
string
0 <= 20 characters /^[\d\s\-().+]+$/
telefone3
string
0 <= 20 characters /^[\d\s\-().+]+$/
ramal
string
0 <= 10 characters /^$|^\d+$/
rgOrgaoEmissor
string
0 <= 20 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
rgUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
rgDataEmissao
string format: date-time
tituloEleitor
string
0 <= 12 characters /^\d{12}$/
tituloEleitorZona
string
0 <= 10 characters /^[a-zA-Z0-9]+$/
tituloEleitorSecao
string
0 <= 10 characters /^[a-zA-Z0-9]+$/
tituloEleitorDataEmissao
string format: date-time
tituloEleitorUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
ctpsSerie
string
0 <= 20 characters /^[\d.\-/]+$/
ctpsDataEmissao
string format: date-time
ctpsUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
ctpsDigital
boolean
cnh
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
cnhCategoria
string
Allowed values: A B C D E AB AC AD AE
cnhDataEmissao
string format: date-time
cnhDataVencimento
string format: date-time
cnhOrgaoEmissor
string
0 <= 20 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cnhDataPrimeira
string format: date-time
cnhUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
certReservista
string
0 <= 30 characters /^[a-zA-Z0-9]+$/
categoriaMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
circunscricaoMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
regiaoMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
certReservistaDataEmissao
string format: date-time
certReservistaOrgaoExpedicao
string
0 <= 50 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
situacaoMilitar
string
Allowed values: RESERVISTA DISPENSADO ALISTADO NAO_SE_APLICA EXCESSO_CONTINGENTE REFORMADO
matriculaEsocial
string
0 <= 30 characters
codCategoria
string
tipoRegimeTrabalhista
string
tipoRegimePrevidenciario
string
tipoAdmissao
string
indicativoAdmissao
string
naturezaAtividade
string
tipoRegimeJornada
string
defFisica
boolean
defVisual
boolean
defAuditiva
boolean
defMental
boolean
defIntelectual
boolean
reabilitadoReadaptado
boolean
preencheCotaPcd
boolean
observacaoDeficiencia
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
municipioId
integer format: int64
municipioDescricao
string
tipoLogradouro
string
sexoEsocial
string
grauInstrucaoEsocial
string
paisNascimento
string
paisNacionalidade
string
tipoContratoPrazo
string
dataTerminoContrato
string format: date-time
clausulaAssecuratoria
boolean
objetoDeterminante
string
0 <= 255 characters
tipoJornadaEsocial
string
tempoParcial
string
horasSemanais
number
horarioNoturno
boolean
descricaoJornada
string
0 <= 999 characters
dataOpcaoFgts
string format: date-time
esocialReciboAdmissao
string
0 <= 40 characters
tipoRua
string
tipoBairro
string
tipoFuncionarioTotvs
string
fichaRegistroTotvs
string
tipoAdmissaoTotvs
string
motivoAdmissaoTotvs
string
motivoMudancaTotvs
string
tipoRecebimentoTotvs
string
situacaoTotvs
string
jornadaMensalTotvs
string
horarioTotvs
string
letraHorarioTotvs
string
sindicatoTotvs
string
contribuicaoSindicalTotvs
string
ocorrenciaSefipTotvs
string
categoriaSefipTotvs
string
situacaoFgtsTotvs
string
situacaoRaisTotvs
string
calculaInssTotvs
boolean
calculaIrrfTotvs
boolean
percentualAdiantamentoTotvs
number
desligado
boolean
dataDesligamento
string format: date-time
motivoDesligamento
string
Allowed values: DEMISSAO_SEM_JUSTA_CAUSA DEMISSAO_COM_JUSTA_CAUSA PEDIDO_DEMISSAO ACORDO_MUTUO TERMINO_CONTRATO APOSENTADORIA FALECIMENTO TRANSFERENCIA_EMPRESA OUTRO
observacaoDesligamento
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
dataValidade
string format: date-time
requerAprovacao
boolean
publico
boolean
versoes
Array<object>

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
documentoId
integer format: int64
numeroVersao
integer format: int32
urlArquivo
string
nomeArquivoOriginal
string
tamanhoBytes
integer format: int64
hashArquivo
string
conteudoOcr
string
comentarioVersao
string
dataUpload
string format: date-time

Referência gerada do contrato da API em 30 de outubro de 2026. taitecnologia.com · Termos de uso · Privacidade

© 2026 T AI TECNOLOGIA LTDA