Estado

Busca de Estados

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

get/api/empresarial/v1/estado

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

Query parameters

Nomestring
SiglaUFstring
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
nomestring nullable
nomePaisstring nullable
siglaUFstring nullable
exteriorboolean
regiaoGeografica'Invalido' | 'Sul' | 'Sudeste' | 'Norte' | 'Nordeste' | 'CentroOeste' | 'Exterior'
codigoSiniefinteger
codigoPaisinteger
mascaraInscricaoEstadualstring nullable
regiaoFiscal'Invalido' | 'Sul_Sudeste_MenosEspiritoSanto' | 'Norte_Nordeste_CentroOeste_MaisEspiritoSanto' | 'ZonaFrancaManaus_MaisExterior'
aliquotaSubstituicaoTributarianumber double
aliquotaInternaICMSnumber double
convenioICMSSTDifalboolean
convenioICMSPartilhadoboolean
calcularICMSPartilhadoConformeRegraEspecificaboolean

Changes

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