Central Fox Tecnologia LTDA Tenant API

openapi: 3.2.0
info:
  title: FOX NF-e Tenant 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: Tenant
paths:
  /api/v1/tenant:
    get:
      operationId: get_api_v1_tenant
      tags:
      - Tenant
      summary: Tenant show
      x-source: app/app/Http/Controllers/Api/V1/TenantController.php:18
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:132
                  slug:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:133
                  name:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:134
                  plan:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:135
                  cnpj:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:136
                  razao_social:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:137
                  inscricao_estadual:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:138
                  crt:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:139
                  endereco:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:140
                  nfe_serie_padrao:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:141
                  nfe_ambiente:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:142
                  cnae_principal:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:143
                  trial_ends_at:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:144
                  onboarding_step:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:145
                  onboarding_completed_at:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:146
              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:
                    id: null
                    slug: null
                    name: null
                    plan: null
          x-source:
          - app/app/Http/Controllers/Api/V1/TenantController.php:22
      security:
      - bearerAuth: []
    patch:
      operationId: patch_api_v1_tenant
      tags:
      - Tenant
      summary: Tenant patch
      x-source: app/app/Http/Controllers/Api/V1/TenantController.php:25
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: true
                  tenant:
                    type: object
                    properties:
                      id:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:132
                      slug:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:133
                      name:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:134
                      plan:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:135
                      cnpj:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:136
                      razao_social:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:137
                      inscricao_estadual:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:138
                      crt:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:139
                      endereco:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:140
                      nfe_serie_padrao:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:141
                      nfe_ambiente:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:142
                      cnae_principal:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:143
                      trial_ends_at:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:144
                      onboarding_step:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:145
                      onboarding_completed_at:
                        description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                        x-source: app/app/Http/Controllers/Api/V1/TenantController.php:146
              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:
                    ok: true
                    tenant:
                      id: null
                      slug: null
                      name: null
                      plan: null
          x-source:
          - app/app/Http/Controllers/Api/V1/TenantController.php:76
      security:
      - bearerAuth: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patch_api_v1_tenantRequest'
            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:
                  cnpj: EXEMPLO_FICTICIO
                  razao_social: EXEMPLO_FICTICIO
                  inscricao_estadual: EXEMPLO_FICTICIO
                  crt: 1
  /api/v1/tenant/onboarding:
    patch:
      operationId: patch_api_v1_tenant_onboarding
      tags:
      - Tenant
      summary: Tenant onboarding
      x-source: app/app/Http/Controllers/Api/V1/TenantController.php:86
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: true
                  onboarding_step:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:123
                  onboarding_completed_at:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/TenantController.php:124
              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:
                    ok: true
                    onboarding_step: null
                    onboarding_completed_at: null
          x-source:
          - app/app/Http/Controllers/Api/V1/TenantController.php:121
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patch_api_v1_tenant_onboardingRequest'
            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:
                  step: 1
  /api/v1/tenant/contingency:
    get:
      operationId: get_api_v1_tenant_contingency
      tags:
      - Tenant
      summary: Contingency index
      x-source: app/app/Http/Controllers/Api/V1/ContingencyController.php:35
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  contingencia:
                    type: array
                    items: {}
                    example: []
              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:
                    contingencia: []
          x-source:
          - app/app/Http/Controllers/Api/V1/ContingencyController.php:51
      security:
      - bearerAuth: []
  /api/v1/tenant/contingency/activate:
    post:
      operationId: post_api_v1_tenant_contingency_activate
      tags:
      - Tenant
      summary: Contingency activate
      x-source: app/app/Http/Controllers/Api/V1/ContingencyController.php:54
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - throttle:10,60
      - ability:contingency:manage
      responses:
        '422':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    message:
                      description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                      x-source: app/app/Http/Controllers/Api/V1/ContingencyController.php:68
                - type: object
                  properties:
                    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:
                    message: null
          x-source:
          - app/app/Http/Controllers/Api/V1/ContingencyController.php:67
          - app/app/Http/Controllers/Api/V1/ContingencyController.php:80
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dominio:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/ContingencyController.php:63
                  ativado:
                    type: boolean
                    example: true
                  modo:
                    anyOf:
                    - description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                      x-source: app/app/Http/Controllers/Api/V1/ContingencyController.php:93
                    - type: string
                      example: OFFLINE
              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:
                    dominio: null
                    ativado: true
                    modo: null
          x-source:
          - app/app/Http/Controllers/Api/V1/ContingencyController.php:90
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_tenant_contingency_activateRequest'
            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:
                  dominio: nfe
                  justificativa: EXEMPLO_FICTICIO
  /api/v1/tenant/contingency/deactivate:
    post:
      operationId: post_api_v1_tenant_contingency_deactivate
      tags:
      - Tenant
      summary: Contingency deactivate
      x-source: app/app/Http/Controllers/Api/V1/ContingencyController.php:97
      x-middleware:
      - api
      - auth:sanctum
      - agent.provider
      - tenant.identify
      - throttle:10,60
      - ability:contingency:manage
      responses:
        '200':
          description: Resposta implementada pelo controlador.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dominio:
                    description: Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.
                    x-source: app/app/Http/Controllers/Api/V1/ContingencyController.php:104
                  ativado:
                    type: boolean
                    example: false
              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:
                    dominio: null
                    ativado: false
          x-source:
          - app/app/Http/Controllers/Api/V1/ContingencyController.php:114
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/post_api_v1_tenant_contingency_deactivateRequest'
            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:
                  dominio: nfe
components:
  schemas:
    patch_api_v1_tenantRequest:
      type: object
      properties:
        cnpj:
          x-laravel-rules:
          - sometimes
          - string
          - max:18
          type: string
          maxLength: 18
        razao_social:
          x-laravel-rules:
          - sometimes
          - string
          - max:255
          type: string
          maxLength: 255
        inscricao_estadual:
          x-laravel-rules:
          - sometimes
          - nullable
          - string
          - max:60
          type:
          - string
          - 'null'
          maxLength: 60
        crt:
          x-laravel-rules:
          - sometimes
          - integer
          - in:1,2,3,4
          type: integer
          enum:
          - 1
          - 2
          - 3
          - 4
        endereco:
          x-laravel-rules:
          - sometimes
          - array
          type: object
          properties:
            logradouro:
              x-laravel-rules:
              - sometimes
              - string
              - max:255
              type: string
              maxLength: 255
            numero:
              x-laravel-rules:
              - sometimes
              - string
              - max:60
              type: string
              maxLength: 60
            bairro:
              x-laravel-rules:
              - sometimes
              - string
              - max:255
              type: string
              maxLength: 255
            municipio:
              x-laravel-rules:
              - sometimes
              - string
              - max:255
              type: string
              maxLength: 255
            uf:
              x-laravel-rules:
              - sometimes
              - string
              - size:2
              type: string
              minLength: 2
              maxLength: 2
            cep:
              x-laravel-rules:
              - sometimes
              - string
              - max:9
              type: string
              maxLength: 9
        nfe_serie_padrao:
          x-laravel-rules:
          - sometimes
          - integer
          - min:1
          - max:999
          type: integer
          minimum: 1
          maximum: 999
        nfe_ambiente:
          x-laravel-rules:
          - sometimes
          - integer
          - in:1,2
          type: integer
          enum:
          - 1
          - 2
        cnae_principal:
          x-laravel-rules:
          - sometimes
          - nullable
          - string
          - max:20
          type:
          - string
          - 'null'
          maxLength: 20
      x-source:
      - app/app/Http/Controllers/Api/V1/TenantController.php:27
    patch_api_v1_tenant_onboardingRequest:
      type: object
      properties:
        step:
          x-laravel-rules:
          - required
          - integer
          - min:0
          - max:4
          type: integer
          minimum: 0
          maximum: 4
        completed:
          x-laravel-rules:
          - sometimes
          - boolean
          type: boolean
      required:
      - step
      x-source:
      - app/app/Http/Controllers/Api/V1/TenantController.php:88
    post_api_v1_tenant_contingency_deactivateRequest:
      type: object
      properties:
        dominio:
          x-laravel-rules:
          - required
          - string
          - in:nfe,cte,nfcom,mdfe,dce
          type: string
          enum:
          - nfe
          - cte
          - nfcom
          - mdfe
          - dce
      required:
      - dominio
      x-source:
      - app/app/Http/Controllers/Api/V1/ContingencyController.php:99
    post_api_v1_tenant_contingency_activateRequest:
      type: object
      properties:
        dominio:
          x-laravel-rules:
          - required
          - string
          - in:nfe,cte,nfcom,mdfe,dce
          type: string
          enum:
          - nfe
          - cte
          - nfcom
          - mdfe
          - dce
        modo:
          x-laravel-rules:
          - sometimes
          - string
          - max:20
          type: string
          maxLength: 20
        justificativa:
          x-laravel-rules:
          - required
          - string
          - min:15
          - max:256
          type: string
          minLength: 15
          maxLength: 256
      required:
      - dominio
      - justificativa
      x-source:
      - app/app/Http/Controllers/Api/V1/ContingencyController.php:56
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer