Atualizar registro de NF-e
curl --request PATCH \
--url https://api.engineapi.com.br/v1/nfe/{id} \
--header 'Content-Type: application/json' \
--data '
{
"issuerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"naturezaOperacao": "<string>",
"serie": 0,
"numero": 0,
"tpNF": 0,
"idDest": 0,
"indFinal": 0,
"indPres": 0,
"finNFe": 0,
"items": [
{
"codigo": "<string>",
"descricao": "<string>",
"ncm": "<string>",
"cfop": "<string>",
"unidade": "<string>",
"quantidade": 1.0001,
"valorUnitario": 1.01,
"ean": "<string>",
"cest": "<string>",
"cBenef": "<string>",
"valorTotal": 123,
"desconto": 1,
"valorFrete": 1,
"valorSeguro": 1,
"outrasDespesas": 1,
"indTot": 123,
"icms": {
"origem": 0,
"cst": "<string>",
"csosn": "<string>",
"aliquota": 123,
"baseCalculo": 123,
"valor": 123,
"baseCalculoST": 123,
"aliquotaST": 123,
"valorST": 123,
"qBCMono": 123,
"adRemICMS": 123,
"vICMSMono": 123,
"qBCMonoRet": 123,
"adRemICMSRet": 123,
"vICMSMonoRet": 123
},
"pis": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123
},
"cofins": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123
},
"ipi": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123,
"cEnq": "<string>"
},
"ibsCbs": {
"ibsUf": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"ibsMun": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"cbs": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"cst": "<string>",
"cClassTrib": "<string>",
"vBC": 1,
"vIbs": 1
}
}
],
"pagamentos": [
{
"valor": 1
}
],
"troco": 1,
"cobranca": {
"duplicatas": [
{
"vencimento": "<string>",
"valor": 1.01,
"numero": "<string>"
}
]
},
"informacoesComplementares": "<string>",
"informacoesFisco": "<string>",
"resolverTributacao": true
}
'import requests
url = "https://api.engineapi.com.br/v1/nfe/{id}"
payload = {
"issuerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"naturezaOperacao": "<string>",
"serie": 0,
"numero": 0,
"tpNF": 0,
"idDest": 0,
"indFinal": 0,
"indPres": 0,
"finNFe": 0,
"items": [
{
"codigo": "<string>",
"descricao": "<string>",
"ncm": "<string>",
"cfop": "<string>",
"unidade": "<string>",
"quantidade": 1.0001,
"valorUnitario": 1.01,
"ean": "<string>",
"cest": "<string>",
"cBenef": "<string>",
"valorTotal": 123,
"desconto": 1,
"valorFrete": 1,
"valorSeguro": 1,
"outrasDespesas": 1,
"indTot": 123,
"icms": {
"origem": 0,
"cst": "<string>",
"csosn": "<string>",
"aliquota": 123,
"baseCalculo": 123,
"valor": 123,
"baseCalculoST": 123,
"aliquotaST": 123,
"valorST": 123,
"qBCMono": 123,
"adRemICMS": 123,
"vICMSMono": 123,
"qBCMonoRet": 123,
"adRemICMSRet": 123,
"vICMSMonoRet": 123
},
"pis": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123
},
"cofins": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123
},
"ipi": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123,
"cEnq": "<string>"
},
"ibsCbs": {
"ibsUf": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"ibsMun": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"cbs": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"cst": "<string>",
"cClassTrib": "<string>",
"vBC": 1,
"vIbs": 1
}
}
],
"pagamentos": [{ "valor": 1 }],
"troco": 1,
"cobranca": { "duplicatas": [
{
"vencimento": "<string>",
"valor": 1.01,
"numero": "<string>"
}
] },
"informacoesComplementares": "<string>",
"informacoesFisco": "<string>",
"resolverTributacao": True
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
issuerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
naturezaOperacao: '<string>',
serie: 0,
numero: 0,
tpNF: 0,
idDest: 0,
indFinal: 0,
indPres: 0,
finNFe: 0,
items: [
{
codigo: '<string>',
descricao: '<string>',
ncm: '<string>',
cfop: '<string>',
unidade: '<string>',
quantidade: 1.0001,
valorUnitario: 1.01,
ean: '<string>',
cest: '<string>',
cBenef: '<string>',
valorTotal: 123,
desconto: 1,
valorFrete: 1,
valorSeguro: 1,
outrasDespesas: 1,
indTot: 123,
icms: {
origem: 0,
cst: '<string>',
csosn: '<string>',
aliquota: 123,
baseCalculo: 123,
valor: 123,
baseCalculoST: 123,
aliquotaST: 123,
valorST: 123,
qBCMono: 123,
adRemICMS: 123,
vICMSMono: 123,
qBCMonoRet: 123,
adRemICMSRet: 123,
vICMSMonoRet: 123
},
pis: {cst: '<string>', baseCalculo: 123, aliquota: 123, valor: 123},
cofins: {cst: '<string>', baseCalculo: 123, aliquota: 123, valor: 123},
ipi: {cst: '<string>', baseCalculo: 123, aliquota: 123, valor: 123, cEnq: '<string>'},
ibsCbs: {
ibsUf: {p: 1, pNominal: 1, pRedAliq: 50, v: 1},
ibsMun: {p: 1, pNominal: 1, pRedAliq: 50, v: 1},
cbs: {p: 1, pNominal: 1, pRedAliq: 50, v: 1},
cst: '<string>',
cClassTrib: '<string>',
vBC: 1,
vIbs: 1
}
}
],
pagamentos: [{valor: 1}],
troco: 1,
cobranca: {duplicatas: [{vencimento: '<string>', valor: 1.01, numero: '<string>'}]},
informacoesComplementares: '<string>',
informacoesFisco: '<string>',
resolverTributacao: true
})
};
fetch('https://api.engineapi.com.br/v1/nfe/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.engineapi.com.br/v1/nfe/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'issuerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'naturezaOperacao' => '<string>',
'serie' => 0,
'numero' => 0,
'tpNF' => 0,
'idDest' => 0,
'indFinal' => 0,
'indPres' => 0,
'finNFe' => 0,
'items' => [
[
'codigo' => '<string>',
'descricao' => '<string>',
'ncm' => '<string>',
'cfop' => '<string>',
'unidade' => '<string>',
'quantidade' => 1.0001,
'valorUnitario' => 1.01,
'ean' => '<string>',
'cest' => '<string>',
'cBenef' => '<string>',
'valorTotal' => 123,
'desconto' => 1,
'valorFrete' => 1,
'valorSeguro' => 1,
'outrasDespesas' => 1,
'indTot' => 123,
'icms' => [
'origem' => 0,
'cst' => '<string>',
'csosn' => '<string>',
'aliquota' => 123,
'baseCalculo' => 123,
'valor' => 123,
'baseCalculoST' => 123,
'aliquotaST' => 123,
'valorST' => 123,
'qBCMono' => 123,
'adRemICMS' => 123,
'vICMSMono' => 123,
'qBCMonoRet' => 123,
'adRemICMSRet' => 123,
'vICMSMonoRet' => 123
],
'pis' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'valor' => 123
],
'cofins' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'valor' => 123
],
'ipi' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'valor' => 123,
'cEnq' => '<string>'
],
'ibsCbs' => [
'ibsUf' => [
'p' => 1,
'pNominal' => 1,
'pRedAliq' => 50,
'v' => 1
],
'ibsMun' => [
'p' => 1,
'pNominal' => 1,
'pRedAliq' => 50,
'v' => 1
],
'cbs' => [
'p' => 1,
'pNominal' => 1,
'pRedAliq' => 50,
'v' => 1
],
'cst' => '<string>',
'cClassTrib' => '<string>',
'vBC' => 1,
'vIbs' => 1
]
]
],
'pagamentos' => [
[
'valor' => 1
]
],
'troco' => 1,
'cobranca' => [
'duplicatas' => [
[
'vencimento' => '<string>',
'valor' => 1.01,
'numero' => '<string>'
]
]
],
'informacoesComplementares' => '<string>',
'informacoesFisco' => '<string>',
'resolverTributacao' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.engineapi.com.br/v1/nfe/{id}"
payload := strings.NewReader("{\n \"issuerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"naturezaOperacao\": \"<string>\",\n \"serie\": 0,\n \"numero\": 0,\n \"tpNF\": 0,\n \"idDest\": 0,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 0,\n \"items\": [\n {\n \"codigo\": \"<string>\",\n \"descricao\": \"<string>\",\n \"ncm\": \"<string>\",\n \"cfop\": \"<string>\",\n \"unidade\": \"<string>\",\n \"quantidade\": 1.0001,\n \"valorUnitario\": 1.01,\n \"ean\": \"<string>\",\n \"cest\": \"<string>\",\n \"cBenef\": \"<string>\",\n \"valorTotal\": 123,\n \"desconto\": 1,\n \"valorFrete\": 1,\n \"valorSeguro\": 1,\n \"outrasDespesas\": 1,\n \"indTot\": 123,\n \"icms\": {\n \"origem\": 0,\n \"cst\": \"<string>\",\n \"csosn\": \"<string>\",\n \"aliquota\": 123,\n \"baseCalculo\": 123,\n \"valor\": 123,\n \"baseCalculoST\": 123,\n \"aliquotaST\": 123,\n \"valorST\": 123,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123,\n \"cEnq\": \"<string>\"\n },\n \"ibsCbs\": {\n \"ibsUf\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"ibsMun\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cbs\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cst\": \"<string>\",\n \"cClassTrib\": \"<string>\",\n \"vBC\": 1,\n \"vIbs\": 1\n }\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1\n }\n ],\n \"troco\": 1,\n \"cobranca\": {\n \"duplicatas\": [\n {\n \"vencimento\": \"<string>\",\n \"valor\": 1.01,\n \"numero\": \"<string>\"\n }\n ]\n },\n \"informacoesComplementares\": \"<string>\",\n \"informacoesFisco\": \"<string>\",\n \"resolverTributacao\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.engineapi.com.br/v1/nfe/{id}")
.header("Content-Type", "application/json")
.body("{\n \"issuerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"naturezaOperacao\": \"<string>\",\n \"serie\": 0,\n \"numero\": 0,\n \"tpNF\": 0,\n \"idDest\": 0,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 0,\n \"items\": [\n {\n \"codigo\": \"<string>\",\n \"descricao\": \"<string>\",\n \"ncm\": \"<string>\",\n \"cfop\": \"<string>\",\n \"unidade\": \"<string>\",\n \"quantidade\": 1.0001,\n \"valorUnitario\": 1.01,\n \"ean\": \"<string>\",\n \"cest\": \"<string>\",\n \"cBenef\": \"<string>\",\n \"valorTotal\": 123,\n \"desconto\": 1,\n \"valorFrete\": 1,\n \"valorSeguro\": 1,\n \"outrasDespesas\": 1,\n \"indTot\": 123,\n \"icms\": {\n \"origem\": 0,\n \"cst\": \"<string>\",\n \"csosn\": \"<string>\",\n \"aliquota\": 123,\n \"baseCalculo\": 123,\n \"valor\": 123,\n \"baseCalculoST\": 123,\n \"aliquotaST\": 123,\n \"valorST\": 123,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123,\n \"cEnq\": \"<string>\"\n },\n \"ibsCbs\": {\n \"ibsUf\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"ibsMun\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cbs\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cst\": \"<string>\",\n \"cClassTrib\": \"<string>\",\n \"vBC\": 1,\n \"vIbs\": 1\n }\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1\n }\n ],\n \"troco\": 1,\n \"cobranca\": {\n \"duplicatas\": [\n {\n \"vencimento\": \"<string>\",\n \"valor\": 1.01,\n \"numero\": \"<string>\"\n }\n ]\n },\n \"informacoesComplementares\": \"<string>\",\n \"informacoesFisco\": \"<string>\",\n \"resolverTributacao\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engineapi.com.br/v1/nfe/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"issuerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"naturezaOperacao\": \"<string>\",\n \"serie\": 0,\n \"numero\": 0,\n \"tpNF\": 0,\n \"idDest\": 0,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 0,\n \"items\": [\n {\n \"codigo\": \"<string>\",\n \"descricao\": \"<string>\",\n \"ncm\": \"<string>\",\n \"cfop\": \"<string>\",\n \"unidade\": \"<string>\",\n \"quantidade\": 1.0001,\n \"valorUnitario\": 1.01,\n \"ean\": \"<string>\",\n \"cest\": \"<string>\",\n \"cBenef\": \"<string>\",\n \"valorTotal\": 123,\n \"desconto\": 1,\n \"valorFrete\": 1,\n \"valorSeguro\": 1,\n \"outrasDespesas\": 1,\n \"indTot\": 123,\n \"icms\": {\n \"origem\": 0,\n \"cst\": \"<string>\",\n \"csosn\": \"<string>\",\n \"aliquota\": 123,\n \"baseCalculo\": 123,\n \"valor\": 123,\n \"baseCalculoST\": 123,\n \"aliquotaST\": 123,\n \"valorST\": 123,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123,\n \"cEnq\": \"<string>\"\n },\n \"ibsCbs\": {\n \"ibsUf\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"ibsMun\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cbs\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cst\": \"<string>\",\n \"cClassTrib\": \"<string>\",\n \"vBC\": 1,\n \"vIbs\": 1\n }\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1\n }\n ],\n \"troco\": 1,\n \"cobranca\": {\n \"duplicatas\": [\n {\n \"vencimento\": \"<string>\",\n \"valor\": 1.01,\n \"numero\": \"<string>\"\n }\n ]\n },\n \"informacoesComplementares\": \"<string>\",\n \"informacoesFisco\": \"<string>\",\n \"resolverTributacao\": true\n}"
response = http.request(request)
puts response.read_bodyNFe
Atualizar registro de NF-e
Atualiza campos do registro interno de uma NF-e ainda não autorizada. Documentos com status AUTHORIZED ou CANCELED são imutáveis (regra de negócio BR-130) e a chamada é recusada com 403. Não altera nada na SEFAZ, só o registro local antes do envio.
PATCH
/
v1
/
nfe
/
{id}
Atualizar registro de NF-e
curl --request PATCH \
--url https://api.engineapi.com.br/v1/nfe/{id} \
--header 'Content-Type: application/json' \
--data '
{
"issuerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"naturezaOperacao": "<string>",
"serie": 0,
"numero": 0,
"tpNF": 0,
"idDest": 0,
"indFinal": 0,
"indPres": 0,
"finNFe": 0,
"items": [
{
"codigo": "<string>",
"descricao": "<string>",
"ncm": "<string>",
"cfop": "<string>",
"unidade": "<string>",
"quantidade": 1.0001,
"valorUnitario": 1.01,
"ean": "<string>",
"cest": "<string>",
"cBenef": "<string>",
"valorTotal": 123,
"desconto": 1,
"valorFrete": 1,
"valorSeguro": 1,
"outrasDespesas": 1,
"indTot": 123,
"icms": {
"origem": 0,
"cst": "<string>",
"csosn": "<string>",
"aliquota": 123,
"baseCalculo": 123,
"valor": 123,
"baseCalculoST": 123,
"aliquotaST": 123,
"valorST": 123,
"qBCMono": 123,
"adRemICMS": 123,
"vICMSMono": 123,
"qBCMonoRet": 123,
"adRemICMSRet": 123,
"vICMSMonoRet": 123
},
"pis": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123
},
"cofins": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123
},
"ipi": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123,
"cEnq": "<string>"
},
"ibsCbs": {
"ibsUf": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"ibsMun": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"cbs": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"cst": "<string>",
"cClassTrib": "<string>",
"vBC": 1,
"vIbs": 1
}
}
],
"pagamentos": [
{
"valor": 1
}
],
"troco": 1,
"cobranca": {
"duplicatas": [
{
"vencimento": "<string>",
"valor": 1.01,
"numero": "<string>"
}
]
},
"informacoesComplementares": "<string>",
"informacoesFisco": "<string>",
"resolverTributacao": true
}
'import requests
url = "https://api.engineapi.com.br/v1/nfe/{id}"
payload = {
"issuerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"naturezaOperacao": "<string>",
"serie": 0,
"numero": 0,
"tpNF": 0,
"idDest": 0,
"indFinal": 0,
"indPres": 0,
"finNFe": 0,
"items": [
{
"codigo": "<string>",
"descricao": "<string>",
"ncm": "<string>",
"cfop": "<string>",
"unidade": "<string>",
"quantidade": 1.0001,
"valorUnitario": 1.01,
"ean": "<string>",
"cest": "<string>",
"cBenef": "<string>",
"valorTotal": 123,
"desconto": 1,
"valorFrete": 1,
"valorSeguro": 1,
"outrasDespesas": 1,
"indTot": 123,
"icms": {
"origem": 0,
"cst": "<string>",
"csosn": "<string>",
"aliquota": 123,
"baseCalculo": 123,
"valor": 123,
"baseCalculoST": 123,
"aliquotaST": 123,
"valorST": 123,
"qBCMono": 123,
"adRemICMS": 123,
"vICMSMono": 123,
"qBCMonoRet": 123,
"adRemICMSRet": 123,
"vICMSMonoRet": 123
},
"pis": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123
},
"cofins": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123
},
"ipi": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"valor": 123,
"cEnq": "<string>"
},
"ibsCbs": {
"ibsUf": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"ibsMun": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"cbs": {
"p": 1,
"pNominal": 1,
"pRedAliq": 50,
"v": 1
},
"cst": "<string>",
"cClassTrib": "<string>",
"vBC": 1,
"vIbs": 1
}
}
],
"pagamentos": [{ "valor": 1 }],
"troco": 1,
"cobranca": { "duplicatas": [
{
"vencimento": "<string>",
"valor": 1.01,
"numero": "<string>"
}
] },
"informacoesComplementares": "<string>",
"informacoesFisco": "<string>",
"resolverTributacao": True
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
issuerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
naturezaOperacao: '<string>',
serie: 0,
numero: 0,
tpNF: 0,
idDest: 0,
indFinal: 0,
indPres: 0,
finNFe: 0,
items: [
{
codigo: '<string>',
descricao: '<string>',
ncm: '<string>',
cfop: '<string>',
unidade: '<string>',
quantidade: 1.0001,
valorUnitario: 1.01,
ean: '<string>',
cest: '<string>',
cBenef: '<string>',
valorTotal: 123,
desconto: 1,
valorFrete: 1,
valorSeguro: 1,
outrasDespesas: 1,
indTot: 123,
icms: {
origem: 0,
cst: '<string>',
csosn: '<string>',
aliquota: 123,
baseCalculo: 123,
valor: 123,
baseCalculoST: 123,
aliquotaST: 123,
valorST: 123,
qBCMono: 123,
adRemICMS: 123,
vICMSMono: 123,
qBCMonoRet: 123,
adRemICMSRet: 123,
vICMSMonoRet: 123
},
pis: {cst: '<string>', baseCalculo: 123, aliquota: 123, valor: 123},
cofins: {cst: '<string>', baseCalculo: 123, aliquota: 123, valor: 123},
ipi: {cst: '<string>', baseCalculo: 123, aliquota: 123, valor: 123, cEnq: '<string>'},
ibsCbs: {
ibsUf: {p: 1, pNominal: 1, pRedAliq: 50, v: 1},
ibsMun: {p: 1, pNominal: 1, pRedAliq: 50, v: 1},
cbs: {p: 1, pNominal: 1, pRedAliq: 50, v: 1},
cst: '<string>',
cClassTrib: '<string>',
vBC: 1,
vIbs: 1
}
}
],
pagamentos: [{valor: 1}],
troco: 1,
cobranca: {duplicatas: [{vencimento: '<string>', valor: 1.01, numero: '<string>'}]},
informacoesComplementares: '<string>',
informacoesFisco: '<string>',
resolverTributacao: true
})
};
fetch('https://api.engineapi.com.br/v1/nfe/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.engineapi.com.br/v1/nfe/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'issuerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'naturezaOperacao' => '<string>',
'serie' => 0,
'numero' => 0,
'tpNF' => 0,
'idDest' => 0,
'indFinal' => 0,
'indPres' => 0,
'finNFe' => 0,
'items' => [
[
'codigo' => '<string>',
'descricao' => '<string>',
'ncm' => '<string>',
'cfop' => '<string>',
'unidade' => '<string>',
'quantidade' => 1.0001,
'valorUnitario' => 1.01,
'ean' => '<string>',
'cest' => '<string>',
'cBenef' => '<string>',
'valorTotal' => 123,
'desconto' => 1,
'valorFrete' => 1,
'valorSeguro' => 1,
'outrasDespesas' => 1,
'indTot' => 123,
'icms' => [
'origem' => 0,
'cst' => '<string>',
'csosn' => '<string>',
'aliquota' => 123,
'baseCalculo' => 123,
'valor' => 123,
'baseCalculoST' => 123,
'aliquotaST' => 123,
'valorST' => 123,
'qBCMono' => 123,
'adRemICMS' => 123,
'vICMSMono' => 123,
'qBCMonoRet' => 123,
'adRemICMSRet' => 123,
'vICMSMonoRet' => 123
],
'pis' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'valor' => 123
],
'cofins' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'valor' => 123
],
'ipi' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'valor' => 123,
'cEnq' => '<string>'
],
'ibsCbs' => [
'ibsUf' => [
'p' => 1,
'pNominal' => 1,
'pRedAliq' => 50,
'v' => 1
],
'ibsMun' => [
'p' => 1,
'pNominal' => 1,
'pRedAliq' => 50,
'v' => 1
],
'cbs' => [
'p' => 1,
'pNominal' => 1,
'pRedAliq' => 50,
'v' => 1
],
'cst' => '<string>',
'cClassTrib' => '<string>',
'vBC' => 1,
'vIbs' => 1
]
]
],
'pagamentos' => [
[
'valor' => 1
]
],
'troco' => 1,
'cobranca' => [
'duplicatas' => [
[
'vencimento' => '<string>',
'valor' => 1.01,
'numero' => '<string>'
]
]
],
'informacoesComplementares' => '<string>',
'informacoesFisco' => '<string>',
'resolverTributacao' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.engineapi.com.br/v1/nfe/{id}"
payload := strings.NewReader("{\n \"issuerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"naturezaOperacao\": \"<string>\",\n \"serie\": 0,\n \"numero\": 0,\n \"tpNF\": 0,\n \"idDest\": 0,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 0,\n \"items\": [\n {\n \"codigo\": \"<string>\",\n \"descricao\": \"<string>\",\n \"ncm\": \"<string>\",\n \"cfop\": \"<string>\",\n \"unidade\": \"<string>\",\n \"quantidade\": 1.0001,\n \"valorUnitario\": 1.01,\n \"ean\": \"<string>\",\n \"cest\": \"<string>\",\n \"cBenef\": \"<string>\",\n \"valorTotal\": 123,\n \"desconto\": 1,\n \"valorFrete\": 1,\n \"valorSeguro\": 1,\n \"outrasDespesas\": 1,\n \"indTot\": 123,\n \"icms\": {\n \"origem\": 0,\n \"cst\": \"<string>\",\n \"csosn\": \"<string>\",\n \"aliquota\": 123,\n \"baseCalculo\": 123,\n \"valor\": 123,\n \"baseCalculoST\": 123,\n \"aliquotaST\": 123,\n \"valorST\": 123,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123,\n \"cEnq\": \"<string>\"\n },\n \"ibsCbs\": {\n \"ibsUf\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"ibsMun\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cbs\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cst\": \"<string>\",\n \"cClassTrib\": \"<string>\",\n \"vBC\": 1,\n \"vIbs\": 1\n }\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1\n }\n ],\n \"troco\": 1,\n \"cobranca\": {\n \"duplicatas\": [\n {\n \"vencimento\": \"<string>\",\n \"valor\": 1.01,\n \"numero\": \"<string>\"\n }\n ]\n },\n \"informacoesComplementares\": \"<string>\",\n \"informacoesFisco\": \"<string>\",\n \"resolverTributacao\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.engineapi.com.br/v1/nfe/{id}")
.header("Content-Type", "application/json")
.body("{\n \"issuerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"naturezaOperacao\": \"<string>\",\n \"serie\": 0,\n \"numero\": 0,\n \"tpNF\": 0,\n \"idDest\": 0,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 0,\n \"items\": [\n {\n \"codigo\": \"<string>\",\n \"descricao\": \"<string>\",\n \"ncm\": \"<string>\",\n \"cfop\": \"<string>\",\n \"unidade\": \"<string>\",\n \"quantidade\": 1.0001,\n \"valorUnitario\": 1.01,\n \"ean\": \"<string>\",\n \"cest\": \"<string>\",\n \"cBenef\": \"<string>\",\n \"valorTotal\": 123,\n \"desconto\": 1,\n \"valorFrete\": 1,\n \"valorSeguro\": 1,\n \"outrasDespesas\": 1,\n \"indTot\": 123,\n \"icms\": {\n \"origem\": 0,\n \"cst\": \"<string>\",\n \"csosn\": \"<string>\",\n \"aliquota\": 123,\n \"baseCalculo\": 123,\n \"valor\": 123,\n \"baseCalculoST\": 123,\n \"aliquotaST\": 123,\n \"valorST\": 123,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123,\n \"cEnq\": \"<string>\"\n },\n \"ibsCbs\": {\n \"ibsUf\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"ibsMun\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cbs\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cst\": \"<string>\",\n \"cClassTrib\": \"<string>\",\n \"vBC\": 1,\n \"vIbs\": 1\n }\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1\n }\n ],\n \"troco\": 1,\n \"cobranca\": {\n \"duplicatas\": [\n {\n \"vencimento\": \"<string>\",\n \"valor\": 1.01,\n \"numero\": \"<string>\"\n }\n ]\n },\n \"informacoesComplementares\": \"<string>\",\n \"informacoesFisco\": \"<string>\",\n \"resolverTributacao\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engineapi.com.br/v1/nfe/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"issuerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"naturezaOperacao\": \"<string>\",\n \"serie\": 0,\n \"numero\": 0,\n \"tpNF\": 0,\n \"idDest\": 0,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 0,\n \"items\": [\n {\n \"codigo\": \"<string>\",\n \"descricao\": \"<string>\",\n \"ncm\": \"<string>\",\n \"cfop\": \"<string>\",\n \"unidade\": \"<string>\",\n \"quantidade\": 1.0001,\n \"valorUnitario\": 1.01,\n \"ean\": \"<string>\",\n \"cest\": \"<string>\",\n \"cBenef\": \"<string>\",\n \"valorTotal\": 123,\n \"desconto\": 1,\n \"valorFrete\": 1,\n \"valorSeguro\": 1,\n \"outrasDespesas\": 1,\n \"indTot\": 123,\n \"icms\": {\n \"origem\": 0,\n \"cst\": \"<string>\",\n \"csosn\": \"<string>\",\n \"aliquota\": 123,\n \"baseCalculo\": 123,\n \"valor\": 123,\n \"baseCalculoST\": 123,\n \"aliquotaST\": 123,\n \"valorST\": 123,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"valor\": 123,\n \"cEnq\": \"<string>\"\n },\n \"ibsCbs\": {\n \"ibsUf\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"ibsMun\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cbs\": {\n \"p\": 1,\n \"pNominal\": 1,\n \"pRedAliq\": 50,\n \"v\": 1\n },\n \"cst\": \"<string>\",\n \"cClassTrib\": \"<string>\",\n \"vBC\": 1,\n \"vIbs\": 1\n }\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1\n }\n ],\n \"troco\": 1,\n \"cobranca\": {\n \"duplicatas\": [\n {\n \"vencimento\": \"<string>\",\n \"valor\": 1.01,\n \"numero\": \"<string>\"\n }\n ]\n },\n \"informacoesComplementares\": \"<string>\",\n \"informacoesFisco\": \"<string>\",\n \"resolverTributacao\": true\n}"
response = http.request(request)
puts response.read_bodyPath Parameters
UUID da NF-e
Body
application/json
UUID do emissor (retornado por POST /v1/companies). Opcional com 1 emissor cadastrado; obrigatório com 2+
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Natureza da operação, texto livre (ex.: "VENDA DE MERCADORIA")
Série da NF-e. Ausente = série padrão do emissor
Required range:
-9007199254740991 <= x <= 9007199254740991Número da NF-e (passthrough). Ausente = alocado automaticamente pela engineAPI
Required range:
-9007199254740991 <= x <= 9007199254740991Tipo de operação: 0=entrada, 1=saída. Padrão: saída
Required range:
-9007199254740991 <= x <= 9007199254740991Identificador de local de destino: 1=interna (mesma UF), 2=interestadual, 3=exterior
Required range:
-9007199254740991 <= x <= 9007199254740991Indica operação com consumidor final: 0=não, 1=sim
Required range:
-9007199254740991 <= x <= 9007199254740991Indicador de presença do comprador: 0=não se aplica, 1=presencial, 2=internet, 3=teleatendimento, etc.
Required range:
-9007199254740991 <= x <= 9007199254740991Finalidade da emissão: 1=normal, 2=complementar, 3=ajuste, 4=devolução
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Itens da nota (mínimo 1). Atenção: o campo é "items", não "itens"
Minimum array length:
1Show child attributes
Show child attributes
Dados de transporte. Se enviado, modFrete é obrigatório
Show child attributes
Show child attributes
Formas de pagamento (mínimo 1, máximo 100). Atenção: o campo é "pagamentos" (array), não "pagamento"
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Valor do troco em R$, para venda com pagamento em dinheiro (máximo 2 casas decimais)
Required range:
x >= 0Cobrança a prazo: fatura (numero, valorOriginal, valorDesconto, valorLiquido) e/ou duplicatas[] (numero, vencimento, valor). Informativo/financeiro: NÃO altera vNF nem pagamentos (quem fecha o total transmitido continua sendo pagamentos)
Show child attributes
Show child attributes
Informações complementares de interesse do contribuinte, impressas no DANFE
Informações adicionais de interesse do fisco
Maximum string length:
2000Ativa a emissão assistida (Cérebro Fiscal): resolve CSOSN e o grupo IBS/CBS de itens sem tributação manual. Requer plano com fiscalBrain + Issuer.fiscalBrainEnabled
Response
Registro atualizado
⌘I