API atual/Referência completa/Fiscal (NF-e e NFC-e)

Configuração de emissão

Define quando a loja emite a nota fiscal de cada pedido, a série da NF-e e se o cliente recebe a nota por e-mail.

A configuração de emissão responde a uma pergunta: em que momento do pedido a nota deve ser gerada? Cada gatilho enfileira o pedido na fila de emissão quando o evento acontece. Exigem o módulo focusnfe e o privilégio manage_nfe ou manage_settings.

`trigger`	Quando o pedido entra na fila
`manual`	Nunca sozinho. A nota só sai quando uma pessoa pede. É o padrão.
`on_paid`	Quando o pagamento é confirmado.
`on_completed`	Quando o pedido é concluído.
`on_shipped`	Quando o pedido é despachado.

Ler a configuração

Devolve a configuração salva. Uma loja que nunca configurou recebe os padrões (manual, série 1, e-mail ligado). Uma loja antiga que usava a opção "emitir ao concluir" do módulo anterior recebe on_completed.

GET/api/v1/admin/fiscal/settingsAdmin

Lê a configuração de emissão

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/fiscal/settings" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Configuração devolvida

json

{
  "trigger": "manual",
  "serie_nfe": "1",
  "email_customer": true,
  "nfce_enabled": false
}

Campos da resposta

triggerstring

manualon_paidon_completedon_shipped

Gatilho de emissão.

serie_nfestring

Série da NF-e. É a série padrão da loja; cada estabelecimento também tem a sua.

email_customerboolean

Se o cliente recebe a nota fiscal por e-mail depois da autorização.

nfce_enabledboolean

Se a emissão de NFC-e (nota de consumidor) está habilitada na loja.

Erros

Status	Quando	Corpo
401	Sem token	`{"error":"missing authorization header"}`
403	Sem privilégio ou módulo desligado	`{"error":"insufficient privileges","privilege_required_any":["manage_nfe","manage_settings"]}`
500	Falha ao ler	`{"error":"failed to load settings","detail":"..."}`

Gravar a configuração

Substitui a configuração inteira. A resposta é o próprio corpo enviado.

PUT/api/v1/admin/fiscal/settingsAdmin

Grava a configuração de emissão

Corpo da requisição

triggerstring

manualon_paidon_completedon_shipped

Gatilho. Vazio equivale a manual na leitura seguinte.

serie_nfestring

Série da NF-e. Vazio equivale a 1 na leitura seguinte.

email_customerboolean

Enviar a nota ao cliente por e-mail. Omitir grava false.

nfce_enabledboolean

Habilitar NFC-e. Omitir grava false.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/fiscal/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "trigger": "on_paid", "serie_nfe": "1", "email_customer": true, "nfce_enabled": false }'

Resposta

200Configuração gravada

json

{
  "trigger": "on_paid",
  "serie_nfe": "1",
  "email_customer": true,
  "nfce_enabled": false
}

Erros

Status	Quando	Corpo
400	JSON inválido	`{"error":"invalid body","detail":"..."}`
500	Falha ao gravar	`{"error":"failed to save settings","detail":"..."}`

Veja também

API atual/Referência completa/Fiscal (NF-e e NFC-e)

Configuração de emissão

Define quando a loja emite a nota fiscal de cada pedido, a série da NF-e e se o cliente recebe a nota por e-mail.

`trigger`	Quando o pedido entra na fila
`manual`	Nunca sozinho. A nota só sai quando uma pessoa pede. É o padrão.
`on_paid`	Quando o pagamento é confirmado.
`on_completed`	Quando o pedido é concluído.
`on_shipped`	Quando o pedido é despachado.

Ler a configuração

GET/api/v1/admin/fiscal/settingsAdmin

Lê a configuração de emissão

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/fiscal/settings" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Configuração devolvida

json

{
  "trigger": "manual",
  "serie_nfe": "1",
  "email_customer": true,
  "nfce_enabled": false
}

Campos da resposta

triggerstring

manualon_paidon_completedon_shipped

Gatilho de emissão.

serie_nfestring

Série da NF-e. É a série padrão da loja; cada estabelecimento também tem a sua.

email_customerboolean

Se o cliente recebe a nota fiscal por e-mail depois da autorização.

nfce_enabledboolean

Se a emissão de NFC-e (nota de consumidor) está habilitada na loja.

Erros

Status	Quando	Corpo
401	Sem token	`{"error":"missing authorization header"}`
403	Sem privilégio ou módulo desligado	`{"error":"insufficient privileges","privilege_required_any":["manage_nfe","manage_settings"]}`
500	Falha ao ler	`{"error":"failed to load settings","detail":"..."}`

Gravar a configuração

Substitui a configuração inteira. A resposta é o próprio corpo enviado.

PUT/api/v1/admin/fiscal/settingsAdmin

Grava a configuração de emissão

Corpo da requisição

triggerstring

manualon_paidon_completedon_shipped

Gatilho. Vazio equivale a manual na leitura seguinte.

serie_nfestring

Série da NF-e. Vazio equivale a 1 na leitura seguinte.

email_customerboolean

Enviar a nota ao cliente por e-mail. Omitir grava false.

nfce_enabledboolean

Habilitar NFC-e. Omitir grava false.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/fiscal/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "trigger": "on_paid", "serie_nfe": "1", "email_customer": true, "nfce_enabled": false }'

Resposta

200Configuração gravada

json

{
  "trigger": "on_paid",
  "serie_nfe": "1",
  "email_customer": true,
  "nfce_enabled": false
}

Erros

Status	Quando	Corpo
400	JSON inválido	`{"error":"invalid body","detail":"..."}`
500	Falha ao gravar	`{"error":"failed to save settings","detail":"..."}`