Versions Compared

Old Version 3

changes.mady.by.user Amanda Vale

Saved on

compared with

New Version 4

changes.mady.by.user Filipe Tagliatti

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

O que é

Na consulta Receita Federal - Certidão de Débitos Relativos a Créditos Tributários Federais e à Dívida Ativa da União - você pode atestar se uma pessoa ou empresa possui dívidas relacionadas a tributos federais e à dívida ativa da união.

Veja mais informações em nossa central de ajuda: Receita Federal - Certidão de Débitos Relativos a Créditos Tributários Federais e à Dívida Ativa da União

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/receita/certidao-negativa

...

Include Page
URL Base
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 Bearer

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

cpfCnpj

string

Sim

CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99

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

Code Block
{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

Code Block
{
  "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

atencao

Ocorre quando o documento informado não existe

positiva_negativa

Certidão positiva com efeitos de negativa

atencao

O documento possui alguma anormalidade, para mais detalhes você deve observar o campo situacao e mensagem.

Valores possíveis do campo “situacao“

Status

Significado

suspenso

inexistente

baixado

anulado

nula

irregular

Resposta com registro encontrado

...