Documentos - GET (V1)

Objetivo

A finalidade deste método é possibilitar a consulta de documentos já enviados para integração.

Chamada

GET [URLAPI]/IntegracaoNFDApi/api/v1/Documentos?NroNota={NroNota}&Serie={Serie}&EmitenteNumeroDocumento={EmitenteNumeroDocumento}&NroEmpresa={NroEmpresa}&DataEmissao={DataEmissao}&DataEntrada={DataEntrada}&CodModelo={CodModelo}&ChaveAcessoNfe={ChaveAcessoNfe}&ChaveAcessoNfse={ChaveAcessoNfse}&Fields={Fields}&Order={Order}&Page={Page}&PageSize={PageSize}

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome	Descrição	Tipo	Informações Adicionais
NroNota	Numero do documento	string	None
Serie	Serie do documento	string	None
EmitenteNumeroDocumento	CPF ou CNPJ do Emitente	string	None
NroEmpresa	Numero da Empresa	integer	None
DataEmissao	Data de emissão	date	None
DataEntrada	Data de entrada	date	None
CodModelo	Modelo	string	None
ChaveAcessoNfe	Chave de acesso da NFe	string	None
ChaveAcessoNfse	Chave de acesso da NFse	string	None
Fields	Quais campos deseja visualizar	string	None
Order	Por qual campo deseja Ordenar	string	None
Page	Numero da Página	integer	None
PageSize	Tamanho da Página	integer	None

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição dos Dados

IListDto<DocumentoResponseDto>– Lista de cenários de Documentos

DocumentoResponseDto

Nome	Descrição	Tipo	Informações Adicionais
Id	Identificador único do Documento	integer	None
NroNota	Numero do documento	integer	None
Serie	Série do documento	string	None
Emitente	Número indicador do cenário	Emitente	None
NroEmpresa	Numero da empresa	integer	None
DataEmissao	Data de emissão	date	None
DataEntrada	Data de entrada	date	None
CodModelo	Modelo	string	None
ChaveAcessoNfe	Chave da acesso da NFe	string	None
ChaveAcessoNfse	Chave da acesso da NFSe	string	None
ValorTotal	Valor total do documento	decimal	None
ValorDesconto	Valor de desconto	decimal	None
Ir	Informações de Base e Valor Ir	Imposto	None
Iss	Informações de Base e Valor Iss	Imposto	None
Pis	Informações de Base e Valor Pis	Imposto	None
Cofins	Informações de Base e Valor Cofins	Imposto	None
Cssll	Informações de Base e Valor Cssll	Imposto	None
Icms	Informações de Base, Valor, Outras e Isento Icms	ImpostoIcms	None
Observacao		string	None
InfoFisco	Informações adicionais para o Fisco	string	None
CodNaturezaDespesa	Código da Natureza de despesa	integer	None
Cte	Dados do CTe, CifFob, Tipo, CodMunicipioOrigem e CodMunicipioDestino	Cte	None
Itens	Lista de itens	List<DocumentoItemDto>	None
Vencimentos	Lista de vencimentos	List<DocumentoVencimentoDto>	None

Formatos de Resposta (Response Formats)

application/json, text/json

{
  "hasNext": true,
  "items": [
    {
      "expandables": [
        "string"
      ],
      "id": 0,
      "nroNota": 0,
      "serie": "string",
      "emitente": {
        "tipoDocumento": "stri",
        "numeroDocumento": "string",
        "razaoSocial": "string"
      },
      "nroEmpresa": 0,
      "dataEmissao": "2025-04-14T12:48:15.389Z",
      "dataEntrada": "2025-04-14T12:48:15.390Z",
      "codModelo": "string",
      "chaveAcessoNfe": "string",
      "chaveAcessoNfse": "string",
      "valorTotal": 0,
      "valorDesconto": 0,
      "ir": {
        "base": 0,
        "valor": 0
      },
      "iss": {
        "base": 0,
        "valor": 0
      },
      "pis": {
        "base": 0,
        "valor": 0
      },
      "cofins": {
        "base": 0,
        "valor": 0
      },
      "cssll": {
        "base": 0,
        "valor": 0
      },
      "icms": {
        "base": 0,
        "valor": 0,
        "outras": 0,
        "isento": 0
      },
      "observacao": "string",
      "infoFisco": "string",
      "codNaturezaDespesa": 0,
      "cte": {
        "tipo": 0,
        "codMunicipioOrigem": 999999999999,
        "codMunicipioDestino": 999999999999
      },
      "itens": [
        {
          "codProduto": "string",
          "descricao": "string",
          "cfop": 0,
          "codNcm": "string",
          "unidade": "string",
          "quantidade": 0,
          "valor": 0,
          "valorTotal": 0,
          "desconto": 0,
          "icms": {
            "base": 0,
            "aliquota": 0,
            "valor": 0,
            "perCredBase": 0,
            "baseSt": 0,
            "valorDif": 0
          },
          "pis": {
            "base": 0,
            "aliquota": 0,
            "valor": 0
          },
          "cofins": {
            "base": 0,
            "aliquota": 0,
            "valor": 0
          },
          "iss": {
            "base": 0,
            "aliquota": 0,
            "valor": 0
          },
          "ipi": {
            "base": 0,
            "aliquota": 0,
            "valor": 0
          }
        }
      ],
      "vencimentos": [
        {
          "dataVencimento": "2025-04-14T12:48:15.390Z",
          "valor": 0
        }
      ]
    }
  ]
}

Árvore de páginas