Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

O que é

Com a consulta Receita - Certidão Negativa de Débitos Relativos às Contribuições Previdenciárias e às de Terceiros é possível realizar as consulta de Certidão Negativa de Débito (CND) / Certidão Positiva de Débito com Efeitos de Negativa (CPD-EN) da Receita Federal.

Veja mais informações em nossa central de ajuda: Receita - Certidão Negativa de Débitos Relativos às Contribuições Previdenciárias

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/receita/certidao-negativa-debitos-contribuicoes-previdenciarias-terceiros

URL Base: https://api.plexi.com.br/

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

cnpj

String

Obrigatório se o campo “cei“ não for preenchido

CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 9999999999999 ou 99.999.999/0009-99

cei

String

Obrigatório se o campo “cnpj“ não for preenchido

CEI válido, com ou sem máscara.

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": {
    "cnpj": [
      "O campo cnpj é obrigatório."
    ],
    "cei": [
      "O campo cei é obrigatório."
    ]
  }
}

 

Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )

Valores possíveis do campo “status“

Status

Significado

negativo

Certidão consta como uma certidão negativa.

positivo_negativo

Certidão consta como uma certidão positiva com efeito de negativa.

erro

Não há certidão emitida para o estabelecimento.

Resposta com registro encontrado

{
    "status": "negativo",
    "fin": "1",
    "dataEmissao": "01/01/2022",
    "numero": "11111111-22222222",
    "nome": "EMPRESA X LTDA",
    "cnpj": "11111111/0000-00",
    "dataValidade": "01/01/2022",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUg..."
}
{
    "status": "positivo_negativo",
    "fin": "1",
    "dataEmissao": "01/01/2022",
    "numero": "11111111-22222222",
    "nome": "EMPRESA X LTDA",
    "cnpj": "11111111/0000-00",
    "dataValidade": "01/01/2022",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUg..."
}

Resposta com erro

{
  "status": "erro",
  "mensagem": "Este documento não possui certidão."
  "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUg..."
}

 

  • No labels