Endpoint Estados (v1)
Descrição geral
Estados
URL
“/public-api/v1/commons/estado“
Verbos suportados
GET
Status HTTP
• 200 = OK;
• 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.
JSON Exemplo
{"id":1, "codigo":"Texto", "nome":"Texto", "codigoibge":0, "idpais":1, "exigeuffavorecida":0, "exigereceita":0, "exigecontribuinteemitente":0, "exigedatavencimento":0, "exigeconvenio":0, "exigedatapagamento":0, "convenio":"Texto"}
Exemplos
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/estado
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/estado/${id}
Lista dos campos do JSON
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
---|---|---|---|---|---|---|
id | ID | Inteiro | ||||
codigo | Código do estado | Caractere | 2 | |||
nome | Nome do estado | Caractere | 50 | |||
codigoibge | Código do estado conforme tabela oficial IBGE | Inteiro | ||||
idpais | Código do país conforme a tabela oficial IBGE | Inteiro | ||||
exigeuffavorecida | Identifica se exige UF favorecida na geração da GNRE | Inteiro | 0 – Não 1 – Sim | |||
exigereceita | Identifica se exige receita na geração da GNRE | Inteiro | 0 – Não 1 – Sim | |||
exigecontribuinteemitente | Identifica se exige contribuinte emitente na geração da GNRE | Inteiro | 0 – Não 1 – Sim | |||
exigedatavencimento | Identifica se exige data de vencimento na geração da GNRE | Inteiro | 0 – Não 1 – Sim | |||
exigeconvenio | Identifica se exige convênio na geração da GNRE | Inteiro | 0 – Não 1 – Sim | |||
exigedatapagamento | Identifica se exige data de pagamento na geração da GNRE | Inteiro | 0 – Não 1 – Sim | |||
convenio | Convênio | Caractere | 30 |
Conteúdo Relacionado
Os artigos listados abaixo estão relacionados ao que você acabou de ler:
• API Rest (WEB)
• Antes de Falar com o Suporte Técnico
• Obtendo suporte técnico e ajuda