InformacaoComplementar

Busca do cadastro de Informações Complementares

Lê uma lista de cadastros de Informações Complementares com base no filtro informado na URL da requisição.

get/api/empresarial/v1/informacao-complementar

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/empresarial/v1/informacao-complementar
  • Auth: HTTP bearer

Query parameters

Grupo'Todos' | 'Grupo1' | 'Grupo2' | 'Grupo3'
Situacao'Todos' | 'Inativo' | 'Ativo'
Descricaostring

Esse campo aceita o caractere coringa (*) podendo ser usado antes (*Teste), depois (Teste*), ou antes e depois do texto (*Teste*). Ao usar o caractere coringa, será retornado todas as Informações Complementares que começarem e/ou terminarem com o texto informado.

Codigostring

Esse campo aceita o caractere coringa (*) podendo ser usado antes (*1), depois (1*), ou antes e depois do código (*1*). Ao usar o caractere coringa, será retornado todas as Informações Complementares que começarem e/ou terminarem com o código informado.

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
codigostring nullable
tipo'Grupo' | 'Analitica'
descricaostring nullable
inativoboolean

Changes

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