POST/nfcom

Issue an electronic communication service invoice

The API validates the JSON schema and business rules. If everything is valid, you receive an ID for each invoice and the document is forwarded to SEFAZ. This route is asynchronous. Check status at GET /nfcom/{idOrChave}/resumo, or register a webhook on the organization or company. Notes: - Generate a unique idIntegracao per invoice. Duplicate requests with the same identifier are processed only once.

Production: https://api.otentecnologia.com.brSandbox: https://api.sandbox.otentecnologia.com.br

Parameters

This route has no path or query parameters.

Request

cURL

curl -X POST 'https://api.otentecnologia.com.br/nfcom' \
  -H 'x-api-key: $OTEN_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '[
  {
    "idIntegracao": "XXXYY999",
    "emitente": {
      "cpfCnpj": "08187168000160"
    },
    "informacoesNFCom": {
      "identificaoNFCom": {
        "codUF": 42,
        "tipoAmbiente": 2,
        "codMod": 62,
        "serie": "1",
        "numero": "55",
        "codNF": "1234567",
        "digitoChaveAcesso": "5",
        "dataEmissao": "2024-08-08",
        "horaEmissao": "09:00:10",
        "tipoEmissao": 1,
        "numeroSiteAutorizador": "0",
        "codigoMunicipio": "4205456",
        "finalidadeEmissao": 0,
        "tipoFaturamento": 0,
        "versaoEmissor": "1",
        "indicadorServico": 1
      },
      "destinatario": {
        "razaoSocial": "Empresa Exemplo",
        "cpfCnpj": "18590252000183",
        "indicadorIEDestinatario": 1,
        "inscricaoEstadual": "257109242",
        "telefone": {
          "ddd": "44",
          "numero": "999998886"
        },
        "email": "exemplo@oten.com.br",
        "endereco": {
          "logradouro": "Rua Exemplo",
          "numero": "112",
          "complemento": "complemento exemplo",
          "bairro": "bairro exemplo",
          "codigoCidade": "4205456",
          "descricaoCidade": "FORQUILHINHA",
          "cep": "89233198",
          "estado": "SC"
        }
      },
      "assinante": {
        "codigoUnicoAssinante": "1",
        "tipoAssinante": 1,
        "tipoServicoUtilizado": 1,
        "numeroContrato": "1234567890",
        "dataInicio": "2024-06-24",
        "dataTermino": "2024-12-24",
        "numeroTerminalPrincipal": "123456789123",
        "codUFTerminalPrincipal": 42,
        "terminaisAdicionais": [
          {
            "numeroTerminalAdicional": "123456789124",
            "codUFTerminalAdicional": 42
          }
        ]
      },
      "detalheProdutoServico": [
        {
          "numeroItem": "1",
          "prod": {
            "codProduto": "1",
            "descricaoProduto": "descrição exemplo do produto",
            "codClassificacao": "0100101",
            "unidadeBasicaMedida": 1,
            "quantidadeFatura": "1",
            "valorItem": "1.00",
            "valorTotalItem": "1.00"
          },
          "imposto": {
            "indSemSituacaoCST": {
              "valor": 1
            }
          }
        }
      ],
      "total": {
        "valorProdutoServicos": "1.00",
        "ICMSTotais": {
          "valorBase": "0.00",
          "valor": "0.00",
          "valorDesonerado": "0.00",
          "valorFCP": "0.00"
        },
        "valorCOFINS": "0.00",
        "valorPIS": "0.00",
        "valorFUNTTEL": "0.00",
        "valorFUST": "0.00",
        "totalRetencaoTributosFederais": {
          "valorPIS": "0.00",
          "valorCOFINS": "0.00",
          "valorCSLL": "0.00",
          "valorIRRF": "0.00"
        },
        "valorDesconto": "0.00",
        "outrasDespesas": "0.00",
        "valorTotalNFCom": "1.00"
      }
    }
  }
]'

Body

application/json

[
  {
    "idIntegracao": "XXXYY999",
    "emitente": {
      "cpfCnpj": "08187168000160"
    },
    "informacoesNFCom": {
      "identificaoNFCom": {
        "codUF": 42,
        "tipoAmbiente": 2,
        "codMod": 62,
        "serie": "1",
        "numero": "55",
        "codNF": "1234567",
        "digitoChaveAcesso": "5",
        "dataEmissao": "2024-08-08",
        "horaEmissao": "09:00:10",
        "tipoEmissao": 1,
        "numeroSiteAutorizador": "0",
        "codigoMunicipio": "4205456",
        "finalidadeEmissao": 0,
        "tipoFaturamento": 0,
        "versaoEmissor": "1",
        "indicadorServico": 1
      },
      "destinatario": {
        "razaoSocial": "Empresa Exemplo",
        "cpfCnpj": "18590252000183",
        "indicadorIEDestinatario": 1,
        "inscricaoEstadual": "257109242",
        "telefone": {
          "ddd": "44",
          "numero": "999998886"
        },
        "email": "exemplo@oten.com.br",
        "endereco": {
          "logradouro": "Rua Exemplo",
          "numero": "112",
          "complemento": "complemento exemplo",
          "bairro": "bairro exemplo",
          "codigoCidade": "4205456",
          "descricaoCidade": "FORQUILHINHA",
          "cep": "89233198",
          "estado": "SC"
        }
      },
      "assinante": {
        "codigoUnicoAssinante": "1",
        "tipoAssinante": 1,
        "tipoServicoUtilizado": 1,
        "numeroContrato": "1234567890",
        "dataInicio": "2024-06-24",
        "dataTermino": "2024-12-24",
        "numeroTerminalPrincipal": "123456789123",
        "codUFTerminalPrincipal": 42,
        "terminaisAdicionais": [
          {
            "numeroTerminalAdicional": "123456789124",
            "codUFTerminalAdicional": 42
          }
        ]
      },
      "detalheProdutoServico": [
        {
          "numeroItem": "1",
          "prod": {
            "codProduto": "1",
            "descricaoProduto": "descrição exemplo do produto",
            "codClassificacao": "0100101",
            "unidadeBasicaMedida": 1,
            "quantidadeFatura": "1",
            "valorItem": "1.00",
            "valorTotalItem": "1.00"
          },
          "imposto": {
            "indSemSituacaoCST": {
              "valor": 1
            }
          }
        }
      ],
      "total": {
        "valorProdutoServicos": "1.00",
        "ICMSTotais": {
          "valorBase": "0.00",
          "valor": "0.00",
          "valorDesonerado": "0.00",
          "valorFCP": "0.00"
        },
        "valorCOFINS": "0.00",
        "valorPIS": "0.00",
        "valorFUNTTEL": "0.00",
        "valorFUST": "0.00",
        "totalRetencaoTributosFederais": {
          "valorPIS": "0.00",
          "valorCOFINS": "0.00",
          "valorCSLL": "0.00",
          "valorIRRF": "0.00"
        },
        "valorDesconto": "0.00",
        "outrasDespesas": "0.00",
        "valorTotalNFCom": "1.00"
      }
    }
  }
]

Responses

200OK

JSON

{
  "documents": [
    {
      "idIntegracao": "XXXYY999999",
      "emitente": "08187168000160",
      "id": "5f6cb8936d8b321859b8fxxx"
    }
  ],
  "message": "Nota(as) em processamento",
  "protocol": "d6aafd45-c85f-40eb-ab02-c46d1855002f"
}

400Bad Request

JSON

{
  "error": {
    "message": "Falha na validação do JSON de MDFe",
    "data": {
      "fields": {
        "emitente": "Preenchimento obrigatório"
      }
    }
  }
}

401Unauthorized

JSON

{
  "error": {
    "message": "Token inválido"
  }
}

409Conflict

JSON

{
  "error": {
    "message": "Já existe um(a) NFCom com os parâmetros informados",
    "data": {
      "new": {
        "cnpj": "08187168000160",
        "idIntegracao": "XXXYY999999"
      },
      "current": {
        "id": "64623038402f6be08eefbb01",
        "idIntegracao": "XXXYY999999",
        "dataEmissao": "15/05/2023",
        "status": "CONCLUIDO",
        "emitente": "08187168000160",
        "cStat": 100,
        "numero": "478",
        "serie": "765",
        "chave": "41230529062609000177587650000004781156149927",
        "protocolo": "941230000013360",
        "mensagem": "Autorizado o uso do NFCom",
        "xml": "https://api.otentecnologia.com.br/nfcom/64623038402f6be08eefbb01/xml",
        "dataAutorizacao": "15/05/2023",
        "pdf": "https://api.otentecnologia.com.br/nfcom/64623038402f6be08eefbb01/pdf"
      }
    }
  }
}