Central Fox Tecnologia LTDA Nfgas API

The nfgas API from Central Fox Tecnologia LTDA — 2 operation(s) for nfgas.

GitHub OpenAPI

Operations 2

POST /api/v1/nfgas Nfgas store #
GET /api/v1/nfgas/{id} Nfgas show #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/foxnfe-com-br:foxnfe-com-br-nfgas-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

foxnfe-com-br-nfgas-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: FOX NF-e Nfgas 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: nfgas
paths:
  /api/v1/nfgas:
    post:
      operationId: post_api_v1_nfgas
      tags:
      - nfgas
      summary: Nfgas store
      x-source: app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:17
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - tenant.status
      - plan.limits
      - throttle:30,60
      - ability:nfes:emit
      responses:
        '201':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      numero_nfgas:
                        type: integer
                      serie:
                        type: integer
                      modelo:
                        type: integer
                      ambiente:
                        type: integer
                      status:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:83
                      chave_acesso:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:84
                      rejection_code:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:84
                      rejection_reason:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:85
                      created_at:
                        type:
                        - string
                        - 'null'
                        format: date-time
              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:
                    data:
                      id: 1
                      numero_nfgas: 1
                      serie: 1
                      modelo: 1
          x-source:
          - app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:65
        '422':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: nfgas_make_failed
                  message:
                    type: string
                  details:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:67
              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: nfgas_make_failed
                    message: EXEMPLO_FICTICIO
                    details: null
          x-source:
          - app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:67
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_nfgasRequest'
            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:
                  ide:
                    cUF: 1
                    dhEmi: EXEMPLO_FICTICIO
                    cMunFG: EXEMPLO_FICTICIO
                  emit:
                    CNPJ: EXEMPLO_FICTIC
                    IE: EXEMPLO_FICTICIO
                    xNome: EXEMPLO_FICTICIO
                    enderEmit:
                      xLgr: EXEMPLO_FICTICIO
                      nro: EXEMPLO_FICTICIO
                      xBairro: EXEMPLO_FICTICIO
                      cMun: EXEMPLO_FICTICIO
                      xMun: EXEMPLO_FICTICIO
                      UF: EXEMPLO_FICTICIO
                      CEP: EXEMPLO_FICTICIO
                  dest:
                    CNPJ: EXEMPLO_FICTICIO
                    xNome: EXEMPLO_FICTICIO
                    enderDest:
                      xLgr: EXEMPLO_FICTICIO
                      nro: EXEMPLO_FICTICIO
                      xBairro: EXEMPLO_FICTICIO
                      cMun: EXEMPLO_FICTICIO
                      xMun: EXEMPLO_FICTICIO
                      UF: EXEMPLO_FICTICIO
                      CEP: EXEMPLO_FICTICIO
                  prod:
                    cProd: EXEMPLO_FICTICIO
                    xProd: EXEMPLO_FICTICIO
                    cClass: EXEMPLO_FICTICIO
                    qFaturada: 1
                    vItem: 1
                    vProd: 1
                  total:
                    vProd: 1
                    vNF: 1
  /api/v1/nfgas/{id}:
    get:
      operationId: get_api_v1_nfgas__id_
      tags:
      - nfgas
      summary: Nfgas show
      x-source: app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:71
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - tenant.status
      - plan.limits
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      numero_nfgas:
                        type: integer
                      serie:
                        type: integer
                      modelo:
                        type: integer
                      ambiente:
                        type: integer
                      status:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:83
                      chave_acesso:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:84
                      rejection_code:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:84
                      rejection_reason:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:85
                      created_at:
                        type:
                        - string
                        - 'null'
                        format: date-time
              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:
                    data:
                      id: 1
                      numero_nfgas: 1
                      serie: 1
                      modelo: 1
          x-source:
          - app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:75
      security:
      - bearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          pattern: '[0-9]+'
components:
  schemas:
    post_api_v1_nfgasRequest:
      type: object
      properties:
        ide:
          x-laravel-rules:
          - required
          - array
          type: object
          properties:
            cUF:
              x-laravel-rules:
              - required
              - integer
              type: integer
            dhEmi:
              x-laravel-rules:
              - required
              - string
              type: string
            serie:
              x-laravel-rules:
              - sometimes
              - integer
              type: integer
            cMunFG:
              x-laravel-rules:
              - required
              - string
              type: string
          required:
          - cUF
          - dhEmi
          - cMunFG
        emit:
          x-laravel-rules:
          - required
          - array
          type: object
          properties:
            CNPJ:
              x-laravel-rules:
              - required
              - string
              - size:14
              type: string
              minLength: 14
              maxLength: 14
            IE:
              x-laravel-rules:
              - required
              - string
              type: string
            xNome:
              x-laravel-rules:
              - required
              - string
              type: string
            enderEmit:
              x-laravel-rules:
              - required
              - array
              type: object
              properties:
                xLgr:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                nro:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                xBairro:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                cMun:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                xMun:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                UF:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                CEP:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
              required:
              - xLgr
              - nro
              - xBairro
              - cMun
              - xMun
              - UF
              - CEP
          required:
          - CNPJ
          - IE
          - xNome
          - enderEmit
        dest:
          x-laravel-rules:
          - required
          - array
          type: object
          properties:
            CNPJ:
              x-laravel-rules:
              - required
              - string
              type: string
            xNome:
              x-laravel-rules:
              - required
              - string
              type: string
            enderDest:
              x-laravel-rules:
              - required
              - array
              type: object
              properties:
                xLgr:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                nro:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                xBairro:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                cMun:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                xMun:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                UF:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
                CEP:
                  x-laravel-rules:
                  - required
                  - string
                  type: string
              required:
              - xLgr
              - nro
              - xBairro
              - cMun
              - xMun
              - UF
              - CEP
          required:
          - CNPJ
          - xNome
          - enderDest
        prod:
          x-laravel-rules:
          - required
          - array
          type: object
          properties:
            cProd:
              x-laravel-rules:
              - required
              - string
              type: string
            xProd:
              x-laravel-rules:
              - required
              - string
              type: string
            cClass:
              x-laravel-rules:
              - required
              - string
              type: string
            qFaturada:
              x-laravel-rules:
              - required
              - numeric
              type: number
            vItem:
              x-laravel-rules:
              - required
              - numeric
              type: number
            vProd:
              x-laravel-rules:
              - required
              - numeric
              type: number
          required:
          - cProd
          - xProd
          - cClass
          - qFaturada
          - vItem
          - vProd
        total:
          x-laravel-rules:
          - required
          - array
          type: object
          properties:
            vProd:
              x-laravel-rules:
              - required
              - numeric
              type: number
            vNF:
              x-laravel-rules:
              - required
              - numeric
              type: number
          required:
          - vProd
          - vNF
      required:
      - ide
      - emit
      - dest
      - prod
      - total
      x-source:
      - app/app/Modules/Fiscal/Nfgas/Http/Controllers/NfgasController.php:19
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer