Documentos - POST (V1)

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
NroNota	Numero do documento	integer	Obrigatório
Serie	Série do documento	string	Obrigatório
Emitente	Número indicador do cenário	Emitente	Obrigatório
NroEmpresa	Numero da empresa	integer	Obrigatório
DataEmissao	Data de emissão	date	Obrigatório
DataEntrada	Data de entrada	date	Obrigatório
CodModelo	Modelo	string	Obrigatório
ChaveAcessoNfe	Chave da acesso da NFe	string	None
ChaveAcessoNfse	Chave da acesso da NFSe	string	None
ValorTotal	Valor total do documento	decimal	Obrigatório
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 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
    }
  ]
}

Árvore de páginas