PGE SP - Dívida Ativa
- Amanda Vale (Unlicensed)
- Filipe Tagliatti (Unlicensed)
O que é
Na consulta PGE - Dívida Ativa - você verifica se uma pessoa ou empresa possui dívida ativa no estado de São Paulo. A dívida ativa inclui vários tipos de débitos, como IPVA, ICMS.
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/pge-sp/divida-ativa
URL Base:
Parâmetros do header
Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com |
Callback | String | Não | URL para onde o resultado da requisição será enviado via HTTP POST. |
Parâmetros do body
Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
cpf | String | Obrigatório se nenhum outro parâmetro for informado | CPF a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99 |
cnpj | String | Obrigatório se nenhum outro parâmetro for informado | CNPJ a ser pesquisado, com ou sem máscara |
cnpjBase | String | Obrigatório se nenhum outro parâmetro for informado | Raiz do CNPJ, primeira parte, com números antes da / ( barra ). |
aiim | String | Obrigatório se nenhum outro parâmetro for informado | Número do AIIM - Auto de Infração e Imposição de Multa |
etiqueta | String | Obrigatório se nenhum outro parâmetro for informado |
|
inscricaoEstadualSp | String | Obrigatório se nenhum outro parâmetro for informado | Inscrição estadual, com ou sem máscara |
renavam | String | Obrigatório se nenhum outro parâmetro for informado | Renavam do veículo |
Retornos possíveis da requisição
Status | Significado | Descrição | Informações retornadas |
|---|---|---|---|
201 | Created | Solicitação criada | Campo requestId, com o ID da requisição criada. |
422 | Unprocessable Entity | A solicitação contém erro | Em quais campos houve erro. |
Exemplos de retornos
Status 201
{
"requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
} |
Status 422
{
"message": "The given data was invalid.",
"errors": {
"cpf": [
"O campo cpf é obrigatório."
],
"nome": [
"O campo name é obrigatório."
]
}
} |
Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )
Valores possíveis do campo “status“
Status | Significado |
|---|---|
negativa | NÃO foram encontrados débitos para o documento pesquisado |
positiva | Foram encontrados débitos relacionados ao documento pesquisado |
Resposta com registro encontrado
{
"status": "positivo",
"nome": "NOME DA EMPRESA",
"cpfCnpj": "00.000.000/0001-00",
"dividas": [
{
"tipo": "ICMS Declarado",
"quantidade": 61,
"origem": "SECRETARIA DA FAZENDA",
"total": 25881200.23
},
{
"tipo": "ICMS Autuação",
"quantidade": 5,
"origem": "SECRETARIA DA FAZENDA",
"total": 456433652.44
},
{
"tipo": "Multa Contratual",
"quantidade": 1,
"origem": "SECRETARIA DE SEGURANÇA PÚBLICA",
"total": 8827.83
},
{
"tipo": "IPVA",
"quantidade": 76,
"origem": "SECRETARIA DA FAZENDA",
"total": 145071.01
}
]
}