Documentos - GET {id} (V1)

Objetivo

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

Chamada

GET [URLAPI]/IntegracaoNFDApi/api/v1/Documentos/{id}

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

Parâmetros URI (URI Parameters)

Nome	Descrição	Tipo	Informações Adicionais
id	id do documento	integer	None
fields	colunas que deseja retornar	string	None
expand	colunas que deseja expandir	string	as colunas possíveis são retornadas em expandables

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição dos Dados

DocumentoResponseDto

application/json

{
  "expandables": [
    "string"
  ],
  "id": 0,
  "nroNota": 0,
  "serie": "string",
  "emitente": {
    "tipoDocumento": "stri",
    "numeroDocumento": "string",
    "razaoSocial": "string"
  },
  "nroEmpresa": 0,
  "dataEmissao": "2025-04-14T14:42:38.461Z",
  "dataEntrada": "2025-04-14T14:42:38.461Z",
  "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-14T14:42:38.461Z",
      "valor": 0
    }
  ]
}

Árvore de páginas