Central do Uniplus

Índice
< Todo o conteúdo
Imprimir

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

IdentificadorDescriçãoObrigatórioTipoTamanhoDecimaisObservações
idIDInteiro
codigoCódigo do estadoCaractere2
nomeNome do estadoCaractere50
codigoibgeCódigo do estado conforme tabela oficial IBGEInteiro
idpaisCódigo do país conforme a tabela oficial IBGEInteiro
exigeuffavorecidaIdentifica se exige UF favorecida na geração da GNREInteiro0 – Não
1 – Sim
exigereceitaIdentifica se exige receita na geração da GNREInteiro0 – Não
1 – Sim
exigecontribuinteemitenteIdentifica se exige contribuinte emitente na geração da GNREInteiro0 – Não
1 – Sim
exigedatavencimentoIdentifica se exige data de vencimento na geração da GNREInteiro0 – Não
1 – Sim
exigeconvenioIdentifica se exige convênio na geração da GNREInteiro0 – Não
1 – Sim
exigedatapagamentoIdentifica se exige data de pagamento na geração da GNREInteiro0 – Não
1 – Sim
convenioConvênioCaractere30

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

15 Artigos recentes

Ver os últimos 100