Objetivo

A finalidade deste método é inserir documento de despesa para integração.

Chamada

POST [URLAPI]/IntegracaoNFDApi/api/v1/Documentos

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

Parâmetros URI (URI Parameters)

Nenhum.

Parâmetros do Corpo (Body Parameters)

DocumentoRequestDto

Nome

Descrição

Tipo

Informações Adicionais

NroNotaNumero do documentointegerNone
SerieSérie do documentostringNone
EmitenteNúmero indicador do cenárioEmitenteNone
NroEmpresaNumero da empresaintegerNone
DataEmissaoData de emissãodateNone
DataEntradaData de entradadateNone
CodModeloModelostringNone
ChaveAcessoNfeChave da acesso da NFestringNone
ChaveAcessoNfseChave da acesso da NFSestringNone
ValorTotalValor total do documentodecimalNone
ValorDescontoValor de descontodecimalNone
IrInformações de Base e Valor IrImpostoNone
IssInformações de Base e Valor IssImpostoNone
PisInformações de Base e Valor PisImpostoNone
CofinsInformações de Base e Valor CofinsImpostoNone
CssllInformações de Base e Valor CssllImpostoNone
IcmsInformações de Base, Valor, Outras e Isento IcmsImpostoIcmsNone
Observacao
stringNone
InfoFiscoInformações adicionais para o FiscostringNone
CodNaturezaDespesaCódigo da Natureza de despesaintegerNone
CteDados do CTe, CifFob, Tipo, CodMunicipioOrigem e CodMunicipioDestinoCteNone
ItensLista de itensList<DocumentoItemDto>None
VencimentosLista de vencimentosList<DocumentoVencimentoDto>None

Formatos da Requisição (Request Formats)

application/json


{
  "nroNota": 999999999999999,
  "serie": "stri",
  "emitente": {
    "tipoDocumento": "stri",
    "numeroDocumento": "string",
    "razaoSocial": "string"
  },
  "nroEmpresa": 0,
  "dataEmissao": "2025-04-14T14:37:03.649Z",
  "dataEntrada": "2025-04-14T14:37:03.649Z",
  "codModelo": "st",
  "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": 9999999,
  "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:37:03.649Z",
      "valor": 0
    }
  ]
}

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Descrição dos Dados

Status Code 201 – Created

DocumentoResponseDto



{
  "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
    }
  ]
}

400 Bad Request


{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}