Pular para o conteúdo principal

GET /nfce/cupom/{recibo}/completa

Consulta completa dos dados da NFCe por recibo.

Parâmetros​

  • recibo (string, path): Recibo da NFCe

Respostas​

200 - Status: 002 (Pendente de processamento)​

{
  "status": "002 (Pendente de processamento)",
  "descricao": "string"
}

200 - Status: 003 (Emitindo documento)​

{
  "status": "003 (Emitindo documento)",
  "descricao": "string",
  "data": {
    "id": "string",
    "numero": "string",
    "serie": "string",
    "cliente": {
      "tipo": "J", // Enum: [ F (Pessoa física), J (Pessoa jurídica) ]
      "nome": "string", // Este campo estara presente caso o cliente for do tipo F.
      "razao-social": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cnpj": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cpf": "string" // Este campo estara presente caso o cliente for do tipo F.
    },
    "valor-total": "string"
  }
}

200 - Status: 004 (Documento emitido)​

{
  "status": "004 (Documento emitido)",
  "descricao": "string",
  "data": {
    "id": "string",
    "numero": "string",
    "serie": "string",
    "cliente": {
      "tipo": "J", // Enum: [ F (Pessoa física), J (Pessoa jurídica) ]
      "nome": "string", // Este campo estara presente caso o cliente for do tipo F.
      "razao-social": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cnpj": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cpf": "string" // Este campo estara presente caso o cliente for do tipo F.
    },
    "itens": [
      {
        "id": "string",
        "produto": "string",
        "nome": "string",
        "quantidade": "string",
        "valor-unitario": "string"
      }
    ],
    "valor-total": "string",
    "valor-aproximado-tributo": "string",
    "sefaz": {
      "data-emissao": "string",
      "chave": "string",
      "protocolo": "string",
      "codigo": "string",
      "mensagem": "string",
      "url-danfe": "string",
      "url-xml": "string"
    }
  }
}

200 - Status: 010 (Documento cancelado)​

{
  "status": "010 (Documento cancelado)",
  "descricao": "string",
  "data": {
    "id": "string",
    "numero": "string",
    "serie": "string",
    "cliente": {
      "tipo": "J", // Enum: [ F (Pessoa física), J (Pessoa jurídica) ]
      "nome": "string", // Este campo estara presente caso o cliente for do tipo F.
      "razao-social": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cnpj": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cpf": "string" // Este campo estara presente caso o cliente for do tipo F.
    },
    "valor-total": "string",
    "valor-aproximado-tributo": "string",
    "sefaz": {
      "data-emissao": "string",
      "chave": "string",
      "protocolo": "string",
      "url-danfe": "string",
      "url-xml": "string"
    }
  }
}

200 - Status: 900 (Rejeição da SEFAZ)​

{
  "status": "900 (Rejeição da SEFAZ)",
  "descricao": "string",
  "data": {
    "id": "string",
    "numero": "string",
    "serie": "string",
    "cliente": {
      "tipo": "J", // Enum: [ F (Pessoa física), J (Pessoa jurídica) ]
      "nome": "string", // Este campo estara presente caso o cliente for do tipo F.
      "razao-social": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cnpj": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cpf": "string" // Este campo estara presente caso o cliente for do tipo F.
    },
    "sefaz": {
      "codigo": "string",
      "mensagem": "string"
    }
  }
}

200 - Status: 500 (Não existe)​

{
  "status": "500 (Não existe)",
  "descricao": "O recibo informado não existe em nossa base."
}

200 - Status: 999 (Erro interno)​

{
  "status": "999 (Erro interno)",
  "descricao": "string",
  "data": {
    "erro": "string"
  }
}

Observações​

Este endpoint exige autenticação.
Utilize os seguintes cabeçalhos:

Authorization: Token `token_da_empresa`
Content-Type: application/json

Exemplo de requisição​

GET https://api.mysebr.com.br/nfemyse-v3/rest/nfce/cupom/{recibo}/completa