{ "openapi": "3.1.0", "info": { "title": "FOX NF-e 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" } ], "paths": { "/api/v1/operations/email/deliveries": { "get": { "operationId": "get_api_v1_operations_email_deliveries", "tags": [ "operations" ], "summary": "EmailHistory index", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailHistoryController.php:44", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:60,1", "ability:operations:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "mailable": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailHistoryController.php:133" }, "recipient": { "type": "string" }, "status": { "type": "string" }, "status_label": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailHistoryController.php:118" }, "attempts": { "type": "integer" }, "awaiting_reconciliation": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailHistoryController.php:110" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } } } }, "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, "mailable": null, "recipient": "EXEMPLO_FICTICIO", "status": "EXEMPLO_FICTICIO" } ], "meta": { "current_page": 1, "last_page": 1, "per_page": 1, "total": 1 } } } } } }, "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailHistoryController.php:50" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/documents/imports": { "post": { "operationId": "post_api_v1_documents_imports", "tags": [ "documents" ], "summary": "DocumentImport store", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:32", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:documents:write,nfes:emit", "throttle:api", "throttle:20,60" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:55" }, "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:56" } } }, "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": { "status": null, "data": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:54" ] }, "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:55" }, "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:56" } } }, "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": { "status": null, "data": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:54" ] }, "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/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:112" }, "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/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:111" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/post_api_v1_documents_importsRequest" }, "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": { "file": "ARQUIVO_FICTICIO" } } } } } } } }, "/api/v1/documents/imports/preview": { "post": { "operationId": "post_api_v1_documents_imports_preview", "tags": [ "documents" ], "summary": "DocumentImport preview", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:67", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:documents:write,nfes:emit", "throttle:api", "throttle:40,60" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "preview" }, "data": { "type": "object", "properties": { "type": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:88" }, "family": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:89" }, "modelo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:90" }, "evento_tipo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:91" }, "evento_seq": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:92" }, "ambiente": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:93" }, "numero": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:94" }, "serie": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:95" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:96" }, "emitente_documento": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:97" }, "destinatario_documento": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:98" }, "bound_role": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:99" }, "emitido_em": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:100" }, "valor_total": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:101" }, "origin": { "type": "string", "example": "importada" }, "integrity": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:103" }, "authorization": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:104" } } } } }, "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": { "status": "preview", "data": { "type": null, "family": null, "modelo": null, "evento_tipo": null } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:85" ] }, "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/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:112" }, "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/Modules/Fiscal/Documents/Http/Controllers/DocumentImportController.php:111" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/post_api_v1_documents_imports_previewRequest" }, "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": { "file": "ARQUIVO_FICTICIO" } } } } } } } }, "/api/v1/documents": { "get": { "operationId": "get_api_v1_documents", "tags": [ "documents" ], "summary": "Document index", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentController.php:33", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:documents:read,nfes:emit", "throttle:api" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentController.php:41" }, "meta": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentController.php:42" }, "totals": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentController.php:43" } } }, "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": null, "meta": null, "totals": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentController.php:40" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "date_from", "in": "query", "required": true, "schema": { "x-laravel-rules": [ "required", "date_format:Y-m-d" ], "type": "string", "format": "date" } }, { "name": "date_to", "in": "query", "required": true, "schema": { "x-laravel-rules": [ "required", "date_format:Y-m-d", "after_or_equal:date_from" ], "type": "string", "format": "date", "description": "Deve ser posterior ou igual a date_from." } }, { "name": "tipos", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "array" ], "type": "array", "items": { "x-laravel-rules": [ "string", "in:55,65,nfse,recebida,nfe,nfce,evento,eventos,inutilizacao,inutilizacoes,cte,57,cte_recebido,nfse_recebida,nfse-recebida" ], "type": "string", "enum": [ "55", "65", "nfse", "recebida", "nfe", "nfce", "evento", "eventos", "inutilizacao", "inutilizacoes", "cte", "57", "cte_recebido", "nfse_recebida", "nfse-recebida" ] } } }, { "name": "ambiente", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "in:1,2" ], "type": [ "integer", "null" ], "enum": [ 1, 2, null ] } }, { "name": "origin", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "string", "in:emitida,recebida,importada" ], "type": [ "string", "null" ], "enum": [ "emitida", "recebida", "importada", null ] } }, { "name": "status", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "string", "in:draft,pending,processing,authorized,rejected,denied,canceled,contingency,substituted,recebida,importada" ], "type": [ "string", "null" ], "enum": [ "draft", "pending", "processing", "authorized", "rejected", "denied", "canceled", "contingency", "substituted", "recebida", "importada", null ] } }, { "name": "participante", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:255" ], "type": [ "string", "null" ], "maxLength": 255 } }, { "name": "valor_min", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{1,15}(\\.\\d{1,2})?$/" ], "type": [ "string", "null" ], "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" } }, { "name": "valor_max", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{1,15}(\\.\\d{1,2})?$/" ], "type": [ "string", "null" ], "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" } }, { "name": "sort", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "string", "in:date,valor,numero" ], "type": "string", "enum": [ "date", "valor", "numero" ] } }, { "name": "sort_direction", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "string", "in:asc,desc" ], "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "integer", "min:1" ], "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "integer", "min:1", "max:100" ], "type": "integer", "minimum": 1, "maximum": 100 } } ] } }, "/api/v1/documents/exports": { "post": { "operationId": "post_api_v1_documents_exports", "tags": [ "documents" ], "summary": "DocumentExport store", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:34", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:documents:read,nfes:emit", "throttle:api", "throttle:30,60" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:41" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:40" ] }, "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:41" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:40" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_documents_exportsRequest" }, "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": { "date_from": "2026-10-01", "date_to": "2026-10-01" } } } } } } } }, "/api/v1/documents/exports/{requestId}/download": { "get": { "operationId": "get_api_v1_documents_exports__requestId__download", "tags": [ "documents" ], "summary": "DocumentExport download", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:107", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:documents:read,nfes:emit", "throttle:api" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "export_not_available" }, "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": "export_not_available", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:117" ] }, "200": { "description": "Download do arquivo.", "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:137" ], "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": "requestId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Za-z]{26}" } } ] } }, "/api/v1/documents/exports/{requestId}": { "get": { "operationId": "get_api_v1_documents_exports__requestId_", "tags": [ "documents" ], "summary": "DocumentExport show", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:50", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:documents:read,nfes:emit", "throttle:api" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "export_not_found" }, "message": { "type": "string", "example": "Exportação não encontrada para este tenant." } } }, "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": "export_not_found", "message": "Exportação não encontrada para este tenant." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:60" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "downloads": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:70" }, "ip": { "anyOf": [ { "type": "string", "example": "" }, { "type": "string", "example": "*" } ] }, "bytes": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:70" }, "downloaded_at": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:70" } } } } } }, "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": { "downloads": [ { "user_id": null, "ip": "", "bytes": null, "downloaded_at": null } ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:66" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Za-z]{26}" } } ] } }, "/api/v1/documents/exports/{requestId}/verify": { "post": { "operationId": "post_api_v1_documents_exports__requestId__verify", "tags": [ "documents" ], "summary": "DocumentExport verify", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:77", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:documents:read,nfes:emit", "throttle:api", "throttle:10,1" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "export_not_available" }, "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": "export_not_available", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:83" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:81" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentExportController.php:86" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9A-Za-z]{26}" } } ] } }, "/api/v1/documents/report": { "get": { "operationId": "get_api_v1_documents_report", "tags": [ "documents" ], "summary": "DocumentReport __invoke", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentReportController.php:19", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:documents:read,nfes:emit", "throttle:api", "throttle:20,1" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "report_limit_exceeded" }, "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": "report_limit_exceeded", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentReportController.php:26" ] }, "200": { "description": "Resposta do controlador.", "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" } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentReportController.php:30" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "format", "in": "query", "required": true, "schema": { "x-laravel-rules": [ "required", "string", "in:csv,xlsx" ], "type": "string", "enum": [ "csv", "xlsx" ] } }, { "name": "date_from", "in": "query", "required": true, "schema": { "x-laravel-rules": [ "required", "date_format:Y-m-d" ], "type": "string", "format": "date" } }, { "name": "date_to", "in": "query", "required": true, "schema": { "x-laravel-rules": [ "required", "date_format:Y-m-d", "after_or_equal:date_from" ], "type": "string", "format": "date", "description": "Deve ser posterior ou igual a date_from." } }, { "name": "tipos", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "array" ], "type": "array", "items": { "x-laravel-rules": [ "string", "in:55,65,nfse,recebida,nfe,nfce,evento,eventos,inutilizacao,inutilizacoes,cte,57,cte_recebido,nfse_recebida,nfse-recebida" ], "type": "string", "enum": [ "55", "65", "nfse", "recebida", "nfe", "nfce", "evento", "eventos", "inutilizacao", "inutilizacoes", "cte", "57", "cte_recebido", "nfse_recebida", "nfse-recebida" ] } } }, { "name": "ambiente", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "in:1,2" ], "type": [ "integer", "null" ], "enum": [ 1, 2, null ] } }, { "name": "origin", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "string", "in:emitida,recebida,importada" ], "type": [ "string", "null" ], "enum": [ "emitida", "recebida", "importada", null ] } }, { "name": "status", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "string", "in:draft,pending,processing,authorized,rejected,denied,canceled,contingency,substituted,recebida,importada" ], "type": [ "string", "null" ], "enum": [ "draft", "pending", "processing", "authorized", "rejected", "denied", "canceled", "contingency", "substituted", "recebida", "importada", null ] } }, { "name": "participante", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:255" ], "type": [ "string", "null" ], "maxLength": 255 } }, { "name": "valor_min", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{1,15}(\\.\\d{1,2})?$/" ], "type": [ "string", "null" ], "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" } }, { "name": "valor_max", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{1,15}(\\.\\d{1,2})?$/" ], "type": [ "string", "null" ], "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" } } ] } }, "/api/v1/documents/{source}/{id}": { "get": { "operationId": "get_api_v1_documents__source___id_", "tags": [ "documents" ], "summary": "Document show", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentController.php:51", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:documents:read,nfes:emit", "throttle:api" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "document_not_found" }, "message": { "type": "string", "example": "Documento não encontrado para este tenant." } } }, "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": "document_not_found", "message": "Documento não encontrado para este tenant." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentController.php:58" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentController.php:64" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Controllers/DocumentController.php:64" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "source", "in": "path", "required": true, "schema": { "type": "string", "pattern": "nfes|nfses|nfe_distribuicao|imported_documents|nfes_eventos|nfe_inutilizacoes|nfse_distribuicao" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe-distribuicao": { "get": { "operationId": "get_api_v1_nfe_distribuicao", "tags": [ "nfe-distribuicao" ], "summary": "DistribuicaoDFe index", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:36", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nsu": { "type": "integer" }, "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:60" }, "categoria": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:62" }, "documento_tipo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:63" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:64" }, "evento_tipo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:65" }, "evento_seq": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:66" }, "resumo": { "type": "boolean" }, "ambiente": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:68" }, "fonte": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:69" }, "captured_at": { "type": [ "string", "null" ], "format": "date-time" } } } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "per_page": { "type": "integer" }, "current_page": { "type": "integer" }, "last_page": { "type": "integer" } } } } }, "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, "nsu": 1, "schema": null, "categoria": null } ], "meta": { "total": 1, "per_page": 1, "current_page": 1, "last_page": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:74" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/nfe-distribuicao/captura-automatica": { "get": { "operationId": "get_api_v1_nfe_distribuicao_captura_automatica", "tags": [ "nfe-distribuicao" ], "summary": "DistribuicaoDFe optins", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:142", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:144" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:146" ] } }, "security": [ { "bearerAuth": [] } ] }, "put": { "operationId": "put_api_v1_nfe_distribuicao_captura_automatica", "tags": [ "nfe-distribuicao" ], "summary": "DistribuicaoDFe enableOptin", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:149", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit" ], "responses": { "422": { "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/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:157" }, "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/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:157" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:165" }, "message": { "type": "string", "example": "Captura automática habilitada para a próxima execução agendada. Nenhuma manifestação é automática." } } }, "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": null, "message": "Captura automática habilitada para a próxima execução agendada. Nenhuma manifestação é automática." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:167" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/put_api_v1_nfe_distribuicao_captura_automaticaRequest" }, "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": { "certificate_id": 1, "ambiente": 1 } } } } } } } }, "/api/v1/nfe-distribuicao/cursor": { "get": { "operationId": "get_api_v1_nfe_distribuicao_cursor", "tags": [ "nfe-distribuicao" ], "summary": "DistribuicaoDFe cursor", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:88", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:96" }, "ambiente": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:97" }, "feed": { "type": "string" }, "ultimo_nsu": { "type": "integer" }, "max_nsu": { "type": "integer" }, "last_cstat": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:101" }, "legado": { "type": "boolean" }, "em_cooldown": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:103" }, "next_allowed_at": { "type": [ "string", "null" ], "format": "date-time" }, "sincronizado_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": [ { "cnpj": null, "ambiente": null, "feed": "EXEMPLO_FICTICIO", "ultimo_nsu": 1 } ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:109" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/nfe-distribuicao/manifestacoes": { "get": { "operationId": "get_api_v1_nfe_distribuicao_manifestacoes", "tags": [ "nfe-distribuicao" ], "summary": "NfeManifestacao index", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:41", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:199" }, "tipo_evento": { "type": "integer" }, "n_seq_evento": { "type": "integer" }, "ambiente": { "type": "integer" }, "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:203" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:204" }, "payload_hash": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:206" }, "aprovado_por": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:207" }, "aprovado_at": { "type": [ "string", "null" ], "format": "date-time" }, "cstat": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:209" }, "xmotivo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:210" }, "protocolo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:211" }, "transmitido_at": { "type": [ "string", "null" ], "format": "date-time" } } } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "per_page": { "type": "integer" }, "current_page": { "type": "integer" }, "last_page": { "type": "integer" } } } } }, "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, "chave_acesso": null, "tipo_evento": 1, "n_seq_evento": 1 } ], "meta": { "total": 1, "per_page": 1, "current_page": 1, "last_page": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:52" ] } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "post_api_v1_nfe_distribuicao_manifestacoes", "tags": [ "nfe-distribuicao" ], "summary": "NfeManifestacao store", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:75", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit" ], "responses": { "409": { "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/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:101" }, "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/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:101" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "error": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:101" }, "message": { "type": "string" } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "manifestation_invalid" }, "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/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:101", "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:104" ] }, "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:199" }, "tipo_evento": { "type": "integer" }, "n_seq_evento": { "type": "integer" }, "ambiente": { "type": "integer" }, "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:203" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:204" }, "payload_hash": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:206" }, "aprovado_por": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:207" }, "aprovado_at": { "type": [ "string", "null" ], "format": "date-time" }, "cstat": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:209" }, "xmotivo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:210" }, "protocolo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:211" }, "transmitido_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, "chave_acesso": null, "tipo_evento": 1, "n_seq_evento": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:107" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfe_distribuicao_manifestacoesRequest" }, "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": { "chave_acesso": "00000000000000000000000000000000000000000000", "tipo_evento": 210200 } } } } } } } }, "/api/v1/nfe-distribuicao/manifestacoes/{id}": { "get": { "operationId": "get_api_v1_nfe_distribuicao_manifestacoes__id_", "tags": [ "nfe-distribuicao" ], "summary": "NfeManifestacao show", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:64", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:199" }, "tipo_evento": { "type": "integer" }, "n_seq_evento": { "type": "integer" }, "ambiente": { "type": "integer" }, "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:203" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:204" }, "payload_hash": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:206" }, "aprovado_por": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:207" }, "aprovado_at": { "type": [ "string", "null" ], "format": "date-time" }, "cstat": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:209" }, "xmotivo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:210" }, "protocolo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:211" }, "transmitido_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, "chave_acesso": null, "tipo_evento": 1, "n_seq_evento": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:71" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "manifestation_not_found" }, "message": { "type": "string", "example": "Manifestação não encontrada para este tenant." } } }, "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": "manifestation_not_found", "message": "Manifestação não encontrada para este tenant." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:188" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe-distribuicao/captura-automatica/{id}": { "delete": { "operationId": "delete_api_v1_nfe_distribuicao_captura_automatica__id_", "tags": [ "nfe-distribuicao" ], "summary": "DistribuicaoDFe disableOptin", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:170", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:173" }, "message": { "type": "string", "example": "Novas capturas agendadas desabilitadas; trabalhos já enfileirados podem estar em andamento." } } }, "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": null, "message": "Novas capturas agendadas desabilitadas; trabalhos já enfileirados podem estar em andamento." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:176" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe-distribuicao/capturar": { "post": { "operationId": "post_api_v1_nfe_distribuicao_capturar", "tags": [ "nfe-distribuicao" ], "summary": "DistribuicaoDFe capturar", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:120", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit", "throttle:30,60" ], "responses": { "409": { "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/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:135" }, "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/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:134" ] }, "422": { "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/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:135" }, "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/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:134" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:132" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:140" ] }, "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:132" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:140" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfe_distribuicao_capturarRequest" }, "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": { "certificate_id": 1, "ambiente": 1, "fonte": "AN" } } } } } } } }, "/api/v1/nfe-distribuicao/manifestacoes/{id}/aprovar": { "post": { "operationId": "post_api_v1_nfe_distribuicao_manifestacoes__id__aprovar", "tags": [ "nfe-distribuicao" ], "summary": "NfeManifestacao aprovar", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:111", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "approval_rejected" }, "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": "approval_rejected", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:125" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:199" }, "tipo_evento": { "type": "integer" }, "n_seq_evento": { "type": "integer" }, "ambiente": { "type": "integer" }, "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:203" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:204" }, "payload_hash": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:206" }, "aprovado_por": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:207" }, "aprovado_at": { "type": [ "string", "null" ], "format": "date-time" }, "cstat": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:209" }, "xmotivo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:210" }, "protocolo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:211" }, "transmitido_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, "chave_acesso": null, "tipo_evento": 1, "n_seq_evento": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:128" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "manifestation_not_found" }, "message": { "type": "string", "example": "Manifestação não encontrada para este tenant." } } }, "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": "manifestation_not_found", "message": "Manifestação não encontrada para este tenant." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:188" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfe_distribuicao_manifestacoes__id__aprovarRequest" }, "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": { "payload_hash": "0000000000000000000000000000000000000000000000000000000000000000" } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe-distribuicao/manifestacoes/{id}/transmitir": { "post": { "operationId": "post_api_v1_nfe_distribuicao_manifestacoes__id__transmitir", "tags": [ "nfe-distribuicao" ], "summary": "NfeManifestacao transmitir", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:132", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_approved" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:143" } } }, "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": "not_approved", "message": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:141" ] }, "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string", "example": "queued" } } } } }, "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, "status": "queued" } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:156" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "manifestation_not_found" }, "message": { "type": "string", "example": "Manifestação não encontrada para este tenant." } } }, "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": "manifestation_not_found", "message": "Manifestação não encontrada para este tenant." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:188" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe-distribuicao/manifestacoes/{id}/reconciliar": { "post": { "operationId": "post_api_v1_nfe_distribuicao_manifestacoes__id__reconciliar", "tags": [ "nfe-distribuicao" ], "summary": "NfeManifestacao reconciliar", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:160", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reconcile_invalid" }, "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": "reconcile_invalid", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:172" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:199" }, "tipo_evento": { "type": "integer" }, "n_seq_evento": { "type": "integer" }, "ambiente": { "type": "integer" }, "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:203" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:204" }, "payload_hash": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:206" }, "aprovado_por": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:207" }, "aprovado_at": { "type": [ "string", "null" ], "format": "date-time" }, "cstat": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:209" }, "xmotivo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:210" }, "protocolo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:211" }, "transmitido_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, "chave_acesso": null, "tipo_evento": 1, "n_seq_evento": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:175" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "manifestation_not_found" }, "message": { "type": "string", "example": "Manifestação não encontrada para este tenant." } } }, "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": "manifestation_not_found", "message": "Manifestação não encontrada para este tenant." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeManifestacaoController.php:188" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe/{invoice}/cce": { "get": { "operationId": "get_api_v1_nfe__invoice__cce", "tags": [ "nfe" ], "summary": "NfeEvents index", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventsController.php:76", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "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" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "sequencial": { "type": "integer" }, "status": { "type": "string" }, "protocolo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventsController.php:91" }, "rejection_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventsController.php:92" }, "rejection_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventsController.php:93" }, "correcao": { "type": "string" }, "authorized_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": { "invoice_id": 1, "data": [ { "id": 1, "sequencial": 1, "status": "EXEMPLO_FICTICIO", "protocolo": null } ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventsController.php:98" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] }, "post": { "operationId": "post_api_v1_nfe__invoice__cce", "tags": [ "nfe" ], "summary": "NfeEvents store", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventsController.php:47", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit", "throttle:30,60" ], "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" }, "sequencial": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventsController.php:52" }, "status": { "type": "string", "example": "queued" }, "message": { "type": "string", "example": "CC-e enfileirada para processamento. Consulte GET .../cce para o desfecho." } } }, "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, "sequencial": null, "status": "queued", "message": "CC-e enfileirada para processamento. Consulte GET .../cce para o desfecho." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventsController.php:65" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfe__invoice__cceRequest" }, "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": { "correcao": "EXEMPLO_FICTICIO" } } } } } }, "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe/inutilizacoes": { "get": { "operationId": "get_api_v1_nfe_inutilizacoes", "tags": [ "nfe" ], "summary": "NfeInutilizacao index", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:24", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:29" } } } }, "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": [ null ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:29" ] } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "post_api_v1_nfe_inutilizacoes", "tags": [ "nfe" ], "summary": "NfeInutilizacao store", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:43", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit", "throttle:30,60" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:75" }, "status": { "anyOf": [ { "type": "string", "example": "queued" }, { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:76" } ] }, "message": { "anyOf": [ { "type": "string", "example": "Inutilização enfileirada para processamento." }, { "type": "string", "example": "Faixa já registrada; devolvendo o estado atual." } ] } } }, "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": null, "status": "queued", "message": "Inutilização enfileirada para processamento." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:74" ] }, "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:75" }, "status": { "anyOf": [ { "type": "string", "example": "queued" }, { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:76" } ] }, "message": { "anyOf": [ { "type": "string", "example": "Inutilização enfileirada para processamento." }, { "type": "string", "example": "Faixa já registrada; devolvendo o estado atual." } ] } } }, "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": null, "status": "queued", "message": "Inutilização enfileirada para processamento." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:74" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfe_inutilizacoesRequest" }, "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": { "serie": 1, "numero_inicial": 1, "numero_final": 1, "justificativa": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/nfe/inutilizacoes/{id}": { "get": { "operationId": "get_api_v1_nfe_inutilizacoes__id_", "tags": [ "nfe" ], "summary": "NfeInutilizacao show", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:32", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:40" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeInutilizacaoController.php:40" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe/{invoice}/ator-interessado": { "get": { "operationId": "get_api_v1_nfe__invoice__ator_interessado", "tags": [ "nfe" ], "summary": "NfeOutrosEventos indexAtor", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:40", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "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" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "tipo_evento": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:103" }, "c_tp_evento": { "type": "string" }, "sequencial": { "type": "integer" }, "status": { "type": "string" }, "protocolo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:107" }, "rejection_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:108" }, "rejection_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:109" }, "payload": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:110" }, "authorized_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": { "invoice_id": 1, "data": [ { "id": 1, "tipo_evento": null, "c_tp_evento": "EXEMPLO_FICTICIO", "sequencial": 1 } ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:114" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] }, "post": { "operationId": "post_api_v1_nfe__invoice__ator_interessado", "tags": [ "nfe" ], "summary": "NfeOutrosEventos storeAtor", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:30", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit", "throttle:30,60" ], "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" }, "sequencial": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:86" }, "status": { "type": "string", "example": "queued" }, "message": { "type": "string", "example": "Evento enfileirado para processamento. Consulte a listagem para o desfecho." }, "resource": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:89" } } }, "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, "sequencial": null, "status": "queued", "message": "Evento enfileirado para processamento. Consulte a listagem para o desfecho." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:84" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfe__invoice__ator_interessadoRequest" }, "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": { "documento": "00000000000" } } } } } }, "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe/{invoice}/insucesso-entrega": { "get": { "operationId": "get_api_v1_nfe__invoice__insucesso_entrega", "tags": [ "nfe" ], "summary": "NfeOutrosEventos indexInsucesso", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:55", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "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" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "tipo_evento": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:103" }, "c_tp_evento": { "type": "string" }, "sequencial": { "type": "integer" }, "status": { "type": "string" }, "protocolo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:107" }, "rejection_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:108" }, "rejection_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:109" }, "payload": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:110" }, "authorized_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": { "invoice_id": 1, "data": [ { "id": 1, "tipo_evento": null, "c_tp_evento": "EXEMPLO_FICTICIO", "sequencial": 1 } ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:114" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] }, "post": { "operationId": "post_api_v1_nfe__invoice__insucesso_entrega", "tags": [ "nfe" ], "summary": "NfeOutrosEventos storeInsucesso", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:45", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit", "throttle:30,60" ], "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" }, "sequencial": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:86" }, "status": { "type": "string", "example": "queued" }, "message": { "type": "string", "example": "Evento enfileirado para processamento. Consulte a listagem para o desfecho." }, "resource": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:89" } } }, "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, "sequencial": null, "status": "queued", "message": "Evento enfileirado para processamento. Consulte a listagem para o desfecho." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:84" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfe__invoice__insucesso_entregaRequest" }, "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": { "dh_tentativa": "2026-10-01T12:00:00Z", "tp_motivo": 1 } } } } } }, "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe/eventos/contratos": { "get": { "operationId": "get_api_v1_nfe_eventos_contratos", "tags": [ "nfe" ], "summary": "NfeEventosContrato contratos", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:27", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {}, "example": [] }, "versao": { "type": "string", "example": "1.00" } } }, "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": [], "versao": "1.00" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:35" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/nfe/{invoice}/eventos": { "get": { "operationId": "get_api_v1_nfe__invoice__eventos", "tags": [ "nfe" ], "summary": "NfeEventosContrato indexPropria", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:58", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "tipo_evento": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:90" }, "c_tp_evento": { "type": "string" }, "sequencial": { "type": "integer" }, "status": { "type": "string" }, "protocolo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:91" }, "rejection_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:91" }, "rejection_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:91" }, "payload": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:92" }, "authorized_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, "tipo_evento": null, "c_tp_evento": "EXEMPLO_FICTICIO", "sequencial": 1 } ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:95" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] }, "post": { "operationId": "post_api_v1_nfe__invoice__eventos", "tags": [ "nfe" ], "summary": "NfeEventosContrato storePropria", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:38", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit", "throttle:30,60" ], "responses": { "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo": { "type": "string" }, "sequencial": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:81" }, "status": { "type": "string", "example": "queued" }, "message": { "type": "string", "example": "Evento enfileirado para processamento. Consulte a listagem para o desfecho." } } }, "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": { "tipo": "EXEMPLO_FICTICIO", "sequencial": null, "status": "queued", "message": "Evento enfileirado para processamento. Consulte a listagem para o desfecho." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:81" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfe__invoice__eventosRequest" }, "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": { "tipo": "conciliacao_financeira", "det_pag": [ { "t_pag": "00", "v_pag": 1, "d_pag": "2026-10-01" } ] } } } } } }, "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe/recebidas/{distribuicao}/eventos": { "get": { "operationId": "get_api_v1_nfe_recebidas__distribuicao__eventos", "tags": [ "nfe" ], "summary": "NfeEventosContrato indexRecebida", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:66", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "tipo_evento": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:90" }, "c_tp_evento": { "type": "string" }, "sequencial": { "type": "integer" }, "status": { "type": "string" }, "protocolo": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:91" }, "rejection_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:91" }, "rejection_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:91" }, "payload": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:92" }, "authorized_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, "tipo_evento": null, "c_tp_evento": "EXEMPLO_FICTICIO", "sequencial": 1 } ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:95" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "distribuicao", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] }, "post": { "operationId": "post_api_v1_nfe_recebidas__distribuicao__eventos", "tags": [ "nfe" ], "summary": "NfeEventosContrato storeRecebida", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:48", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit", "throttle:30,60" ], "responses": { "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo": { "type": "string" }, "sequencial": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:81" }, "status": { "type": "string", "example": "queued" }, "message": { "type": "string", "example": "Evento enfileirado para processamento. Consulte a listagem para o desfecho." } } }, "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": { "tipo": "EXEMPLO_FICTICIO", "sequencial": null, "status": "queued", "message": "Evento enfileirado para processamento. Consulte a listagem para o desfecho." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeEventosContratoController.php:81" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfe_recebidas__distribuicao__eventosRequest" }, "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": { "tipo": "conciliacao_financeira", "det_pag": [ { "t_pag": "00", "v_pag": 1, "d_pag": "2026-10-01" } ] } } } } } }, "parameters": [ { "name": "distribuicao", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe/{invoice}/insucesso-entrega/{evento}/cancelar": { "post": { "operationId": "post_api_v1_nfe__invoice__insucesso_entrega__evento__cancelar", "tags": [ "nfe" ], "summary": "NfeOutrosEventos cancelInsucesso", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:61", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:api", "ability:nfes:emit", "throttle:30,60" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "example": "Esta operação não aceita corpo." } } }, { "type": "object", "properties": { "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:73" } } } ] }, "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": "Esta operação não aceita corpo." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:65", "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:73" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Evento de insucesso não encontrado nesta NF-e." } } }, "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": "Evento de insucesso não encontrado nesta NF-e." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:70" ] }, "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" }, "sequencial": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:86" }, "status": { "type": "string", "example": "queued" }, "message": { "type": "string", "example": "Evento enfileirado para processamento. Consulte a listagem para o desfecho." }, "resource": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:89" } } }, "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, "sequencial": null, "status": "queued", "message": "Evento enfileirado para processamento. Consulte a listagem para o desfecho." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeOutrosEventosController.php:84" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } }, { "name": "evento", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/reference-data/municipalities": { "get": { "operationId": "get_api_v1_reference_data_municipalities", "tags": [ "reference-data" ], "summary": "ReferenceData municipalitiesIndex", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:33", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:140" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:150" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "max:100", "not_regex:/[\\x00-\\x1F\\x7F]/" ], "type": [ "string", "null" ], "maxLength": 100 } }, { "name": "uf", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "size:2", "alpha" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 } }, { "name": "page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100000" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100000 } }, { "name": "per_page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ] } }, "/api/v1/reference-data/municipalities/{code}": { "get": { "operationId": "get_api_v1_reference_data_municipalities__code_", "tags": [ "reference-data" ], "summary": "ReferenceData municipalityShow", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:55", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_code_not_found" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:164" }, "code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:165" }, "available": { "type": "boolean", "example": true } } }, "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": "reference_code_not_found", "dataset": null, "code": null, "available": true } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:162" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:156" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:170" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d{7}" } } ] } }, "/api/v1/reference-data/cfop": { "get": { "operationId": "get_api_v1_reference_data_cfop", "tags": [ "reference-data" ], "summary": "ReferenceData cfopIndex", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:38", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:140" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:150" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "max:100", "not_regex:/[\\x00-\\x1F\\x7F]/" ], "type": [ "string", "null" ], "maxLength": 100 } }, { "name": "uf", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "size:2", "alpha" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 } }, { "name": "page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100000" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100000 } }, { "name": "per_page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ] } }, "/api/v1/reference-data/cfop/{code}": { "get": { "operationId": "get_api_v1_reference_data_cfop__code_", "tags": [ "reference-data" ], "summary": "ReferenceData cfopShow", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:60", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_code_not_found" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:164" }, "code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:165" }, "available": { "type": "boolean", "example": true } } }, "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": "reference_code_not_found", "dataset": null, "code": null, "available": true } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:162" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:156" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:170" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d{4}" } } ] } }, "/api/v1/reference-data/cnae": { "get": { "operationId": "get_api_v1_reference_data_cnae", "tags": [ "reference-data" ], "summary": "ReferenceData cnaeIndex", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:43", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:140" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:150" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "max:100", "not_regex:/[\\x00-\\x1F\\x7F]/" ], "type": [ "string", "null" ], "maxLength": 100 } }, { "name": "uf", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "size:2", "alpha" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 } }, { "name": "page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100000" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100000 } }, { "name": "per_page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ] } }, "/api/v1/reference-data/cnae/{code}": { "get": { "operationId": "get_api_v1_reference_data_cnae__code_", "tags": [ "reference-data" ], "summary": "ReferenceData cnaeShow", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:65", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_code_not_found" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:164" }, "code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:165" }, "available": { "type": "boolean", "example": true } } }, "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": "reference_code_not_found", "dataset": null, "code": null, "available": true } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:162" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:156" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:170" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d{7}" } } ] } }, "/api/v1/reference-data/ncm": { "get": { "operationId": "get_api_v1_reference_data_ncm", "tags": [ "reference-data" ], "summary": "ReferenceData ncmIndex", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:48", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:140" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:150" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "max:100", "not_regex:/[\\x00-\\x1F\\x7F]/" ], "type": [ "string", "null" ], "maxLength": 100 } }, { "name": "uf", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "size:2", "alpha" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 } }, { "name": "page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100000" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100000 } }, { "name": "per_page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ] } }, "/api/v1/reference-data/ncm/{code}": { "get": { "operationId": "get_api_v1_reference_data_ncm__code_", "tags": [ "reference-data" ], "summary": "ReferenceData ncmShow", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:70", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_code_not_found" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:164" }, "code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:165" }, "available": { "type": "boolean", "example": true } } }, "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": "reference_code_not_found", "dataset": null, "code": null, "available": true } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:162" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:156" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:170" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d{2,8}" } } ] } }, "/api/v1/reference-data/servicos-nacionais": { "get": { "operationId": "get_api_v1_reference_data_servicos_nacionais", "tags": [ "reference-data" ], "summary": "ReferenceData servicoNacionalIndex", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:75", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:140" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:150" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "max:100", "not_regex:/[\\x00-\\x1F\\x7F]/" ], "type": [ "string", "null" ], "maxLength": 100 } }, { "name": "uf", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "size:2", "alpha" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 } }, { "name": "page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100000" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100000 } }, { "name": "per_page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ] } }, "/api/v1/reference-data/servicos-nacionais/{code}": { "get": { "operationId": "get_api_v1_reference_data_servicos_nacionais__code_", "tags": [ "reference-data" ], "summary": "ReferenceData servicoNacionalShow", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:85", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_code_not_found" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:164" }, "code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:165" }, "available": { "type": "boolean", "example": true } } }, "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": "reference_code_not_found", "dataset": null, "code": null, "available": true } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:162" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:156" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:170" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d{6}" } } ] } }, "/api/v1/reference-data/nbs": { "get": { "operationId": "get_api_v1_reference_data_nbs", "tags": [ "reference-data" ], "summary": "ReferenceData nbsIndex", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:80", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:140" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:150" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "max:100", "not_regex:/[\\x00-\\x1F\\x7F]/" ], "type": [ "string", "null" ], "maxLength": 100 } }, { "name": "uf", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "size:2", "alpha" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 } }, { "name": "page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100000" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100000 } }, { "name": "per_page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1", "max:100" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ] } }, "/api/v1/reference-data/nbs/{code}": { "get": { "operationId": "get_api_v1_reference_data_nbs__code_", "tags": [ "reference-data" ], "summary": "ReferenceData nbsShow", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:90", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_code_not_found" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:164" }, "code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:165" }, "available": { "type": "boolean", "example": true } } }, "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": "reference_code_not_found", "dataset": null, "code": null, "available": true } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:162" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:156" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:170" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "reference_dataset_unavailable" }, "dataset": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:181" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:182" }, "available": { "type": "boolean", "example": false }, "source": { "type": "null" } } }, "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": "reference_dataset_unavailable", "dataset": null, "message": null, "available": false } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:179" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d{5,9}" } } ] } }, "/api/v1/reference-data/cep/{cep}": { "get": { "operationId": "get_api_v1_reference_data_cep__cep_", "tags": [ "reference-data" ], "summary": "ReferenceData cepShow", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:97", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:128" }, "source": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:128" }, "available": { "type": "boolean", "example": true } } }, "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": null, "source": null, "available": true } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:128" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:129" } }, "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": [ null ] } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:129" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:130" } }, "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": [ null ] } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:130" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:131" } }, "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": [ null ] } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:131" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cep", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d{5}-?\\d{3}" } } ] } }, "/api/v1/reference-data/cnpj/{cnpj}": { "get": { "operationId": "get_api_v1_reference_data_cnpj__cnpj_", "tags": [ "reference-data" ], "summary": "ReferenceData cnpjShow", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:108", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "ability:reference:read,documents:read,nfes:emit", "throttle:api" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:128" }, "source": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:128" }, "available": { "type": "boolean", "example": true } } }, "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": null, "source": null, "available": true } } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:128" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:129" } }, "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": [ null ] } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:129" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:130" } }, "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": [ null ] } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:130" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:131" } }, "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": [ null ] } } } }, "x-source": [ "app/app/Modules/Fiscal/ReferenceData/Http/Controllers/ReferenceDataController.php:131" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cnpj", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[A-Za-z0-9.\\/-]{14,18}" } } ] } }, "/api/v1/health": { "get": { "operationId": "get_api_v1_health", "tags": [ "health" ], "summary": "Health __invoke", "x-source": "app/app/Http/Controllers/Api/V1/HealthController.php:18", "x-middleware": [ "api" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/HealthController.php:22" }, "service": { "type": "string", "example": "foxnfe" }, "time": { "type": "string", "format": "date-time" }, "components": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/HealthController.php:20" } } } }, "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": null, "service": "foxnfe", "time": "2026-10-01T12:00:00Z", "components": [ null ] } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/HealthController.php:24" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/HealthController.php:22" }, "service": { "type": "string", "example": "foxnfe" }, "time": { "type": "string", "format": "date-time" }, "components": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/HealthController.php:20" } } } }, "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": null, "service": "foxnfe", "time": "2026-10-01T12:00:00Z", "components": [ null ] } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/HealthController.php:24" ] } } } }, "/api/v1/status": { "get": { "operationId": "get_api_v1_status", "tags": [ "status" ], "summary": "Status api", "x-source": "app/app/Modules/Status/Http/Controllers/StatusController.php:16", "x-middleware": [ "api", "throttle:60,1" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Status/Http/Controllers/StatusController.php:18" }, "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": null } } } }, "x-source": [ "app/app/Modules/Status/Http/Controllers/StatusController.php:18" ] } } } }, "/api/v1/auth/login": { "post": { "operationId": "post_api_v1_auth_login", "tags": [ "auth" ], "summary": "Auth login", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:19", "x-middleware": [ "api", "throttle:5,1" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:50" }, "token_type": { "type": "string", "example": "Bearer" }, "abilities": { "type": "array", "items": { "type": "string", "example": "certificates:read" } }, "expires_at": { "type": "string", "format": "date-time" }, "user": { "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/Auth/AuthController.php:55" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:56" }, "email": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:57" }, "tenant_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:58" } } } } }, "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": { "token": null, "token_type": "Bearer", "abilities": [ "certificates:read" ], "expires_at": "2026-10-01T12:00:00Z" } } } } }, "x-source": [ "app/app/Http/Controllers/Auth/AuthController.php:49" ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_auth_loginRequest" }, "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": { "email": "integracao@example.invalid", "password": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/auth/register": { "post": { "operationId": "post_api_v1_auth_register", "tags": [ "auth" ], "summary": "Register register", "x-source": "app/app/Http/Controllers/Auth/RegisterController.php:39", "x-middleware": [ "api", "throttle:5,1" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/RegisterController.php:110" }, "abilities": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/RegisterController.php:111" }, "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/Auth/RegisterController.php:113" }, "slug": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/RegisterController.php:114" }, "plan": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/RegisterController.php:115" }, "trial_ends_at": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/RegisterController.php:116" }, "nfe_ambiente": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/RegisterController.php:117" } } }, "user": { "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/Auth/RegisterController.php:120" }, "email": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/RegisterController.php:121" } } }, "proximo_passo": { "type": "string", "example": "Acesse /onboarding para completar: dados fiscais → certificado A1 → teste de NF-e em homologação." } } }, "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": { "token": null, "abilities": null, "tenant": { "id": null, "slug": null, "plan": null, "trial_ends_at": null }, "user": { "id": null, "email": null } } } } } }, "x-source": [ "app/app/Http/Controllers/Auth/RegisterController.php:109" ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_auth_registerRequest" }, "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": { "name": "EXEMPLO_FICTICIO", "email": "integracao@example.invalid", "password": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/auth/forgot-password": { "post": { "operationId": "post_api_v1_auth_forgot_password", "tags": [ "auth" ], "summary": "PasswordReset forgot", "x-source": "app/app/Http/Controllers/Auth/PasswordResetController.php:29", "x-middleware": [ "api", "throttle:5,1" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Se o e-mail estiver cadastrado, enviaremos um link de redefinição de senha." } } }, "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, "message": "Se o e-mail estiver cadastrado, enviaremos um link de redefinição de senha." } } } } }, "x-source": [ "app/app/Http/Controllers/Auth/PasswordResetController.php:35" ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_auth_forgot_passwordRequest" }, "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": { "email": "integracao@example.invalid" } } } } } } } }, "/api/v1/auth/reset-password": { "post": { "operationId": "post_api_v1_auth_reset_password", "tags": [ "auth" ], "summary": "PasswordReset reset", "x-source": "app/app/Http/Controllers/Auth/PasswordResetController.php:45", "x-middleware": [ "api", "throttle:5,1" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Senha redefinida com sucesso. Faça login com a nova senha." } } }, "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, "message": "Senha redefinida com sucesso. Faça login com a nova senha." } } } } }, "x-source": [ "app/app/Http/Controllers/Auth/PasswordResetController.php:64" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "reset_failed" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/PasswordResetController.php:73" } } }, "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": false, "error": "reset_failed", "message": null } } } } }, "x-source": [ "app/app/Http/Controllers/Auth/PasswordResetController.php:70" ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_auth_reset_passwordRequest" }, "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": { "token": "EXEMPLO_FICTICIO", "email": "integracao@example.invalid", "password": null } } } } } } } }, "/api/v1/public/support-tickets": { "post": { "operationId": "post_api_v1_public_support_tickets", "tags": [ "public" ], "summary": "Community storeTicket", "x-source": "app/app/Modules/Community/Http/Controllers/CommunityController.php:21", "x-middleware": [ "api", "throttle:20,1" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Community/Http/Controllers/CommunityController.php:31" }, { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Community/Http/Controllers/CommunityController.php:28" } } } ] } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Community/Http/Controllers/CommunityController.php:31" ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_public_support_ticketsRequest" }, "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": { "email": "integracao@example.invalid", "subject": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/public/newsletter/subscribe": { "post": { "operationId": "post_api_v1_public_newsletter_subscribe", "tags": [ "public" ], "summary": "Community subscribeNewsletter", "x-source": "app/app/Modules/Community/Http/Controllers/CommunityController.php:34", "x-middleware": [ "api", "throttle:20,1" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "email": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Community/Http/Controllers/CommunityController.php:43" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Community/Http/Controllers/CommunityController.php:44" } } } } }, "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": { "email": null, "status": null } } } } } }, "x-source": [ "app/app/Modules/Community/Http/Controllers/CommunityController.php:42" ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_public_newsletter_subscribeRequest" }, "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": { "email": "integracao@example.invalid" } } } } } } } }, "/api/v1/public/newsletter/unsubscribe/{token}": { "get": { "operationId": "get_api_v1_public_newsletter_unsubscribe__token_", "tags": [ "public" ], "summary": "Community unsubscribeNewsletter", "x-source": "app/app/Modules/Community/Http/Controllers/CommunityController.php:48", "x-middleware": [ "api", "throttle:20,1" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "unsubscribed": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Community/Http/Controllers/CommunityController.php:50" } } } } }, "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": { "unsubscribed": null } } } } } }, "x-source": [ "app/app/Modules/Community/Http/Controllers/CommunityController.php:52" ] } }, "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/auth/logout": { "post": { "operationId": "post_api_v1_auth_logout", "tags": [ "auth" ], "summary": "Auth logout", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:63", "x-middleware": [ "api", "auth:sanctum", "agent.provider" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "example": true } } }, "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 } } } } }, "x-source": [ "app/app/Http/Controllers/Auth/AuthController.php:77" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/auth/me": { "get": { "operationId": "get_api_v1_auth_me", "tags": [ "auth" ], "summary": "Auth me", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:80", "x-middleware": [ "api", "auth:sanctum", "agent.provider" ], "responses": { "401": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "unauthenticated" } } }, "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": "unauthenticated" } } } } }, "x-source": [ "app/app/Http/Controllers/Auth/AuthController.php:84" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "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/Auth/AuthController.php:107" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:108" }, "email": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:109" }, "tenant_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:110" } } }, "tenant": { "type": [ "object", "null" ], "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:113" }, "slug": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:114" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:115" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:116" } } }, "subscription": { "type": [ "object", "null" ], "properties": { "plan_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:119" }, "plan_name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:120" }, "status": { "type": "string", "enum": [ "draft", "pending", "processing", "authorized", "rejected", "denied", "canceled", "contingency" ], "x-source": "app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php" }, "billing_cycle": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:122" }, "trial_ends_at": { "type": [ "string", "null" ], "format": "date-time" }, "current_period_end": { "type": [ "string", "null" ], "format": "date-time" } } }, "abilities": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Auth/AuthController.php:126" } } }, "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": { "user": { "id": null, "name": null, "email": null, "tenant_id": null }, "tenant": { "id": null, "slug": null, "name": null, "status": null }, "subscription": { "plan_code": null, "plan_name": null, "status": "draft", "billing_cycle": null }, "abilities": null } } } } }, "x-source": [ "app/app/Http/Controllers/Auth/AuthController.php:105" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/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:79" ] }, "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:92" }, { "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:89" ] } }, "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:96", "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:103" }, "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:113" ] } }, "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" } } } } } } } }, "/api/v1/automations/catalog": { "get": { "operationId": "get_api_v1_automations_catalog", "tags": [ "automations" ], "summary": "AutomationRule catalog", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:42", "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": { "events": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:39" }, "ops": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:44" }, "actions": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:44" } } } } }, "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": { "events": null, "ops": null, "actions": null } } } } } }, "x-source": [ "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:44" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/automations": { "get": { "operationId": "get_api_v1_automations", "tags": [ "automations" ], "summary": "AutomationRule index", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:47", "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": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "version": { "type": "integer" }, "trigger_event": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "conditions": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "actions": { "type": "array", "items": {} }, "active": { "type": "boolean" }, "created_by": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "last_run_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "last_message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } } } }, "limits": { "type": "object", "properties": { "max_rules": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:166" }, "active_rules": { "type": "integer" } } } } }, "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, "name": null, "version": 1, "trigger_event": null } ], "limits": { "max_rules": null, "active_rules": 1 } } } } } }, "x-source": [ "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:51" ] } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "post_api_v1_automations", "tags": [ "automations" ], "summary": "AutomationRule store", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:54", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:30,60", "ability:nfes:emit" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "plan_limit_automations" }, "message": { "type": "string", "example": "Limite de regras ativas do plano atingido." }, "max_rules": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:166" } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "webhook_url_refused" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:153" }, "reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:152" } } } ] }, "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": "plan_limit_automations", "message": "Limite de regras ativas do plano atingido.", "max_rules": null } } } } }, "x-source": [ "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:65", "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:153" ] }, "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "version": { "type": "integer" }, "trigger_event": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "conditions": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "has_secret": { "type": "boolean", "example": true } } }, { "type": "array", "items": {}, "example": [] } ] } }, "active": { "type": "boolean" }, "created_by": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "last_run_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "last_message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "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, "name": null, "version": 1, "trigger_event": null } } } } } }, "x-source": [ "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:73" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_automationsRequest" }, "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": { "name": "EXEMPLO_FICTICIO", "trigger_event": "", "actions": [ { "type": "webhook" } ] } } } } } } } }, "/api/v1/automations/{id}": { "get": { "operationId": "get_api_v1_automations__id_", "tags": [ "automations" ], "summary": "AutomationRule show", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:76", "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": { "versions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "version": { "type": "integer" }, "active": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } } } }, "id": { "type": "integer" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "version": { "type": "integer" }, "trigger_event": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "conditions": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "has_secret": { "type": "boolean", "example": true } } }, { "type": "array", "items": {}, "example": [] } ] } }, "active": { "type": "boolean" }, "created_by": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "last_run_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "last_message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "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": { "versions": [ { "id": 1, "version": 1, "active": false, "created_at": "2026-10-01T12:00:00Z" } ], "id": 1, "name": null, "version": 1 } } } } } }, "x-source": [ "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:81" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/automations/{id}/runs": { "get": { "operationId": "get_api_v1_automations__id__runs", "tags": [ "automations" ], "summary": "AutomationRule runs", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:116", "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": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "version": { "type": "integer" }, "event": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:120" }, "dry_run": { "type": "boolean" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:120" }, "payload_sha256": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:120" }, "result": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:120" }, "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, "version": 1, "event": null, "dry_run": false } ] } } } } }, "x-source": [ "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:122" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/automations/{id}/dry-run": { "post": { "operationId": "post_api_v1_automations__id__dry_run", "tags": [ "automations" ], "summary": "AutomationRule dryRun", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:107", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:60,60", "ability:nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "dry_run": { "type": "boolean", "example": true } } } } }, "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": { "dry_run": true } } } } } }, "x-source": [ "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:113" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_automations__id__dry_runRequest" }, "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": { "payload": [ null ] } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/automations/{id}/activate": { "post": { "operationId": "post_api_v1_automations__id__activate", "tags": [ "automations" ], "summary": "AutomationRule activate", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:85", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:30,60", "ability:nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "version": { "type": "integer" }, "trigger_event": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "conditions": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "has_secret": { "type": "boolean", "example": true } } }, { "type": "array", "items": {}, "example": [] } ] } }, "active": { "type": "boolean" }, "created_by": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "last_run_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "last_message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "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, "name": null, "version": 1, "trigger_event": null } } } } } }, "x-source": [ "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:95" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/automations/{id}/deactivate": { "post": { "operationId": "post_api_v1_automations__id__deactivate", "tags": [ "automations" ], "summary": "AutomationRule deactivate", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:98", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:30,60", "ability:nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "version": { "type": "integer" }, "trigger_event": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "conditions": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:180" }, "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "has_secret": { "type": "boolean", "example": true } } }, { "type": "array", "items": {}, "example": [] } ] } }, "active": { "type": "boolean" }, "created_by": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "last_run_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "last_message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:181" }, "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, "name": null, "version": 1, "trigger_event": null } } } } } }, "x-source": [ "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:103" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/ctes": { "post": { "operationId": "post_api_v1_ctes", "tags": [ "ctes" ], "summary": "Cte store", "x-source": "app/app/Modules/Fiscal/Cte/Http/Controllers/CteController.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_cte": { "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/Cte/Http/Controllers/CteController.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/Cte/Http/Controllers/CteController.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/Cte/Http/Controllers/CteController.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/Cte/Http/Controllers/CteController.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_cte": 1, "serie": 1, "modelo": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Cte/Http/Controllers/CteController.php:65" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "cte_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/Cte/Http/Controllers/CteController.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": "cte_make_failed", "message": "EXEMPLO_FICTICIO", "details": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Cte/Http/Controllers/CteController.php:67" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_ctesRequest" }, "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, "CFOP": "EXEM", "natOp": "EXEMPLO_FICTICIO", "dhEmi": "EXEMPLO_FICTICIO", "cMunIni": "EXEMPLO_FICTICIO", "xMunIni": "EXEMPLO_FICTICIO", "UFIni": "EX", "cMunFim": "EXEMPLO_FICTICIO", "xMunFim": "EXEMPLO_FICTICIO", "UFFim": "EX" }, "toma": 1, "emit": [ null ], "enderEmit": [ null ], "rem": [ null ], "enderReme": [ null ], "dest": [ null ], "enderDest": [ null ], "vPrest": { "vTPrest": 1, "vRec": 1 }, "icms": { "vBC": 1, "pICMS": 1, "vICMS": 1 }, "infCarga": { "proPred": "EXEMPLO_FICTICIO" }, "infQ": { "cUnid": "EXEMPLO_FICTICIO", "tpMed": "EXEMPLO_FICTICIO", "qCarga": 1 }, "rodo": { "RNTRC": "EXEMPLO_FICTICIO" }, "infRespTec": { "CNPJ": "EXEMPLO_FICTICIO", "xContato": "EXEMPLO_FICTICIO", "email": "integracao@example.invalid", "fone": "EXEMPLO_FICTICIO" } } } } } } } } }, "/api/v1/ctes/{id}": { "get": { "operationId": "get_api_v1_ctes__id_", "tags": [ "ctes" ], "summary": "Cte show", "x-source": "app/app/Modules/Fiscal/Cte/Http/Controllers/CteController.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_cte": { "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/Cte/Http/Controllers/CteController.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/Cte/Http/Controllers/CteController.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/Cte/Http/Controllers/CteController.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/Cte/Http/Controllers/CteController.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_cte": 1, "serie": 1, "modelo": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Cte/Http/Controllers/CteController.php:75" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/mdfes": { "post": { "operationId": "post_api_v1_mdfes", "tags": [ "mdfes" ], "summary": "Mdfe store", "x-source": "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.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_mdfe": { "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/Mdfe/Http/Controllers/MdfeController.php:75" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.php:76" }, "rejection_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.php:76" }, "rejection_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.php:77" }, "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_mdfe": 1, "serie": 1, "modelo": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.php:57" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "mdfe_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/Mdfe/Http/Controllers/MdfeController.php:59" } } }, "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": "mdfe_make_failed", "message": "EXEMPLO_FICTICIO", "details": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.php:59" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_mdfesRequest" }, "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", "UFIni": "EX", "UFFim": "EX" }, "emit": [ null ], "enderEmit": [ null ], "infMunCarrega": { "cMunCarrega": "EXEMPLO_FICTICIO", "xMunCarrega": "EXEMPLO_FICTICIO" }, "infMunDescarga": { "cMunDescarga": "EXEMPLO_FICTICIO", "xMunDescarga": "EXEMPLO_FICTICIO" }, "infNFe": { "chNFe": "EXEMPLO_FICTICIOXXXXXXXXXXXXXXXXXXXXXXXXXXXX" }, "veicTracao": { "placa": "EXEMPLO_FICTICIO", "tara": 1, "tpRod": "EXEMPLO_FICTICIO", "tpCar": "EXEMPLO_FICTICIO" }, "tot": { "vCarga": 1, "cUnid": "EXEMPLO_FICTICIO", "qCarga": 1 }, "infRespTec": { "CNPJ": "EXEMPLO_FICTICIO", "xContato": "EXEMPLO_FICTICIO", "email": "integracao@example.invalid", "fone": "EXEMPLO_FICTICIO" } } } } } } } } }, "/api/v1/mdfes/{id}": { "get": { "operationId": "get_api_v1_mdfes__id_", "tags": [ "mdfes" ], "summary": "Mdfe show", "x-source": "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.php:63", "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_mdfe": { "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/Mdfe/Http/Controllers/MdfeController.php:75" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.php:76" }, "rejection_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.php:76" }, "rejection_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.php:77" }, "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_mdfe": 1, "serie": 1, "modelo": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.php:67" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfcoms": { "post": { "operationId": "post_api_v1_nfcoms", "tags": [ "nfcoms" ], "summary": "Nfcom store", "x-source": "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.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_nfcom": { "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/Nfcom/Http/Controllers/NfcomController.php:87" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.php:88" }, "rejection_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.php:88" }, "rejection_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.php:89" }, "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_nfcom": 1, "serie": 1, "modelo": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.php:69" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "nfcom_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/Nfcom/Http/Controllers/NfcomController.php:71" } } }, "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": "nfcom_make_failed", "message": "EXEMPLO_FICTICIO", "details": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.php:71" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfcomsRequest" }, "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_FICTICIO", "xNome": "EXEMPLO_FICTICIO", "CRT": 1, "IE": "00" }, "enderEmit": [ null ], "dest": { "xNome": "EXEMPLO_FICTICIO", "indIEDest": 1 }, "enderDest": { "xLgr": "EXEMPLO_FICTICIO", "nro": "EXEMPLO_FICTICIO", "xBairro": "EXEMPLO_FICTICIO", "cMun": "EXEMPLO_FICTICIO", "xMun": "EXEMPLO_FICTICIO", "CEP": "EXEMPLO_FICTICIO", "UF": "EXEMPLO_FICTICIO" }, "assinante": { "iCodAssinante": "EXEMPLO_FICTICIO", "tpAssinante": 1, "tpServUtil": 1 }, "prod": { "cProd": "EXEMPLO_FICTICIO", "xProd": "EXEMPLO_FICTICIO", "cClass": "0000000", "uMed": "EXEMPLO_FICTICIO", "qFaturada": 1, "vItem": 1, "vProd": 1 }, "total": { "vProd": 1, "vNF": 1 } } } } } } } } }, "/api/v1/nfcoms/{id}": { "get": { "operationId": "get_api_v1_nfcoms__id_", "tags": [ "nfcoms" ], "summary": "Nfcom show", "x-source": "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.php:75", "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_nfcom": { "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/Nfcom/Http/Controllers/NfcomController.php:87" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.php:88" }, "rejection_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.php:88" }, "rejection_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.php:89" }, "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_nfcom": 1, "serie": 1, "modelo": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.php:79" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/dces": { "post": { "operationId": "post_api_v1_dces", "tags": [ "dces" ], "summary": "Dce store", "x-source": "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.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_dce": { "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/Dce/Http/Controllers/DceController.php:79" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.php:80" }, "rejection_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.php:80" }, "rejection_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.php:81" }, "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_dce": 1, "serie": 1, "modelo": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.php:61" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "dce_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/Dce/Http/Controllers/DceController.php:63" } } }, "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": "dce_make_failed", "message": "EXEMPLO_FICTICIO", "details": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.php:63" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_dcesRequest" }, "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" }, "emit": { "CNPJ": "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": { "xProd": "EXEMPLO_FICTICIO", "NCM": "00", "qCom": 1, "vUnCom": 1, "vProd": 1 }, "total": { "vDC": 1 } } } } } } } } }, "/api/v1/dces/{id}": { "get": { "operationId": "get_api_v1_dces__id_", "tags": [ "dces" ], "summary": "Dce show", "x-source": "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.php:67", "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_dce": { "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/Dce/Http/Controllers/DceController.php:79" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.php:80" }, "rejection_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.php:80" }, "rejection_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.php:81" }, "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_dce": 1, "serie": 1, "modelo": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.php:71" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/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]+" } } ] } }, "/api/v1/retail-sync/events": { "post": { "operationId": "post_api_v1_retail_sync_events", "tags": [ "retail-sync" ], "summary": "RetailSync ingestEvent", "x-source": "app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:17", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:60,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" }, "client_event_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:31" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:32" }, "result": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:33" } } } } }, "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, "client_event_id": null, "status": null, "result": null } } } } } }, "x-source": [ "app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:29" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "retail_sync_failed" }, "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": "retail_sync_failed", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:36" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_retail_sync_eventsRequest" }, "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": { "client_event_id": "EXEMPLO_FICTICIO", "event_type": "EXEMPLO_FICTICIO", "payload": [ null ] } } } } } } } }, "/api/v1/retail-sync/manifest": { "get": { "operationId": "get_api_v1_retail_sync_manifest", "tags": [ "retail-sync" ], "summary": "RetailSync manifest", "x-source": "app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:40", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "ability:nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:45" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:45" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/companies": { "get": { "operationId": "get_api_v1_companies", "tags": [ "companies" ], "summary": "Company index", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:23", "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": "array", "items": { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "cnpj_alfanumerico": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "razao_social": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "nome_fantasia": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "inscricao_estadual": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "inscricao_municipal": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "crt": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "endereco": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "nfe_serie_padrao": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "nfe_ambiente": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "cnae_principal": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:192" }, "is_default": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:192" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } } } }, "quota": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:29" } } }, "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": null, "cnpj": null, "cnpj_alfanumerico": null, "razao_social": null } ], "quota": null } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:29" ] } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "post_api_v1_companies", "tags": [ "companies" ], "summary": "Company store", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:37", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:30,60", "ability:certificates:write" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:42" }, "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": null } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:47" ] }, "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:42" }, "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": null } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:47" ] }, "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/Modules/Tenant/Http/Controllers/CompanyController.php:170" }, "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/Modules/Tenant/Http/Controllers/CompanyController.php:170" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_companiesRequest" }, "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" } } } } } } } }, "/api/v1/companies/quota": { "get": { "operationId": "get_api_v1_companies_quota", "tags": [ "companies" ], "summary": "Company quota", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:32", "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": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:34" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:34" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/companies/{id}": { "get": { "operationId": "get_api_v1_companies__id_", "tags": [ "companies" ], "summary": "Company show", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:50", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found" } } }, "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": "not_found" } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:54" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "cnpj_alfanumerico": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "razao_social": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "nome_fantasia": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "inscricao_estadual": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "inscricao_municipal": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "crt": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "endereco": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "nfe_serie_padrao": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "nfe_ambiente": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "cnae_principal": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:192" }, "is_default": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:192" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_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": null, "cnpj": null, "cnpj_alfanumerico": null, "razao_social": null } } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:54" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] }, "patch": { "operationId": "patch_api_v1_companies__id_", "tags": [ "companies" ], "summary": "Company update", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:57", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:30,60", "ability:certificates:write" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found" } } }, "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": "not_found" } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:61" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:66" }, "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": null } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:66" ] }, "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/Modules/Tenant/Http/Controllers/CompanyController.php:170" }, "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/Modules/Tenant/Http/Controllers/CompanyController.php:170" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch_api_v1_companies__id_Request" }, "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", "nome_fantasia": "EXEMPLO_FICTICIO", "inscricao_estadual": "EXEMPLO_FICTICIO" } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/companies/{id}/inactivate": { "post": { "operationId": "post_api_v1_companies__id__inactivate", "tags": [ "companies" ], "summary": "Company inactivate", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:72", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:30,60", "ability:certificates:write" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found" } } }, "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": "not_found" } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:107" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "cnpj_alfanumerico": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "razao_social": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "nome_fantasia": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "inscricao_estadual": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "inscricao_municipal": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "crt": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "endereco": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "nfe_serie_padrao": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "nfe_ambiente": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "cnae_principal": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:192" }, "is_default": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:192" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_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": null, "cnpj": null, "cnpj_alfanumerico": null, "razao_social": null } } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:115" ] }, "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/Modules/Tenant/Http/Controllers/CompanyController.php:170" }, "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/Modules/Tenant/Http/Controllers/CompanyController.php:170" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/companies/{id}/activate": { "post": { "operationId": "post_api_v1_companies__id__activate", "tags": [ "companies" ], "summary": "Company activate", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:73", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:30,60", "ability:certificates:write" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found" } } }, "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": "not_found" } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:107" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "cnpj_alfanumerico": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "razao_social": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "nome_fantasia": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "inscricao_estadual": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "inscricao_municipal": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "crt": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "endereco": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "nfe_serie_padrao": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "nfe_ambiente": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "cnae_principal": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:192" }, "is_default": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:192" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_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": null, "cnpj": null, "cnpj_alfanumerico": null, "razao_social": null } } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:115" ] }, "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/Modules/Tenant/Http/Controllers/CompanyController.php:170" }, "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/Modules/Tenant/Http/Controllers/CompanyController.php:170" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/companies/{id}/default": { "post": { "operationId": "post_api_v1_companies__id__default", "tags": [ "companies" ], "summary": "Company makeDefault", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:75", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:30,60", "ability:certificates:write" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found" } } }, "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": "not_found" } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:79" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "cnpj_alfanumerico": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "razao_social": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "nome_fantasia": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:189" }, "inscricao_estadual": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "inscricao_municipal": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "crt": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "endereco": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:190" }, "nfe_serie_padrao": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "nfe_ambiente": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "cnae_principal": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:191" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:192" }, "is_default": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Tenant/Services/CompanyService.php:192" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_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": null, "cnpj": null, "cnpj_alfanumerico": null, "razao_social": null } } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:82" ] }, "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/Modules/Tenant/Http/Controllers/CompanyController.php:170" }, "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/Modules/Tenant/Http/Controllers/CompanyController.php:170" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/companies/{id}/certificates": { "get": { "operationId": "get_api_v1_companies__id__certificates", "tags": [ "companies" ], "summary": "Company certificates", "x-source": "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:89", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found" } } }, "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": "not_found" } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:93" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "company_id": { "type": [ "integer", "null" ] }, "scope": { "anyOf": [ { "type": "string", "example": "vinculado" }, { "type": "string", "example": "por_cnpj" } ] } } } } } }, "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": [ { "company_id": 1, "scope": "vinculado" } ] } } } } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:100" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/certificates": { "get": { "operationId": "get_api_v1_certificates", "tags": [ "certificates" ], "summary": "Certificate index", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:41", "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": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:51" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:51" ] } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "post_api_v1_certificates", "tags": [ "certificates" ], "summary": "Certificate store", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:63", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:10,60", "ability:certificates:write" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:115" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:115" ] }, "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/Modules/Security/Certificate/Http/Controllers/CertificateController.php:117" }, "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/Modules/Security/Certificate/Http/Controllers/CertificateController.php:117" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "wrong_password" }, "message": { "type": "string" } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "expired_certificate" }, "message": { "type": "string" } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "cnpj_mismatch" }, "message": { "type": "string" } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "invalid_pfx" }, "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": "wrong_password", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:119", "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:121", "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:123", "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:127" ] }, "409": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "duplicate" }, "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": "duplicate", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:125" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "vault_unavailable" } } }, "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": "vault_unavailable" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:129" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_certificatesRequest" }, "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": { "pfx": "EXEMPLO_FICTICIO", "password": "EXEMPLO_FICTICIO", "label": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/certificates/rotate": { "post": { "operationId": "post_api_v1_certificates_rotate", "tags": [ "certificates" ], "summary": "Certificate rotate", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:145", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:10,60", "ability:certificates:write" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:181" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:181" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "wrong_password" }, "message": { "type": "string" } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "expired_certificate" }, "message": { "type": "string" } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "cnpj_mismatch" }, "message": { "type": "string" } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "invalid_pfx" }, "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": "wrong_password", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:183", "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:185", "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:187", "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:191" ] }, "409": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "duplicate" }, "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": "duplicate", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:189" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "vault_unavailable" } } }, "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": "vault_unavailable" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:193" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_certificates_rotateRequest" }, "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": { "pfx": "EXEMPLO_FICTICIO", "password": "EXEMPLO_FICTICIO", "label": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/certificates/validate": { "post": { "operationId": "post_api_v1_certificates_validate", "tags": [ "certificates" ], "summary": "Certificate validate", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:134", "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": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:137" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:137" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_certificates_validateRequest" }, "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": { "pfx": "EXEMPLO_FICTICIO", "password": "EXEMPLO_FICTICIO", "label": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/certificates/{id}": { "get": { "operationId": "get_api_v1_certificates__id_", "tags": [ "certificates" ], "summary": "Certificate show", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:54", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found" } } }, "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": "not_found" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:58" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:60" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:60" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] }, "delete": { "operationId": "delete_api_v1_certificates__id_", "tags": [ "certificates" ], "summary": "Certificate destroy", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:223", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "ability:certificates:write" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "revoked" } } }, "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": { "status": "revoked" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:227" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found" } } }, "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": "not_found" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:227" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/certificates/{id}/revoke": { "post": { "operationId": "post_api_v1_certificates__id__revoke", "tags": [ "certificates" ], "summary": "Certificate revoke", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:214", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "ability:certificates:write" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "revoked" } } }, "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": { "status": "revoked" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:219" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found_or_already_revoked" } } }, "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": "not_found_or_already_revoked" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:220" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_certificates__id__revokeRequest" }, "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": { "reason": "EXEMPLO_FICTICIO" } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/certificates/{id}/recover": { "post": { "operationId": "post_api_v1_certificates__id__recover", "tags": [ "certificates" ], "summary": "Certificate recover", "x-source": "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:202", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "ability:certificates:write" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "example": "recovered" } } }, { "type": "object", "properties": { "status": { "type": "string", "example": "already_active" } } } ] }, "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": { "status": "recovered" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:207", "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:208" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "recovery_denied" }, "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": "recovery_denied", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:210" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/email/suppressions": { "get": { "operationId": "get_api_v1_email_suppressions", "tags": [ "email" ], "summary": "EmailSuppression index", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:40", "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": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:43" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:45" ] } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "post_api_v1_email_suppressions", "tags": [ "email" ], "summary": "EmailSuppression store", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:48", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:30,60", "ability:certificates:write" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "suppressed" }, "email": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Notification/Services/EmailSuppressionService.php:25" } } }, "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": { "status": "suppressed", "email": null } } } } }, "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:63" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_email_suppressionsRequest" }, "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": { "email": "integracao@example.invalid", "reason": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/email/suppressions/release": { "post": { "operationId": "post_api_v1_email_suppressions_release", "tags": [ "email" ], "summary": "EmailSuppression release", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:97", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:30,60", "ability:certificates:write" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "released" }, "email": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Notification/Services/EmailSuppressionService.php:25" } } }, "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": { "status": "released", "email": null } } } } }, "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:111" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found_or_already_released" } } }, "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": "not_found_or_already_released" } } } } }, "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:112" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_email_suppressions_releaseRequest" }, "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": { "email": "integracao@example.invalid" } } } } } } } }, "/api/v1/email/bounces": { "post": { "operationId": "post_api_v1_email_bounces", "tags": [ "email" ], "summary": "EmailSuppression bounce", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:73", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:30,60", "ability:certificates:write" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "anyOf": [ { "type": "string", "example": "suppressed" }, { "type": "string", "example": "recorded" } ] }, "type": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:92" }, "email": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Notification/Services/EmailSuppressionService.php:25" } } }, "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": { "status": "suppressed", "type": null, "email": null } } } } }, "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:90" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_email_bouncesRequest" }, "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": { "email": "integracao@example.invalid", "type": "hard" } } } } } } } }, "/api/v1/email/deliveries/resend": { "post": { "operationId": "post_api_v1_email_deliveries_resend", "tags": [ "email" ], "summary": "EmailDelivery resend", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:23", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "plan.limits", "throttle:10,60", "ability:certificates:write" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:38" }, "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": null } } } }, "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:52" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:38" }, "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": null } } } }, "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:52" ] }, "409": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:38" }, "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": null } } } }, "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:52" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_email_deliveries_resendRequest" }, "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": { "dedupe_key": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/support/cases": { "get": { "operationId": "get_api_v1_support_cases", "tags": [ "support" ], "summary": "SupportCase index", "x-source": "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:32", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:60,1", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:37" } } } }, "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": [ null ] } } } } }, "x-source": [ "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:37" ] } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "post_api_v1_support_cases", "tags": [ "support" ], "summary": "SupportCase store", "x-source": "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:41", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:60,1", "tenant.identify", "tenant.status", "throttle:20,60" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:52" }, { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:49" } } } ] } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:52" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_support_casesRequest" }, "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": { "subject": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/support/cases/sla": { "get": { "operationId": "get_api_v1_support_cases_sla", "tags": [ "support" ], "summary": "SupportCase sla", "x-source": "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:67", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:60,1", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:72" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:72" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/support/cases/{id}": { "get": { "operationId": "get_api_v1_support_cases__id_", "tags": [ "support" ], "summary": "SupportCase show", "x-source": "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:55", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:60,1", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:63" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:63" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe/emit": { "post": { "operationId": "post_api_v1_nfe_emit", "tags": [ "nfe" ], "summary": "Nfe emit", "x-source": "app/app/Http/Controllers/Api/V1/NfeController.php:36", "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_nfe_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": { "tipo": 55, "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/nfe/lotes/preview": { "post": { "operationId": "post_api_v1_nfe_lotes_preview", "tags": [ "nfe" ], "summary": "NfeBatch preview", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:21", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "throttle:40,60", "ability:nfes:emit" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "file_required" }, "message": { "type": "string", "example": "Envie um CSV (campo file) de até 2 MiB." } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "csv_invalid" }, "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": "file_required", "message": "Envie um CSV (campo file) de até 2 MiB." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:25", "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:30" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "preview" }, "dry_run": { "type": "boolean", "example": true }, "file_sha256": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:36" }, "rows_total": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:37" }, "rows_valid": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:38" }, "rows_failed": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:39" }, "errors": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:40" }, "sample": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:41" } } }, "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": { "status": "preview", "dry_run": true, "file_sha256": null, "rows_total": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:33" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/nfe/lotes": { "post": { "operationId": "post_api_v1_nfe_lotes", "tags": [ "nfe" ], "summary": "NfeBatch store", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:45", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "throttle:20,60", "ability:nfes:emit" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "file_required" }, "message": { "type": "string", "example": "Envie o mesmo CSV conferido na prévia." } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "preview_mismatch" }, "message": { "type": "string", "example": "O arquivo difere do que foi conferido na prévia." } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "csv_invalid" }, "message": { "type": "string" } } }, { "type": "object", "properties": { "error": { "type": "string", "example": "no_valid_rows" }, "message": { "type": "string", "example": "Nenhuma linha válida para emitir." }, "errors": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:62" } } } ] }, "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": "file_required", "message": "Envie o mesmo CSV conferido na prévia." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:50", "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:54", "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:59", "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:62" ] }, "409": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "batch_duplicate" }, "message": { "type": "string", "example": "Este arquivo já foi importado neste tenant." }, "batch_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:75" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:75" } } }, "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": "batch_duplicate", "message": "Este arquivo já foi importado neste tenant.", "batch_id": null, "status": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:75" ] }, "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "queued" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:128" }, "filename": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:128" }, "file_sha256": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:128" }, "rows_total": { "type": "integer" }, "rows_valid": { "type": "integer" }, "rows_failed": { "type": "integer" }, "processed_at": { "type": [ "string", "null" ], "format": "date-time" }, "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": { "status": "queued", "data": { "id": 1, "status": null, "filename": null, "file_sha256": null } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:81" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfe_lotesRequest" }, "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": { "preview_sha256": "0000000000000000000000000000000000000000000000000000000000000000" } } } } } } }, "get": { "operationId": "get_api_v1_nfe_lotes", "tags": [ "nfe" ], "summary": "NfeBatch index", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:84", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "ability:nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:135" } } } }, "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": [ null ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:88" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/nfe/lotes/{id}": { "get": { "operationId": "get_api_v1_nfe_lotes__id_", "tags": [ "nfe" ], "summary": "NfeBatch show", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:91", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "ability:nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:128" }, "filename": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:128" }, "file_sha256": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:128" }, "rows_total": { "type": "integer" }, "rows_valid": { "type": "integer" }, "rows_failed": { "type": "integer" }, "processed_at": { "type": [ "string", "null" ], "format": "date-time" }, "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, "status": null, "filename": null, "file_sha256": null } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:96" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe/rejeicoes": { "get": { "operationId": "get_api_v1_nfe_rejeicoes", "tags": [ "nfe" ], "summary": "NfeRejeicao index", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeRejeicaoController.php:14", "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": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeRejeicaoController.php:16" }, "acoes": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeRejeicaoController.php:16" } } }, "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": null, "acoes": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeRejeicaoController.php:16" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/nfe/rejeicoes/{cstat}": { "get": { "operationId": "get_api_v1_nfe_rejeicoes__cstat_", "tags": [ "nfe" ], "summary": "NfeRejeicao show", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeRejeicaoController.php:19", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "cstat_invalido" }, "message": { "type": "string", "example": "Informe o cStat com 3 dígitos." } } }, "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": "cstat_invalido", "message": "Informe o cStat com 3 dígitos." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeRejeicaoController.php:22" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeRejeicaoController.php:25" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeRejeicaoController.php:25" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "cstat", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/nfe/homologacao": { "get": { "operationId": "get_api_v1_nfe_homologacao", "tags": [ "nfe" ], "summary": "NfeHomolog index", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:22", "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": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:28" }, "runs": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:28" } } } }, "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": null, "runs": [ null ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:28" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/nfe/homologacao/run": { "post": { "operationId": "post_api_v1_nfe_homologacao_run", "tags": [ "nfe" ], "summary": "NfeHomolog run", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:31", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "throttle:5,1", "ability:nfes:emit" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "error": { "type": "string", "example": "cenario_invalido" }, "cenarios": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:42" } } }, { "type": "object", "properties": { "error": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:48" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:51" } } } ] }, "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": "cenario_invalido", "cenarios": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:42", "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:51" ] }, "409": { "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/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:48" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:51" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:51" ] }, "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:59" } } } }, "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": [ null ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:59" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfe_homologacao_runRequest" }, "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": { "modelo": 55 } } } } } } } }, "/api/v1/nfe/homologacao/{id}/xml": { "get": { "operationId": "get_api_v1_nfe_homologacao__id__xml", "tags": [ "nfe" ], "summary": "NfeHomolog xml", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:62", "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": "not_found" } } }, "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": "not_found" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:77" ] }, "200": { "description": "Resposta do controlador.", "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" } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:81" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe/homologacao/{id}/pdf": { "get": { "operationId": "get_api_v1_nfe_homologacao__id__pdf", "tags": [ "nfe" ], "summary": "NfeHomolog pdf", "x-source": "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:67", "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": "not_found" } } }, "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": "not_found" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:77" ] }, "200": { "description": "Resposta do controlador.", "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" } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:81" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfe/{invoice}": { "get": { "operationId": "get_api_v1_nfe__invoice_", "tags": [ "nfe" ], "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/nfe/{invoice}/xml": { "get": { "operationId": "get_api_v1_nfe__invoice__xml", "tags": [ "nfe" ], "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/nfe/{invoice}/pdf": { "get": { "operationId": "get_api_v1_nfe__invoice__pdf", "tags": [ "nfe" ], "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/nfe/{invoice}/cancel": { "post": { "operationId": "post_api_v1_nfe__invoice__cancel", "tags": [ "nfe" ], "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_nfe__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]+" } } ] } }, "/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]+" } } ] } }, "/api/v1/print-jobs": { "post": { "operationId": "post_api_v1_print_jobs", "tags": [ "print-jobs" ], "summary": "PrintJob enqueue", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:21", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "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/PrintJobController.php:65" }, "document_type": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:66" }, "document_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:67" }, "status": { "type": "string", "enum": [ "draft", "pending", "processing", "authorized", "rejected", "denied", "canceled", "contingency" ], "x-source": "app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php" }, "download_url": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:69" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "printed_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": null, "document_type": null, "document_id": null, "status": "draft" } } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/PrintJobController.php:36" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_print_jobsRequest" }, "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": { "document_type": "nfe", "document_id": 1 } } } } } } } }, "/api/v1/print-jobs/pending": { "get": { "operationId": "get_api_v1_print_jobs_pending", "tags": [ "print-jobs" ], "summary": "PrintJob pending", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:39", "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": { "data": { "type": "array", "items": { "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/PrintJobController.php:65" }, "document_type": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:66" }, "document_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:67" }, "status": { "type": "string", "enum": [ "draft", "pending", "processing", "authorized", "rejected", "denied", "canceled", "contingency" ], "x-source": "app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php" }, "download_url": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:69" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "printed_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": null, "document_type": null, "document_id": null, "status": "draft" } ] } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/PrintJobController.php:45" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/print-jobs/{printJob}/ack": { "post": { "operationId": "post_api_v1_print_jobs__printJob__ack", "tags": [ "print-jobs" ], "summary": "PrintJob acknowledge", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:48", "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": "print_job_not_found" } } }, "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": "print_job_not_found" } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/PrintJobController.php:54" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "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/PrintJobController.php:65" }, "document_type": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:66" }, "document_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:67" }, "status": { "type": "string", "enum": [ "draft", "pending", "processing", "authorized", "rejected", "denied", "canceled", "contingency" ], "x-source": "app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php" }, "download_url": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PrintJobController.php:69" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "printed_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": null, "document_type": null, "document_id": null, "status": "draft" } } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/PrintJobController.php:59" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "printJob", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfse/emit": { "post": { "operationId": "post_api_v1_nfse_emit", "tags": [ "nfse" ], "summary": "Nfse emit", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:32", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "idempotency", "nfse.quota", "fiscal.guard" ], "responses": { "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "nfse_id": { "type": "integer", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "status": { "type": "string", "enum": [ "draft", "pending", "processing", "authorized", "rejected", "canceled", "substituted" ] }, "message": { "type": "string", "example": "NFSe enfileirada para emissão" } } }, "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": { "nfse_id": 1, "status": "draft", "message": "NFSe enfileirada para emissão" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:39" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfse_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": { "competencia": "0000-00", "cnpj_prestador": "00000000000000", "inscricao_municipal": "EXEMPLO_FICTICIO", "descricao_servico": "EXEMPLO_FICTICIO", "codigo_municipio_prestacao": "0000000", "valor_servico": 1, "tomador": { "nome": "EXEMPLO_FICTICIO" }, "prestador": { "endereco": { "logradouro": "EXEMPLO_FICTICIO", "numero": "EXEMPLO_FI", "bairro": "EXEMPLO_FICTICIO", "codigo_municipio": "EXEMPLO", "uf": "EX", "cep": "00000000" } } } } } } } } } }, "/api/v1/nfse/recebidas": { "get": { "operationId": "get_api_v1_nfse_recebidas", "tags": [ "nfse" ], "summary": "NfseDistribuicao index", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:21", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nsu": { "type": "integer" }, "tipo_documento": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:31" }, "chave_acesso": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:31" }, "evento_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:32" }, "ambiente": { "type": "integer" }, "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:32" }, "gerado_em": { "type": [ "string", "null" ], "format": "date-time" }, "captured_at": { "type": [ "string", "null" ], "format": "date-time" } } } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "per_page": { "type": "integer" }, "current_page": { "type": "integer" }, "last_page": { "type": "integer" } } } } }, "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, "nsu": 1, "tipo_documento": null, "chave_acesso": null } ], "meta": { "total": 1, "per_page": 1, "current_page": 1, "last_page": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:36" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/nfse/recebidas/cursor": { "get": { "operationId": "get_api_v1_nfse_recebidas_cursor", "tags": [ "nfse" ], "summary": "NfseDistribuicao cursor", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:39", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "cnpj": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:42" }, "ambiente": { "type": "integer" }, "feed": { "type": "string", "example": "ADN" }, "ultimo_nsu": { "type": "integer" }, "max_nsu": { "type": "integer" }, "last_status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:43" }, "em_cooldown": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Models/NfseDistribuicaoCursor.php:42" }, "next_allowed_at": { "type": [ "string", "null" ], "format": "date-time" }, "sincronizado_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": [ { "cnpj": null, "ambiente": 1, "feed": "ADN", "ultimo_nsu": 1 } ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:47" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/nfse/recebidas/captura-automatica": { "get": { "operationId": "get_api_v1_nfse_recebidas_captura_automatica", "tags": [ "nfse" ], "summary": "NfseDistribuicao optins", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:64", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "ability:documents:read,nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:66" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:68" ] } }, "security": [ { "bearerAuth": [] } ] }, "put": { "operationId": "put_api_v1_nfse_recebidas_captura_automatica", "tags": [ "nfse" ], "summary": "NfseDistribuicao enableOptin", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:71", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "ability:nfes:emit" ], "responses": { "422": { "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/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:78" }, "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/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:78" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:85" }, "message": { "type": "string", "example": "Captura automática de NFS-e recebidas habilitada para a próxima execução agendada." } } }, "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": null, "message": "Captura automática de NFS-e recebidas habilitada para a próxima execução agendada." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:87" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/put_api_v1_nfse_recebidas_captura_automaticaRequest" }, "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": { "certificate_id": 1, "ambiente": 1 } } } } } } } }, "/api/v1/nfse/recebidas/capturar": { "post": { "operationId": "post_api_v1_nfse_recebidas_capturar", "tags": [ "nfse" ], "summary": "NfseDistribuicao capturar", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:50", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "throttle:30,60", "ability:nfes:emit" ], "responses": { "409": { "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/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:58" }, "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/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:58" ] }, "422": { "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/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:58" }, "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/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:58" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:56" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:61" ] }, "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:56" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:61" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfse_recebidas_capturarRequest" }, "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": { "certificate_id": 1, "ambiente": 1 } } } } } } } }, "/api/v1/nfse/recebidas/captura-automatica/{id}": { "delete": { "operationId": "delete_api_v1_nfse_recebidas_captura_automatica__id_", "tags": [ "nfse" ], "summary": "NfseDistribuicao disableOptin", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:90", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "ability:nfes:emit" ], "responses": { "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "optin_not_found" } } }, "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": "optin_not_found" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:94" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:97" }, "enabled": { "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": { "data": { "id": null, "enabled": false } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:97" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfse/cobertura": { "get": { "operationId": "get_api_v1_nfse_cobertura", "tags": [ "nfse" ], "summary": "NfseCobertura index", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:18", "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": { "data": { "type": "array", "items": { "type": "object", "properties": { "ibge_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:74" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:74" }, "uf": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:74" }, "provider": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:75" }, "integration_type": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:75" }, "adesao_nacional": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:76" }, "driver": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:76" }, "ops": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:77" } }, "homologacao_externa": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:78" } } } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer", "example": 50 }, "last_page": { "type": "integer" } } } } }, "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": [ { "ibge_code": null, "name": null, "uf": null, "provider": null } ], "meta": { "total": 1, "page": 1, "per_page": 50, "last_page": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:38" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "uf", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "size:2" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 } }, { "name": "q", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "max:80" ], "type": [ "string", "null" ], "maxLength": 80 } }, { "name": "provider", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "string", "max:30" ], "type": [ "string", "null" ], "maxLength": 30 } }, { "name": "page", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "integer", "min:1" ], "type": [ "integer", "null" ], "minimum": 1 } } ] } }, "/api/v1/nfse/cobertura/provedores": { "get": { "operationId": "get_api_v1_nfse_cobertura_provedores", "tags": [ "nfse" ], "summary": "NfseCobertura provedores", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:57", "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": { "data": { "type": "array", "items": {}, "example": [] }, "provas": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:65" }, "estados": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:65" } } } }, "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": [], "provas": null, "estados": [ null ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:65" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/nfse/cobertura/{ibge}": { "get": { "operationId": "get_api_v1_nfse_cobertura__ibge_", "tags": [ "nfse" ], "summary": "NfseCobertura show", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:44", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "ibge_invalido" } } }, "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": "ibge_invalido" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:47" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "municipio_nao_encontrado" }, "capacidades": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:51" } } }, "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": "municipio_nao_encontrado", "capacidades": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:51" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "capacidades": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:54" }, "ibge_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:74" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:74" }, "uf": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:74" }, "provider": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:75" }, "integration_type": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:75" }, "adesao_nacional": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:76" }, "driver": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:76" }, "ops": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:77" } }, "homologacao_externa": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:78" } } } } }, "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": { "capacidades": null, "ibge_code": null, "name": null, "uf": null } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseCoberturaController.php:54" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "ibge", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfse/{nfse}": { "get": { "operationId": "get_api_v1_nfse__nfse_", "tags": [ "nfse" ], "summary": "Nfse show", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:54", "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": { "nfse_id": { "type": "integer", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "status": { "type": "string", "enum": [ "draft", "pending", "processing", "authorized", "rejected", "canceled", "substituted" ], "x-source": "app/app/Modules/Fiscal/Nfse/Enums/NfseStatus.php" }, "numero_nfse": { "type": [ "string", "null" ], "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "chave_acesso": { "type": [ "string", "null" ], "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "codigo_verificacao": { "type": [ "string", "null" ], "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "competencia": { "type": "string", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "valor_servico": { "type": "number", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "valor_iss": { "type": "number", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "aliquota_iss": { "type": "number", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "descricao_servico": { "type": "string", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "prestador_cnpj": { "type": "string", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "tomador_nome": { "type": "string", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "authorized_at": { "type": [ "string", "null" ], "format": "date-time" }, "canceled_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": { "nfse_id": 1, "status": "draft", "numero_nfse": "EXEMPLO_FICTICIO", "chave_acesso": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:64" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "nfse", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfse/{nfse}/cancel": { "post": { "operationId": "post_api_v1_nfse__nfse__cancel", "tags": [ "nfse" ], "summary": "Nfse cancel", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:85", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "cancelation_not_allowed" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:92" } } }, "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": "cancelation_not_allowed", "message": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:90" ] }, "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "nfse_id": { "type": "integer", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.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": { "nfse_id": 1, "message": "Cancelamento enfileirado" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:101" ] }, "409": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "operacao_nao_oferecida" }, "operacao": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:151" }, "provider": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:152" }, "codigo_municipio_prestacao": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:153" }, "message": { "type": "string" }, "cobertura_url": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:155" } } }, "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": "operacao_nao_oferecida", "operacao": null, "provider": null, "codigo_municipio_prestacao": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:149" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfse__nfse__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": "nfse", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfse/{nfse}/substitute": { "post": { "operationId": "post_api_v1_nfse__nfse__substitute", "tags": [ "nfse" ], "summary": "Nfse substitute", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:110", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "substitution_not_allowed" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:117" } } }, "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": "substitution_not_allowed", "message": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:115" ] }, "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "nfse_id": { "type": "integer", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "message": { "type": "string", "example": "Substituição enfileirada" } } }, "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": { "nfse_id": 1, "message": "Substituição enfileirada" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:135" ] }, "409": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "operacao_nao_oferecida" }, "operacao": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:151" }, "provider": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:152" }, "codigo_municipio_prestacao": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:153" }, "message": { "type": "string" }, "cobertura_url": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:155" } } }, "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": "operacao_nao_oferecida", "operacao": null, "provider": null, "codigo_municipio_prestacao": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:149" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_nfse__nfse__substituteRequest" }, "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": { "motivo": "EXEMPLO_FICTICIO", "competencia": "0000-00", "descricao_servico": "EXEMPLO_FICTICIO", "codigo_tributacao_nacional": "00.00.00.00", "codigo_tributacao_municipal": "EXEMPLO_FICTICIO", "codigo_municipio_prestacao": "0000000", "valor_servico": 1, "aliquota_iss": 1, "inscricao_municipal": "EXEMPLO_FICTICIO", "tomador": { "nome": "EXEMPLO_FICTICIO" }, "prestador": { "endereco": { "logradouro": "EXEMPLO_FICTICIO", "numero": "EXEMPLO_FI", "bairro": "EXEMPLO_FICTICIO", "codigo_municipio": "EXEMPLO", "uf": "EX", "cep": "00000000" } } } } } } } }, "parameters": [ { "name": "nfse", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/nfse/consult/{chave}": { "get": { "operationId": "get_api_v1_nfse_consult__chave_", "tags": [ "nfse" ], "summary": "Nfse consult", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:165", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:170" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:170" ] }, "502": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "govbr_api_error" }, "message": { "type": "string" }, "http_status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:175" } } }, "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": "govbr_api_error", "message": "EXEMPLO_FICTICIO", "http_status": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:172" ] }, "default": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "govbr_api_error" }, "message": { "type": "string" }, "http_status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:175" } } }, "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": "govbr_api_error", "message": "EXEMPLO_FICTICIO", "http_status": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:172" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "chave", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/nfse/consult/numero/{numero}": { "get": { "operationId": "get_api_v1_nfse_consult_numero__numero_", "tags": [ "nfse" ], "summary": "Nfse consultPorNumero", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:183", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:188" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:188" ] }, "502": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "govbr_api_error" }, "message": { "type": "string" }, "http_status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:193" } } }, "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": "govbr_api_error", "message": "EXEMPLO_FICTICIO", "http_status": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:190" ] }, "default": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "govbr_api_error" }, "message": { "type": "string" }, "http_status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:193" } } }, "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": "govbr_api_error", "message": "EXEMPLO_FICTICIO", "http_status": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:190" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "numero", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/fiscal/risk-score": { "get": { "operationId": "get_api_v1_fiscal_risk_score", "tags": [ "fiscal" ], "summary": "FiscalRiskScore show", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:22", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tenant_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:40" }, "score": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:41" }, "classification": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:42" }, "threshold": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:43" }, "breakdown": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:44" }, "cached": { "type": "boolean", "example": true } } }, "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": { "tenant_id": null, "score": null, "classification": null, "threshold": null } } } } }, "x-source": [ "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:39" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/fiscal/risk-score/recalculate": { "post": { "operationId": "post_api_v1_fiscal_risk_score_recalculate", "tags": [ "fiscal" ], "summary": "FiscalRiskScore recalculate", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:49", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status", "throttle:5,60" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tenant_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:64" }, "score": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:65" }, "classification": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:66" }, "threshold": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:67" }, "breakdown": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:68" }, "cached": { "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": { "tenant_id": null, "score": null, "classification": null, "threshold": null } } } } }, "x-source": [ "app/app/Modules/Security/FiscalGuard/Http/Controllers/FiscalRiskScoreController.php:63" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/autopilot/alerts": { "get": { "operationId": "get_api_v1_autopilot_alerts", "tags": [ "autopilot" ], "summary": "Autopilot index", "x-source": "app/app/Modules/Fiscal/Autopilot/Http/Controllers/AutopilotController.php:14", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:60,1", "tenant.identify", "tenant.status" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "tenant context required" } } }, "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": "tenant context required" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Autopilot/Http/Controllers/AutopilotController.php:22" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Autopilot/Http/Controllers/AutopilotController.php:45" }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "per_page": { "type": "integer" }, "current_page": { "type": "integer" }, "last_page": { "type": "integer" } } } } }, "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": null, "meta": { "total": 1, "per_page": 1, "current_page": 1, "last_page": 1 } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Autopilot/Http/Controllers/AutopilotController.php:44" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/fiscal-agent/rtc/status": { "get": { "operationId": "get_api_v1_fiscal_agent_rtc_status", "tags": [ "fiscal-agent" ], "summary": "Rtc status", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:22", "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": { "ready": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:27" }, "source": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:28" }, "version": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:29" }, "sha256": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:30" }, "imported_at": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:31" }, "records": { "anyOf": [ { "type": "integer", "example": 0 }, { "type": "integer" } ] } } }, "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": { "ready": null, "source": null, "version": null, "sha256": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:26" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ready": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:27" }, "source": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:28" }, "version": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:29" }, "sha256": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:30" }, "imported_at": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:31" }, "records": { "anyOf": [ { "type": "integer", "example": 0 }, { "type": "integer" } ] } } }, "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": { "ready": null, "source": null, "version": null, "sha256": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:26" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/fiscal-agent/rtc/classifications": { "get": { "operationId": "get_api_v1_fiscal_agent_rtc_classifications", "tags": [ "fiscal-agent" ], "summary": "Rtc classifications", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:36", "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": { "source_version": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:51" }, "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:43" } } }, "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": { "source_version": null, "data": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:51" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "dfe_type", "in": "query", "required": true, "schema": { "x-laravel-rules": [ "required", "string", "in:NFE,NFCE,NFSE" ], "type": "string", "enum": [ "NFE", "NFCE", "NFSE" ] } }, { "name": "cst", "in": "query", "required": false, "schema": { "x-laravel-rules": [ "nullable", "regex:/^\\d{3}$/" ], "pattern": "^\\d{3}$" } } ] } }, "/api/v1/fiscal-agent/rtc/resolve": { "post": { "operationId": "post_api_v1_fiscal_agent_rtc_resolve", "tags": [ "fiscal-agent" ], "summary": "Rtc resolve", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:85", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "example": "blocked" }, "code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:124" }, "message": { "type": "string" } } }, { "type": "object", "properties": { "status": { "anyOf": [ { "type": "string", "example": "blocked" }, { "type": "string", "example": "unavailable" } ] }, "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": { "status": "blocked", "code": null, "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:122", "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:133" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "anyOf": [ { "type": "string", "example": "blocked" }, { "type": "string", "example": "unavailable" } ] }, "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": { "status": "blocked", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:133" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "resolved" }, "resolution_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:141" }, "cst": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:142" }, "cclass_trib": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:143" }, "source_version": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:144" }, "calculator_version": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:145" }, "calculator_output": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.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": { "status": "resolved", "resolution_id": null, "cst": null, "cclass_trib": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:139" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_fiscal_agent_rtc_resolveRequest" }, "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": { "sku": "EXEMPLO_FICTICIO", "dfe_type": "NFE", "tax_date": "2026-10-01T12:00:00Z", "item_number": 1, "calculator_payload": [ null ] } } } } } } } }, "/api/v1/fiscal-agent/rtc/resolutions/{id}": { "get": { "operationId": "get_api_v1_fiscal_agent_rtc_resolutions__id_", "tags": [ "fiscal-agent" ], "summary": "Rtc showResolution", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:55", "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": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:59" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:59" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/fiscal-agent/rtc/resolutions/{id}/verify": { "post": { "operationId": "post_api_v1_fiscal_agent_rtc_resolutions__id__verify", "tags": [ "fiscal-agent" ], "summary": "Rtc verifyResolution", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:63", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "throttle:20,1", "ability:nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:66" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:68" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:66" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:68" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/fiscal-agent/prepare": { "post": { "operationId": "post_api_v1_fiscal_agent_prepare", "tags": [ "fiscal-agent" ], "summary": "FiscalAgentApproval prepare", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:22", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:33" }, { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:33", "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:67" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_fiscal_agent_prepareRequest" }, "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": { "action": "nfe.emit", "payload": [ null ] } } } } } } } }, "/api/v1/fiscal-agent/approve": { "post": { "operationId": "post_api_v1_fiscal_agent_approve", "tags": [ "fiscal-agent" ], "summary": "FiscalAgentApproval approve", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:78", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "fiscal.human" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:87" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:87" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "approval_invalid" }, "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": "approval_invalid", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:94" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_fiscal_agent_approveRequest" }, "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": { "prepare_token": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/fiscal-agent/approvals": { "get": { "operationId": "get_api_v1_fiscal_agent_approvals", "tags": [ "fiscal-agent" ], "summary": "FiscalAgentApproval index", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:99", "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": { "data": { "type": "array", "items": { "type": "object", "properties": { "request_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:138" }, "approval_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:138" }, "action": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:138" }, "environment": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:138" }, "payload_sha256": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:139" }, "resolution_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:139" }, "source_version": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:139" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:139" }, "requested_by": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:140" }, "approved_by": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:140" }, "revoked_by": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:140" }, "revoke_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:140" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "approved_at": { "type": [ "string", "null" ], "format": "date-time" }, "consumed_at": { "type": [ "string", "null" ], "format": "date-time" }, "revoked_at": { "type": [ "string", "null" ], "format": "date-time" }, "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": [ { "request_id": null, "approval_id": null, "action": null, "environment": null } ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:108" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/fiscal-agent/approvals/{requestId}": { "get": { "operationId": "get_api_v1_fiscal_agent_approvals__requestId_", "tags": [ "fiscal-agent" ], "summary": "FiscalAgentApproval show", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:111", "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": { "data": { "type": "object", "properties": { "request_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:138" }, "approval_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:138" }, "action": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:138" }, "environment": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:138" }, "payload_sha256": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:139" }, "resolution_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:139" }, "source_version": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:139" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:139" }, "requested_by": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:140" }, "approved_by": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:140" }, "revoked_by": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:140" }, "revoke_reason": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:140" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "approved_at": { "type": [ "string", "null" ], "format": "date-time" }, "consumed_at": { "type": [ "string", "null" ], "format": "date-time" }, "revoked_at": { "type": [ "string", "null" ], "format": "date-time" }, "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": { "request_id": null, "approval_id": null, "action": null, "environment": null } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:117" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/fiscal-agent/approvals/{requestId}/revoke": { "post": { "operationId": "post_api_v1_fiscal_agent_approvals__requestId__revoke", "tags": [ "fiscal-agent" ], "summary": "FiscalAgentApproval revoke", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:120", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "fiscal.human" ], "responses": { "409": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "approval_not_revocable" }, "message": { "type": "string", "example": "Aprovação inexistente, já consumida ou já revogada." } } }, "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": "approval_not_revocable", "message": "Aprovação inexistente, já consumida ou já revogada." } } } } }, "x-source": [ "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:127" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:131" }, "status": { "type": "string", "example": "revoked" } } } } }, "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": { "request_id": null, "status": "revoked" } } } } } }, "x-source": [ "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:131" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_fiscal_agent_approvals__requestId__revokeRequest" }, "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": { "reason": "EXEMPLO_FICTICIO" } } } } } }, "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/fiscal-agent/nfe/{invoice}/cancel": { "post": { "operationId": "post_api_v1_fiscal_agent_nfe__invoice__cancel", "tags": [ "fiscal-agent" ], "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", "fiscal.agent.approval:nfe.cancel" ], "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_fiscal_agent_nfe__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]+" } } ] } }, "/api/v1/fiscal-agent/nfce/{invoice}/cancel": { "post": { "operationId": "post_api_v1_fiscal_agent_nfce__invoice__cancel", "tags": [ "fiscal-agent" ], "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", "fiscal.agent.approval:nfce.cancel" ], "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_fiscal_agent_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]+" } } ] } }, "/api/v1/fiscal-agent/nfse/{nfse}/cancel": { "post": { "operationId": "post_api_v1_fiscal_agent_nfse__nfse__cancel", "tags": [ "fiscal-agent" ], "summary": "Nfse cancel", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:85", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "fiscal.agent.approval:nfse.cancel" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "cancelation_not_allowed" }, "message": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:92" } } }, "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": "cancelation_not_allowed", "message": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:90" ] }, "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "nfse_id": { "type": "integer", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.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": { "nfse_id": 1, "message": "Cancelamento enfileirado" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:101" ] }, "409": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "operacao_nao_oferecida" }, "operacao": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:151" }, "provider": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:152" }, "codigo_municipio_prestacao": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:153" }, "message": { "type": "string" }, "cobertura_url": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:155" } } }, "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": "operacao_nao_oferecida", "operacao": null, "provider": null, "codigo_municipio_prestacao": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:149" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_fiscal_agent_nfse__nfse__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": "nfse", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/fiscal-agent/nfe/emit": { "post": { "operationId": "post_api_v1_fiscal_agent_nfe_emit", "tags": [ "fiscal-agent" ], "summary": "Nfe emit", "x-source": "app/app/Http/Controllers/Api/V1/NfeController.php:36", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "idempotency", "nfe.quota", "fiscal.guard", "fiscal.agent.approval:nfe.emit" ], "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_fiscal_agent_nfe_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": { "tipo": 55, "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/fiscal-agent/nfce/emit": { "post": { "operationId": "post_api_v1_fiscal_agent_nfce_emit", "tags": [ "fiscal-agent" ], "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", "fiscal.agent.approval:nfce.emit" ], "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_fiscal_agent_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/fiscal-agent/nfse/emit": { "post": { "operationId": "post_api_v1_fiscal_agent_nfse_emit", "tags": [ "fiscal-agent" ], "summary": "Nfse emit", "x-source": "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:32", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:api", "tenant.identify", "tenant.status", "idempotency", "nfse.quota", "fiscal.guard", "fiscal.agent.approval:nfse.emit" ], "responses": { "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "nfse_id": { "type": "integer", "x-source": "app/app/Modules/Fiscal/Nfse/Models/Nfse.php" }, "status": { "type": "string", "enum": [ "draft", "pending", "processing", "authorized", "rejected", "canceled", "substituted" ] }, "message": { "type": "string", "example": "NFSe enfileirada para emissão" } } }, "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": { "nfse_id": 1, "status": "draft", "message": "NFSe enfileirada para emissão" } } } } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseController.php:39" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_fiscal_agent_nfse_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": { "competencia": "0000-00", "cnpj_prestador": "00000000000000", "inscricao_municipal": "EXEMPLO_FICTICIO", "descricao_servico": "EXEMPLO_FICTICIO", "codigo_municipio_prestacao": "0000000", "valor_servico": 1, "tomador": { "nome": "EXEMPLO_FICTICIO" }, "prestador": { "endereco": { "logradouro": "EXEMPLO_FICTICIO", "numero": "EXEMPLO_FI", "bairro": "EXEMPLO_FICTICIO", "codigo_municipio": "EXEMPLO", "uf": "EX", "cep": "00000000" } } } } } } } } } }, "/api/v1/rtc-parameterization": { "get": { "operationId": "get_api_v1_rtc_parameterization", "tags": [ "rtc-parameterization" ], "summary": "RtcParameterization overview", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:24", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "taxpayer_profiles": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:29" }, "catalog_items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:30" }, "operation_rules": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:31" }, "item_tax_profiles": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:32" } } }, "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": { "taxpayer_profiles": null, "catalog_items": null, "operation_rules": null, "item_tax_profiles": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:28" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/rtc-parameterization/taxpayer-profiles": { "post": { "operationId": "post_api_v1_rtc_parameterization_taxpayer_profiles", "tags": [ "rtc-parameterization" ], "summary": "RtcParameterization approveTaxpayerProfile", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:43", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status", "fiscal.human" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:71" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:78" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_rtc_parameterization_taxpayer_profilesRequest" }, "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": { "crt": 1, "ibs_cbs_regime": "EXEMPLO_FICTICIO", "valid_from": "2026-10-01" } } } } } } } }, "/api/v1/rtc-parameterization/catalog-items": { "put": { "operationId": "put_api_v1_rtc_parameterization_catalog_items", "tags": [ "rtc-parameterization" ], "summary": "RtcParameterization upsertCatalogItem", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:81", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status", "fiscal.human" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:100" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:105" ] }, "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:100" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:105" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/put_api_v1_rtc_parameterization_catalog_itemsRequest" }, "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": { "sku": "EXEMPLO_FICTICIO", "type": "product", "description": "EXEMPLO_FICTICIO", "unit": "EXEMPLO_" } } } } } } } }, "/api/v1/rtc-parameterization/operation-rules": { "post": { "operationId": "post_api_v1_rtc_parameterization_operation_rules", "tags": [ "rtc-parameterization" ], "summary": "RtcParameterization approveOperationRule", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:108", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status", "fiscal.human" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:123" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:130" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_rtc_parameterization_operation_rulesRequest" }, "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": { "dfe_type": "NFE", "priority": 1, "valid_from": "2026-10-01" } } } } } } } }, "/api/v1/rtc-parameterization/item-tax-profiles": { "post": { "operationId": "post_api_v1_rtc_parameterization_item_tax_profiles", "tags": [ "rtc-parameterization" ], "summary": "RtcParameterization approveItemTaxProfile", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:133", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status", "fiscal.human" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:176" }, "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": null } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:187" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_rtc_parameterization_item_tax_profilesRequest" }, "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": { "catalog_item_id": 1, "cclass_trib": "000000", "valid_from": "2026-10-01" } } } } } } } }, "/api/v1/rtc-parameterization/scenarios": { "get": { "operationId": "get_api_v1_rtc_parameterization_scenarios", "tags": [ "rtc-parameterization" ], "summary": "RtcScenario index", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:19", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:24" } } } }, "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": [ null ] } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:24" ] } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "post_api_v1_rtc_parameterization_scenarios", "tags": [ "rtc-parameterization" ], "summary": "RtcScenario store", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:27", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status", "ability:nfes:emit" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:48" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:48" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_rtc_parameterization_scenariosRequest" }, "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": { "name": "AA", "dfe_type": "NFE", "input": { "sku": "EXEMPLO_FICTICIO", "tax_date": "2026-10-01T12:00:00Z", "item_number": 1, "calculator_payload": [ null ] } } } } } } } } }, "/api/v1/rtc-parameterization/scenarios/run": { "post": { "operationId": "post_api_v1_rtc_parameterization_scenarios_run", "tags": [ "rtc-parameterization" ], "summary": "RtcScenario runAll", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:62", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status", "throttle:10,1", "ability:nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:64" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:64" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/rtc-parameterization/scenarios/{id}/run": { "post": { "operationId": "post_api_v1_rtc_parameterization_scenarios__id__run", "tags": [ "rtc-parameterization" ], "summary": "RtcScenario run", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:51", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status", "throttle:20,1", "ability:nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:57" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:59" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:57" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:59" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/rtc-parameterization/scenarios/{id}": { "delete": { "operationId": "delete_api_v1_rtc_parameterization_scenarios__id_", "tags": [ "rtc-parameterization" ], "summary": "RtcScenario destroy", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:67", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:30,1", "tenant.identify", "tenant.status", "ability:nfes:emit" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "inactive" }, "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:74" } } }, "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": { "status": "inactive", "id": null } } } } }, "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:74" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/plans/current": { "get": { "operationId": "get_api_v1_plans_current", "tags": [ "plans" ], "summary": "Plan current", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:24", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "plan": { "type": "object", "properties": { "code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:32" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:33" }, "price_brl_cents": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:34" }, "monthly_note_quota": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:35" }, "max_cnpjs": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:36" }, "max_users": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:37" }, "features": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:38" } } }, "usage": { "type": "object", "properties": { "nfes_current_month": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:41" }, "nfes_quota_month": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:42" }, "period": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:43" } } } } }, "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": { "plan": { "code": null, "name": null, "price_brl_cents": null, "monthly_note_quota": null }, "usage": { "nfes_current_month": null, "nfes_quota_month": null, "period": null } } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/PlanController.php:30" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/plans/usage": { "get": { "operationId": "get_api_v1_plans_usage", "tags": [ "plans" ], "summary": "Plan usage", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:49", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "current_month": { "type": "object", "properties": { "nfes_issued": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:58" }, "quota": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:54" }, "remaining": { "anyOf": [ { "type": "null" }, { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:60" } ] }, "quota_exceeded": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:61" }, "period": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:62" } } }, "plan": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:64" } } }, "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": { "current_month": { "nfes_issued": null, "quota": null, "remaining": null, "quota_exceeded": null }, "plan": null } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/PlanController.php:56" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/plans/upgrade": { "post": { "operationId": "post_api_v1_plans_upgrade", "tags": [ "plans" ], "summary": "Plan upgrade", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:69", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "downgrade_not_allowed" }, "message": { "type": "string", "example": "Current month usage exceeds new plan quota." } } }, "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": "downgrade_not_allowed", "message": "Current month usage exceeds new plan quota." } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/PlanController.php:92" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Plan updated successfully." }, "plan": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.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": { "message": "Plan updated successfully.", "plan": null } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/PlanController.php:122" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_plans_upgradeRequest" }, "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": { "plan_code": "free" } } } } } } } }, "/api/v1/plans/expire": { "post": { "operationId": "post_api_v1_plans_expire", "tags": [ "plans" ], "summary": "Plan expireToFree", "x-source": "app/app/Http/Controllers/Api/V1/PlanController.php:129", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Subscription expired, downgraded to free." } } }, "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": "Subscription expired, downgraded to free." } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/PlanController.php:161" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/privacy/data-export": { "get": { "operationId": "get_api_v1_privacy_data_export", "tags": [ "privacy" ], "summary": "DataSubject dataExport", "x-source": "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:16", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tenant_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:25" }, "exported_at": { "type": "string", "format": "date-time" }, "data": { "type": "object", "properties": { "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:28" }, "slug": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:29" }, "plan": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:30" }, "status": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:31" }, "created_at": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:32" }, "nfe_count": { "type": "integer" }, "nfse_count": { "type": "integer" } } }, "note": { "type": "string", "example": "Fiscal documents (NF-e, NFS-e) are retained 5 years per Lei 9.784/1999 art.37 and cannot be bulk-exported via this endpoint." } } }, "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": { "tenant_id": null, "exported_at": "2026-10-01T12:00:00Z", "data": { "name": null, "slug": null, "plan": null, "status": null }, "note": "Fiscal documents (NF-e, NFS-e) are retained 5 years per Lei 9.784/1999 art.37 and cannot be bulk-exported via this endpoint." } } } } }, "x-source": [ "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:24" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/privacy/data-erasure": { "delete": { "operationId": "delete_api_v1_privacy_data_erasure", "tags": [ "privacy" ], "summary": "DataSubject dataErasure", "x-source": "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:40", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify" ], "responses": { "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "string" }, "received_at": { "type": "string", "format": "date-time" }, "deadline_at": { "type": "string", "format": "date-time" }, "status": { "type": "string", "example": "accepted" }, "message": { "type": "string", "example": "Erasure request accepted. Non-fiscal personal data will be removed within 15 business days." }, "note": { "type": "string", "example": "Fiscal documents cannot be erased — mandatory 5-year retention under Lei 9.784/1999." } } }, "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": { "request_id": "EXEMPLO_FICTICIO", "received_at": "2026-10-01T12:00:00Z", "deadline_at": "2026-10-01T12:00:00Z", "status": "accepted" } } } } }, "x-source": [ "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:58" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/privacy/automated-decisions": { "get": { "operationId": "get_api_v1_privacy_automated_decisions", "tags": [ "privacy" ], "summary": "DataSubject automatedDecisions", "x-source": "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:68", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "decisions": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string", "example": "FiscalGuard" }, "purpose": { "type": "string", "example": "Fiscal risk scoring and compliance monitoring (COAF/PLD-FT)" }, "logic": { "type": "string", "example": "Multi-signal weighted scoring based on NF-e emission patterns" }, "data_used": { "type": "array", "items": { "type": "string", "example": "nfe_emission_history" } }, "impact": { "type": "string", "example": "Automated alerts and potential COAF reporting" }, "legal_basis": { "type": "string", "example": "Lei 9.613/1998 art.11 (PLD-FT obligations)" }, "opt_out": { "type": "boolean", "example": false }, "opt_out_reason": { "type": "string", "example": "Legal obligation — cannot be disabled" } } } } } }, "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": { "decisions": [ { "system": "FiscalGuard", "purpose": "Fiscal risk scoring and compliance monitoring (COAF/PLD-FT)", "logic": "Multi-signal weighted scoring based on NF-e emission patterns", "data_used": [ "nfe_emission_history" ] } ] } } } } }, "x-source": [ "app/app/Modules/Compliance/Http/Controllers/DataSubjectController.php:70" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/billing/subscription": { "get": { "operationId": "get_api_v1_billing_subscription", "tags": [ "billing" ], "summary": "Billing subscription", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:96", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data": { "type": "null" } } }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:117" }, "status": { "type": "string", "enum": [ "draft", "pending", "processing", "authorized", "rejected", "denied", "canceled", "contingency" ], "x-source": "app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php" }, "billing_cycle": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:119" }, "current_period_start": { "type": [ "string", "null" ] }, "current_period_end": { "type": [ "string", "null" ] }, "plan": { "type": "object", "properties": { "code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:123" }, "name": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:124" }, "price_brl_cents": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:125" } } } } } } } ] }, "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": null } } } } }, "x-source": [ "app/app/Modules/Billing/Http/Controllers/BillingController.php:112", "app/app/Modules/Billing/Http/Controllers/BillingController.php:115" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/billing/subscribe": { "post": { "operationId": "post_api_v1_billing_subscribe", "tags": [ "billing" ], "summary": "Billing subscribe", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:27", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:5,60" ], "responses": { "409": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "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": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Billing/Http/Controllers/BillingController.php:40" ] }, "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "external_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:44" }, "pix_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:45" }, "checkout_url": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:46" } } }, "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": { "external_id": null, "pix_code": null, "checkout_url": null } } } } }, "x-source": [ "app/app/Modules/Billing/Http/Controllers/BillingController.php:43" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_billing_subscribeRequest" }, "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": { "plan_code": "starter", "gateway": "stripe" } } } } } } } }, "/api/v1/billing/change-plan": { "post": { "operationId": "post_api_v1_billing_change_plan", "tags": [ "billing" ], "summary": "Billing changePlan", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:50", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status" ], "responses": { "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "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": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Billing/Http/Controllers/BillingController.php:60" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Plan changed successfully" } } }, "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": "Plan changed successfully" } } } } }, "x-source": [ "app/app/Modules/Billing/Http/Controllers/BillingController.php:63" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_billing_change_planRequest" }, "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": { "plan_code": "free" } } } } } } } }, "/api/v1/billing/cancel": { "post": { "operationId": "post_api_v1_billing_cancel", "tags": [ "billing" ], "summary": "Billing cancel", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:66", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Subscription canceled" } } }, "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": "Subscription canceled" } } } } }, "x-source": [ "app/app/Modules/Billing/Http/Controllers/BillingController.php:75" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/billing/invoices": { "get": { "operationId": "get_api_v1_billing_invoices", "tags": [ "billing" ], "summary": "Billing invoices", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:78", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Billing/Http/Controllers/BillingController.php:85" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Billing/Http/Controllers/BillingController.php:93" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/billing/payment-methods": { "get": { "operationId": "get_api_v1_billing_payment_methods", "tags": [ "billing" ], "summary": "PaymentMethod index", "x-source": "app/app/Modules/Billing/Http/Controllers/PaymentMethodController.php:20", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Billing/Http/Controllers/PaymentMethodController.php:27" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Billing/Http/Controllers/PaymentMethodController.php:35" ] } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "post_api_v1_billing_payment_methods", "tags": [ "billing" ], "summary": "PaymentMethod store", "x-source": "app/app/Modules/Billing/Http/Controllers/PaymentMethodController.php:41", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:10,60" ], "responses": { "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Billing/Http/Controllers/PaymentMethodController.php:64" } } }, "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": null } } } } }, "x-source": [ "app/app/Modules/Billing/Http/Controllers/PaymentMethodController.php:71" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_billing_payment_methodsRequest" }, "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": { "gateway": null, "type": "card", "external_id": "EXEMPLO_FICTICIO" } } } } } } } }, "/api/v1/billing/payment-methods/{id}": { "delete": { "operationId": "delete_api_v1_billing_payment_methods__id_", "tags": [ "billing" ], "summary": "PaymentMethod destroy", "x-source": "app/app/Modules/Billing/Http/Controllers/PaymentMethodController.php:77", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status" ], "responses": { "204": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "null" }, "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": null } } } }, "x-source": [ "app/app/Modules/Billing/Http/Controllers/PaymentMethodController.php:92" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "[0-9]+" } } ] } }, "/api/v1/affiliates": { "get": { "operationId": "get_api_v1_affiliates", "tags": [ "affiliates" ], "summary": "Affiliate index", "x-source": "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:45", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "referrals": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:55" }, "referral_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:56" }, "referred_email": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:57" }, "status": { "type": "string", "enum": [ "draft", "pending", "processing", "authorized", "rejected", "denied", "canceled", "contingency" ], "x-source": "app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php" }, "converted_at": { "type": [ "string", "null" ], "format": "date-time" } } } }, "commissions": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:62" }, "referral_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:63" }, "amount_cents": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:64" }, "status": { "type": "string", "enum": [ "draft", "pending", "processing", "authorized", "rejected", "denied", "canceled", "contingency" ], "x-source": "app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.php" }, "accrued_at": { "type": "string", "format": "date-time" }, "reversed_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": { "referrals": [ { "id": null, "referral_code": null, "referred_email": null, "status": "draft" } ], "commissions": [ { "id": null, "referral_id": null, "amount_cents": null, "status": "draft" } ] } } } } } }, "x-source": [ "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:52" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/affiliates/referrals": { "post": { "operationId": "post_api_v1_affiliates_referrals", "tags": [ "affiliates" ], "summary": "Affiliate store", "x-source": "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:21", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "tenant.status", "throttle:20,60" ], "responses": { "409": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "referral_duplicate" }, "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": "referral_duplicate", "message": "EXEMPLO_FICTICIO" } } } } }, "x-source": [ "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:34" ] }, "201": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:38" }, "referral_code": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:39" }, "referred_email": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:40" }, "status": { "type": "string", "enum": [ "draft", "pending", "processing", "authorized", "rejected", "denied", "canceled", "contingency" ], "x-source": "app/app/Modules/Fiscal/Nfe/Enums/NfeStatus.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": { "data": { "id": null, "referral_code": null, "referred_email": null, "status": "draft" } } } } } }, "x-source": [ "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:37" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_affiliates_referralsRequest" }, "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": { "referred_email": "integracao@example.invalid" } } } } } } } }, "/api/v1/webhooks/config": { "get": { "operationId": "get_api_v1_webhooks_config", "tags": [ "webhooks" ], "summary": "WebhookConfig show", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:30", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "configured": { "type": "boolean", "example": false } } }, { "type": "object", "properties": { "configured": { "type": "boolean", "example": true }, "webhook_url": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:40" }, "secret_preview": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:249" }, "active": { "type": "boolean" } } } ] }, "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": { "configured": false } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:35", "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:38" ] } }, "security": [ { "bearerAuth": [] } ] }, "put": { "operationId": "put_api_v1_webhooks_config", "tags": [ "webhooks" ], "summary": "WebhookConfig update", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:46", "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 }, "webhook_url": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:73" }, "secret_preview": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:249" }, "active": { "type": "boolean" } } }, "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, "webhook_url": null, "secret_preview": null, "active": false } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:71" ] } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/put_api_v1_webhooks_configRequest" }, "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": { "webhook_url": "https://example.invalid/callback" } } } } } } }, "delete": { "operationId": "delete_api_v1_webhooks_config", "tags": [ "webhooks" ], "summary": "WebhookConfig destroy", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:79", "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 }, "active": { "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": { "ok": true, "active": false } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:84", "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:89" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/webhooks/deliveries": { "get": { "operationId": "get_api_v1_webhooks_deliveries", "tags": [ "webhooks" ], "summary": "WebhookConfig deliveries", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:92", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:94" }, "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": null } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:106" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/webhooks/events": { "get": { "operationId": "get_api_v1_webhooks_events", "tags": [ "webhooks" ], "summary": "WebhookConfig events", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:205", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "throttle:60,1" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:208" }, "type_prefix": { "type": "string", "example": "br.com.centralfox.foxnfe." }, "signature": { "type": "string", "example": "HMAC-SHA256 sobre o corpo canônico (chaves ordenadas), cabeçalho X-Webhook-Signature: sha256=" }, "delivery": { "type": "string", "example": "at-least-once; deduplicar pelo id do CloudEvent" } } }, "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": null, "type_prefix": "br.com.centralfox.foxnfe.", "signature": "HMAC-SHA256 sobre o corpo canônico (chaves ordenadas), cabeçalho X-Webhook-Signature: sha256=", "delivery": "at-least-once; deduplicar pelo id do CloudEvent" } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:207" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/webhooks/test": { "post": { "operationId": "post_api_v1_webhooks_test", "tags": [ "webhooks" ], "summary": "WebhookConfig test", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:215", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "throttle:10,1" ], "responses": { "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "example": true }, "event": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:227" }, "delivery_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:217" } } }, "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, "event": null, "delivery_id": null } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:225" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/webhooks/deliveries/{delivery}/resend": { "post": { "operationId": "post_api_v1_webhooks_deliveries__delivery__resend", "tags": [ "webhooks" ], "summary": "WebhookConfig resend", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:117", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "tenant.identify", "throttle:10,1" ], "responses": { "409": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Entrega já realizada com sucesso." } } }, "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": false, "message": "Entrega já realizada com sucesso." } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:141" ] }, "422": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Entrega não está em estado terminal de falha." } } }, "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": false, "message": "Entrega não está em estado terminal de falha." } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:148" ] }, "503": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Não foi possível confirmar o enfileiramento. Consulte o histórico antes de tentar novamente." }, "delivery_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:193" } } }, "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": false, "message": "Não foi possível confirmar o enfileiramento. Consulte o histórico antes de tentar novamente.", "delivery_id": null } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:190" ] }, "202": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "example": true }, "delivery_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:198" } } }, "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, "delivery_id": null } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:198" ] } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "delivery", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/admin/costs": { "get": { "operationId": "get_api_v1_admin_costs", "tags": [ "admin" ], "summary": "Cost index", "x-source": "app/app/Http/Controllers/Api/V1/Admin/CostController.php:20", "x-middleware": [ "api", "auth:sanctum", "agent.provider", "throttle:10,1" ], "responses": { "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "period_days": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/Admin/CostController.php:23" }, "generated_at": { "type": "string", "format": "date-time" }, "summary": { "type": "object", "properties": { "tenant_count": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/Admin/CostController.php:37" }, "total_gateway_fee_cents": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/Admin/CostController.php:27" }, "total_nfe_cost_cents": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/Admin/CostController.php:28" }, "total_nfse_cost_cents": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/Admin/CostController.php:29" }, "total_storage_cost_cents": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/Admin/CostController.php:30" }, "total_op_cost_cents": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/Admin/CostController.php:31" }, "total_op_cost_brl": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/Admin/CostController.php:43" } } }, "tenants": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/Admin/CostController.php:25" } } }, "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": { "period_days": null, "generated_at": "2026-10-01T12:00:00Z", "summary": { "tenant_count": null, "total_gateway_fee_cents": null, "total_nfe_cost_cents": null, "total_nfse_cost_cents": null }, "tenants": null } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/Admin/CostController.php:33" ] } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/webhooks/billing/{gateway}": { "post": { "operationId": "post_api_v1_webhooks_billing__gateway_", "tags": [ "webhooks" ], "summary": "Webhook handle", "x-source": [ "app/routes/api.php:329-333", "app/app/Modules/Billing/Http/Controllers/WebhookController.php:20-66", "app/app/Modules/Billing/Http/Controllers/WebhookController.php:69-74" ], "x-middleware": [ "api", "throttle:60,1" ], "responses": { "200": { "description": "Evento verificado e processado.", "content": { "text/plain": { "schema": { "type": "string", "example": "OK" }, "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" } } } } }, "400": { "description": "Gateway desconhecido.", "content": { "text/plain": { "schema": { "type": "string", "example": "Unknown gateway" }, "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": "Unknown gateway" } } } } }, "401": { "description": "Assinatura ausente ou inválida.", "content": { "text/plain": { "schema": { "type": "string", "example": "Signature invalid" }, "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": "Signature invalid" } } } } }, "429": { "description": "Limite de requisições excedido." }, "500": { "description": "Falha interna ao processar o evento já verificado.", "content": { "text/plain": { "schema": { "type": "string", "example": "Internal error" }, "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": "Internal error" } } } } } }, "parameters": [ { "name": "gateway", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "stripe" ] }, "description": "Gateway de cobrança. Valor implementado: stripe." }, { "name": "Stripe-Signature", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Assinatura Stripe do corpo bruto." } ], "description": "Recebe webhook público de cobrança. A assinatura é verificada antes de qualquer persistência. O único gateway aceito atualmente é Stripe.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Evento bruto do gateway; o formato varia conforme o tipo de evento Stripe." }, "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": {} } } } } } } }, "/api/v1/crypto-invoices/auto-confirm": { "post": { "operationId": "post_api_v1_crypto_invoices_auto_confirm", "tags": [ "crypto-invoices" ], "summary": "CryptoInvoice __invoke", "x-source": "app/app/Http/Controllers/Api/V1/CryptoInvoiceController.php:19", "x-middleware": [ "api", "throttle:120,1" ], "responses": { "401": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "invalid_signature" } } }, "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": "invalid_signature" } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/CryptoInvoiceController.php:22" ] }, "200": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "example": "already_processed" } } }, { "type": "object", "properties": { "status": { "type": "string", "example": "confirmed" }, "reference": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/CryptoInvoiceController.php:71" }, "tenant_id": { "description": "Valor calculado pelo servidor; o tipo não é restringido sem evidência estática.", "x-source": "app/app/Http/Controllers/Api/V1/CryptoInvoiceController.php:72" } } } ] }, "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": { "status": "already_processed" } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/CryptoInvoiceController.php:35", "app/app/Http/Controllers/Api/V1/CryptoInvoiceController.php:69" ] }, "404": { "description": "Resposta implementada pelo controlador.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "no_match" } } }, "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": { "status": "no_match" } } } } }, "x-source": [ "app/app/Http/Controllers/Api/V1/CryptoInvoiceController.php:50" ] } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/post_api_v1_crypto_invoices_auto_confirmRequest" }, "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": { "txid": "EXEMPLO_FICTICIO", "amount_usdt": 1 } } } } } } } }, "/api/v1/mcp": { "get": { "operationId": "get_api_v1_mcp", "tags": [ "mcp" ], "summary": "Mcp discover", "x-source": [ "app/routes/api.php:340-342", "app/app/Modules/Mcp/Http/Controllers/McpController.php:82-99" ], "x-middleware": [ "api", "throttle:60,1" ], "responses": { "200": { "description": "Metadados públicos de discovery MCP.", "content": { "application/json": { "schema": { "type": "object", "required": [ "service", "endpoint", "protocol", "methods", "authentication", "tools", "docs" ], "properties": { "service": { "type": "string", "example": "FOX NF-e" }, "endpoint": { "type": "string", "format": "uri" }, "protocol": { "type": "string" }, "methods": { "type": "array", "items": { "type": "string", "enum": [ "POST", "DELETE" ] } }, "authentication": { "type": "object", "additionalProperties": { "type": "string" } }, "tools": { "type": "integer", "minimum": 0 }, "docs": { "type": "string", "format": "uri" } } }, "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": { "service": "FOX NF-e", "endpoint": "https://example.invalid/callback", "protocol": "EXEMPLO_FICTICIO", "methods": [ "POST" ], "authentication": {}, "tools": 1, "docs": "https://example.invalid/callback" } } } } } }, "405": { "description": "SSE via GET não é oferecido.", "headers": { "Allow": { "schema": { "type": "string", "example": "POST, DELETE" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "example": "SSE GET is not offered" } } }, "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": "SSE GET is not offered" } } } } } }, "429": { "description": "Limite de requisições excedido." } }, "description": "Discovery público do transporte MCP. Retorna metadados para navegador e catálogo. Requisições que pedem text/event-stream recebem 405 porque SSE GET não é oferecido.", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "Se contiver text/event-stream, o servidor rejeita com 405.", "schema": { "type": "string" } } ] }, "post": { "operationId": "post_api_v1_mcp", "tags": [ "mcp" ], "summary": "Mcp handle", "x-source": [ "app/routes/api.php:344-348", "app/app/Modules/Mcp/Http/Controllers/McpController.php:117-160", "app/app/Modules/Mcp/Http/Controllers/McpController.php:169-218" ], "x-middleware": [ "api", "auth:sanctum", "throttle:120,1", "tenant.identify", "tenant.status", "plan.limits", "mcp.fiscal.readonly" ], "responses": { "200": { "description": "Resposta JSON-RPC única ou lote de respostas. Erros de método/parâmetros também usam envelope JSON-RPC com HTTP 200.", "headers": { "Mcp-Session-Id": { "description": "Identificador de sessão recebido ou gerado pelo servidor.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "jsonrpc", "id" ], "additionalProperties": true, "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": {}, "result": {}, "error": { "type": "object", "required": [ "code", "message" ], "additionalProperties": true, "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } }, { "type": "array", "items": { "type": "object", "required": [ "jsonrpc", "id" ], "additionalProperties": true, "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": {}, "result": {}, "error": { "type": "object", "required": [ "code", "message" ], "additionalProperties": true, "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} } } } } } ] }, "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": { "jsonrpc": "2.0", "id": null } } } } } }, "202": { "description": "Notificação JSON-RPC sem id; não há resultado JSON-RPC." }, "400": { "description": "Versão MCP não suportada ou initialize enviado com uma sessão existente." }, "401": { "description": "Token Sanctum ausente ou inválido." }, "403": { "description": "Origin, tenant, plano ou política MCP não permite a operação." }, "404": { "description": "Mcp-Session-Id não encontrado ou não vinculado ao usuário e tenant autenticados." }, "429": { "description": "Limite de requisições excedido." } }, "security": [ { "bearerAuth": [] } ], "description": "Transporte MCP Streamable HTTP autenticado. Aceita uma mensagem JSON-RPC 2.0 ou um lote. initialize cria sessão vinculada ao usuário e tenant; chamadas posteriores podem informar Mcp-Session-Id. Respostas de métodos são dinâmicas; notificações sem id retornam 202.", "parameters": [ { "name": "Mcp-Session-Id", "in": "header", "required": false, "description": "Sessão previamente emitida por initialize. initialize exige ausência deste header; outras chamadas validam seu vínculo com usuário e tenant.", "schema": { "type": "string" } }, { "name": "MCP-Protocol-Version", "in": "header", "required": false, "description": "Quando informado, deve ser 2025-06-18.", "schema": { "type": "string", "enum": [ "2025-06-18" ] } }, { "name": "Origin", "in": "header", "required": false, "description": "Quando informado, deve pertencer à lista de origens FoxNFe aceita pelo controlador.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "method" ], "additionalProperties": true, "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": {}, "method": { "type": "string" }, "params": { "type": "object", "additionalProperties": true } } }, { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "method" ], "additionalProperties": true, "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": {}, "method": { "type": "string" }, "params": { "type": "object", "additionalProperties": true } } } } ] }, "examples": { "ping": { "value": { "jsonrpc": "2.0", "id": 1, "method": "ping", "params": {} } }, "initialize": { "value": { "jsonrpc": "2.0", "id": 1, "method": "initialize", "params": { "protocolVersion": "2025-06-18", "clientInfo": { "name": "cliente", "version": "1.0" } } } } } } } } }, "delete": { "operationId": "delete_api_v1_mcp", "tags": [ "mcp" ], "summary": "Mcp destroy", "x-source": [ "app/routes/api.php:350-352", "app/app/Modules/Mcp/Http/Controllers/McpController.php:101-115" ], "x-middleware": [ "api", "auth:sanctum" ], "responses": { "204": { "description": "Sessão encontrada e removida; sem corpo." }, "401": { "description": "Token Sanctum ausente ou inválido." }, "404": { "description": "Header ausente, sessão inexistente ou sessão pertencente a outro usuário/tenant." } }, "security": [ { "bearerAuth": [] } ], "description": "Encerra uma sessão MCP válida vinculada ao usuário autenticado e remove seu estado do cache.", "parameters": [ { "name": "Mcp-Session-Id", "in": "header", "required": true, "description": "Identificador da sessão a encerrar. Deve existir e pertencer ao usuário autenticado.", "schema": { "type": "string" } } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } }, "schemas": { "post_api_v1_documents_importsRequest": { "type": "object", "properties": { "file": { "x-laravel-rules": [ "required", "file", "max:2048" ], "type": "string", "format": "binary" }, "preview_sha256": { "x-laravel-rules": [ "sometimes", "string", "regex:/^[0-9a-f]{64}$/" ], "type": "string", "pattern": "^[0-9a-f]{64}$" } }, "required": [ "file" ], "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Requests/ImportDocumentRequest.php:31" ] }, "post_api_v1_documents_imports_previewRequest": { "type": "object", "properties": { "file": { "x-laravel-rules": [ "required", "file", "max:2048" ], "type": "string", "format": "binary" }, "preview_sha256": { "x-laravel-rules": [ "sometimes", "string", "regex:/^[0-9a-f]{64}$/" ], "type": "string", "pattern": "^[0-9a-f]{64}$" } }, "required": [ "file" ], "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Requests/ImportDocumentRequest.php:31" ] }, "post_api_v1_documents_exportsRequest": { "type": "object", "properties": { "retention_hours": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:720" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 720 }, "date_from": { "x-laravel-rules": [ "required", "date_format:Y-m-d" ], "type": "string", "format": "date" }, "date_to": { "x-laravel-rules": [ "required", "date_format:Y-m-d", "after_or_equal:date_from" ], "type": "string", "format": "date", "description": "Deve ser posterior ou igual a date_from." }, "tipos": { "x-laravel-rules": [ "sometimes", "array" ], "type": "array", "items": { "x-laravel-rules": [ "string", "in:55,65,nfse,recebida,nfe,nfce,evento,eventos,inutilizacao,inutilizacoes,cte,57,cte_recebido,nfse_recebida,nfse-recebida" ], "type": "string", "enum": [ "55", "65", "nfse", "recebida", "nfe", "nfce", "evento", "eventos", "inutilizacao", "inutilizacoes", "cte", "57", "cte_recebido", "nfse_recebida", "nfse-recebida" ] } }, "ambiente": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "in:1,2" ], "type": [ "integer", "null" ], "enum": [ 1, 2, null ] }, "origin": { "x-laravel-rules": [ "sometimes", "nullable", "string", "in:emitida,recebida,importada" ], "type": [ "string", "null" ], "enum": [ "emitida", "recebida", "importada", null ] }, "status": { "x-laravel-rules": [ "sometimes", "nullable", "string", "in:draft,pending,processing,authorized,rejected,denied,canceled,contingency,substituted,recebida,importada" ], "type": [ "string", "null" ], "enum": [ "draft", "pending", "processing", "authorized", "rejected", "denied", "canceled", "contingency", "substituted", "recebida", "importada", null ] }, "participante": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:255" ], "type": [ "string", "null" ], "maxLength": 255 }, "valor_min": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{1,15}(\\.\\d{1,2})?$/" ], "type": [ "string", "null" ], "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" }, "valor_max": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{1,15}(\\.\\d{1,2})?$/" ], "type": [ "string", "null" ], "pattern": "^\\d{1,15}(\\.\\d{1,2})?$" } }, "required": [ "date_from", "date_to" ], "x-source": [ "app/app/Modules/Fiscal/Documents/Http/Requests/CreateDocumentExportRequest.php:14" ] }, "put_api_v1_nfe_distribuicao_captura_automaticaRequest": { "type": "object", "properties": { "certificate_id": { "x-laravel-rules": [ "required", "integer", "min:1" ], "type": "integer", "minimum": 1 }, "ambiente": { "x-laravel-rules": [ "required", "integer", "in:1,2" ], "type": "integer", "enum": [ 1, 2 ] }, "fonte": { "x-laravel-rules": [ "sometimes", "string", "in:AN,CTE" ], "type": "string", "enum": [ "AN", "CTE" ] } }, "required": [ "certificate_id", "ambiente" ], "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/DistribuicaoDFeController.php:151" ] }, "post_api_v1_nfe_distribuicao_capturarRequest": { "type": "object", "properties": { "certificate_id": { "x-laravel-rules": [ "sometimes", "integer", "min:1" ], "type": "integer", "minimum": 1 }, "ambiente": { "x-laravel-rules": [ "sometimes", "integer", "in:1,2" ], "type": "integer", "enum": [ 1, 2 ] }, "fonte": { "x-laravel-rules": [ "sometimes", "string", "in:AN,CTE" ], "type": "string", "enum": [ "AN", "CTE" ] } }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Requests/CapturarDistribuicaoRequest.php:22" ] }, "post_api_v1_nfe_distribuicao_manifestacoesRequest": { "type": "object", "properties": { "chave_acesso": { "x-laravel-rules": [ "required", "string", "regex:/^[0-9]{6}[0-9A-Z]{12}[0-9]{26}$/" ], "type": "string", "pattern": "^[0-9]{6}[0-9A-Z]{12}[0-9]{26}$" }, "tipo_evento": { "x-laravel-rules": [ "required", "integer", "in:210200,210210,210220,210240" ], "type": "integer", "enum": [ 210200, 210210, 210220, 210240 ] }, "n_seq_evento": { "x-laravel-rules": [ "sometimes", "integer", "min:1", "max:20" ], "type": "integer", "minimum": 1, "maximum": 20 }, "justificativa": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:255" ], "type": [ "string", "null" ], "maxLength": 255 }, "nfe_distribuicao_id": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1" ], "type": [ "integer", "null" ], "minimum": 1 }, "certificate_id": { "x-laravel-rules": [ "sometimes", "integer", "min:1" ], "type": "integer", "minimum": 1 }, "ambiente": { "x-laravel-rules": [ "sometimes", "integer", "in:1,2" ], "type": "integer", "enum": [ 1, 2 ] } }, "required": [ "chave_acesso", "tipo_evento" ], "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Requests/SolicitarManifestacaoRequest.php:25" ] }, "post_api_v1_nfe_distribuicao_manifestacoes__id__aprovarRequest": { "type": "object", "properties": { "payload_hash": { "x-laravel-rules": [ "required", "string", "regex:/^[0-9a-f]{64}$/" ], "type": "string", "pattern": "^[0-9a-f]{64}$" } }, "required": [ "payload_hash" ], "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Requests/AprovarManifestacaoRequest.php:22" ] }, "post_api_v1_nfe__invoice__cceRequest": { "type": "object", "properties": { "correcao": { "x-laravel-rules": [ "required", "string", "min:15", "max:1000" ], "type": "string", "minLength": 15, "maxLength": 1000 }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:20" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 20 } }, "required": [ "correcao" ], "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Requests/StoreCartaCorrecaoRequest.php:58" ] }, "post_api_v1_nfe_inutilizacoesRequest": { "type": "object", "properties": { "modelo": { "x-laravel-rules": [ "sometimes", "integer", "in:55,65" ], "type": "integer", "enum": [ 55, 65 ] }, "serie": { "x-laravel-rules": [ "required", "integer", "min:0", "max:999" ], "type": "integer", "minimum": 0, "maximum": 999 }, "ano": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:0", "max:2099" ], "type": [ "integer", "null" ], "minimum": 0, "maximum": 2099 }, "numero_inicial": { "x-laravel-rules": [ "required", "integer", "min:1", "max:999999999" ], "type": "integer", "minimum": 1, "maximum": 999999999 }, "numero_final": { "x-laravel-rules": [ "required", "integer", "min:1", "max:999999999", "gte:numero_inicial" ], "type": "integer", "minimum": 1, "maximum": 999999999 }, "justificativa": { "x-laravel-rules": [ "required", "string", "min:15", "max:255" ], "type": "string", "minLength": 15, "maxLength": 255 } }, "required": [ "serie", "numero_inicial", "numero_final", "justificativa" ], "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Requests/StoreInutilizacaoRequest.php:26" ] }, "post_api_v1_nfe__invoice__ator_interessadoRequest": { "type": "object", "properties": { "documento": { "x-laravel-rules": [ "required", "string", "regex:/^(?:\\d{11}|\\d{14})$/" ], "type": "string", "pattern": "^(?:\\d{11}|\\d{14})$" }, "tp_autor": { "x-laravel-rules": [ "sometimes", "integer", "in:1,2,3" ], "type": "integer", "enum": [ 1, 2, 3 ] }, "tp_autorizacao": { "x-laravel-rules": [ "sometimes", "integer", "in:0,1" ], "type": "integer", "enum": [ 0, 1 ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 } }, "required": [ "documento" ], "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Requests/StoreAtorInteressadoRequest.php:15" ] }, "post_api_v1_nfe__invoice__insucesso_entregaRequest": { "type": "object", "properties": { "dh_tentativa": { "x-laravel-rules": [ "required", "date", "before_or_equal:now" ], "type": "string", "format": "date-time", "description": "Deve ser anterior ou igual a now." }, "n_tentativa": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "tp_motivo": { "x-laravel-rules": [ "required", "integer", "in:1,2,3,4" ], "type": "integer", "enum": [ 1, 2, 3, 4 ] }, "justificativa": { "x-laravel-rules": [ "required_if:tp_motivo,4", "nullable", "string", "min:15", "max:250" ], "type": [ "string", "null" ], "description": "Obrigatório quando tp_motivo,4.", "minLength": 15, "maxLength": 250 }, "latitude": { "x-laravel-rules": [ "sometimes", "nullable", "numeric", "between:-90,90" ], "type": [ "number", "null" ] }, "longitude": { "x-laravel-rules": [ "sometimes", "nullable", "numeric", "between:-180,180" ], "type": [ "number", "null" ] }, "imagem_base64": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:700000", "regex:/^[A-Za-z0-9+\\/]+={0,2}$/" ], "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", "null" ], "maxLength": 700000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 } }, "required": [ "dh_tentativa", "tp_motivo" ], "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Requests/StoreInsucessoEntregaRequest.php:22" ] }, "post_api_v1_nfe__invoice__eventosRequest": { "oneOf": [ { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "conciliacao_financeira" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "det_pag": { "x-laravel-rules": [ "required", "array", "min:1", "max:100" ], "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "object", "properties": { "ind_pag": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "in:0,1" ], "type": [ "integer", "null" ], "enum": [ 0, 1, null ] }, "t_pag": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{2}$/" ], "type": "string", "pattern": "^\\d{2}$" }, "x_pag": { "x-laravel-rules": [ "sometimes", "nullable", "string", "min:2", "max:60" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 60 }, "v_pag": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "d_pag": { "x-laravel-rules": [ "required", "date_format:Y-m-d" ], "type": "string", "format": "date" }, "cnpj_pag": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{14}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{14}$" }, "uf_pag": { "x-laravel-rules": [ "sometimes", "nullable", "string", "size:2" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 }, "cnpj_if": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{14}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{14}$" }, "t_band": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{2}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{2}$" }, "c_aut": { "x-laravel-rules": [ "sometimes", "nullable", "string", "min:1", "max:128" ], "type": [ "string", "null" ], "minLength": 1, "maxLength": 128 }, "cnpj_receb": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{14}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{14}$" }, "uf_receb": { "x-laravel-rules": [ "sometimes", "nullable", "string", "size:2" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 } }, "required": [ "t_pag", "v_pag", "d_pag" ] } } }, "required": [ "tipo", "det_pag" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "cancelamento_conciliacao" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "evento_id": { "x-laravel-rules": [ "required", "integer", "min:1" ], "type": "integer", "minimum": 1 } }, "required": [ "tipo", "evento_id" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "cancelamento_evento" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "evento_id": { "x-laravel-rules": [ "required", "integer", "min:1" ], "type": "integer", "minimum": 1 } }, "required": [ "tipo", "evento_id" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_pagto_integral" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 } }, "required": [ "tipo" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_importacao_zfm" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_perda_transporte_fornecedor" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 }, "v_ibs_estoque": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs_estoque": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade", "v_ibs_estoque", "v_cbs_estoque" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_fornecimento_nao_realizado" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_atualizacao_entrega" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "data_prevista": { "x-laravel-rules": [ "required", "date_format:Y-m-d" ], "type": "string", "format": "date" } }, "required": [ "tipo", "data_prevista" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_apropriacao_cred_presumido" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_bc": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "g_ibs": { "x-laravel-rules": [ "sometimes", "nullable", "array" ], "type": [ "object", "null" ], "properties": { "c_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_ibs", "string", "min:1", "max:4" ], "type": "string", "description": "Obrigatório quando estiver presente itens.*.g_ibs.", "minLength": 1, "maxLength": 4 }, "p_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_ibs", "numeric", "min:0" ], "type": "number", "description": "Obrigatório quando estiver presente itens.*.g_ibs.", "minimum": 0 }, "v_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_ibs", "numeric", "min:0" ], "type": "number", "description": "Obrigatório quando estiver presente itens.*.g_ibs.", "minimum": 0 } } }, "g_cbs": { "x-laravel-rules": [ "sometimes", "nullable", "array" ], "type": [ "object", "null" ], "properties": { "c_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_cbs", "string", "min:1", "max:4" ], "type": "string", "description": "Obrigatório quando estiver presente itens.*.g_cbs.", "minLength": 1, "maxLength": 4 }, "p_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_cbs", "numeric", "min:0" ], "type": "number", "description": "Obrigatório quando estiver presente itens.*.g_cbs.", "minimum": 0 }, "v_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_cbs", "numeric", "min:0" ], "type": "number", "description": "Obrigatório quando estiver presente itens.*.g_cbs.", "minimum": 0 } } } }, "required": [ "item", "v_bc" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_consumo_pessoal" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "tp_autor": { "x-laravel-rules": [ "required", "integer", "in:1,2" ], "type": "integer", "enum": [ 1, 2 ] }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 }, "chave": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{44}$/" ], "type": "string", "pattern": "^\\d{44}$" }, "n_item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade", "chave", "n_item" ] } } }, "required": [ "tipo", "tp_autor", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_perda_transporte_adquirente" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_aceite_debito" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "ind_aceitacao": { "x-laravel-rules": [ "required", "integer", "in:0,1" ], "type": "integer", "enum": [ 0, 1 ] } }, "required": [ "tipo", "ind_aceitacao" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_imobilizacao_item" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_apropriacao_cred_combustivel" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_apropriacao_cred_bens" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_cred_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cred_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 } }, "required": [ "item", "v_cred_ibs", "v_cred_cbs" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_manif_transf_cred_ibs" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "ind_aceitacao": { "x-laravel-rules": [ "required", "integer", "in:0,1" ], "type": "integer", "enum": [ 0, 1 ] } }, "required": [ "tipo", "ind_aceitacao" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_manif_transf_cred_cbs" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "ind_aceitacao": { "x-laravel-rules": [ "required", "integer", "in:0,1" ], "type": "integer", "enum": [ 0, 1 ] } }, "required": [ "tipo", "ind_aceitacao" ], "additionalProperties": false } ], "discriminator": { "propertyName": "tipo" }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Requests/StoreEventoContratoRequest.php:35" ] }, "post_api_v1_nfe_recebidas__distribuicao__eventosRequest": { "oneOf": [ { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "conciliacao_financeira" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "det_pag": { "x-laravel-rules": [ "required", "array", "min:1", "max:100" ], "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "object", "properties": { "ind_pag": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "in:0,1" ], "type": [ "integer", "null" ], "enum": [ 0, 1, null ] }, "t_pag": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{2}$/" ], "type": "string", "pattern": "^\\d{2}$" }, "x_pag": { "x-laravel-rules": [ "sometimes", "nullable", "string", "min:2", "max:60" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 60 }, "v_pag": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "d_pag": { "x-laravel-rules": [ "required", "date_format:Y-m-d" ], "type": "string", "format": "date" }, "cnpj_pag": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{14}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{14}$" }, "uf_pag": { "x-laravel-rules": [ "sometimes", "nullable", "string", "size:2" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 }, "cnpj_if": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{14}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{14}$" }, "t_band": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{2}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{2}$" }, "c_aut": { "x-laravel-rules": [ "sometimes", "nullable", "string", "min:1", "max:128" ], "type": [ "string", "null" ], "minLength": 1, "maxLength": 128 }, "cnpj_receb": { "x-laravel-rules": [ "sometimes", "nullable", "string", "regex:/^\\d{14}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{14}$" }, "uf_receb": { "x-laravel-rules": [ "sometimes", "nullable", "string", "size:2" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 } }, "required": [ "t_pag", "v_pag", "d_pag" ] } } }, "required": [ "tipo", "det_pag" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "cancelamento_conciliacao" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "evento_id": { "x-laravel-rules": [ "required", "integer", "min:1" ], "type": "integer", "minimum": 1 } }, "required": [ "tipo", "evento_id" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "cancelamento_evento" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "evento_id": { "x-laravel-rules": [ "required", "integer", "min:1" ], "type": "integer", "minimum": 1 } }, "required": [ "tipo", "evento_id" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_pagto_integral" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 } }, "required": [ "tipo" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_importacao_zfm" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_perda_transporte_fornecedor" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 }, "v_ibs_estoque": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs_estoque": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade", "v_ibs_estoque", "v_cbs_estoque" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_fornecimento_nao_realizado" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_atualizacao_entrega" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "data_prevista": { "x-laravel-rules": [ "required", "date_format:Y-m-d" ], "type": "string", "format": "date" } }, "required": [ "tipo", "data_prevista" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_apropriacao_cred_presumido" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_bc": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "g_ibs": { "x-laravel-rules": [ "sometimes", "nullable", "array" ], "type": [ "object", "null" ], "properties": { "c_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_ibs", "string", "min:1", "max:4" ], "type": "string", "description": "Obrigatório quando estiver presente itens.*.g_ibs.", "minLength": 1, "maxLength": 4 }, "p_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_ibs", "numeric", "min:0" ], "type": "number", "description": "Obrigatório quando estiver presente itens.*.g_ibs.", "minimum": 0 }, "v_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_ibs", "numeric", "min:0" ], "type": "number", "description": "Obrigatório quando estiver presente itens.*.g_ibs.", "minimum": 0 } } }, "g_cbs": { "x-laravel-rules": [ "sometimes", "nullable", "array" ], "type": [ "object", "null" ], "properties": { "c_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_cbs", "string", "min:1", "max:4" ], "type": "string", "description": "Obrigatório quando estiver presente itens.*.g_cbs.", "minLength": 1, "maxLength": 4 }, "p_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_cbs", "numeric", "min:0" ], "type": "number", "description": "Obrigatório quando estiver presente itens.*.g_cbs.", "minimum": 0 }, "v_cred_pres": { "x-laravel-rules": [ "required_with:itens.*.g_cbs", "numeric", "min:0" ], "type": "number", "description": "Obrigatório quando estiver presente itens.*.g_cbs.", "minimum": 0 } } } }, "required": [ "item", "v_bc" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_consumo_pessoal" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "tp_autor": { "x-laravel-rules": [ "required", "integer", "in:1,2" ], "type": "integer", "enum": [ 1, 2 ] }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 }, "chave": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{44}$/" ], "type": "string", "pattern": "^\\d{44}$" }, "n_item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade", "chave", "n_item" ] } } }, "required": [ "tipo", "tp_autor", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_perda_transporte_adquirente" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_aceite_debito" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "ind_aceitacao": { "x-laravel-rules": [ "required", "integer", "in:0,1" ], "type": "integer", "enum": [ 0, 1 ] } }, "required": [ "tipo", "ind_aceitacao" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_imobilizacao_item" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_apropriacao_cred_combustivel" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "quantidade": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "unidade": { "x-laravel-rules": [ "required", "string", "min:1", "max:6" ], "type": "string", "minLength": 1, "maxLength": 6 } }, "required": [ "item", "v_ibs", "v_cbs", "quantidade", "unidade" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_apropriacao_cred_bens" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "itens": { "x-laravel-rules": [ "required", "array", "min:1", "max:990" ], "type": "array", "minItems": 1, "maxItems": 990, "items": { "type": "object", "properties": { "item": { "x-laravel-rules": [ "required", "integer", "min:1", "max:990" ], "type": "integer", "minimum": 1, "maximum": 990 }, "v_cred_ibs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 }, "v_cred_cbs": { "x-laravel-rules": [ "required", "numeric", "min:0" ], "type": "number", "minimum": 0 } }, "required": [ "item", "v_cred_ibs", "v_cred_cbs" ] } } }, "required": [ "tipo", "itens" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_manif_transf_cred_ibs" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "ind_aceitacao": { "x-laravel-rules": [ "required", "integer", "in:0,1" ], "type": "integer", "enum": [ 0, 1 ] } }, "required": [ "tipo", "ind_aceitacao" ], "additionalProperties": false }, { "type": "object", "properties": { "tipo": { "type": "string", "enum": [ "rtc_manif_transf_cred_cbs" ] }, "sequencial": { "x-laravel-rules": [ "sometimes", "nullable", "integer", "min:1", "max:999" ], "type": [ "integer", "null" ], "minimum": 1, "maximum": 999 }, "ind_aceitacao": { "x-laravel-rules": [ "required", "integer", "in:0,1" ], "type": "integer", "enum": [ 0, 1 ] } }, "required": [ "tipo", "ind_aceitacao" ], "additionalProperties": false } ], "discriminator": { "propertyName": "tipo" }, "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Requests/StoreEventoContratoRequest.php:35" ] }, "post_api_v1_auth_loginRequest": { "type": "object", "properties": { "email": { "x-laravel-rules": [ "required", "string", "email", "max:255" ], "type": "string", "format": "email", "maxLength": 255 }, "password": { "x-laravel-rules": [ "required", "string", "min:8", "max:255" ], "type": "string", "minLength": 8, "maxLength": 255 }, "device_name": { "x-laravel-rules": [ "sometimes", "string", "max:100" ], "type": "string", "maxLength": 100 } }, "required": [ "email", "password" ], "x-source": [ "app/app/Http/Controllers/Auth/AuthController.php:21" ] }, "post_api_v1_auth_registerRequest": { "type": "object", "properties": { "name": { "x-laravel-rules": [ "required", "string", "max:120" ], "type": "string", "maxLength": 120 }, "email": { "x-laravel-rules": [ "required", "email", "max:255" ], "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", "format": "email", "maxLength": 255 }, "password": { "x-laravel-rules": [ "required", "string", "min:8", "max:72" ], "type": "string", "minLength": 8, "maxLength": 72 }, "empresa": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:120" ], "type": [ "string", "null" ], "maxLength": 120 }, "referral_code": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:40" ], "type": [ "string", "null" ], "maxLength": 40 } }, "required": [ "name", "email", "password" ], "x-source": [ "app/app/Http/Controllers/Auth/RegisterController.php:41" ] }, "post_api_v1_auth_forgot_passwordRequest": { "type": "object", "properties": { "email": { "x-laravel-rules": [ "required", "email", "max:255" ], "type": "string", "format": "email", "maxLength": 255 } }, "required": [ "email" ], "x-source": [ "app/app/Http/Controllers/Auth/PasswordResetController.php:31" ] }, "post_api_v1_auth_reset_passwordRequest": { "type": "object", "properties": { "token": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "email": { "x-laravel-rules": [ "required", "email" ], "type": "string", "format": "email" }, "password": { "x-laravel-rules": [ "required", "confirmed" ], "x-laravel-custom-validation": true, "description": "Validação adicional de domínio é aplicada pelo servidor (por exemplo dígitos verificadores e autorização). Exige confirmação no campo de mesmo nome com sufixo _confirmation ." } }, "required": [ "token", "email", "password" ], "x-source": [ "app/app/Http/Controllers/Auth/PasswordResetController.php:47" ] }, "post_api_v1_public_support_ticketsRequest": { "type": "object", "properties": { "email": { "x-laravel-rules": [ "required", "email", "max:255" ], "type": "string", "format": "email", "maxLength": 255 }, "subject": { "x-laravel-rules": [ "required", "string", "min:3", "max:200" ], "type": "string", "minLength": 3, "maxLength": 200 } }, "required": [ "email", "subject" ], "x-source": [ "app/app/Modules/Community/Http/Controllers/CommunityController.php:23" ] }, "post_api_v1_public_newsletter_subscribeRequest": { "type": "object", "properties": { "email": { "x-laravel-rules": [ "required", "email", "max:255" ], "type": "string", "format": "email", "maxLength": 255 } }, "required": [ "email" ], "x-source": [ "app/app/Modules/Community/Http/Controllers/CommunityController.php:36" ] }, "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_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" ] }, "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:98" ] }, "post_api_v1_automationsRequest": { "type": "object", "properties": { "name": { "x-laravel-rules": [ "required", "string", "max:80", "regex:/^[\\pL\\pN\\p{Pd} _.]+$/u" ], "type": "string", "maxLength": 80 }, "trigger_event": { "x-laravel-rules": [ "required", "string", "in:" ], "type": "string", "enum": [ "" ] }, "conditions": { "x-laravel-rules": [ "sometimes", "array", "max:10" ], "type": "array", "maxItems": 10, "items": { "type": "object", "properties": { "field": { "x-laravel-rules": [ "required", "string", "max:120", "regex:/^[A-Za-z0-9_.]+$/" ], "type": "string", "maxLength": 120, "pattern": "^[A-Za-z0-9_.]+$" }, "op": { "x-laravel-rules": [ "required", "in:eq,ne,gt,gte,lt,lte,contains,in,exists,not_exists" ], "enum": [ "eq", "ne", "gt", "gte", "lt", "lte", "contains", "in", "exists", "not_exists" ] }, "value": { "x-laravel-rules": [ "nullable" ] } }, "required": [ "field", "op" ] } }, "actions": { "x-laravel-rules": [ "required", "array", "min:1", "max:3" ], "type": "array", "minItems": 1, "maxItems": 3, "items": { "type": "object", "properties": { "type": { "x-laravel-rules": [ "required", "in:webhook,email" ], "enum": [ "webhook", "email" ] }, "url": { "x-laravel-rules": [ "required_if:actions.*.type,webhook", "nullable", "url", "max:500" ], "type": [ "string", "null" ], "format": "uri", "description": "Obrigatório quando actions.*.type,webhook.", "maxLength": 500 }, "secret": { "x-laravel-rules": [ "nullable", "string", "max:128" ], "type": [ "string", "null" ], "maxLength": 128 }, "to": { "x-laravel-rules": [ "required_if:actions.*.type,email", "nullable", "email", "max:255" ], "type": [ "string", "null" ], "format": "email", "description": "Obrigatório quando actions.*.type,email.", "maxLength": 255 }, "subject": { "x-laravel-rules": [ "nullable", "string", "max:120" ], "type": [ "string", "null" ], "maxLength": 120 } }, "required": [ "type" ] } } }, "required": [ "name", "trigger_event", "actions" ], "x-source": [ "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:128" ] }, "post_api_v1_automations__id__dry_runRequest": { "type": "object", "properties": { "payload": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true } }, "required": [ "payload" ], "x-source": [ "app/app/Modules/Automation/Http/Controllers/AutomationRuleController.php:110" ] }, "post_api_v1_ctesRequest": { "type": "object", "properties": { "ide": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "cUF": { "x-laravel-rules": [ "required", "integer" ], "type": "integer" }, "CFOP": { "x-laravel-rules": [ "required", "string", "size:4" ], "type": "string", "minLength": 4, "maxLength": 4 }, "natOp": { "x-laravel-rules": [ "required", "string", "max:60" ], "type": "string", "maxLength": 60 }, "dhEmi": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "serie": { "x-laravel-rules": [ "sometimes", "integer" ], "type": "integer" }, "cMunIni": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "xMunIni": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "UFIni": { "x-laravel-rules": [ "required", "string", "size:2" ], "type": "string", "minLength": 2, "maxLength": 2 }, "cMunFim": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "xMunFim": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "UFFim": { "x-laravel-rules": [ "required", "string", "size:2" ], "type": "string", "minLength": 2, "maxLength": 2 } }, "required": [ "cUF", "CFOP", "natOp", "dhEmi", "cMunIni", "xMunIni", "UFIni", "cMunFim", "xMunFim", "UFFim" ] }, "toma": { "x-laravel-rules": [ "required", "integer", "between:0,3" ], "type": "integer" }, "emit": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "enderEmit": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "rem": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "enderReme": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "dest": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "enderDest": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "vPrest": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "vTPrest": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" }, "vRec": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" } }, "required": [ "vTPrest", "vRec" ] }, "icms": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "vBC": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" }, "pICMS": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" }, "vICMS": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" } }, "required": [ "vBC", "pICMS", "vICMS" ] }, "infCarga": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "proPred": { "x-laravel-rules": [ "required", "string" ], "type": "string" } }, "required": [ "proPred" ] }, "infQ": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "cUnid": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "tpMed": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "qCarga": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" } }, "required": [ "cUnid", "tpMed", "qCarga" ] }, "rodo": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "RNTRC": { "x-laravel-rules": [ "required", "string" ], "type": "string" } }, "required": [ "RNTRC" ] }, "infRespTec": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "CNPJ": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "xContato": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "email": { "x-laravel-rules": [ "required", "email" ], "type": "string", "format": "email" }, "fone": { "x-laravel-rules": [ "required", "string" ], "type": "string" } }, "required": [ "CNPJ", "xContato", "email", "fone" ] } }, "required": [ "ide", "toma", "emit", "enderEmit", "rem", "enderReme", "dest", "enderDest", "vPrest", "icms", "infCarga", "infQ", "rodo", "infRespTec" ], "x-source": [ "app/app/Modules/Fiscal/Cte/Http/Controllers/CteController.php:19" ] }, "post_api_v1_mdfesRequest": { "type": "object", "properties": { "ide": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "cUF": { "x-laravel-rules": [ "required", "integer" ], "type": "integer" }, "tpEmit": { "x-laravel-rules": [ "sometimes", "integer" ], "type": "integer" }, "dhEmi": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "serie": { "x-laravel-rules": [ "sometimes", "integer" ], "type": "integer" }, "UFIni": { "x-laravel-rules": [ "required", "string", "size:2" ], "type": "string", "minLength": 2, "maxLength": 2 }, "UFFim": { "x-laravel-rules": [ "required", "string", "size:2" ], "type": "string", "minLength": 2, "maxLength": 2 } }, "required": [ "cUF", "dhEmi", "UFIni", "UFFim" ] }, "emit": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "enderEmit": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "infMunCarrega": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "cMunCarrega": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "xMunCarrega": { "x-laravel-rules": [ "required", "string" ], "type": "string" } }, "required": [ "cMunCarrega", "xMunCarrega" ] }, "infMunDescarga": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "cMunDescarga": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "xMunDescarga": { "x-laravel-rules": [ "required", "string" ], "type": "string" } }, "required": [ "cMunDescarga", "xMunDescarga" ] }, "infNFe": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "chNFe": { "x-laravel-rules": [ "required", "string", "size:44" ], "type": "string", "minLength": 44, "maxLength": 44 } }, "required": [ "chNFe" ] }, "veicTracao": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "placa": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "tara": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" }, "tpRod": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "tpCar": { "x-laravel-rules": [ "required", "string" ], "type": "string" } }, "required": [ "placa", "tara", "tpRod", "tpCar" ] }, "tot": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "vCarga": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" }, "cUnid": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "qCarga": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" } }, "required": [ "vCarga", "cUnid", "qCarga" ] }, "infRespTec": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "CNPJ": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "xContato": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "email": { "x-laravel-rules": [ "required", "email" ], "type": "string", "format": "email" }, "fone": { "x-laravel-rules": [ "required", "string" ], "type": "string" } }, "required": [ "CNPJ", "xContato", "email", "fone" ] } }, "required": [ "ide", "emit", "enderEmit", "infMunCarrega", "infMunDescarga", "infNFe", "veicTracao", "tot", "infRespTec" ], "x-source": [ "app/app/Modules/Fiscal/Mdfe/Http/Controllers/MdfeController.php:19" ] }, "post_api_v1_nfcomsRequest": { "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" ], "type": "string" }, "xNome": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "CRT": { "x-laravel-rules": [ "required", "integer" ], "type": "integer" }, "IE": { "x-laravel-rules": [ "required", "regex:/^[0-9]{2,14}$/" ], "pattern": "^[0-9]{2,14}$" } }, "required": [ "CNPJ", "xNome", "CRT", "IE" ] }, "enderEmit": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "dest": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "xNome": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "CNPJ": { "x-laravel-rules": [ "required_without_all:dest.CPF,dest.idOutros", "nullable", "string" ], "type": [ "string", "null" ], "description": "Obrigatório quando todos estiverem ausentes dest.CPF,dest.idOutros." }, "CPF": { "x-laravel-rules": [ "required_without_all:dest.CNPJ,dest.idOutros", "nullable", "string" ], "type": [ "string", "null" ], "description": "Obrigatório quando todos estiverem ausentes dest.CNPJ,dest.idOutros." }, "idOutros": { "x-laravel-rules": [ "required_without_all:dest.CNPJ,dest.CPF", "nullable", "string" ], "type": [ "string", "null" ], "description": "Obrigatório quando todos estiverem ausentes dest.CNPJ,dest.CPF." }, "indIEDest": { "x-laravel-rules": [ "required", "integer" ], "type": "integer" } }, "required": [ "xNome", "indIEDest" ] }, "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" }, "CEP": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "UF": { "x-laravel-rules": [ "required", "string" ], "type": "string" } }, "required": [ "xLgr", "nro", "xBairro", "cMun", "xMun", "CEP", "UF" ] }, "assinante": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "iCodAssinante": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "tpAssinante": { "x-laravel-rules": [ "required", "integer" ], "type": "integer" }, "tpServUtil": { "x-laravel-rules": [ "required", "integer" ], "type": "integer" } }, "required": [ "iCodAssinante", "tpAssinante", "tpServUtil" ] }, "det": { "x-laravel-rules": [ "sometimes", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "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", "regex:/^[0-9]{7}$/" ], "pattern": "^[0-9]{7}$" }, "uMed": { "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", "uMed", "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", "enderEmit", "dest", "enderDest", "assinante", "prod", "total" ], "x-source": [ "app/app/Modules/Fiscal/Nfcom/Http/Controllers/NfcomController.php:19" ] }, "post_api_v1_dcesRequest": { "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" } }, "required": [ "cUF", "dhEmi" ] }, "emit": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "CNPJ": { "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", "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": { "xProd": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "NCM": { "x-laravel-rules": [ "required", "regex:/^([0-9]{2}|[0-9]{8})$/" ], "pattern": "^([0-9]{2}|[0-9]{8})$" }, "qCom": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" }, "vUnCom": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" }, "vProd": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" } }, "required": [ "xProd", "NCM", "qCom", "vUnCom", "vProd" ] }, "total": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "vDC": { "x-laravel-rules": [ "required", "numeric" ], "type": "number" } }, "required": [ "vDC" ] } }, "required": [ "ide", "emit", "dest", "prod", "total" ], "x-source": [ "app/app/Modules/Fiscal/Dce/Http/Controllers/DceController.php:19" ] }, "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" ] }, "post_api_v1_retail_sync_eventsRequest": { "type": "object", "properties": { "client_event_id": { "x-laravel-rules": [ "required", "string", "max:120" ], "type": "string", "maxLength": 120 }, "event_type": { "x-laravel-rules": [ "required", "string", "max:40" ], "type": "string", "maxLength": 40 }, "payload": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true } }, "required": [ "client_event_id", "event_type", "payload" ], "x-source": [ "app/app/Modules/Fiscal/RetailSync/Http/Controllers/RetailSyncController.php:19" ] }, "post_api_v1_companiesRequest": { "type": "object", "properties": { "cnpj": { "x-laravel-rules": [ "required", "string", "max:18" ], "type": "string", "maxLength": 18 }, "razao_social": { "x-laravel-rules": [ "required", "string", "max:255" ], "type": "string", "maxLength": 255 }, "nome_fantasia": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:255" ], "type": [ "string", "null" ], "maxLength": 255 }, "inscricao_estadual": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:60" ], "type": [ "string", "null" ], "maxLength": 60 }, "inscricao_municipal": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:20" ], "type": [ "string", "null" ], "maxLength": 20 }, "crt": { "x-laravel-rules": [ "sometimes", "integer", "in:1,2,3,4" ], "type": "integer", "enum": [ 1, 2, 3, 4 ] }, "endereco": { "x-laravel-rules": [ "sometimes", "nullable", "array" ], "type": [ "object", "null" ], "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 }, "is_default": { "x-laravel-rules": [ "sometimes", "boolean" ], "type": "boolean" }, "dry_run": { "x-laravel-rules": [ "sometimes", "boolean" ], "type": "boolean" } }, "required": [ "cnpj", "razao_social" ], "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:39" ] }, "patch_api_v1_companies__id_Request": { "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 }, "nome_fantasia": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:255" ], "type": [ "string", "null" ], "maxLength": 255 }, "inscricao_estadual": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:60" ], "type": [ "string", "null" ], "maxLength": 60 }, "inscricao_municipal": { "x-laravel-rules": [ "sometimes", "nullable", "string", "max:20" ], "type": [ "string", "null" ], "maxLength": 20 }, "crt": { "x-laravel-rules": [ "sometimes", "integer", "in:1,2,3,4" ], "type": "integer", "enum": [ 1, 2, 3, 4 ] }, "endereco": { "x-laravel-rules": [ "sometimes", "nullable", "array" ], "type": [ "object", "null" ], "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 }, "is_default": { "x-laravel-rules": [ "sometimes", "boolean" ], "type": "boolean" }, "dry_run": { "x-laravel-rules": [ "sometimes", "boolean" ], "type": "boolean" } }, "x-source": [ "app/app/Modules/Tenant/Http/Controllers/CompanyController.php:63" ] }, "post_api_v1_certificatesRequest": { "type": "object", "properties": { "pfx": { "x-laravel-rules": [ "required", "string", "max:1500000" ], "type": "string", "maxLength": 1500000 }, "password": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "label": { "x-laravel-rules": [ "required", "string", "max:255" ], "type": "string", "maxLength": 255 }, "cnpj_override": { "x-laravel-rules": [ "nullable", "string", "regex:/^\\d{14}$|^[A-Z0-9]{14}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{14}$|^[A-Z0-9]{14}$" }, "company_id": { "x-laravel-rules": [ "nullable", "integer", "min:1" ], "type": [ "integer", "null" ], "minimum": 1 } }, "required": [ "pfx", "password", "label" ], "x-source": [ "app/app/Modules/Security/Certificate/Http/Requests/CertificateUploadRequest.php:13" ] }, "post_api_v1_certificates_rotateRequest": { "type": "object", "properties": { "pfx": { "x-laravel-rules": [ "required", "string", "max:1500000" ], "type": "string", "maxLength": 1500000 }, "password": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "label": { "x-laravel-rules": [ "required", "string", "max:255" ], "type": "string", "maxLength": 255 }, "cnpj_override": { "x-laravel-rules": [ "nullable", "string", "regex:/^\\d{14}$|^[A-Z0-9]{14}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{14}$|^[A-Z0-9]{14}$" }, "company_id": { "x-laravel-rules": [ "nullable", "integer", "min:1" ], "type": [ "integer", "null" ], "minimum": 1 } }, "required": [ "pfx", "password", "label" ], "x-source": [ "app/app/Modules/Security/Certificate/Http/Requests/CertificateUploadRequest.php:13" ] }, "post_api_v1_certificates_validateRequest": { "type": "object", "properties": { "pfx": { "x-laravel-rules": [ "required", "string", "max:1500000" ], "type": "string", "maxLength": 1500000 }, "password": { "x-laravel-rules": [ "required", "string" ], "type": "string" }, "label": { "x-laravel-rules": [ "required", "string", "max:255" ], "type": "string", "maxLength": 255 }, "cnpj_override": { "x-laravel-rules": [ "nullable", "string", "regex:/^\\d{14}$|^[A-Z0-9]{14}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{14}$|^[A-Z0-9]{14}$" }, "company_id": { "x-laravel-rules": [ "nullable", "integer", "min:1" ], "type": [ "integer", "null" ], "minimum": 1 } }, "required": [ "pfx", "password", "label" ], "x-source": [ "app/app/Modules/Security/Certificate/Http/Requests/CertificateUploadRequest.php:13" ] }, "post_api_v1_certificates__id__revokeRequest": { "type": "object", "properties": { "reason": { "x-laravel-rules": [ "required", "string", "max:1000" ], "type": "string", "maxLength": 1000 } }, "required": [ "reason" ], "x-source": [ "app/app/Modules/Security/Certificate/Http/Controllers/CertificateController.php:216" ] }, "post_api_v1_email_suppressionsRequest": { "type": "object", "properties": { "email": { "x-laravel-rules": [ "required", "email", "max:255" ], "type": "string", "format": "email", "maxLength": 255 }, "reason": { "x-laravel-rules": [ "required", "string", "max:255" ], "type": "string", "maxLength": 255 } }, "required": [ "email", "reason" ], "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:50" ] }, "post_api_v1_email_suppressions_releaseRequest": { "type": "object", "properties": { "email": { "x-laravel-rules": [ "required", "email", "max:255" ], "type": "string", "format": "email", "maxLength": 255 } }, "required": [ "email" ], "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:99" ] }, "post_api_v1_email_bouncesRequest": { "type": "object", "properties": { "email": { "x-laravel-rules": [ "required", "email", "max:255" ], "type": "string", "format": "email", "maxLength": 255 }, "type": { "x-laravel-rules": [ "required", "string", "in:hard,soft,complaint" ], "type": "string", "enum": [ "hard", "soft", "complaint" ] }, "reason": { "x-laravel-rules": [ "nullable", "string", "max:200" ], "type": [ "string", "null" ], "maxLength": 200 } }, "required": [ "email", "type" ], "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailSuppressionController.php:75" ] }, "post_api_v1_email_deliveries_resendRequest": { "type": "object", "properties": { "dedupe_key": { "x-laravel-rules": [ "required", "string", "max:255" ], "type": "string", "maxLength": 255 }, "allow_uncertain": { "x-laravel-rules": [ "sometimes", "boolean" ], "type": "boolean" }, "dry_run": { "x-laravel-rules": [ "sometimes", "boolean" ], "type": "boolean" } }, "required": [ "dedupe_key" ], "x-source": [ "app/app/Modules/Notification/Http/Controllers/EmailDeliveryController.php:25" ] }, "post_api_v1_support_casesRequest": { "type": "object", "properties": { "subject": { "x-laravel-rules": [ "required", "string", "min:3", "max:200" ], "type": "string", "minLength": 3, "maxLength": 200 }, "channel": { "x-laravel-rules": [ "sometimes", "string", "in:api,web,email,whatsapp" ], "type": "string", "enum": [ "api", "web", "email", "whatsapp" ] }, "priority": { "x-laravel-rules": [ "sometimes", "string", "in:low,normal,high,urgent" ], "type": "string", "enum": [ "low", "normal", "high", "urgent" ] } }, "required": [ "subject" ], "x-source": [ "app/app/Modules/Support/Http/Controllers/SupportCaseController.php:43" ] }, "post_api_v1_nfe_emitRequest": { "type": "object", "properties": { "tipo": { "x-laravel-rules": [ "required", "integer", "in:55,65" ], "type": "integer", "enum": [ 55, 65 ] }, "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 } } } }, "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": [ "tipo", "destinatario", "itens" ], "x-source": [ "app/app/Http/Requests/EmitNfeRequest.php:20" ] }, "post_api_v1_nfe_lotesRequest": { "type": "object", "properties": { "preview_sha256": { "x-laravel-rules": [ "required", "string", "regex:/^[0-9a-f]{64}$/" ], "type": "string", "pattern": "^[0-9a-f]{64}$" } }, "required": [ "preview_sha256" ], "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeBatchController.php:47" ] }, "post_api_v1_nfe_homologacao_runRequest": { "type": "object", "properties": { "modelo": { "x-laravel-rules": [ "required", "integer", "in:55,65" ], "type": "integer", "enum": [ 55, 65 ] }, "cenario": { "x-laravel-rules": [ "nullable", "string", "max:60" ], "type": [ "string", "null" ], "maxLength": 60 }, "mode": { "x-laravel-rules": [ "nullable", "string", "in:simulated,sefaz" ], "type": [ "string", "null" ], "enum": [ "simulated", "sefaz", null ] } }, "required": [ "modelo" ], "x-source": [ "app/app/Modules/Fiscal/Nfe/Http/Controllers/NfeHomologController.php:33" ] }, "post_api_v1_nfe__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" ] }, "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 } } } }, "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" ] }, "post_api_v1_print_jobsRequest": { "type": "object", "properties": { "document_type": { "x-laravel-rules": [ "required", "string", "in:nfe,nfce,nfse,cte,mdfe,nfcom" ], "type": "string", "enum": [ "nfe", "nfce", "nfse", "cte", "mdfe", "nfcom" ] }, "document_id": { "x-laravel-rules": [ "required", "integer", "min:1" ], "type": "integer", "minimum": 1 } }, "required": [ "document_type", "document_id" ], "x-source": [ "app/app/Http/Controllers/Api/V1/PrintJobController.php:23" ] }, "post_api_v1_nfse_emitRequest": { "type": "object", "properties": { "competencia": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{4}-\\d{2}$/" ], "type": "string", "pattern": "^\\d{4}-\\d{2}$" }, "cnpj_prestador": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{14}$/" ], "type": "string", "pattern": "^\\d{14}$" }, "inscricao_municipal": { "x-laravel-rules": [ "required", "string", "max:20" ], "type": "string", "maxLength": 20 }, "razao_social_prestador": { "x-laravel-rules": [ "nullable", "string", "max:255" ], "type": [ "string", "null" ], "maxLength": 255 }, "descricao_servico": { "x-laravel-rules": [ "required", "string", "min:5", "max:2000" ], "type": "string", "minLength": 5, "maxLength": 2000 }, "cnae": { "x-laravel-rules": [ "nullable", "string", "regex:/^\\d{4}[-.]?\\d{1}[\\/.]?\\d{2}$|^\\d{7}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{4}[-.]?\\d{1}[/.]?\\d{2}$|^\\d{7}$" }, "codigo_tributacao_nacional": { "x-laravel-rules": [ "required_without:cnae", "nullable", "string", "regex:/^\\d{2}\\.\\d{2}\\.\\d{2}\\.\\d{2}$/" ], "type": [ "string", "null" ], "description": "Obrigatório na ausência de cnae.", "pattern": "^\\d{2}\\.\\d{2}\\.\\d{2}\\.\\d{2}$" }, "codigo_tributacao_municipal": { "x-laravel-rules": [ "required_without:cnae", "nullable", "string", "max:20" ], "type": [ "string", "null" ], "description": "Obrigatório na ausência de cnae.", "maxLength": 20 }, "aliquota_iss": { "x-laravel-rules": [ "required_without:cnae", "nullable", "numeric", "min:0", "max:100" ], "type": [ "number", "null" ], "description": "Obrigatório na ausência de cnae.", "minimum": 0, "maximum": 100 }, "codigo_municipio_prestacao": { "x-laravel-rules": [ "required", "string", "size:7", "regex:/^\\d{7}$/" ], "type": "string", "minLength": 7, "maxLength": 7, "pattern": "^\\d{7}$" }, "codigo_nbs": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "nullable", "string", "regex:/^\\d{9}$/" ], "type": [ "string", "null" ], "description": "Obrigatório quando rtc.incluir,true.", "pattern": "^\\d{9}$" }, "valor_servico": { "x-laravel-rules": [ "required", "numeric", "min:0.01" ], "type": "number", "minimum": 0.01 }, "valor_deducoes": { "x-laravel-rules": [ "nullable", "numeric", "min:0" ], "type": [ "number", "null" ], "minimum": 0 }, "informacoes_adicionais": { "x-laravel-rules": [ "nullable", "string", "max:255" ], "type": [ "string", "null" ], "maxLength": 255 }, "tomador": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "cnpj": { "x-laravel-rules": [ "required_without:tomador.cpf", "nullable", "string", "regex:/^\\d{14}$/" ], "x-laravel-custom-validation": true, "description": "Validação adicional de domínio é aplicada pelo servidor (por exemplo dígitos verificadores e autorização). Obrigatório na ausência de tomador.cpf.", "type": [ "string", "null" ], "pattern": "^\\d{14}$" }, "cpf": { "x-laravel-rules": [ "required_without:tomador.cnpj", "nullable", "string" ], "x-laravel-custom-validation": true, "description": "Validação adicional de domínio é aplicada pelo servidor (por exemplo dígitos verificadores e autorização). Obrigatório na ausência de tomador.cnpj.", "type": [ "string", "null" ] }, "nome": { "x-laravel-rules": [ "required", "string", "max:255" ], "type": "string", "maxLength": 255 }, "endereco": { "x-laravel-rules": [ "nullable", "array" ], "type": [ "array", "object", "null" ], "items": {}, "additionalProperties": true } }, "required": [ "nome" ] }, "rtc": { "x-laravel-rules": [ "nullable", "array" ], "type": [ "object", "null" ], "properties": { "incluir": { "x-laravel-rules": [ "sometimes", "boolean" ], "type": "boolean" }, "resolution_id": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "string", "max:64" ], "type": "string", "description": "Obrigatório quando rtc.incluir,true.", "maxLength": 64 }, "sku": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "string", "max:80" ], "type": "string", "description": "Obrigatório quando rtc.incluir,true.", "maxLength": 80 }, "cind_op": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "string", "regex:/^\\d{6}$/" ], "type": "string", "description": "Obrigatório quando rtc.incluir,true.", "pattern": "^\\d{6}$" }, "fin_nfse": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "string", "in:0,1,2" ], "type": "string", "description": "Obrigatório quando rtc.incluir,true.", "enum": [ "0", "1", "2" ] }, "ind_dest": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "string", "in:0,1" ], "type": "string", "description": "Obrigatório quando rtc.incluir,true.", "enum": [ "0", "1" ] } }, "x-prohibited-fields": [ "cst", "cclass_trib", "source_version", "valor_ibs", "valor_cbs" ] }, "prestador": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "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:10" ], "type": "string", "maxLength": 10 }, "bairro": { "x-laravel-rules": [ "required", "string", "max:100" ], "type": "string", "maxLength": 100 }, "codigo_municipio": { "x-laravel-rules": [ "required", "string", "size:7" ], "type": "string", "minLength": 7, "maxLength": 7 }, "uf": { "x-laravel-rules": [ "required", "string", "size:2" ], "type": "string", "minLength": 2, "maxLength": 2 }, "cep": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{8}$/" ], "type": "string", "pattern": "^\\d{8}$" } }, "required": [ "logradouro", "numero", "bairro", "codigo_municipio", "uf", "cep" ] } }, "required": [ "endereco" ] } }, "required": [ "competencia", "cnpj_prestador", "inscricao_municipal", "descricao_servico", "codigo_municipio_prestacao", "valor_servico", "tomador", "prestador" ], "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Requests/EmitNfseRequest.php:17" ] }, "post_api_v1_nfse_recebidas_capturarRequest": { "type": "object", "properties": { "certificate_id": { "x-laravel-rules": [ "sometimes", "integer", "min:1" ], "type": "integer", "minimum": 1 }, "ambiente": { "x-laravel-rules": [ "sometimes", "integer", "in:1,2" ], "type": "integer", "enum": [ 1, 2 ] } }, "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:52" ] }, "put_api_v1_nfse_recebidas_captura_automaticaRequest": { "type": "object", "properties": { "certificate_id": { "x-laravel-rules": [ "required", "integer", "min:1" ], "type": "integer", "minimum": 1 }, "ambiente": { "x-laravel-rules": [ "required", "integer", "in:1,2" ], "type": "integer", "enum": [ 1, 2 ] } }, "required": [ "certificate_id", "ambiente" ], "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Controllers/NfseDistribuicaoController.php:73" ] }, "post_api_v1_nfse__nfse__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/Modules/Fiscal/Nfse/Http/Requests/CancelNfseRequest.php:20" ] }, "post_api_v1_nfse__nfse__substituteRequest": { "type": "object", "properties": { "motivo": { "x-laravel-rules": [ "required", "string", "min:15", "max:255" ], "type": "string", "minLength": 15, "maxLength": 255 }, "competencia": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{4}-\\d{2}$/" ], "type": "string", "pattern": "^\\d{4}-\\d{2}$" }, "descricao_servico": { "x-laravel-rules": [ "required", "string", "min:5", "max:2000" ], "type": "string", "minLength": 5, "maxLength": 2000 }, "codigo_tributacao_nacional": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{2}\\.\\d{2}\\.\\d{2}\\.\\d{2}$/" ], "type": "string", "pattern": "^\\d{2}\\.\\d{2}\\.\\d{2}\\.\\d{2}$" }, "codigo_tributacao_municipal": { "x-laravel-rules": [ "required", "string", "max:20" ], "type": "string", "maxLength": 20 }, "codigo_municipio_prestacao": { "x-laravel-rules": [ "required", "string", "size:7", "regex:/^\\d{7}$/" ], "type": "string", "minLength": 7, "maxLength": 7, "pattern": "^\\d{7}$" }, "codigo_nbs": { "x-laravel-rules": [ "nullable", "string", "max:9" ], "type": [ "string", "null" ], "maxLength": 9 }, "valor_servico": { "x-laravel-rules": [ "required", "numeric", "min:0.01" ], "type": "number", "minimum": 0.01 }, "valor_deducoes": { "x-laravel-rules": [ "nullable", "numeric", "min:0" ], "type": [ "number", "null" ], "minimum": 0 }, "aliquota_iss": { "x-laravel-rules": [ "required", "numeric", "min:0", "max:100" ], "type": "number", "minimum": 0, "maximum": 100 }, "inscricao_municipal": { "x-laravel-rules": [ "required", "string", "max:20" ], "type": "string", "maxLength": 20 }, "informacoes_adicionais": { "x-laravel-rules": [ "nullable", "string", "max:255" ], "type": [ "string", "null" ], "maxLength": 255 }, "tomador": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "cnpj": { "x-laravel-rules": [ "nullable", "string", "size:14" ], "type": [ "string", "null" ], "minLength": 14, "maxLength": 14 }, "cpf": { "x-laravel-rules": [ "nullable", "string", "size:11" ], "type": [ "string", "null" ], "minLength": 11, "maxLength": 11 }, "nome": { "x-laravel-rules": [ "required", "string", "max:255" ], "type": "string", "maxLength": 255 }, "endereco": { "x-laravel-rules": [ "nullable", "array" ], "type": [ "array", "object", "null" ], "items": {}, "additionalProperties": true } }, "required": [ "nome" ] }, "prestador": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "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:10" ], "type": "string", "maxLength": 10 }, "bairro": { "x-laravel-rules": [ "required", "string", "max:100" ], "type": "string", "maxLength": 100 }, "codigo_municipio": { "x-laravel-rules": [ "required", "string", "size:7" ], "type": "string", "minLength": 7, "maxLength": 7 }, "uf": { "x-laravel-rules": [ "required", "string", "size:2" ], "type": "string", "minLength": 2, "maxLength": 2 }, "cep": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{8}$/" ], "type": "string", "pattern": "^\\d{8}$" } }, "required": [ "logradouro", "numero", "bairro", "codigo_municipio", "uf", "cep" ] } }, "required": [ "endereco" ] } }, "required": [ "motivo", "competencia", "descricao_servico", "codigo_tributacao_nacional", "codigo_tributacao_municipal", "codigo_municipio_prestacao", "valor_servico", "aliquota_iss", "inscricao_municipal", "tomador", "prestador" ], "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Requests/SubstituirNfseRequest.php:20" ] }, "post_api_v1_fiscal_agent_rtc_resolveRequest": { "type": "object", "properties": { "sku": { "x-laravel-rules": [ "required", "string", "max:80" ], "type": "string", "maxLength": 80 }, "dfe_type": { "x-laravel-rules": [ "required", "string", "in:NFE,NFCE,NFSE" ], "type": "string", "enum": [ "NFE", "NFCE", "NFSE" ] }, "tax_date": { "x-laravel-rules": [ "required", "date" ], "type": "string", "format": "date-time" }, "item_number": { "x-laravel-rules": [ "required", "integer", "min:1" ], "type": "integer", "minimum": 1 }, "calculator_payload": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "establishment_key": { "x-laravel-rules": [ "nullable", "string", "max:32" ], "type": [ "string", "null" ], "maxLength": 32 }, "operation_code": { "x-laravel-rules": [ "nullable", "string", "max:12" ], "type": [ "string", "null" ], "maxLength": 12 }, "origin_uf": { "x-laravel-rules": [ "nullable", "string", "size:2" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 }, "destination_uf": { "x-laravel-rules": [ "nullable", "string", "size:2" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 }, "recipient_indicator": { "x-laravel-rules": [ "nullable", "string", "max:24" ], "type": [ "string", "null" ], "maxLength": 24 }, "purpose": { "x-laravel-rules": [ "nullable", "string", "max:32" ], "type": [ "string", "null" ], "maxLength": 32 }, "document_reference": { "x-laravel-rules": [ "nullable", "string", "max:80" ], "type": [ "string", "null" ], "maxLength": 80 } }, "required": [ "sku", "dfe_type", "tax_date", "item_number", "calculator_payload" ], "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcController.php:87" ] }, "post_api_v1_fiscal_agent_prepareRequest": { "type": "object", "properties": { "action": { "x-laravel-rules": [ "required", "string", "in:nfe.emit,nfce.emit,nfse.emit,nfe.cancel,nfce.cancel,nfe.inutilizar,nfe.manifestar,nfse.cancel" ], "type": "string", "enum": [ "nfe.emit", "nfce.emit", "nfse.emit", "nfe.cancel", "nfce.cancel", "nfe.inutilizar", "nfe.manifestar", "nfse.cancel" ] }, "resolution_id": { "x-laravel-rules": [ "nullable", "uuid" ], "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", "null" ], "format": "uuid" }, "payload": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true } }, "required": [ "action", "payload" ], "x-source": [ "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:24" ] }, "post_api_v1_fiscal_agent_approveRequest": { "type": "object", "properties": { "prepare_token": { "x-laravel-rules": [ "required", "string", "max:8192" ], "type": "string", "maxLength": 8192 } }, "required": [ "prepare_token" ], "x-source": [ "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:80" ] }, "post_api_v1_fiscal_agent_approvals__requestId__revokeRequest": { "type": "object", "properties": { "reason": { "x-laravel-rules": [ "sometimes", "string", "max:500" ], "type": "string", "maxLength": 500 } }, "x-source": [ "app/app/Modules/Fiscal/Agent/Http/Controllers/FiscalAgentApprovalController.php:123" ] }, "post_api_v1_fiscal_agent_nfe__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" ] }, "post_api_v1_fiscal_agent_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" ] }, "post_api_v1_fiscal_agent_nfse__nfse__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/Modules/Fiscal/Nfse/Http/Requests/CancelNfseRequest.php:20" ] }, "post_api_v1_fiscal_agent_nfe_emitRequest": { "type": "object", "properties": { "tipo": { "x-laravel-rules": [ "required", "integer", "in:55,65" ], "type": "integer", "enum": [ 55, 65 ] }, "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 } } } }, "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": [ "tipo", "destinatario", "itens" ], "x-source": [ "app/app/Http/Requests/EmitNfeRequest.php:20" ] }, "post_api_v1_fiscal_agent_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 } } } }, "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_fiscal_agent_nfse_emitRequest": { "type": "object", "properties": { "competencia": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{4}-\\d{2}$/" ], "type": "string", "pattern": "^\\d{4}-\\d{2}$" }, "cnpj_prestador": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{14}$/" ], "type": "string", "pattern": "^\\d{14}$" }, "inscricao_municipal": { "x-laravel-rules": [ "required", "string", "max:20" ], "type": "string", "maxLength": 20 }, "razao_social_prestador": { "x-laravel-rules": [ "nullable", "string", "max:255" ], "type": [ "string", "null" ], "maxLength": 255 }, "descricao_servico": { "x-laravel-rules": [ "required", "string", "min:5", "max:2000" ], "type": "string", "minLength": 5, "maxLength": 2000 }, "cnae": { "x-laravel-rules": [ "nullable", "string", "regex:/^\\d{4}[-.]?\\d{1}[\\/.]?\\d{2}$|^\\d{7}$/" ], "type": [ "string", "null" ], "pattern": "^\\d{4}[-.]?\\d{1}[/.]?\\d{2}$|^\\d{7}$" }, "codigo_tributacao_nacional": { "x-laravel-rules": [ "required_without:cnae", "nullable", "string", "regex:/^\\d{2}\\.\\d{2}\\.\\d{2}\\.\\d{2}$/" ], "type": [ "string", "null" ], "description": "Obrigatório na ausência de cnae.", "pattern": "^\\d{2}\\.\\d{2}\\.\\d{2}\\.\\d{2}$" }, "codigo_tributacao_municipal": { "x-laravel-rules": [ "required_without:cnae", "nullable", "string", "max:20" ], "type": [ "string", "null" ], "description": "Obrigatório na ausência de cnae.", "maxLength": 20 }, "aliquota_iss": { "x-laravel-rules": [ "required_without:cnae", "nullable", "numeric", "min:0", "max:100" ], "type": [ "number", "null" ], "description": "Obrigatório na ausência de cnae.", "minimum": 0, "maximum": 100 }, "codigo_municipio_prestacao": { "x-laravel-rules": [ "required", "string", "size:7", "regex:/^\\d{7}$/" ], "type": "string", "minLength": 7, "maxLength": 7, "pattern": "^\\d{7}$" }, "codigo_nbs": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "nullable", "string", "regex:/^\\d{9}$/" ], "type": [ "string", "null" ], "description": "Obrigatório quando rtc.incluir,true.", "pattern": "^\\d{9}$" }, "valor_servico": { "x-laravel-rules": [ "required", "numeric", "min:0.01" ], "type": "number", "minimum": 0.01 }, "valor_deducoes": { "x-laravel-rules": [ "nullable", "numeric", "min:0" ], "type": [ "number", "null" ], "minimum": 0 }, "informacoes_adicionais": { "x-laravel-rules": [ "nullable", "string", "max:255" ], "type": [ "string", "null" ], "maxLength": 255 }, "tomador": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "cnpj": { "x-laravel-rules": [ "required_without:tomador.cpf", "nullable", "string", "regex:/^\\d{14}$/" ], "x-laravel-custom-validation": true, "description": "Validação adicional de domínio é aplicada pelo servidor (por exemplo dígitos verificadores e autorização). Obrigatório na ausência de tomador.cpf.", "type": [ "string", "null" ], "pattern": "^\\d{14}$" }, "cpf": { "x-laravel-rules": [ "required_without:tomador.cnpj", "nullable", "string" ], "x-laravel-custom-validation": true, "description": "Validação adicional de domínio é aplicada pelo servidor (por exemplo dígitos verificadores e autorização). Obrigatório na ausência de tomador.cnpj.", "type": [ "string", "null" ] }, "nome": { "x-laravel-rules": [ "required", "string", "max:255" ], "type": "string", "maxLength": 255 }, "endereco": { "x-laravel-rules": [ "nullable", "array" ], "type": [ "array", "object", "null" ], "items": {}, "additionalProperties": true } }, "required": [ "nome" ] }, "rtc": { "x-laravel-rules": [ "nullable", "array" ], "type": [ "object", "null" ], "properties": { "incluir": { "x-laravel-rules": [ "sometimes", "boolean" ], "type": "boolean" }, "resolution_id": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "string", "max:64" ], "type": "string", "description": "Obrigatório quando rtc.incluir,true.", "maxLength": 64 }, "sku": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "string", "max:80" ], "type": "string", "description": "Obrigatório quando rtc.incluir,true.", "maxLength": 80 }, "cind_op": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "string", "regex:/^\\d{6}$/" ], "type": "string", "description": "Obrigatório quando rtc.incluir,true.", "pattern": "^\\d{6}$" }, "fin_nfse": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "string", "in:0,1,2" ], "type": "string", "description": "Obrigatório quando rtc.incluir,true.", "enum": [ "0", "1", "2" ] }, "ind_dest": { "x-laravel-rules": [ "required_if:rtc.incluir,true", "string", "in:0,1" ], "type": "string", "description": "Obrigatório quando rtc.incluir,true.", "enum": [ "0", "1" ] } }, "x-prohibited-fields": [ "cst", "cclass_trib", "source_version", "valor_ibs", "valor_cbs" ] }, "prestador": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "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:10" ], "type": "string", "maxLength": 10 }, "bairro": { "x-laravel-rules": [ "required", "string", "max:100" ], "type": "string", "maxLength": 100 }, "codigo_municipio": { "x-laravel-rules": [ "required", "string", "size:7" ], "type": "string", "minLength": 7, "maxLength": 7 }, "uf": { "x-laravel-rules": [ "required", "string", "size:2" ], "type": "string", "minLength": 2, "maxLength": 2 }, "cep": { "x-laravel-rules": [ "required", "string", "regex:/^\\d{8}$/" ], "type": "string", "pattern": "^\\d{8}$" } }, "required": [ "logradouro", "numero", "bairro", "codigo_municipio", "uf", "cep" ] } }, "required": [ "endereco" ] } }, "required": [ "competencia", "cnpj_prestador", "inscricao_municipal", "descricao_servico", "codigo_municipio_prestacao", "valor_servico", "tomador", "prestador" ], "x-source": [ "app/app/Modules/Fiscal/Nfse/Http/Requests/EmitNfseRequest.php:17" ] }, "post_api_v1_rtc_parameterization_taxpayer_profilesRequest": { "type": "object", "properties": { "establishment_key": { "x-laravel-rules": [ "nullable", "string", "max:32" ], "type": [ "string", "null" ], "maxLength": 32 }, "crt": { "x-laravel-rules": [ "required", "integer", "in:1,2,3" ], "type": "integer", "enum": [ 1, 2, 3 ] }, "ibs_cbs_regime": { "x-laravel-rules": [ "required", "string", "max:32" ], "type": "string", "maxLength": 32 }, "valid_from": { "x-laravel-rules": [ "required", "date_format:Y-m-d" ], "type": "string", "format": "date" }, "valid_until": { "x-laravel-rules": [ "nullable", "date_format:Y-m-d", "after_or_equal:valid_from" ], "type": [ "string", "null" ], "format": "date", "description": "Deve ser posterior ou igual a valid_from." }, "special_regimes": { "x-laravel-rules": [ "nullable", "array" ], "type": [ "array", "object", "null" ], "items": {}, "additionalProperties": true } }, "required": [ "crt", "ibs_cbs_regime", "valid_from" ], "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:45" ] }, "put_api_v1_rtc_parameterization_catalog_itemsRequest": { "type": "object", "properties": { "sku": { "x-laravel-rules": [ "required", "string", "max:80" ], "type": "string", "maxLength": 80 }, "type": { "x-laravel-rules": [ "required", "in:product,service" ], "enum": [ "product", "service" ] }, "description": { "x-laravel-rules": [ "required", "string", "max:255" ], "type": "string", "maxLength": 255 }, "ncm": { "x-laravel-rules": [ "nullable", "regex:/^\\d{8}$/" ], "pattern": "^\\d{8}$" }, "nbs": { "x-laravel-rules": [ "nullable", "regex:/^\\d{9}$/" ], "pattern": "^\\d{9}$" }, "unit": { "x-laravel-rules": [ "required", "string", "max:8" ], "type": "string", "maxLength": 8 }, "active": { "x-laravel-rules": [ "sometimes", "boolean" ], "type": "boolean" } }, "required": [ "sku", "type", "description", "unit" ], "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:83" ] }, "post_api_v1_rtc_parameterization_operation_rulesRequest": { "type": "object", "properties": { "establishment_key": { "x-laravel-rules": [ "nullable", "string", "max:32" ], "type": [ "string", "null" ], "maxLength": 32 }, "dfe_type": { "x-laravel-rules": [ "required", "in:NFE,NFCE,NFSE" ], "enum": [ "NFE", "NFCE", "NFSE" ] }, "operation_code": { "x-laravel-rules": [ "nullable", "string", "max:12" ], "type": [ "string", "null" ], "maxLength": 12 }, "origin_uf": { "x-laravel-rules": [ "nullable", "regex:/^[A-Z]{2}$/" ], "pattern": "^[A-Z]{2}$" }, "destination_uf": { "x-laravel-rules": [ "nullable", "regex:/^[A-Z]{2}$/" ], "pattern": "^[A-Z]{2}$" }, "recipient_indicator": { "x-laravel-rules": [ "nullable", "string", "max:24" ], "type": [ "string", "null" ], "maxLength": 24 }, "purpose": { "x-laravel-rules": [ "nullable", "string", "max:32" ], "type": [ "string", "null" ], "maxLength": 32 }, "priority": { "x-laravel-rules": [ "required", "integer", "min:0", "max:65535" ], "type": "integer", "minimum": 0, "maximum": 65535 }, "valid_from": { "x-laravel-rules": [ "required", "date_format:Y-m-d" ], "type": "string", "format": "date" }, "valid_until": { "x-laravel-rules": [ "nullable", "date_format:Y-m-d", "after_or_equal:valid_from" ], "type": [ "string", "null" ], "format": "date", "description": "Deve ser posterior ou igual a valid_from." }, "active": { "x-laravel-rules": [ "sometimes", "boolean" ], "type": "boolean" } }, "required": [ "dfe_type", "priority", "valid_from" ], "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:110" ] }, "post_api_v1_rtc_parameterization_item_tax_profilesRequest": { "type": "object", "properties": { "catalog_item_id": { "x-laravel-rules": [ "required", "integer" ], "type": "integer" }, "operation_rule_id": { "x-laravel-rules": [ "nullable", "integer" ], "type": [ "integer", "null" ] }, "cclass_trib": { "x-laravel-rules": [ "required", "regex:/^\\d{6}$/" ], "pattern": "^\\d{6}$" }, "valid_from": { "x-laravel-rules": [ "required", "date_format:Y-m-d" ], "type": "string", "format": "date" }, "valid_until": { "x-laravel-rules": [ "nullable", "date_format:Y-m-d", "after_or_equal:valid_from" ], "type": [ "string", "null" ], "format": "date", "description": "Deve ser posterior ou igual a valid_from." } }, "required": [ "catalog_item_id", "cclass_trib", "valid_from" ], "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcParameterizationController.php:135" ] }, "post_api_v1_rtc_parameterization_scenariosRequest": { "type": "object", "properties": { "name": { "x-laravel-rules": [ "required", "string", "regex:/^[A-Za-z0-9][A-Za-z0-9._-]{1,79}$/" ], "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{1,79}$" }, "dfe_type": { "x-laravel-rules": [ "required", "string", "in:NFE,NFCE,NFSE" ], "type": "string", "enum": [ "NFE", "NFCE", "NFSE" ] }, "input": { "x-laravel-rules": [ "required", "array" ], "type": "object", "properties": { "sku": { "x-laravel-rules": [ "required", "string", "max:80" ], "type": "string", "maxLength": 80 }, "tax_date": { "x-laravel-rules": [ "required", "date" ], "type": "string", "format": "date-time" }, "item_number": { "x-laravel-rules": [ "required", "integer", "min:1" ], "type": "integer", "minimum": 1 }, "calculator_payload": { "x-laravel-rules": [ "required", "array" ], "type": [ "array", "object" ], "items": {}, "additionalProperties": true }, "establishment_key": { "x-laravel-rules": [ "nullable", "string", "max:32" ], "type": [ "string", "null" ], "maxLength": 32 }, "operation_code": { "x-laravel-rules": [ "nullable", "string", "max:12" ], "type": [ "string", "null" ], "maxLength": 12 }, "origin_uf": { "x-laravel-rules": [ "nullable", "string", "size:2" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 }, "destination_uf": { "x-laravel-rules": [ "nullable", "string", "size:2" ], "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 }, "recipient_indicator": { "x-laravel-rules": [ "nullable", "string", "max:24" ], "type": [ "string", "null" ], "maxLength": 24 }, "purpose": { "x-laravel-rules": [ "nullable", "string", "max:32" ], "type": [ "string", "null" ], "maxLength": 32 } }, "required": [ "sku", "tax_date", "item_number", "calculator_payload" ] }, "expected_cst": { "x-laravel-rules": [ "nullable", "regex:/^\\d{3}$/" ], "pattern": "^\\d{3}$" }, "expected_cclass_trib": { "x-laravel-rules": [ "nullable", "regex:/^\\d{6}$/" ], "pattern": "^\\d{6}$" } }, "required": [ "name", "dfe_type", "input" ], "x-source": [ "app/app/Modules/Fiscal/Rtc/Http/Controllers/RtcScenarioController.php:29" ] }, "post_api_v1_plans_upgradeRequest": { "type": "object", "properties": { "plan_code": { "x-laravel-rules": [ "required", "string", "in:free,starter,growth,pro,scale,enterprise" ], "type": "string", "enum": [ "free", "starter", "growth", "pro", "scale", "enterprise" ] } }, "required": [ "plan_code" ], "x-source": [ "app/app/Http/Controllers/Api/V1/PlanController.php:71" ] }, "post_api_v1_billing_subscribeRequest": { "type": "object", "properties": { "plan_code": { "x-laravel-rules": [ "required", "string", "in:starter,growth,pro,scale,enterprise" ], "type": "string", "enum": [ "starter", "growth", "pro", "scale", "enterprise" ] }, "gateway": { "x-laravel-rules": [ "required", "string", "in:stripe" ], "type": "string", "enum": [ "stripe" ] }, "billing_cycle": { "x-laravel-rules": [ "sometimes", "string", "in:monthly,annual" ], "type": "string", "enum": [ "monthly", "annual" ] } }, "required": [ "plan_code", "gateway" ], "x-source": [ "app/app/Modules/Billing/Http/Requests/CreateSubscriptionRequest.php:17" ] }, "post_api_v1_billing_change_planRequest": { "type": "object", "properties": { "plan_code": { "x-laravel-rules": [ "required", "string", "in:free,starter,growth,pro,scale,enterprise" ], "type": "string", "enum": [ "free", "starter", "growth", "pro", "scale", "enterprise" ] } }, "required": [ "plan_code" ], "x-source": [ "app/app/Modules/Billing/Http/Requests/ChangePlanRequest.php:17" ] }, "post_api_v1_billing_payment_methodsRequest": { "type": "object", "properties": { "gateway": { "x-laravel-rules": [ "required" ], "x-laravel-custom-validation": true, "description": "Validação adicional de domínio é aplicada pelo servidor (por exemplo dígitos verificadores e autorização)." }, "type": { "x-laravel-rules": [ "required", "string", "in:card,pix,boleto" ], "type": "string", "enum": [ "card", "pix", "boleto" ] }, "external_id": { "x-laravel-rules": [ "required", "string", "max:200" ], "type": "string", "maxLength": 200 }, "last_four": { "x-laravel-rules": [ "nullable", "string", "size:4" ], "type": [ "string", "null" ], "minLength": 4, "maxLength": 4 }, "brand": { "x-laravel-rules": [ "nullable", "string", "max:30" ], "type": [ "string", "null" ], "maxLength": 30 }, "is_default": { "x-laravel-rules": [ "boolean" ], "type": "boolean" }, "metadata": { "x-laravel-rules": [ "nullable", "array" ], "type": [ "array", "object", "null" ], "items": {}, "additionalProperties": true } }, "required": [ "gateway", "type", "external_id" ], "x-source": [ "app/app/Modules/Billing/Http/Controllers/PaymentMethodController.php:46" ] }, "post_api_v1_affiliates_referralsRequest": { "type": "object", "properties": { "referred_email": { "x-laravel-rules": [ "required", "email", "max:255" ], "type": "string", "format": "email", "maxLength": 255 } }, "required": [ "referred_email" ], "x-source": [ "app/app/Modules/Affiliates/Http/Controllers/AffiliateController.php:23" ] }, "put_api_v1_webhooks_configRequest": { "type": "object", "properties": { "webhook_url": { "x-laravel-rules": [ "required", "url", "max:2048" ], "type": "string", "format": "uri", "maxLength": 2048 }, "webhook_secret": { "x-laravel-rules": [ "sometimes", "string", "min:16", "max:255" ], "type": "string", "minLength": 16, "maxLength": 255 } }, "required": [ "webhook_url" ], "x-source": [ "app/app/Http/Controllers/Api/V1/WebhookConfigController.php:48" ] }, "post_api_v1_crypto_invoices_auto_confirmRequest": { "type": "object", "properties": { "txid": { "x-laravel-rules": [ "required", "string", "min:10", "max:128" ], "type": "string", "minLength": 10, "maxLength": 128 }, "amount_usdt": { "x-laravel-rules": [ "required", "numeric", "min:0.000001" ], "type": "number", "minimum": 1e-06 } }, "required": [ "txid", "amount_usdt" ], "x-source": [ "app/app/Http/Controllers/Api/V1/CryptoInvoiceController.php:25" ] } } } }