Filial

Busca de Empresas/Filiais

Lê uma lista de Empresas/Filiais com base no filtro informado na URL da requisição.

get/api/empresarial/v1/filial

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/filial
  • Auth: HTTP bearer

Query parameters

CodigoInicialinteger
CodigoFinalinteger
Identificacaostring
RazaoSocialstring
CpfCnpjstring
UFstring
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
identificacaostring nullable
razaoSocialstring nullable
nomeFantasiastring nullable
cpfCnpjstring nullable
situacao'Invalido' | 'Ativa' | 'Inativa' | 'SemMovimento' | 'Abandonada' | 'Baixada'
estabelecimento'Invalido' | 'Matriz' | 'Filial'
idMatrizstring nullable
ufstring nullable
inscricaoEstadualstring nullable
inscricaoMunicipalstring nullable

Changes

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