Terceiro

Busca de Terceiros

Lê uma lista de Terceiros Analíticos com base no filtro informado na URL da requisição.

get/api/folha/v1/terceiro

Request

  • Base URL: https://api-docs.wk.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api-docs.wk.com.br/api/folha/v1/terceiro
  • Auth: HTTP bearer

Query parameters

Codigointeger
Caracteristica'Todos' | 'ContribuinteIndividual' | 'Transporte' | 'Alimentacao' | 'PlanoSaude' | 'Seguro' | 'Gerais' | 'CooperativaTrabalho' | 'ObraConstrucaoCivil' | 'ProdutorRural' | 'CooperativaTrabalhoOdontologica' | 'CooperativaTrabalhoMedico' | 'InformacoesEstagio' | 'RecursosPatrocinio' | 'Facultativo' | 'PrevidenciaPrivada' | 'SaudeSeguranca' | 'Treinamento' | 'InformacoesProcessosTrabalhistas'
Nomestring
Situacao'Todos' | 'Inativo' | 'Ativo'
Idsstring[]

IDs dos registros a serem filtrados. Caso seja passado um ID inválido ou inexistente o dado será retornado como null.

CodigosIntegradorstring[]

Códigos de integrador dos registros a serem filtrados.

Fieldsstring[]

Campos retornados na busca.

Response

OK

idstring nullable
codigoIntegradorstring nullable
codigointeger
caracteristica'Todos' | 'ContribuinteIndividual' | 'Transporte' | 'Alimentacao' | 'PlanoSaude' | 'Seguro' | 'Gerais' | 'CooperativaTrabalho' | 'ObraConstrucaoCivil' | 'ProdutorRural' | 'CooperativaTrabalhoOdontologica' | 'CooperativaTrabalhoMedico' | 'InformacoesEstagio' | 'RecursosPatrocinio' | 'Facultativo' | 'PrevidenciaPrivada' | 'SaudeSeguranca' | 'Treinamento' | 'InformacoesProcessosTrabalhistas'
classificacaostring nullable
nomestring nullable
tipoInscricao'CNPJ' | 'CEI' | 'NitPisPasep' | 'CPF' | 'CNO' | 'CAEPF'
inscricaostring nullable
inativoboolean
ativoInativoDesdestring date

Changes

No recorded changes to this operation across all 1 revision of this API.