Central Fox Tecnologia LTDA Nfce API
The nfce API from Central Fox Tecnologia LTDA — 5 operation(s) for nfce.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/foxnfe-com-br:foxnfe-com-br-nfce-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: FOX NF-e Nfce API
version: '1.20260923'
description: Contrato derivado das rotas, regras Laravel e respostas estáticas. Condições de validação são descritas nos campos. x-source identifica a evidência. Valores dinâmicos sem tipo comprovado não recebem tipos inventados.
servers:
- url: https://www.foxnfe.com.br
tags:
- name: nfce
paths:
/api/v1/nfce/emit:
post:
operationId: post_api_v1_nfce_emit
tags:
- nfce
summary: Nfe emitNfce
x-source: app/app/Http/Controllers/Api/V1/NfeController.php:62
x-middleware:
- api
- auth:sanctum
- agent.provider
- throttle:api
- tenant.identify
- tenant.status
- idempotency
- nfe.quota
- fiscal.guard
responses:
default:
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/NfeController.php:46
message:
type: string
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: null
message: EXEMPLO_FICTICIO
x-source:
- app/app/Http/Controllers/Api/V1/NfeController.php:46
'202':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
invoice_id:
type: integer
x-source: app/app/Modules/Fiscal/Nfe/Models/Nfe.php
status:
type: string
enum:
- draft
- pending
- processing
- authorized
- rejected
- denied
- canceled
- contingency
x-source: app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php
message:
type: string
example: NF-e enfileirada para emissão
ambiente:
anyOf:
- type: string
example: producao
- type: string
example: homologacao
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
invoice_id: 1
status: draft
message: NF-e enfileirada para emissão
ambiente: producao
x-source:
- app/app/Http/Controllers/Api/V1/NfeController.php:49
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/post_api_v1_nfce_emitRequest'
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
destinatario:
cpf_cnpj: EXEMPLO_FICTICIO
nome: EXEMPLO_FICTICIO
endereco:
logradouro: EXEMPLO_FICTICIO
numero: EXEMPLO_FICTICIO
bairro: EXEMPLO_FICTICIO
municipio: EXEMPLO_FICTICIO
uf: EX
cep: '00000000'
itens:
- produto: EXEMPLO_FICTICIO
ncm: '00000000'
cfop: '0000'
unidade: EXEMPL
quantidade: 1
valor_unitario: 1
/api/v1/nfce/{invoice}:
get:
operationId: get_api_v1_nfce__invoice_
tags:
- nfce
summary: Nfe show
x-source: app/app/Http/Controllers/Api/V1/NfeController.php:77
x-middleware:
- api
- auth:sanctum
- agent.provider
- throttle:api
- tenant.identify
- tenant.status
responses:
'200':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
invoice_id:
type: integer
x-source: app/app/Modules/Fiscal/Nfe/Models/Nfe.php
tipo:
type: integer
x-source: app/app/Modules/Fiscal/Nfe/Models/Nfe.php
numero:
type: integer
x-source: app/app/Modules/Fiscal/Nfe/Models/Nfe.php
serie:
type: integer
x-source: app/app/Modules/Fiscal/Nfe/Models/Nfe.php
status:
type: string
enum:
- draft
- pending
- processing
- authorized
- rejected
- denied
- canceled
- contingency
x-source: app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php
chave_acesso:
type:
- string
- 'null'
x-source: app/app/Modules/Fiscal/Nfe/Models/Nfe.php
protocolo:
type:
- string
- 'null'
x-source: app/app/Modules/Fiscal/Nfe/Models/Nfe.php
emitted_at:
type:
- string
- 'null'
format: date-time
xml_url:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/NfeController.php:91
pdf_url:
description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
x-source: app/app/Http/Controllers/Api/V1/NfeController.php:94
rejection:
type:
- object
- 'null'
properties:
code:
type:
- string
- 'null'
x-source: app/app/Modules/Fiscal/Nfe/Models/Nfe.php
reason:
type:
- string
- 'null'
x-source: app/app/Modules/Fiscal/Nfe/Models/Nfe.php
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
invoice_id: 1
tipo: 1
numero: 1
serie: 1
x-source:
- app/app/Http/Controllers/Api/V1/NfeController.php:81
security:
- bearerAuth: []
parameters:
- name: invoice
in: path
required: true
schema:
type: integer
pattern: '[0-9]+'
/api/v1/nfce/{invoice}/xml:
get:
operationId: get_api_v1_nfce__invoice__xml
tags:
- nfce
summary: Nfe downloadXml
x-source: app/app/Http/Controllers/Api/V1/NfeController.php:108
x-middleware:
- api
- auth:sanctum
- agent.provider
- throttle:api
- tenant.identify
- tenant.status
responses:
'404':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: xml_not_available
message:
type: string
example: XML autorizado indisponível.
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: xml_not_available
message: XML autorizado indisponível.
x-source:
- app/app/Http/Controllers/Api/V1/NfeController.php:113
'200':
description: Resposta do controlador.
content:
application/xml:
schema:
type: string
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value: EXEMPLO_FICTICIO
x-source:
- app/app/Http/Controllers/Api/V1/NfeController.php:119
security:
- bearerAuth: []
parameters:
- name: invoice
in: path
required: true
schema:
type: integer
pattern: '[0-9]+'
/api/v1/nfce/{invoice}/pdf:
get:
operationId: get_api_v1_nfce__invoice__pdf
tags:
- nfce
summary: Nfe downloadPdf
x-source: app/app/Http/Controllers/Api/V1/NfeController.php:129
x-middleware:
- api
- auth:sanctum
- agent.provider
- throttle:api
- tenant.identify
- tenant.status
responses:
'404':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
anyOf:
- type: object
properties:
error:
type: string
example: pdf_not_available
message:
type: string
example: DANFE PDF indisponível.
- type: object
properties:
error:
type: string
example: pdf_not_found
message:
type: string
example: Arquivo DANFE não encontrado.
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
error: pdf_not_available
message: DANFE PDF indisponível.
x-source:
- app/app/Http/Controllers/Api/V1/NfeController.php:134
- app/app/Http/Controllers/Api/V1/NfeController.php:140
'200':
description: Download do arquivo.
x-source:
- app/app/Http/Controllers/Api/V1/NfeController.php:146
content:
application/octet-stream:
schema:
type: string
format: binary
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value: ARQUIVO_FICTICIO
security:
- bearerAuth: []
parameters:
- name: invoice
in: path
required: true
schema:
type: integer
pattern: '[0-9]+'
/api/v1/nfce/{invoice}/cancel:
post:
operationId: post_api_v1_nfce__invoice__cancel
tags:
- nfce
summary: Nfe cancel
x-source: app/app/Http/Controllers/Api/V1/NfeController.php:156
x-middleware:
- api
- auth:sanctum
- agent.provider
- throttle:api
- tenant.identify
- tenant.status
responses:
'202':
description: Resposta implementada pelo controlador.
content:
application/json:
schema:
type: object
properties:
invoice_id:
type: integer
x-source: app/app/Modules/Fiscal/Nfe/Models/Nfe.php
message:
type: string
example: Cancelamento enfileirado
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
invoice_id: 1
message: Cancelamento enfileirado
x-source:
- app/app/Http/Controllers/Api/V1/NfeController.php:169
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/post_api_v1_nfce__invoice__cancelRequest'
examples:
estrutura_ficticia:
summary: Exemplo estrutural fictício; não é recibo de execução.
description: Dados sintéticos para explicar o formato. Identificadores, cadastros fiscais, arquivos e regras de domínio devem ser substituídos por valores válidos do ambiente de homologação. Este exemplo não comprova aceitação fiscal.
value:
justificativa: EXEMPLO_FICTICIO
parameters:
- name: invoice
in: path
required: true
schema:
type: integer
pattern: '[0-9]+'
components:
schemas:
post_api_v1_nfce_emitRequest:
type: object
properties:
natureza_operacao:
x-laravel-rules:
- sometimes
- string
- max:60
type: string
maxLength: 60
pagamentos:
x-laravel-rules:
- sometimes
- array
- min:1
type: array
minItems: 1
items:
type: object
properties:
forma:
x-laravel-rules:
- required_with:pagamentos
- string
- regex:/^\d{2}$/
type: string
description: Obrigatório quando estiver presente pagamentos.
pattern: ^\d{2}$
valor:
x-laravel-rules:
- required_with:pagamentos
- numeric
- min:0
type: number
description: Obrigatório quando estiver presente pagamentos.
minimum: 0
tipo_integracao:
x-laravel-rules:
- sometimes
- integer
- in:1,2
type: integer
enum:
- 1
- 2
cnpj_credenciadora:
x-laravel-rules:
- sometimes
- string
- regex:/^\d{14}$/
type: string
pattern: ^\d{14}$
bandeira:
x-laravel-rules:
- sometimes
- string
- regex:/^\d{2}$/
type: string
pattern: ^\d{2}$
autorizacao:
x-laravel-rules:
- sometimes
- string
- max:128
type: string
maxLength: 128
destinatario:
x-laravel-rules:
- required
- array
type: object
properties:
cpf_cnpj:
x-laravel-rules:
- required
- string
x-laravel-custom-validation: true
description: Validação adicional de domínio é aplicada pelo servidor (por exemplo dígitos verificadores e autorização).
type: string
nome:
x-laravel-rules:
- required
- string
- max:255
type: string
maxLength: 255
inscricao_estadual:
x-laravel-rules:
- nullable
- string
- max:14
type:
- string
- 'null'
maxLength: 14
endereco:
x-laravel-rules:
- required
- array
type: object
properties:
logradouro:
x-laravel-rules:
- required
- string
- max:255
type: string
maxLength: 255
numero:
x-laravel-rules:
- required
- string
- max:60
type: string
maxLength: 60
bairro:
x-laravel-rules:
- required
- string
- max:60
type: string
maxLength: 60
municipio:
x-laravel-rules:
- required
- string
- max:60
type: string
maxLength: 60
uf:
x-laravel-rules:
- required
- string
- size:2
type: string
minLength: 2
maxLength: 2
cep:
x-laravel-rules:
- required
- regex:/^\d{8}$/
pattern: ^\d{8}$
required:
- logradouro
- numero
- bairro
- municipio
- uf
- cep
required:
- cpf_cnpj
- nome
- endereco
itens:
x-laravel-rules:
- required
- array
- min:1
type: array
minItems: 1
items:
type: object
properties:
produto:
x-laravel-rules:
- required
- string
- max:120
type: string
maxLength: 120
codigo:
x-laravel-rules:
- required_with:itens.*.rtc_resolution_id
- nullable
- string
- max:60
type:
- string
- 'null'
description: Obrigatório quando estiver presente itens.*.rtc_resolution_id.
maxLength: 60
ncm:
x-laravel-rules:
- required
- regex:/^\d{8}$/
pattern: ^\d{8}$
cfop:
x-laravel-rules:
- required
- regex:/^\d{4}$/
pattern: ^\d{4}$
unidade:
x-laravel-rules:
- required
- string
- max:6
type: string
maxLength: 6
quantidade:
x-laravel-rules:
- required
- numeric
- min:0.01
type: number
minimum: 0.01
valor_unitario:
x-laravel-rules:
- required
- numeric
- min:0.01
type: number
minimum: 0.01
csosn:
x-laravel-rules:
- nullable
- string
- max:3
type:
- string
- 'null'
maxLength: 3
cst:
x-laravel-rules:
- nullable
- string
- max:3
type:
- string
- 'null'
maxLength: 3
rtc_resolution_id:
x-laravel-rules:
- nullable
- uuid
type:
- string
- 'null'
format: uuid
required:
- produto
- ncm
- cfop
- unidade
- quantidade
- valor_unitario
x-prohibited-fields:
- ibscbs
required:
- destinatario
- itens
x-source:
- app/app/Http/Requests/EmitNfeRequest.php:20
post_api_v1_nfce__invoice__cancelRequest:
type: object
properties:
justificativa:
x-laravel-rules:
- required
- string
- min:15
- max:255
type: string
minLength: 15
maxLength: 255
required:
- justificativa
x-source:
- app/app/Http/Requests/CancelNfeRequest.php:27
securitySchemes:
bearerAuth:
type: http
scheme: bearer