Devoluções de compra

Devoluções a fornecedores e NF-e de retorno.

Base: https://api.nivesistemas.com.br · 23 endpoints

GET /purchase-returns

Listar devoluções de compra

curl -X GET "https://api.nivesistemas.com.br/purchase-returns" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/purchase-returns",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /purchase-returns/parse-source-xml

Ler XML da NF-e de entrada na devolução avulsa, sem criar compra

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`xml`	string	não	Conteúdo do XML da NF-e

curl -X POST "https://api.nivesistemas.com.br/purchase-returns/parse-source-xml" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"xml":""}'

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/parse-source-xml", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "xml": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/purchase-returns/parse-source-xml",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "xml": ""
    },
)
print(res.json())

GET /purchase-returns/:id

Detalhe

Parâmetros de rota: id

curl -X GET "https://api.nivesistemas.com.br/purchase-returns/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/{id}", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/purchase-returns/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /purchase-returns/:id/cancel

Cancelar

Parâmetros de rota: id

curl -X POST "https://api.nivesistemas.com.br/purchase-returns/{id}/cancel" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/{id}/cancel", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/purchase-returns/{id}/cancel",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /purchase-returns/:id/emit-nfe

Emitir NF-e de devolução

Parâmetros de rota: id

curl -X POST "https://api.nivesistemas.com.br/purchase-returns/{id}/emit-nfe" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/{id}/emit-nfe", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/purchase-returns/{id}/emit-nfe",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /purchase-returns/:id/return-nfe/cancel

Cancelar NF-e de devolução na SEFAZ (até 24h após a autorização)

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`justification`	string	não	Justificativa com 15 a 255 caracteres

curl -X POST "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/cancel" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"justification":""}'

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/cancel", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "justification": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/cancel",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "justification": ""
    },
)
print(res.json())

POST /purchase-returns/:id/return-nfe/reconcile

Consultar na SEFAZ se a NF-e já foi autorizada, sem reenviar

Parâmetros de rota: id

curl -X POST "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/reconcile" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/reconcile", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/reconcile",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /purchase-returns/:id/return-nfe/xml

Baixar XML

Parâmetros de rota: id

curl -X GET "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/xml" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/xml", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/xml",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /purchase-returns/:id/return-nfe/pdf

Baixar PDF

Parâmetros de rota: id

curl -X GET "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/pdf" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/pdf", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/pdf",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /purchase-returns/:id/return-nfe/danfe-html

DANFE em HTML (autorizada ou cancelada)

Parâmetros de rota: id

curl -X GET "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/danfe-html" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/danfe-html", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/danfe-html",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /purchase-returns/return-nfe/bulk-download

Baixar em ZIP o DANFE (PDF) ou o XML de várias devoluções

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`ids`	string[]	não	Devoluções selecionadas (máximo 50)
`kind`	“pdf” \| “xml”	não	O que baixar de cada NF-e

curl -X POST "https://api.nivesistemas.com.br/purchase-returns/return-nfe/bulk-download" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"ids":null,"kind":null}'

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/return-nfe/bulk-download", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "ids": null,
    "kind": null
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/purchase-returns/return-nfe/bulk-download",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "ids": None,
      "kind": None
    },
)
print(res.json())

POST /purchase-returns/:id/return-nfe/send-email

Enviar XML e DANFE por e-mail ao fornecedor

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`email`	string	não	E-mail de destino

curl -X POST "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/send-email" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"email":""}'

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/send-email", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/purchase-returns/{id}/return-nfe/send-email",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "email": ""
    },
)
print(res.json())

POST /purchase-returns

Criar devolução de compra

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`purchaseId`	string	não	Compra recebida de origem
`items`	array	não	[{ purchaseItemId, quantity }]
`reason`	string	não	Motivo da devolução (opcional)
`emitPurchaseReturnNfe`	boolean	não	Emite NF-e modelo 55 de devolução referenciando a NF-e de entrada
`adjustPayable`	boolean	não	Abate o valor devolvido do saldo em aberto da conta a pagar da compra (últimas parcelas primeiro)

curl -X POST "https://api.nivesistemas.com.br/purchase-returns" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"purchaseId":"","items":[],"reason":"","emitPurchaseReturnNfe":true,"adjustPayable":true}'

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "purchaseId": "",
    "items": [],
    "reason": "",
    "emitPurchaseReturnNfe": true,
    "adjustPayable": true
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/purchase-returns",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "purchaseId": "",
      "items": [],
      "reason": "",
      "emitPurchaseReturnNfe": True,
      "adjustPayable": True
    },
)
print(res.json())

POST /purchase-returns/standalone

Criar devolução avulsa (sem compra lançada)

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`supplierId`	string	não	Fornecedor que vai receber a mercadoria
`items`	array	não	[{ variantId, quantity, unitCost }] — unitCost opcional usa o custo do produto
`refAccessKey`	string	não	Chave (44 dígitos) da NF-e de entrada, quando existir. Sem ela a NF-e sai sem refNFe
`reason`	string	não	Motivo da devolução (opcional)
`emitPurchaseReturnNfe`	boolean	não	Emite NF-e modelo 55 de devolução para o fornecedor

curl -X POST "https://api.nivesistemas.com.br/purchase-returns/standalone" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"supplierId":"","items":[],"refAccessKey":"","reason":"","emitPurchaseReturnNfe":true}'

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/standalone", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "supplierId": "",
    "items": [],
    "refAccessKey": "",
    "reason": "",
    "emitPurchaseReturnNfe": true
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/purchase-returns/standalone",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "supplierId": "",
      "items": [],
      "refAccessKey": "",
      "reason": "",
      "emitPurchaseReturnNfe": True
    },
)
print(res.json())

GET /purchase-returns/source-nfe

Buscar a NF-e de compra de origem pela chave

Query params

Campo	Tipo	Obrigatório	Descrição
`accessKey`	string	sim	Chave de acesso (44 dígitos)

Resposta: { found, accessKey, emitCrt, items }

curl -X GET "https://api.nivesistemas.com.br/purchase-returns/source-nfe" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/source-nfe", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/purchase-returns/source-nfe",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /purchase-returns/drafts

Listar rascunhos de devolução

curl -X GET "https://api.nivesistemas.com.br/purchase-returns/drafts" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/drafts", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/purchase-returns/drafts",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /purchase-returns/drafts

Salvar rascunho de devolução (fornecedor, chave de referência, itens)

Resposta: 201 Created

curl -X POST "https://api.nivesistemas.com.br/purchase-returns/drafts" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/drafts", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/purchase-returns/drafts",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PUT /purchase-returns/drafts/:id

Atualizar rascunho

Parâmetros de rota: id

curl -X PUT "https://api.nivesistemas.com.br/purchase-returns/drafts/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/drafts/{id}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "PUT",
    "https://api.nivesistemas.com.br/purchase-returns/drafts/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /purchase-returns/drafts/:id

Excluir rascunho

Parâmetros de rota: id

Resposta: 204 No Content

curl -X DELETE "https://api.nivesistemas.com.br/purchase-returns/drafts/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/drafts/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "DELETE",
    "https://api.nivesistemas.com.br/purchase-returns/drafts/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /purchase-returns/drafts/:id/finalize

Finalizar rascunho em devolução

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`emitPurchaseReturnNfe`	boolean	não	Emitir NF-e de devolução (padrão false)

curl -X POST "https://api.nivesistemas.com.br/purchase-returns/drafts/{id}/finalize" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"emitPurchaseReturnNfe":true}'

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/drafts/{id}/finalize", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "emitPurchaseReturnNfe": true
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/purchase-returns/drafts/{id}/finalize",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "emitPurchaseReturnNfe": True
    },
)
print(res.json())

GET /purchase-returns/ref-nfe-suggestions

Sugerir a NF-e de entrada a referenciar numa devolução avulsa, a partir do fornecedor e das variantes devolvidas

Query params

Campo	Tipo	Obrigatório	Descrição
`supplierId`	uuid	não	Fornecedor (omitido = qualquer)
`variantIds`	string	não	Variantes devolvidas, separadas por vírgula (até 200)

Resposta: Lista (até 50) de compras recebidas que trouxeram essas variantes: purchaseId, purchaseReference, accessKey (44 dígitos), invoiceNumber, invoiceSeries, issueDate, receivedAt, totalAmount e supplierName. Sem variantIds retorna lista vazia.

curl -X GET "https://api.nivesistemas.com.br/purchase-returns/ref-nfe-suggestions" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/ref-nfe-suggestions", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/purchase-returns/ref-nfe-suggestions",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /purchase-returns/:id/ref-nfe-suggestions

Sugerir a NF-e de entrada para uma devolução já registrada (usa o fornecedor e os itens dela)

Parâmetros de rota: id

Resposta: Mesmo formato de /purchase-returns/ref-nfe-suggestions. 404 se a devolução não existe.

curl -X GET "https://api.nivesistemas.com.br/purchase-returns/{id}/ref-nfe-suggestions" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/{id}/ref-nfe-suggestions", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/purchase-returns/{id}/ref-nfe-suggestions",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PUT /purchase-returns/:id/ref-access-key

Referenciar ou corrigir a NF-e de entrada de uma devolução avulsa antes de (re)emitir a NF-e de devolução

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`refAccessKey`	string	sim	Chave de acesso da NF-e de entrada (44 dígitos, modelo 55; pontuação é ignorada)

Resposta: O detalhe da devolução. 400 se a chave é inválida, não é modelo 55, não confere com o CNPJ do fornecedor, a devolução é vinculada a uma compra (corrija na compra), não está registrada ou a NF-e de devolução já foi autorizada; 409 se estiver em processamento na SEFAZ.

curl -X PUT "https://api.nivesistemas.com.br/purchase-returns/{id}/ref-access-key" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"refAccessKey":""}'

const res = await fetch("https://api.nivesistemas.com.br/purchase-returns/{id}/ref-access-key", {
  method: "PUT",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "refAccessKey": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "PUT",
    "https://api.nivesistemas.com.br/purchase-returns/{id}/ref-access-key",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "refAccessKey": ""
    },
)
print(res.json())