Como consultar resumo dos DFes recebidos?

Após consultar o último NSU é possível realizar uma consulta resumida de um documento recebido.

Confira mais detalhes no passo a passo abaixo.

---

Buscar os resumos dos documentos recebidos

1. Para começar, faça uma requisição tipo GET ao endpoint buscar os resumos dos documentos recebidos pelo MDe, utilizando o último NSU;

   [URL_BASE]/api/empresas/{empresa}/docs/{ambiente}/{codModelo}/mde/{ultimoNsu}

2. Preencha as seguintes informações (path parameters):

   • {empresa}*: CNPJ da empresa;
   • {ambiente}*: hom ou prod;
   • {codModelo}*: 55 (NFe), 57 (CTe), 58 (MDFe), 59 (CFe-SAT), 65 (NFCe), 66 (NF3e), 67 (CTeOS) ou 99 (NFSe);
   • {ultimoNsu}*: NSU da consulta.

3. Se precisar, preencha o seguinte parâmetro de consulta (query parameters):

   • {relacao}opcional: conforme a tabela abaixo:

Modelo DFe	Conta com módulo de emissão/importação	Conta com módulo de recebimento
NFe	emitente	destinatário, transportador, autorizados
NFCe	emitente	destinatário, transportador, autorizados
NFSe	emitente/prestador	destinatário/tomador, autorizados
MDFe	emitente	autorizados
CTe	emitente	destinatário, tomador, expedidor, autorizados
CTeOS	emitente	tomador, autorizados
CFe	emitente	destinatário, autorizados

4. Informe o x-auth-token no cabeçalho (header parameters) da requisição.

Exemplo de requisição

O exemplo abaixo traz um modelo de requisição preenchido para a consulta de um resumo dos documentos recebidos pelo MDe:

Observação

A requisição contém dados fictícios, somente para demonstração.

curl -L -X GET 'https://rest-teste.oobj.com.br/api/empresas/07385111000102/docs/hom/55/mde/0?relacao=destinatario' \
-H 'Accept: */*' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg'

Exemplo de retorno

{
  "cStat": 0,
  "dhResp": "string",
  "info": "string",
  "interessado": "string",
  "maxNSU": 0,
  "mod": 0,
  "nsu": 0,
  "relacaoDocumento": "EMITENTE",
  "resumos": [
    {
      "cfops": [
        "string"
      ],
      "chDFe": "string",
      "dhEmi": "string",
      "dhRecbto": "string",
      "dhRecebtoOobj": "string",
      "digVal": "string",
      "docEmit": "string",
      "ieEmit": "string",
      "mod": 0,
      "nomeEmit": "string",
      "nsu": 0,
      "numero": 0,
      "parcelas": [
        {
          "dataVencimento": "string",
          "nParcela": "string",
          "vParcela": 0
        }
      ],
      "prot": "string",
      "serie": 0,
      "sitDF": "string",
      "statusArquivo": "string",
      "temProc": false,
      "tpAmb": 0,
      "tpDF": 0,
      "vDF": 0
    }
  ],
  "tpAmb": 0,
  "ultNSU": 0,
  "verAplic": "string",
  "xMotivo": "string"
}

Pronto! Você acaba consultar o resumo de documentos recebidos utilizando como referência o último NSU.