Atualizar registro de NF-e
curl --request PATCH \
--url https://api.engineapi.com.br/v1/nfe/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"issuerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"naturezaOperacao": "<string>",
"serie": 0,
"numero": 0,
"tpNF": 0,
"idDest": 1,
"indFinal": 0,
"indPres": 0,
"finNFe": 3,
"referenciadas": [
{
"chaveAcesso": "<string>"
}
],
"procRef": [
{
"nProc": "<string>"
}
],
"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": 0,
"unidadeTributavel": "<string>",
"quantidadeTributavel": 1.0001,
"valorUnitarioTributavel": 123,
"icms": {
"origem": 4,
"cst": "<string>",
"csosn": "<string>",
"aliquota": 123,
"baseCalculo": 123,
"valor": 123,
"baseCalculoST": 123,
"aliquotaST": 123,
"valorST": 123,
"pRedBC": 1,
"vBC": 1,
"pICMS": 1,
"vICMS": 1,
"vBCFCP": 1,
"pFCP": 1,
"vFCP": 1,
"pMVAST": 1,
"pRedBCST": 1,
"vBCST": 1,
"pICMSST": 1,
"vICMSST": 1,
"vBCFCPST": 1,
"pFCPST": 1,
"vFCPST": 1,
"pCredSN": 1,
"vCredICMSSN": 1,
"vBCSTRet": 1,
"pST": 1,
"vICMSSubstituto": 1,
"vICMSSTRet": 1,
"vBCFCPSTRet": 1,
"pFCPSTRet": 1,
"vFCPSTRet": 1,
"pRedBCEfet": 1,
"vBCEfet": 1,
"pICMSEfet": 1,
"vICMSEfet": 1,
"qBCMono": 123,
"adRemICMS": 123,
"vICMSMono": 123,
"qBCMonoRet": 123,
"adRemICMSRet": 123,
"vICMSMonoRet": 123,
"cBenefRBC": "<string>",
"vICMSDeson": 1,
"motDesICMS": "<string>",
"vICMSOp": 1,
"pDif": 1,
"vICMSDif": 1,
"pFCPDif": 1,
"vFCPDif": 1,
"vFCPEfet": 1
},
"pis": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeVendida": 123,
"valorAliquotaUnidade": 123,
"valor": 123
},
"cofins": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeVendida": 123,
"valorAliquotaUnidade": 123,
"valor": 123
},
"ipi": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeUnidadeTributavel": 123,
"valorUnidadeTributavel": 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
},
"gCred": [
{
"cCredPresumido": "<string>",
"pCredPresumido": 1,
"vCredPresumido": 1
}
]
}
],
"pagamentos": [
{
"valor": 1,
"indicador": 0
}
],
"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": 1,
"indFinal": 0,
"indPres": 0,
"finNFe": 3,
"referenciadas": [{ "chaveAcesso": "<string>" }],
"procRef": [{ "nProc": "<string>" }],
"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": 0,
"unidadeTributavel": "<string>",
"quantidadeTributavel": 1.0001,
"valorUnitarioTributavel": 123,
"icms": {
"origem": 4,
"cst": "<string>",
"csosn": "<string>",
"aliquota": 123,
"baseCalculo": 123,
"valor": 123,
"baseCalculoST": 123,
"aliquotaST": 123,
"valorST": 123,
"pRedBC": 1,
"vBC": 1,
"pICMS": 1,
"vICMS": 1,
"vBCFCP": 1,
"pFCP": 1,
"vFCP": 1,
"pMVAST": 1,
"pRedBCST": 1,
"vBCST": 1,
"pICMSST": 1,
"vICMSST": 1,
"vBCFCPST": 1,
"pFCPST": 1,
"vFCPST": 1,
"pCredSN": 1,
"vCredICMSSN": 1,
"vBCSTRet": 1,
"pST": 1,
"vICMSSubstituto": 1,
"vICMSSTRet": 1,
"vBCFCPSTRet": 1,
"pFCPSTRet": 1,
"vFCPSTRet": 1,
"pRedBCEfet": 1,
"vBCEfet": 1,
"pICMSEfet": 1,
"vICMSEfet": 1,
"qBCMono": 123,
"adRemICMS": 123,
"vICMSMono": 123,
"qBCMonoRet": 123,
"adRemICMSRet": 123,
"vICMSMonoRet": 123,
"cBenefRBC": "<string>",
"vICMSDeson": 1,
"motDesICMS": "<string>",
"vICMSOp": 1,
"pDif": 1,
"vICMSDif": 1,
"pFCPDif": 1,
"vFCPDif": 1,
"vFCPEfet": 1
},
"pis": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeVendida": 123,
"valorAliquotaUnidade": 123,
"valor": 123
},
"cofins": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeVendida": 123,
"valorAliquotaUnidade": 123,
"valor": 123
},
"ipi": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeUnidadeTributavel": 123,
"valorUnidadeTributavel": 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
},
"gCred": [
{
"cCredPresumido": "<string>",
"pCredPresumido": 1,
"vCredPresumido": 1
}
]
}
],
"pagamentos": [
{
"valor": 1,
"indicador": 0
}
],
"troco": 1,
"cobranca": { "duplicatas": [
{
"vencimento": "<string>",
"valor": 1.01,
"numero": "<string>"
}
] },
"informacoesComplementares": "<string>",
"informacoesFisco": "<string>",
"resolverTributacao": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
issuerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
naturezaOperacao: '<string>',
serie: 0,
numero: 0,
tpNF: 0,
idDest: 1,
indFinal: 0,
indPres: 0,
finNFe: 3,
referenciadas: [{chaveAcesso: '<string>'}],
procRef: [{nProc: '<string>'}],
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: 0,
unidadeTributavel: '<string>',
quantidadeTributavel: 1.0001,
valorUnitarioTributavel: 123,
icms: {
origem: 4,
cst: '<string>',
csosn: '<string>',
aliquota: 123,
baseCalculo: 123,
valor: 123,
baseCalculoST: 123,
aliquotaST: 123,
valorST: 123,
pRedBC: 1,
vBC: 1,
pICMS: 1,
vICMS: 1,
vBCFCP: 1,
pFCP: 1,
vFCP: 1,
pMVAST: 1,
pRedBCST: 1,
vBCST: 1,
pICMSST: 1,
vICMSST: 1,
vBCFCPST: 1,
pFCPST: 1,
vFCPST: 1,
pCredSN: 1,
vCredICMSSN: 1,
vBCSTRet: 1,
pST: 1,
vICMSSubstituto: 1,
vICMSSTRet: 1,
vBCFCPSTRet: 1,
pFCPSTRet: 1,
vFCPSTRet: 1,
pRedBCEfet: 1,
vBCEfet: 1,
pICMSEfet: 1,
vICMSEfet: 1,
qBCMono: 123,
adRemICMS: 123,
vICMSMono: 123,
qBCMonoRet: 123,
adRemICMSRet: 123,
vICMSMonoRet: 123,
cBenefRBC: '<string>',
vICMSDeson: 1,
motDesICMS: '<string>',
vICMSOp: 1,
pDif: 1,
vICMSDif: 1,
pFCPDif: 1,
vFCPDif: 1,
vFCPEfet: 1
},
pis: {
cst: '<string>',
baseCalculo: 123,
aliquota: 123,
quantidadeVendida: 123,
valorAliquotaUnidade: 123,
valor: 123
},
cofins: {
cst: '<string>',
baseCalculo: 123,
aliquota: 123,
quantidadeVendida: 123,
valorAliquotaUnidade: 123,
valor: 123
},
ipi: {
cst: '<string>',
baseCalculo: 123,
aliquota: 123,
quantidadeUnidadeTributavel: 123,
valorUnidadeTributavel: 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
},
gCred: [{cCredPresumido: '<string>', pCredPresumido: 1, vCredPresumido: 1}]
}
],
pagamentos: [{valor: 1, indicador: 0}],
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' => 1,
'indFinal' => 0,
'indPres' => 0,
'finNFe' => 3,
'referenciadas' => [
[
'chaveAcesso' => '<string>'
]
],
'procRef' => [
[
'nProc' => '<string>'
]
],
'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' => 0,
'unidadeTributavel' => '<string>',
'quantidadeTributavel' => 1.0001,
'valorUnitarioTributavel' => 123,
'icms' => [
'origem' => 4,
'cst' => '<string>',
'csosn' => '<string>',
'aliquota' => 123,
'baseCalculo' => 123,
'valor' => 123,
'baseCalculoST' => 123,
'aliquotaST' => 123,
'valorST' => 123,
'pRedBC' => 1,
'vBC' => 1,
'pICMS' => 1,
'vICMS' => 1,
'vBCFCP' => 1,
'pFCP' => 1,
'vFCP' => 1,
'pMVAST' => 1,
'pRedBCST' => 1,
'vBCST' => 1,
'pICMSST' => 1,
'vICMSST' => 1,
'vBCFCPST' => 1,
'pFCPST' => 1,
'vFCPST' => 1,
'pCredSN' => 1,
'vCredICMSSN' => 1,
'vBCSTRet' => 1,
'pST' => 1,
'vICMSSubstituto' => 1,
'vICMSSTRet' => 1,
'vBCFCPSTRet' => 1,
'pFCPSTRet' => 1,
'vFCPSTRet' => 1,
'pRedBCEfet' => 1,
'vBCEfet' => 1,
'pICMSEfet' => 1,
'vICMSEfet' => 1,
'qBCMono' => 123,
'adRemICMS' => 123,
'vICMSMono' => 123,
'qBCMonoRet' => 123,
'adRemICMSRet' => 123,
'vICMSMonoRet' => 123,
'cBenefRBC' => '<string>',
'vICMSDeson' => 1,
'motDesICMS' => '<string>',
'vICMSOp' => 1,
'pDif' => 1,
'vICMSDif' => 1,
'pFCPDif' => 1,
'vFCPDif' => 1,
'vFCPEfet' => 1
],
'pis' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'quantidadeVendida' => 123,
'valorAliquotaUnidade' => 123,
'valor' => 123
],
'cofins' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'quantidadeVendida' => 123,
'valorAliquotaUnidade' => 123,
'valor' => 123
],
'ipi' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'quantidadeUnidadeTributavel' => 123,
'valorUnidadeTributavel' => 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
],
'gCred' => [
[
'cCredPresumido' => '<string>',
'pCredPresumido' => 1,
'vCredPresumido' => 1
]
]
]
],
'pagamentos' => [
[
'valor' => 1,
'indicador' => 0
]
],
'troco' => 1,
'cobranca' => [
'duplicatas' => [
[
'vencimento' => '<string>',
'valor' => 1.01,
'numero' => '<string>'
]
]
],
'informacoesComplementares' => '<string>',
'informacoesFisco' => '<string>',
'resolverTributacao' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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\": 1,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 3,\n \"referenciadas\": [\n {\n \"chaveAcesso\": \"<string>\"\n }\n ],\n \"procRef\": [\n {\n \"nProc\": \"<string>\"\n }\n ],\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\": 0,\n \"unidadeTributavel\": \"<string>\",\n \"quantidadeTributavel\": 1.0001,\n \"valorUnitarioTributavel\": 123,\n \"icms\": {\n \"origem\": 4,\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 \"pRedBC\": 1,\n \"vBC\": 1,\n \"pICMS\": 1,\n \"vICMS\": 1,\n \"vBCFCP\": 1,\n \"pFCP\": 1,\n \"vFCP\": 1,\n \"pMVAST\": 1,\n \"pRedBCST\": 1,\n \"vBCST\": 1,\n \"pICMSST\": 1,\n \"vICMSST\": 1,\n \"vBCFCPST\": 1,\n \"pFCPST\": 1,\n \"vFCPST\": 1,\n \"pCredSN\": 1,\n \"vCredICMSSN\": 1,\n \"vBCSTRet\": 1,\n \"pST\": 1,\n \"vICMSSubstituto\": 1,\n \"vICMSSTRet\": 1,\n \"vBCFCPSTRet\": 1,\n \"pFCPSTRet\": 1,\n \"vFCPSTRet\": 1,\n \"pRedBCEfet\": 1,\n \"vBCEfet\": 1,\n \"pICMSEfet\": 1,\n \"vICMSEfet\": 1,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123,\n \"cBenefRBC\": \"<string>\",\n \"vICMSDeson\": 1,\n \"motDesICMS\": \"<string>\",\n \"vICMSOp\": 1,\n \"pDif\": 1,\n \"vICMSDif\": 1,\n \"pFCPDif\": 1,\n \"vFCPDif\": 1,\n \"vFCPEfet\": 1\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeUnidadeTributavel\": 123,\n \"valorUnidadeTributavel\": 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 \"gCred\": [\n {\n \"cCredPresumido\": \"<string>\",\n \"pCredPresumido\": 1,\n \"vCredPresumido\": 1\n }\n ]\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1,\n \"indicador\": 0\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("x-api-key", "<api-key>")
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("x-api-key", "<api-key>")
.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\": 1,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 3,\n \"referenciadas\": [\n {\n \"chaveAcesso\": \"<string>\"\n }\n ],\n \"procRef\": [\n {\n \"nProc\": \"<string>\"\n }\n ],\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\": 0,\n \"unidadeTributavel\": \"<string>\",\n \"quantidadeTributavel\": 1.0001,\n \"valorUnitarioTributavel\": 123,\n \"icms\": {\n \"origem\": 4,\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 \"pRedBC\": 1,\n \"vBC\": 1,\n \"pICMS\": 1,\n \"vICMS\": 1,\n \"vBCFCP\": 1,\n \"pFCP\": 1,\n \"vFCP\": 1,\n \"pMVAST\": 1,\n \"pRedBCST\": 1,\n \"vBCST\": 1,\n \"pICMSST\": 1,\n \"vICMSST\": 1,\n \"vBCFCPST\": 1,\n \"pFCPST\": 1,\n \"vFCPST\": 1,\n \"pCredSN\": 1,\n \"vCredICMSSN\": 1,\n \"vBCSTRet\": 1,\n \"pST\": 1,\n \"vICMSSubstituto\": 1,\n \"vICMSSTRet\": 1,\n \"vBCFCPSTRet\": 1,\n \"pFCPSTRet\": 1,\n \"vFCPSTRet\": 1,\n \"pRedBCEfet\": 1,\n \"vBCEfet\": 1,\n \"pICMSEfet\": 1,\n \"vICMSEfet\": 1,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123,\n \"cBenefRBC\": \"<string>\",\n \"vICMSDeson\": 1,\n \"motDesICMS\": \"<string>\",\n \"vICMSOp\": 1,\n \"pDif\": 1,\n \"vICMSDif\": 1,\n \"pFCPDif\": 1,\n \"vFCPDif\": 1,\n \"vFCPEfet\": 1\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeUnidadeTributavel\": 123,\n \"valorUnidadeTributavel\": 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 \"gCred\": [\n {\n \"cCredPresumido\": \"<string>\",\n \"pCredPresumido\": 1,\n \"vCredPresumido\": 1\n }\n ]\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1,\n \"indicador\": 0\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["x-api-key"] = '<api-key>'
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\": 1,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 3,\n \"referenciadas\": [\n {\n \"chaveAcesso\": \"<string>\"\n }\n ],\n \"procRef\": [\n {\n \"nProc\": \"<string>\"\n }\n ],\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\": 0,\n \"unidadeTributavel\": \"<string>\",\n \"quantidadeTributavel\": 1.0001,\n \"valorUnitarioTributavel\": 123,\n \"icms\": {\n \"origem\": 4,\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 \"pRedBC\": 1,\n \"vBC\": 1,\n \"pICMS\": 1,\n \"vICMS\": 1,\n \"vBCFCP\": 1,\n \"pFCP\": 1,\n \"vFCP\": 1,\n \"pMVAST\": 1,\n \"pRedBCST\": 1,\n \"vBCST\": 1,\n \"pICMSST\": 1,\n \"vICMSST\": 1,\n \"vBCFCPST\": 1,\n \"pFCPST\": 1,\n \"vFCPST\": 1,\n \"pCredSN\": 1,\n \"vCredICMSSN\": 1,\n \"vBCSTRet\": 1,\n \"pST\": 1,\n \"vICMSSubstituto\": 1,\n \"vICMSSTRet\": 1,\n \"vBCFCPSTRet\": 1,\n \"pFCPSTRet\": 1,\n \"vFCPSTRet\": 1,\n \"pRedBCEfet\": 1,\n \"vBCEfet\": 1,\n \"pICMSEfet\": 1,\n \"vICMSEfet\": 1,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123,\n \"cBenefRBC\": \"<string>\",\n \"vICMSDeson\": 1,\n \"motDesICMS\": \"<string>\",\n \"vICMSOp\": 1,\n \"pDif\": 1,\n \"vICMSDif\": 1,\n \"pFCPDif\": 1,\n \"vFCPDif\": 1,\n \"vFCPEfet\": 1\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeUnidadeTributavel\": 123,\n \"valorUnidadeTributavel\": 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 \"gCred\": [\n {\n \"cCredPresumido\": \"<string>\",\n \"pCredPresumido\": 1,\n \"vCredPresumido\": 1\n }\n ]\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1,\n \"indicador\": 0\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' \
--header 'x-api-key: <api-key>' \
--data '
{
"issuerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"naturezaOperacao": "<string>",
"serie": 0,
"numero": 0,
"tpNF": 0,
"idDest": 1,
"indFinal": 0,
"indPres": 0,
"finNFe": 3,
"referenciadas": [
{
"chaveAcesso": "<string>"
}
],
"procRef": [
{
"nProc": "<string>"
}
],
"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": 0,
"unidadeTributavel": "<string>",
"quantidadeTributavel": 1.0001,
"valorUnitarioTributavel": 123,
"icms": {
"origem": 4,
"cst": "<string>",
"csosn": "<string>",
"aliquota": 123,
"baseCalculo": 123,
"valor": 123,
"baseCalculoST": 123,
"aliquotaST": 123,
"valorST": 123,
"pRedBC": 1,
"vBC": 1,
"pICMS": 1,
"vICMS": 1,
"vBCFCP": 1,
"pFCP": 1,
"vFCP": 1,
"pMVAST": 1,
"pRedBCST": 1,
"vBCST": 1,
"pICMSST": 1,
"vICMSST": 1,
"vBCFCPST": 1,
"pFCPST": 1,
"vFCPST": 1,
"pCredSN": 1,
"vCredICMSSN": 1,
"vBCSTRet": 1,
"pST": 1,
"vICMSSubstituto": 1,
"vICMSSTRet": 1,
"vBCFCPSTRet": 1,
"pFCPSTRet": 1,
"vFCPSTRet": 1,
"pRedBCEfet": 1,
"vBCEfet": 1,
"pICMSEfet": 1,
"vICMSEfet": 1,
"qBCMono": 123,
"adRemICMS": 123,
"vICMSMono": 123,
"qBCMonoRet": 123,
"adRemICMSRet": 123,
"vICMSMonoRet": 123,
"cBenefRBC": "<string>",
"vICMSDeson": 1,
"motDesICMS": "<string>",
"vICMSOp": 1,
"pDif": 1,
"vICMSDif": 1,
"pFCPDif": 1,
"vFCPDif": 1,
"vFCPEfet": 1
},
"pis": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeVendida": 123,
"valorAliquotaUnidade": 123,
"valor": 123
},
"cofins": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeVendida": 123,
"valorAliquotaUnidade": 123,
"valor": 123
},
"ipi": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeUnidadeTributavel": 123,
"valorUnidadeTributavel": 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
},
"gCred": [
{
"cCredPresumido": "<string>",
"pCredPresumido": 1,
"vCredPresumido": 1
}
]
}
],
"pagamentos": [
{
"valor": 1,
"indicador": 0
}
],
"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": 1,
"indFinal": 0,
"indPres": 0,
"finNFe": 3,
"referenciadas": [{ "chaveAcesso": "<string>" }],
"procRef": [{ "nProc": "<string>" }],
"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": 0,
"unidadeTributavel": "<string>",
"quantidadeTributavel": 1.0001,
"valorUnitarioTributavel": 123,
"icms": {
"origem": 4,
"cst": "<string>",
"csosn": "<string>",
"aliquota": 123,
"baseCalculo": 123,
"valor": 123,
"baseCalculoST": 123,
"aliquotaST": 123,
"valorST": 123,
"pRedBC": 1,
"vBC": 1,
"pICMS": 1,
"vICMS": 1,
"vBCFCP": 1,
"pFCP": 1,
"vFCP": 1,
"pMVAST": 1,
"pRedBCST": 1,
"vBCST": 1,
"pICMSST": 1,
"vICMSST": 1,
"vBCFCPST": 1,
"pFCPST": 1,
"vFCPST": 1,
"pCredSN": 1,
"vCredICMSSN": 1,
"vBCSTRet": 1,
"pST": 1,
"vICMSSubstituto": 1,
"vICMSSTRet": 1,
"vBCFCPSTRet": 1,
"pFCPSTRet": 1,
"vFCPSTRet": 1,
"pRedBCEfet": 1,
"vBCEfet": 1,
"pICMSEfet": 1,
"vICMSEfet": 1,
"qBCMono": 123,
"adRemICMS": 123,
"vICMSMono": 123,
"qBCMonoRet": 123,
"adRemICMSRet": 123,
"vICMSMonoRet": 123,
"cBenefRBC": "<string>",
"vICMSDeson": 1,
"motDesICMS": "<string>",
"vICMSOp": 1,
"pDif": 1,
"vICMSDif": 1,
"pFCPDif": 1,
"vFCPDif": 1,
"vFCPEfet": 1
},
"pis": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeVendida": 123,
"valorAliquotaUnidade": 123,
"valor": 123
},
"cofins": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeVendida": 123,
"valorAliquotaUnidade": 123,
"valor": 123
},
"ipi": {
"cst": "<string>",
"baseCalculo": 123,
"aliquota": 123,
"quantidadeUnidadeTributavel": 123,
"valorUnidadeTributavel": 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
},
"gCred": [
{
"cCredPresumido": "<string>",
"pCredPresumido": 1,
"vCredPresumido": 1
}
]
}
],
"pagamentos": [
{
"valor": 1,
"indicador": 0
}
],
"troco": 1,
"cobranca": { "duplicatas": [
{
"vencimento": "<string>",
"valor": 1.01,
"numero": "<string>"
}
] },
"informacoesComplementares": "<string>",
"informacoesFisco": "<string>",
"resolverTributacao": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
issuerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
naturezaOperacao: '<string>',
serie: 0,
numero: 0,
tpNF: 0,
idDest: 1,
indFinal: 0,
indPres: 0,
finNFe: 3,
referenciadas: [{chaveAcesso: '<string>'}],
procRef: [{nProc: '<string>'}],
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: 0,
unidadeTributavel: '<string>',
quantidadeTributavel: 1.0001,
valorUnitarioTributavel: 123,
icms: {
origem: 4,
cst: '<string>',
csosn: '<string>',
aliquota: 123,
baseCalculo: 123,
valor: 123,
baseCalculoST: 123,
aliquotaST: 123,
valorST: 123,
pRedBC: 1,
vBC: 1,
pICMS: 1,
vICMS: 1,
vBCFCP: 1,
pFCP: 1,
vFCP: 1,
pMVAST: 1,
pRedBCST: 1,
vBCST: 1,
pICMSST: 1,
vICMSST: 1,
vBCFCPST: 1,
pFCPST: 1,
vFCPST: 1,
pCredSN: 1,
vCredICMSSN: 1,
vBCSTRet: 1,
pST: 1,
vICMSSubstituto: 1,
vICMSSTRet: 1,
vBCFCPSTRet: 1,
pFCPSTRet: 1,
vFCPSTRet: 1,
pRedBCEfet: 1,
vBCEfet: 1,
pICMSEfet: 1,
vICMSEfet: 1,
qBCMono: 123,
adRemICMS: 123,
vICMSMono: 123,
qBCMonoRet: 123,
adRemICMSRet: 123,
vICMSMonoRet: 123,
cBenefRBC: '<string>',
vICMSDeson: 1,
motDesICMS: '<string>',
vICMSOp: 1,
pDif: 1,
vICMSDif: 1,
pFCPDif: 1,
vFCPDif: 1,
vFCPEfet: 1
},
pis: {
cst: '<string>',
baseCalculo: 123,
aliquota: 123,
quantidadeVendida: 123,
valorAliquotaUnidade: 123,
valor: 123
},
cofins: {
cst: '<string>',
baseCalculo: 123,
aliquota: 123,
quantidadeVendida: 123,
valorAliquotaUnidade: 123,
valor: 123
},
ipi: {
cst: '<string>',
baseCalculo: 123,
aliquota: 123,
quantidadeUnidadeTributavel: 123,
valorUnidadeTributavel: 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
},
gCred: [{cCredPresumido: '<string>', pCredPresumido: 1, vCredPresumido: 1}]
}
],
pagamentos: [{valor: 1, indicador: 0}],
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' => 1,
'indFinal' => 0,
'indPres' => 0,
'finNFe' => 3,
'referenciadas' => [
[
'chaveAcesso' => '<string>'
]
],
'procRef' => [
[
'nProc' => '<string>'
]
],
'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' => 0,
'unidadeTributavel' => '<string>',
'quantidadeTributavel' => 1.0001,
'valorUnitarioTributavel' => 123,
'icms' => [
'origem' => 4,
'cst' => '<string>',
'csosn' => '<string>',
'aliquota' => 123,
'baseCalculo' => 123,
'valor' => 123,
'baseCalculoST' => 123,
'aliquotaST' => 123,
'valorST' => 123,
'pRedBC' => 1,
'vBC' => 1,
'pICMS' => 1,
'vICMS' => 1,
'vBCFCP' => 1,
'pFCP' => 1,
'vFCP' => 1,
'pMVAST' => 1,
'pRedBCST' => 1,
'vBCST' => 1,
'pICMSST' => 1,
'vICMSST' => 1,
'vBCFCPST' => 1,
'pFCPST' => 1,
'vFCPST' => 1,
'pCredSN' => 1,
'vCredICMSSN' => 1,
'vBCSTRet' => 1,
'pST' => 1,
'vICMSSubstituto' => 1,
'vICMSSTRet' => 1,
'vBCFCPSTRet' => 1,
'pFCPSTRet' => 1,
'vFCPSTRet' => 1,
'pRedBCEfet' => 1,
'vBCEfet' => 1,
'pICMSEfet' => 1,
'vICMSEfet' => 1,
'qBCMono' => 123,
'adRemICMS' => 123,
'vICMSMono' => 123,
'qBCMonoRet' => 123,
'adRemICMSRet' => 123,
'vICMSMonoRet' => 123,
'cBenefRBC' => '<string>',
'vICMSDeson' => 1,
'motDesICMS' => '<string>',
'vICMSOp' => 1,
'pDif' => 1,
'vICMSDif' => 1,
'pFCPDif' => 1,
'vFCPDif' => 1,
'vFCPEfet' => 1
],
'pis' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'quantidadeVendida' => 123,
'valorAliquotaUnidade' => 123,
'valor' => 123
],
'cofins' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'quantidadeVendida' => 123,
'valorAliquotaUnidade' => 123,
'valor' => 123
],
'ipi' => [
'cst' => '<string>',
'baseCalculo' => 123,
'aliquota' => 123,
'quantidadeUnidadeTributavel' => 123,
'valorUnidadeTributavel' => 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
],
'gCred' => [
[
'cCredPresumido' => '<string>',
'pCredPresumido' => 1,
'vCredPresumido' => 1
]
]
]
],
'pagamentos' => [
[
'valor' => 1,
'indicador' => 0
]
],
'troco' => 1,
'cobranca' => [
'duplicatas' => [
[
'vencimento' => '<string>',
'valor' => 1.01,
'numero' => '<string>'
]
]
],
'informacoesComplementares' => '<string>',
'informacoesFisco' => '<string>',
'resolverTributacao' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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\": 1,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 3,\n \"referenciadas\": [\n {\n \"chaveAcesso\": \"<string>\"\n }\n ],\n \"procRef\": [\n {\n \"nProc\": \"<string>\"\n }\n ],\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\": 0,\n \"unidadeTributavel\": \"<string>\",\n \"quantidadeTributavel\": 1.0001,\n \"valorUnitarioTributavel\": 123,\n \"icms\": {\n \"origem\": 4,\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 \"pRedBC\": 1,\n \"vBC\": 1,\n \"pICMS\": 1,\n \"vICMS\": 1,\n \"vBCFCP\": 1,\n \"pFCP\": 1,\n \"vFCP\": 1,\n \"pMVAST\": 1,\n \"pRedBCST\": 1,\n \"vBCST\": 1,\n \"pICMSST\": 1,\n \"vICMSST\": 1,\n \"vBCFCPST\": 1,\n \"pFCPST\": 1,\n \"vFCPST\": 1,\n \"pCredSN\": 1,\n \"vCredICMSSN\": 1,\n \"vBCSTRet\": 1,\n \"pST\": 1,\n \"vICMSSubstituto\": 1,\n \"vICMSSTRet\": 1,\n \"vBCFCPSTRet\": 1,\n \"pFCPSTRet\": 1,\n \"vFCPSTRet\": 1,\n \"pRedBCEfet\": 1,\n \"vBCEfet\": 1,\n \"pICMSEfet\": 1,\n \"vICMSEfet\": 1,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123,\n \"cBenefRBC\": \"<string>\",\n \"vICMSDeson\": 1,\n \"motDesICMS\": \"<string>\",\n \"vICMSOp\": 1,\n \"pDif\": 1,\n \"vICMSDif\": 1,\n \"pFCPDif\": 1,\n \"vFCPDif\": 1,\n \"vFCPEfet\": 1\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeUnidadeTributavel\": 123,\n \"valorUnidadeTributavel\": 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 \"gCred\": [\n {\n \"cCredPresumido\": \"<string>\",\n \"pCredPresumido\": 1,\n \"vCredPresumido\": 1\n }\n ]\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1,\n \"indicador\": 0\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("x-api-key", "<api-key>")
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("x-api-key", "<api-key>")
.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\": 1,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 3,\n \"referenciadas\": [\n {\n \"chaveAcesso\": \"<string>\"\n }\n ],\n \"procRef\": [\n {\n \"nProc\": \"<string>\"\n }\n ],\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\": 0,\n \"unidadeTributavel\": \"<string>\",\n \"quantidadeTributavel\": 1.0001,\n \"valorUnitarioTributavel\": 123,\n \"icms\": {\n \"origem\": 4,\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 \"pRedBC\": 1,\n \"vBC\": 1,\n \"pICMS\": 1,\n \"vICMS\": 1,\n \"vBCFCP\": 1,\n \"pFCP\": 1,\n \"vFCP\": 1,\n \"pMVAST\": 1,\n \"pRedBCST\": 1,\n \"vBCST\": 1,\n \"pICMSST\": 1,\n \"vICMSST\": 1,\n \"vBCFCPST\": 1,\n \"pFCPST\": 1,\n \"vFCPST\": 1,\n \"pCredSN\": 1,\n \"vCredICMSSN\": 1,\n \"vBCSTRet\": 1,\n \"pST\": 1,\n \"vICMSSubstituto\": 1,\n \"vICMSSTRet\": 1,\n \"vBCFCPSTRet\": 1,\n \"pFCPSTRet\": 1,\n \"vFCPSTRet\": 1,\n \"pRedBCEfet\": 1,\n \"vBCEfet\": 1,\n \"pICMSEfet\": 1,\n \"vICMSEfet\": 1,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123,\n \"cBenefRBC\": \"<string>\",\n \"vICMSDeson\": 1,\n \"motDesICMS\": \"<string>\",\n \"vICMSOp\": 1,\n \"pDif\": 1,\n \"vICMSDif\": 1,\n \"pFCPDif\": 1,\n \"vFCPDif\": 1,\n \"vFCPEfet\": 1\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeUnidadeTributavel\": 123,\n \"valorUnidadeTributavel\": 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 \"gCred\": [\n {\n \"cCredPresumido\": \"<string>\",\n \"pCredPresumido\": 1,\n \"vCredPresumido\": 1\n }\n ]\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1,\n \"indicador\": 0\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["x-api-key"] = '<api-key>'
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\": 1,\n \"indFinal\": 0,\n \"indPres\": 0,\n \"finNFe\": 3,\n \"referenciadas\": [\n {\n \"chaveAcesso\": \"<string>\"\n }\n ],\n \"procRef\": [\n {\n \"nProc\": \"<string>\"\n }\n ],\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\": 0,\n \"unidadeTributavel\": \"<string>\",\n \"quantidadeTributavel\": 1.0001,\n \"valorUnitarioTributavel\": 123,\n \"icms\": {\n \"origem\": 4,\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 \"pRedBC\": 1,\n \"vBC\": 1,\n \"pICMS\": 1,\n \"vICMS\": 1,\n \"vBCFCP\": 1,\n \"pFCP\": 1,\n \"vFCP\": 1,\n \"pMVAST\": 1,\n \"pRedBCST\": 1,\n \"vBCST\": 1,\n \"pICMSST\": 1,\n \"vICMSST\": 1,\n \"vBCFCPST\": 1,\n \"pFCPST\": 1,\n \"vFCPST\": 1,\n \"pCredSN\": 1,\n \"vCredICMSSN\": 1,\n \"vBCSTRet\": 1,\n \"pST\": 1,\n \"vICMSSubstituto\": 1,\n \"vICMSSTRet\": 1,\n \"vBCFCPSTRet\": 1,\n \"pFCPSTRet\": 1,\n \"vFCPSTRet\": 1,\n \"pRedBCEfet\": 1,\n \"vBCEfet\": 1,\n \"pICMSEfet\": 1,\n \"vICMSEfet\": 1,\n \"qBCMono\": 123,\n \"adRemICMS\": 123,\n \"vICMSMono\": 123,\n \"qBCMonoRet\": 123,\n \"adRemICMSRet\": 123,\n \"vICMSMonoRet\": 123,\n \"cBenefRBC\": \"<string>\",\n \"vICMSDeson\": 1,\n \"motDesICMS\": \"<string>\",\n \"vICMSOp\": 1,\n \"pDif\": 1,\n \"vICMSDif\": 1,\n \"pFCPDif\": 1,\n \"vFCPDif\": 1,\n \"vFCPEfet\": 1\n },\n \"pis\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"cofins\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeVendida\": 123,\n \"valorAliquotaUnidade\": 123,\n \"valor\": 123\n },\n \"ipi\": {\n \"cst\": \"<string>\",\n \"baseCalculo\": 123,\n \"aliquota\": 123,\n \"quantidadeUnidadeTributavel\": 123,\n \"valorUnidadeTributavel\": 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 \"gCred\": [\n {\n \"cCredPresumido\": \"<string>\",\n \"pCredPresumido\": 1,\n \"vCredPresumido\": 1\n }\n ]\n }\n ],\n \"pagamentos\": [\n {\n \"valor\": 1,\n \"indicador\": 0\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_bodyAuthorizations
API-KeyJWT-auth
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)$Identificador de local de destino: 1=interna, 2=interestadual, 3=exterior. Ausente: a API deriva do 1º dígito do CFOP dos itens (1/5=interna, 2/6=interestadual, 3/7=exterior). A UF do emissor vem do cadastro da empresa. Valor explícito vence sempre. Itens com CFOPs que derivam idDest diferentes recusam 422 CFOP_IDDEST_DIVERGENTE nomeando os códigos
Indica operação com consumidor final: 0=não, 1=sim. Ausente: o motor deriva 1 quando o destinatário é não contribuinte (indicadorIE=9 ou CPF), conforme NT 2016.002 da SEFAZ; nos demais casos vale 0. Informar 0 com destinatário não contribuinte recusa com 422 INDFINAL_INCOERENTE_COM_DESTINATARIO antes de numerar
Required range:
-9007199254740991 <= x <= 9007199254740991Finalidade da emissão: 1=normal, 2=complementar, 3=ajuste, 4=devolução, 5=nota de crédito, 6=nota de débito. Ausente = 1. As finalidades 2, 3 e 4 exigem "referenciadas" (a nota original): sem o grupo a SEFAZ rejeitaria a nota DEPOIS de consumir o número (cStat 254 na finalidade 2, cStat 321 na 4), então a API recusa com 422 FINALIDADE_SEM_NFREF antes de numerar. As finalidades 3 e 4 exigem ainda "pagamentos" com forma "90" (sem pagamento).
Required range:
1 <= x <= 6Cobrança a prazo: fatura (numero, valorOriginal, valorDesconto, valorLiquido) sozinha, ou fatura + duplicatas[] (numero, vencimento, valor) juntas. O XSD aceita duplicatas sem fatura (irmãos, minOccurs=0); a API recusa essa combinação antes de numerar, pelas regras nacionais Y01-20 e Y10-10 (422 COBRANCA_INVALIDA). Informativo/financeiro: NÃO altera vNF nem pagamentos (quem fecha o total transmitido continua sendo pagamentos)
Show child attributes
Show child attributes
Response
Registro atualizado