Sensio API
  1. NFes
Sensio API
  • Introdução
  • People
    • Buscar pessoas cadastradas
      GET
    • Cadastrar uma nova pessoa
      POST
    • Encontrar pessoa pelo Id
      GET
  • Items
    • Cadastrar um novo item
      POST
    • Retorna uma lista de itens
      GET
    • Retorna um item específico
      GET
    • Editar item
      POST
    • Retorna as composições do item e/ou das variações
      GET
  • POs
    • Retorna todas as ordens de produção
      GET
    • Retorna uma ordem de produção específica
      GET
    • Retorna uma ordem de produção específica buscando pelo código
      GET
    • Alterar estágio de OP
      PUT
    • Retorna estágios de produção
      GET
  • Sales
    • Retorna listagem de pedidos
      GET
    • Retorna todos as vendas (apenas vendas)
      GET
    • Retorna um pedido específico
      GET
    • Retorna um pedido específico, buscando pelo código
      GET
    • Cadastrar um novo pedido
      POST
    • Cancelar um pedido
      PUT
    • Faturar um pedido
      PUT
  • NFes
    • Lista as NFes
      GET
    • Retorna uma NFe específica
      GET
    • Retorna XML da NFe
      GET
    • Retorna DANFE da NFe
      GET
  • NFSes
    • Lista Notas Fiscais de Serviço
    • Retorna uma NFSe por id
    • Retorna XML da NFSe
    • Retorna PDF da NFSe
  • Transactions
    • Cadastrar um novo lançamento financeiro
    • Retorna lançamentos paginados
    • Retorna um lançamento específico
  • Item Categories
    • Listar categorias de itens
  • Warehouses
    • Lista os depósitos
  • Custom Fields
    • Listar Campos Personalizados
  • Batches
    • Retorna lotes de um item
    • Listar lotes
  • Webhooks
    • Atualiza a URL chamada ao criar uma NFe
    • Formato de chamada do webhook ao importar uma NFe
  • Services
    • Retorna serviços cadastrados
  • Accounting
    • Retorna contas contábeis
  • CTes
    • Retorna CTes
    • Retorna CTe pelo id
  1. NFes

Retorna uma NFe específica

GET
/nfes/nfe/{id}
NFes

Requisição

Parâmetros Path
id
string 
requerido

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/nfes/nfe/'

Respostas

🟢200OK
application/json
Response
Body
chave
string 
opcional
Chave de acesso da NFe
type
enum<string> 
opcional
Tipo da NFe
Valores permitidos:
SaídaEntrada
date
string 
opcional
Data da NFe
nNF
string 
opcional
Número da NFe
serie
string 
opcional
Série da NFe
status
enum<string> 
opcional
Status da NFe
Valores permitidos:
AutorizadaPendenteCanceladaDenegada
customer
string 
opcional
Destinatário/Emitente da NFe
sale
string 
opcional
Id do pedido associado (se houver)
vNF
number 
opcional
Valor total da NFe
dest
object (nfe_dest) 
opcional
personId
string 
opcional
Id do destinatário da NFe
CNPJ
string 
opcional
CNPJ do destinatário da NFe
CPF
string 
opcional
CPF do destinatário da NFe
xNome
string 
opcional
Nome do destinatário da NFe
IE
string 
opcional
Inscrição Estadual do destinatário da NFe
email
string 
opcional
Email do destinatário da NFe
enderDest
object (nfe_dest_enderDest) 
opcional
items
array[object (nfe_items) {2}] 
opcional
prod
object (nfe_prod) 
opcional
impostos
object (nfe_impostos) 
opcional
total
object (nfe_total) 
opcional
vBC
number 
opcional
Valor Total da Base de Cálculo
vICMS
number 
opcional
Valor Total do ICMS
vBCST
number 
opcional
Valor Total da Base de Cálculo ST
vST
number 
opcional
Valor Total do ICMS ST
vProd
number 
opcional
Valor Total dos Produtos
vFrete
number 
opcional
Valor Total do Frete
vDesc
number 
opcional
Valor Total do Desconto
vOutro
number 
opcional
Valor Total de Outras Despesas
vSeg
number 
opcional
Valor Total de Seguro
vIPI
number 
opcional
Valor Total do IPI
vPIS
number 
opcional
Valor Total do PIS
vCOFINS
number 
opcional
Valor Total do COFINS
vNF
number 
opcional
Valor Total da NFe
Exemplo
{
    "chave": "string",
    "type": "Saída",
    "date": "string",
    "nNF": "string",
    "serie": "string",
    "status": "Autorizada",
    "customer": "string",
    "sale": "string",
    "vNF": 0,
    "dest": {
        "personId": "string",
        "CNPJ": "string",
        "CPF": "string",
        "xNome": "string",
        "IE": "string",
        "email": "string",
        "enderDest": {
            "xLgr": "string",
            "nro": "string",
            "xCpl": "string",
            "xBairro": "string",
            "xMun": "string",
            "UF": "string",
            "CEP": "string",
            "xPais": "string",
            "fone": "string"
        }
    },
    "items": [
        {
            "prod": {
                "itemId": "string",
                "variationId": "string",
                "cProd": "string",
                "cProdOrig": "string",
                "xProd": "string",
                "xProdOrig": "string",
                "uCom": "string",
                "qCom": 0,
                "vUnCom": 0,
                "vProd": 0,
                "vFrete": 0,
                "vDesc": 0,
                "vOutro": 0,
                "vSeg": 0,
                "CFOP": "string",
                "NCM": "string",
                "CEST": "string"
            },
            "impostos": {
                "ICMS": {
                    "orig": "string",
                    "CST": "string",
                    "vBC": 0,
                    "pICMS": 0,
                    "vICMS": 0,
                    "vICMSST": 0
                },
                "IPI": {
                    "CST": "string",
                    "vBC": 0,
                    "pIPI": 0,
                    "vIPI": 0
                },
                "PIS": {
                    "CST": "string",
                    "vBC": 0,
                    "pPIS": 0,
                    "vPIS": 0
                },
                "COFINS": {
                    "CST": "string",
                    "vBC": 0,
                    "pCOFINS": 0,
                    "vCOFINS": 0
                }
            }
        }
    ],
    "total": {
        "vBC": 0,
        "vICMS": 0,
        "vBCST": 0,
        "vST": 0,
        "vProd": 0,
        "vFrete": 0,
        "vDesc": 0,
        "vOutro": 0,
        "vSeg": 0,
        "vIPI": 0,
        "vPIS": 0,
        "vCOFINS": 0,
        "vNF": 0
    }
}
🟠400Bad Request
🔴500Server Error
Página anterior
Lista as NFes
Próxima página
Retorna XML da NFe
Built with