{ "openapi": "3.1.1", "info": { "title": "Notavia App - API", "description": "API da Notavia App. **Integradores:** usem só as rotas do grupo **API de integração**, autenticadas pela chave de API (`X-Api-Key`, criada em Administração → Integração) — conceitos, exemplos e sandbox em [/devs](/devs). Os demais grupos são rotas internas do portal e da plataforma, listadas por transparência.", "contact": { "name": "Suporte Notavia", "url": "https://app.notavia.com.br/devs", "email": "suporte@notavia.com.br" }, "version": "v1" }, "servers": [ { "url": "https://app.notavia.com.br/" } ], "paths": { "/.well-known/security.txt": { "get": { "tags": [ "Páginas públicas e saúde" ], "responses": { "200": { "description": "OK" } } } }, "/api/produtos/sugerir-ncm": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SugerirNcmRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/nfse/codigos-tributacao": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "codigo", "in": "query", "schema": { "type": "string" } }, { "name": "item", "in": "query", "schema": { "type": "string" } }, { "name": "busca", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/auditoria": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "de", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "busca", "in": "query", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/dashboard": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/onboarding/checklist": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/credenciamento-nfe": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/assinatura": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/assinatura/checkout": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/assinatura/mudar-plano": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/assinatura/portal": { "post": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/assinatura/dados-faturamento": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadosFaturamento" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/assinatura/nfse": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/assinatura/nfse/{id}/pdf": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "baixar", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/assinatura/nfse/{id}/xml": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/assinatura/faturas": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/webhooks/stripe": { "post": { "tags": [ "Webhooks" ], "responses": { "200": { "description": "OK" } } } }, "/juridico/{slug}": { "get": { "tags": [ "Páginas públicas e saúde" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/health": { "get": { "tags": [ "Páginas públicas e saúde" ], "responses": { "200": { "description": "OK" } } } }, "/status.json": { "get": { "tags": [ "Páginas públicas e saúde" ], "responses": { "200": { "description": "OK" } } } }, "/status": { "get": { "tags": [ "Páginas públicas e saúde" ], "responses": { "200": { "description": "OK" } } } }, "/sitemap.xml": { "get": { "tags": [ "Páginas públicas e saúde" ], "responses": { "200": { "description": "OK" } } } }, "/robots.txt": { "get": { "tags": [ "Páginas públicas e saúde" ], "responses": { "200": { "description": "OK" } } } }, "/ajuda": { "get": { "tags": [ "Páginas públicas e saúde" ], "responses": { "200": { "description": "OK" } } } }, "/ajuda/{slug}": { "get": { "tags": [ "Páginas públicas e saúde" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/devs": { "get": { "tags": [ "Páginas públicas e saúde" ], "responses": { "200": { "description": "OK" } } } }, "/devs/{slug}": { "get": { "tags": [ "Páginas públicas e saúde" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/account/login": { "get": { "tags": [ "Autenticação" ], "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "returnUrl", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/account/external-callback": { "get": { "tags": [ "Autenticação" ], "parameters": [ { "name": "returnUrl", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/account/logout": { "post": { "tags": [ "Autenticação" ], "responses": { "200": { "description": "OK" } } } }, "/account/email/iniciar": { "post": { "tags": [ "Autenticação" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailLoginIniciarRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/account/email/confirmar": { "post": { "tags": [ "Autenticação" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailLoginConfirmarRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/me/aceitar-termos": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AceitarTermosRequest" } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/providers": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/emitentes": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarEmitenteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/emitentes/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarEmitenteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/emitentes/{id}/certificado": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "arquivo", "senha" ], "type": "object", "allOf": [ { "type": "object", "properties": { "arquivo": { "$ref": "#/components/schemas/IFormFile" } } }, { "type": "object", "properties": { "senha": { "type": "string" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/emitentes/{id}/logotipo": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "arquivo" ], "type": "object", "properties": { "arquivo": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/emitentes/{id}/consulta-cadastro": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/grupos-produto": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarGrupoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/grupos-produto/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarGrupoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/grupos-cliente": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarGrupoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/grupos-cliente/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarGrupoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/grupos-ncm": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarGrupoNcmRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/grupos-ncm/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarGrupoNcmRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/grupos-ncm/por-ncm/{ncm}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "ncm", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/produtos": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarProdutoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/produtos/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarProdutoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clientes/consulta-cnpj": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "cnpj", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clientes": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarClienteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/clientes/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarClienteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/importacao/{recurso}/modelo": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "recurso", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/importacao/produtos/previa": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "arquivo" ], "type": "object", "properties": { "arquivo": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/importacao/produtos/confirmar": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalvarProdutoRequest" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/importacao/clientes/previa": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "arquivo" ], "type": "object", "properties": { "arquivo": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/importacao/clientes/confirmar": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalvarClienteRequest" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/operacoes-fiscais": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarOperacaoFiscalRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/operacoes-fiscais/{id}/cobertura-matriz": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/operacoes-fiscais/{id}/regras-matriz": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/operacoes-fiscais/{id}/regras-matriz/gerar": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GerarRegrasOperacaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/operacoes-fiscais/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarOperacaoFiscalRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "confirmado", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/transportadoras": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarTransportadoraRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/transportadoras/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarTransportadoraRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/embalagens": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarEmbalagemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/embalagens/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarEmbalagemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/regras-tributarias": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarRegraTributariaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/regras-tributarias/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarRegraTributariaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/regras-tributarias/{id}/historico": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/regras-tributarias/historico/{historicoId}/desfazer": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "historicoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/assistente-impostos/previa": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerfilRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/assistente-impostos/aplicar": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerfilRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/simulador/calcular": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimularRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/notas": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "status", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "busca", "in": "query", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notas/{id}/consultar-situacao": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notas/exportar-xmls": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notas/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notas/{id}/duplicar": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notas/{id}/xml": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notas/{id}/danfe": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notas/emitir": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmitirNotaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/notas/verificar": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmitirNotaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/notas/{id}/cancelar": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelarNotaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/notas/{id}/cce": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartaCorrecaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/notas/{id}/eventos": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notas/{id}/eventos/{eventoId}/dacce": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "eventoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notas/{id}/eventos/{eventoId}/xml": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "eventoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/inutilizacoes": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InutilizarRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/inutilizacoes/orientacao": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/dce/emitir": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmitirDceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/dce": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/dce/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/dce/{id}/xml": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/dce/{id}/dace": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/dce/{id}/cancelar": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelarDceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/dce/{id}/consultar-situacao": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/nfse/emitir": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmitirNfseRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/nfse/retencoes/previa": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmitirNfseRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/nfse": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "busca", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/nfse/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/nfse/{id}/xml": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/nfse/{id}/dps": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/nfse/{id}/danfse": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/nfse/{id}/cancelar": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelarNfseRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/nfse/recuperar": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecuperarNfseRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/nfse/aliquota-servico": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cTribNac", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "cTribMun", "in": "query", "schema": { "type": "string" } }, { "name": "municipio", "in": "query", "schema": { "type": "string" } }, { "name": "competencia", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/nfse/{id}/consultar": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/servicos": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "apenasAtivos", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarServicoPrestadoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/servicos/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarServicoPrestadoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/plataforma/certificado-dce": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "arquivo", "senha" ], "type": "object", "allOf": [ { "type": "object", "properties": { "arquivo": { "$ref": "#/components/schemas/IFormFile" } } }, { "type": "object", "properties": { "senha": { "type": "string" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/api-keys": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarApiKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/api-keys/{id}": { "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/webhook-config": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookConfigRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/grupos-produto/{codigo}": { "put": { "tags": [ "API de integração" ], "parameters": [ { "name": "codigo", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarGrupoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/grupos-produto": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/grupos-cliente/{codigo}": { "put": { "tags": [ "API de integração" ], "parameters": [ { "name": "codigo", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarGrupoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/grupos-cliente": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/grupos-ncm/{codigo}": { "put": { "tags": [ "API de integração" ], "parameters": [ { "name": "codigo", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarGrupoNcmRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/grupos-ncm": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/produtos/{codigo}": { "put": { "tags": [ "API de integração" ], "parameters": [ { "name": "codigo", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarProdutoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/produtos": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/clientes/{cpfCnpj}": { "put": { "tags": [ "API de integração" ], "parameters": [ { "name": "cpfCnpj", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarClienteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/clientes": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/operacoes-fiscais/{codigo}": { "put": { "tags": [ "API de integração" ], "parameters": [ { "name": "codigo", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarOperacaoFiscalRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/operacoes-fiscais": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/transportadoras/{cpfCnpj}": { "put": { "tags": [ "API de integração" ], "parameters": [ { "name": "cpfCnpj", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarTransportadoraRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/transportadoras": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/emissoes": { "post": { "tags": [ "API de integração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegracaoEmissaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/cancelamentos": { "post": { "tags": [ "API de integração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegracaoCancelamentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/cartas-correcao": { "post": { "tags": [ "API de integração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegracaoCceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/inutilizacoes": { "post": { "tags": [ "API de integração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegracaoInutilizacaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/emissoes/{jobId}": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/eventos/{jobId}": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/dce": { "post": { "tags": [ "API de integração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegracaoDceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/dce/cancelamentos": { "post": { "tags": [ "API de integração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegracaoDceCancelamentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/dce/{jobId}": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/nfse": { "post": { "tags": [ "API de integração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegracaoNfseRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/nfse/cancelamentos": { "post": { "tags": [ "API de integração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegracaoNfseCancelamentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/nfse/{jobId}": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/servicos/{codigo}": { "put": { "tags": [ "API de integração" ], "parameters": [ { "name": "codigo", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarServicoPrestadoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/integracao/dce/{chave}/xml": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "chave", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/nfse/{chave}/xml": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "chave", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/nfse/{chave}/danfse": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "chave", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/dce/{chave}/dace": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "chave", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/notas/{chave}/xml": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "chave", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integracao/notas/{chave}/danfe": { "get": { "tags": [ "API de integração" ], "parameters": [ { "name": "chave", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/seguranca/autenticador": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/seguranca/autenticador/iniciar": { "post": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/seguranca/autenticador/confirmar-email": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodigoEmailRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/seguranca/autenticador/ativar": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodigoTotpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/seguranca/autenticador/remover": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodigoEmailRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/usuarios": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/usuarios/convites": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvidarUsuarioRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/usuarios/convites/{id}": { "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/usuarios/{id}/papel": { "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlterarPapelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/usuarios/{id}/emitentes": { "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlterarEmpresasUsuarioRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/usuarios/{id}": { "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/solicitacoes-acesso": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/solicitacoes-acesso/{id}/aprovar": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/solicitacoes-acesso/{id}/recusar": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notificacoes/resumo": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/notificacoes": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnviarNotificacaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/notificacoes/{id}/lida": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notificacoes/lidas": { "post": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/notificacoes/enviadas": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/notificacoes/{id}": { "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/account/suporte/login": { "get": { "tags": [ "Autenticação" ], "responses": { "200": { "description": "OK" } } } }, "/account/suporte/callback": { "get": { "tags": [ "Autenticação" ], "responses": { "200": { "description": "OK" } } } }, "/api/suporte/contas": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/suporte/entrar": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntrarContaSuporteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/suporte/trocar-conta": { "post": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/acesso-suporte": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutorizarSuporteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/relatorios/faturamento": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "formato", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/relatorios/impostos": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "formato", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/relatorios/por-cliente": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "formato", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/relatorios/por-produto": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "formato", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/relatorios/dce": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "formato", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ibpt/status": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/ibpt/importar": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "arquivo", "uf" ], "type": "object", "allOf": [ { "type": "object", "properties": { "arquivo": { "$ref": "#/components/schemas/IFormFile" } } }, { "type": "object", "properties": { "uf": { "type": "string" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/distribuicao": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/distribuicao/{id}/xml": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/distribuicao/{emitenteId}/consultar": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/canais": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/canais/pedidos/{id}/emitir": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/canais/pedidos/emitir-pendentes": { "post": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/canais/pedidos": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/canais/{id}": { "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtualizarCanalRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/canais/{canal}/conectar-url": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "canal", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/erp": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/erp/conectar": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConectarErpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/erp/documentos": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/erp/documentos/{id}/emitir": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/erp/documentos/emitir-pendentes": { "post": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/erp/{id}": { "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtualizarErpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/erp/{id}/agente": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/diag/sefaz-status": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "motor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/diag/nfse-sp": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "codigoServico", "in": "query", "schema": { "type": "string" } }, { "name": "im", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/diag/nfse-sp/ccm": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/diag/emitir-nativo": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "serie", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "contingencia", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/diag/operacoes-nativo": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/diag/cancelar-nativo": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "chave", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "protocolo", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "motor", "in": "query", "schema": { "type": "string" } }, { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/diag/inutilizar-nativo": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "serie", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "numero", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/diag/status-autorizadoras": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "ambiente", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/revisoes": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/revisoes/regras/{id}/sugestoes": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/recomendacoes-impostos": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "Ncm", "in": "query", "schema": { "type": "string" } }, { "name": "Regime", "in": "query", "schema": { "type": "string" } }, { "name": "UfOrigem", "in": "query", "schema": { "type": "string" } }, { "name": "UfDestino", "in": "query", "schema": { "type": "string" } }, { "name": "ClienteContribuinte", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "ConsumidorFinal", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "TipoOperacao", "in": "query", "schema": { "type": "string", "default": "Saida" } }, { "name": "Origem", "in": "query", "schema": { "type": "string" } }, { "name": "CodigoProdutoAnp", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecomendacaoImpostosRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/recomendacoes-impostos/aceitar": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AceitarRecomendacaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/assistente/conversas": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/assistente/conversas/{id}": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/assistente/conversas/{id}/mensagens": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnviarMensagemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/series": { "get": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "emitenteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "modelo", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "confirmado", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarSerieRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/series/{id}": { "put": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "confirmado", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarSerieRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/series/{id}/padrao": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/me/perfil": { "put": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtualizarPerfilRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me/consentimento-cookies": { "put": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentimentoCookiesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me/foto": { "post": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "arquivo" ], "type": "object", "properties": { "arquivo": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/me/tours/{chave}": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "chave", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/me/videos/{chave}": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "chave", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/conta/empresa": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmpresaContaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/conta/conversoes": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } } }, "/api/conta/conversoes/{id}/disparada": { "post": { "tags": [ "Portal (uso interno)" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/email-nota-config": { "get": { "tags": [ "Portal (uso interno)" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Portal (uso interno)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailNotaConfigRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/publico/nfe/{chave}.xml": { "get": { "tags": [ "Páginas públicas e saúde" ], "parameters": [ { "name": "chave", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "t", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/publico/nfe/{chave}.pdf": { "get": { "tags": [ "Páginas públicas e saúde" ], "parameters": [ { "name": "chave", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "t", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/nuvemshop-app/api/config": { "get": { "tags": [ "Páginas públicas e saúde" ], "responses": { "200": { "description": "OK" } } } }, "/nuvemshop-app/api/pedidos": { "get": { "tags": [ "Páginas públicas e saúde" ], "parameters": [ { "name": "pagina", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AceitarRecomendacaoRequest": { "required": [ "regime", "ncm", "csosn" ], "type": "object", "properties": { "regime": { "type": [ "null", "string" ] }, "ncm": { "type": [ "null", "string" ] }, "csosn": { "type": [ "null", "string" ] } } }, "AceitarTermosRequest": { "required": [ "consentimentoCookies" ], "type": "object", "properties": { "consentimentoCookies": { "type": [ "null", "boolean" ] } } }, "AdicaoImportacaoRequest": { "required": [ "numero", "sequencial" ], "type": "object", "properties": { "numero": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "sequencial": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "codigoFabricante": { "type": [ "null", "string" ] }, "valorDesconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "numeroDrawback": { "type": [ "null", "string" ] } } }, "AlterarEmpresasUsuarioRequest": { "required": [ "emitentes" ], "type": "object", "properties": { "emitentes": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "AlterarPapelRequest": { "required": [ "papel" ], "type": "object", "properties": { "papel": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "AtividadeEventoNfseRequest": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": "string" }, "dataInicio": { "type": [ "null", "string" ], "format": "date" }, "dataFim": { "type": [ "null", "string" ], "format": "date" }, "codigoEvento": { "type": [ "null", "string" ] }, "endereco": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EnderecoSimplesNfseRequest" } ] } } }, "AtualizarCanalRequest": { "required": [ "emitenteId", "operacaoFiscalPadraoId", "operacaoFiscalDevolucaoId", "gatilhoEmissao", "emissaoAutomatica", "uploadAutomatico", "cancelarAutomatico", "apelido" ], "type": "object", "properties": { "emitenteId": { "type": [ "null", "string" ], "format": "uuid" }, "operacaoFiscalPadraoId": { "type": [ "null", "string" ], "format": "uuid" }, "operacaoFiscalDevolucaoId": { "type": [ "null", "string" ], "format": "uuid" }, "gatilhoEmissao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "emissaoAutomatica": { "type": [ "null", "boolean" ] }, "uploadAutomatico": { "type": [ "null", "boolean" ] }, "cancelarAutomatico": { "type": [ "null", "boolean" ] }, "apelido": { "type": [ "null", "string" ] }, "modalidadeFretePadrao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "AtualizarErpRequest": { "required": [ "emitenteId", "operacaoFiscalPadraoId", "operacaoFiscalDevolucaoId", "gatilhoEmissao", "emissaoAutomatica", "confiarImpostoErp", "escreverRetorno", "cancelarAutomatico", "apelido" ], "type": "object", "properties": { "emitenteId": { "type": [ "null", "string" ], "format": "uuid" }, "operacaoFiscalPadraoId": { "type": [ "null", "string" ], "format": "uuid" }, "operacaoFiscalDevolucaoId": { "type": [ "null", "string" ], "format": "uuid" }, "gatilhoEmissao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "emissaoAutomatica": { "type": [ "null", "boolean" ] }, "confiarImpostoErp": { "type": [ "null", "boolean" ] }, "escreverRetorno": { "type": [ "null", "boolean" ] }, "cancelarAutomatico": { "type": [ "null", "boolean" ] }, "apelido": { "type": [ "null", "string" ] } } }, "AtualizarPerfilRequest": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": [ "null", "string" ] } } }, "AutorizarSuporteRequest": { "required": [ "validade" ], "type": "object", "properties": { "validade": { "type": [ "null", "string" ] } } }, "CancelarDceRequest": { "required": [ "justificativa" ], "type": "object", "properties": { "justificativa": { "type": "string" } } }, "CancelarNfseRequest": { "required": [ "justificativa" ], "type": "object", "properties": { "justificativa": { "type": "string" }, "motivo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } } }, "CancelarNotaRequest": { "required": [ "justificativa" ], "type": "object", "properties": { "justificativa": { "type": "string" } } }, "CartaCorrecaoRequest": { "required": [ "correcao" ], "type": "object", "properties": { "correcao": { "type": "string" } } }, "CheckoutRequest": { "required": [ "plano" ], "type": "object", "properties": { "plano": { "type": "string" }, "anual": { "type": "boolean", "default": false } } }, "CideRequest": { "required": [ "baseCalculo", "aliquota", "valor" ], "type": "object", "properties": { "baseCalculo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "aliquota": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "CobrancaRequest": { "type": "object", "properties": { "numeroFatura": { "type": [ "null", "string" ] }, "duplicatas": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DuplicataRequest" } } } }, "CodigoEmailRequest": { "required": [ "codigo" ], "type": "object", "properties": { "codigo": { "type": "string" } } }, "CodigoTotpRequest": { "required": [ "codigo" ], "type": "object", "properties": { "codigo": { "type": "string" } } }, "CombustivelRequest": { "required": [ "codigoAnp" ], "type": "object", "properties": { "codigoAnp": { "type": "string" }, "descricaoAnp": { "type": [ "null", "string" ] }, "percentualGlp": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "percentualGasNacional": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "percentualGasImportado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "valorPartida": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "ufConsumo": { "type": [ "null", "string" ] }, "codif": { "type": [ "null", "string" ] }, "quantidadeTempAmbiente": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "cide": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CideRequest" } ] }, "encerrante": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EncerranteRequest" } ] } } }, "ConectarErpRequest": { "required": [ "sistema", "baseUrl", "banco", "usuario", "segredo" ], "type": "object", "properties": { "sistema": { "type": "string" }, "baseUrl": { "type": "string" }, "banco": { "type": [ "null", "string" ] }, "usuario": { "type": [ "null", "string" ] }, "segredo": { "type": "string" }, "modoConectividade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } }, "ConsentimentoCookiesRequest": { "required": [ "consentimento" ], "type": "object", "properties": { "consentimento": { "type": [ "null", "boolean" ] } } }, "ConvidarUsuarioRequest": { "required": [ "email", "papel" ], "type": "object", "properties": { "email": { "type": "string" }, "papel": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "emitentes": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "CreditoZfmRequest": { "required": [ "tipo", "competApur", "valor" ], "type": "object", "properties": { "tipo": { "type": "string" }, "competApur": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "CriarApiKeyRequest": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": "string" } } }, "DadosFaturamento": { "type": "object", "properties": { "razaoSocial": { "type": [ "null", "string" ] }, "cpfCnpj": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "inscricaoMunicipal": { "type": [ "null", "string" ] }, "logradouro": { "type": [ "null", "string" ] }, "numero": { "type": [ "null", "string" ] }, "complemento": { "type": [ "null", "string" ] }, "bairro": { "type": [ "null", "string" ] }, "codigoMunicipioIbge": { "type": [ "null", "string" ] }, "municipio": { "type": [ "null", "string" ] }, "uf": { "type": [ "null", "string" ] }, "cep": { "type": [ "null", "string" ] }, "completo": { "type": "boolean" } } }, "DeclaracaoImportacaoRequest": { "required": [ "numeroDocumento", "dataRegistro", "localDesembaraco", "ufDesembaraco", "dataDesembaraco", "viaTransporte", "formaIntermediacao", "adicoes" ], "type": "object", "properties": { "numeroDocumento": { "type": "string" }, "dataRegistro": { "type": "string", "format": "date" }, "localDesembaraco": { "type": "string" }, "ufDesembaraco": { "type": "string" }, "dataDesembaraco": { "type": "string", "format": "date" }, "viaTransporte": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "formaIntermediacao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "adicoes": { "type": "array", "items": { "$ref": "#/components/schemas/AdicaoImportacaoRequest" } }, "codigoExportador": { "type": [ "null", "string" ] }, "valorAfrmm": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "cnpjAdquirente": { "type": [ "null", "string" ] }, "cpfAdquirente": { "type": [ "null", "string" ] }, "ufTerceiro": { "type": [ "null", "string" ] } } }, "DetExportRequest": { "type": "object", "properties": { "numeroDrawback": { "type": [ "null", "string" ] }, "registroExportacao": { "type": [ "null", "string" ] }, "chaveNFeExportacao": { "type": [ "null", "string" ] }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 } } }, "DuplicataRequest": { "required": [ "numero", "vencimento", "valor" ], "type": "object", "properties": { "numero": { "type": "string" }, "vencimento": { "type": "string", "format": "date" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "EmailLoginConfirmarRequest": { "required": [ "email", "codigo" ], "type": "object", "properties": { "email": { "type": "string" }, "codigo": { "type": "string" } } }, "EmailLoginIniciarRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "EmailNotaConfigRequest": { "required": [ "ativo", "assunto", "corpo" ], "type": "object", "properties": { "ativo": { "type": "boolean" }, "assunto": { "type": [ "null", "string" ] }, "corpo": { "type": [ "null", "string" ] } } }, "EmitirDceRequest": { "required": [ "emitenteId", "tpEmit", "remetente", "destinatario", "itens" ], "type": "object", "properties": { "emitenteId": { "type": "string", "format": "uuid" }, "tpEmit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "remetente": { "$ref": "#/components/schemas/PessoaDceRequest" }, "destinatario": { "$ref": "#/components/schemas/PessoaDceRequest" }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDceRequest" } }, "transporte": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TransporteDceRequest" } ] }, "plataforma": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlataformaDceRequest" } ] }, "infoComplementar": { "type": [ "null", "string" ] }, "serieId": { "type": [ "null", "string" ], "format": "uuid" } } }, "EmitirNfseRequest": { "required": [ "emitenteId", "valorServicos" ], "type": "object", "properties": { "emitenteId": { "type": "string", "format": "uuid" }, "valorServicos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "servicoPrestadoId": { "type": [ "null", "string" ], "format": "uuid" }, "codigoServico": { "type": [ "null", "string" ] }, "clienteId": { "type": [ "null", "string" ], "format": "uuid" }, "tomador": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PessoaNfseRequest" } ] }, "intermediario": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PessoaNfseRequest" } ] }, "discriminacao": { "type": [ "null", "string" ] }, "codigoTributacaoNacional": { "type": [ "null", "string" ] }, "codigoTributacaoMunicipio": { "type": [ "null", "string" ] }, "aliquotaIss": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "tributacaoIssqn": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "retencaoIssqn": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "tipoImunidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "paisResultado": { "type": [ "null", "string" ] }, "codigoMunicipioPrestacao": { "type": [ "null", "string" ] }, "paisPrestacao": { "type": [ "null", "string" ] }, "descontoIncondicionado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "descontoCondicionado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "deducao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "aplicarRetencoesFederais": { "type": [ "null", "boolean" ] }, "competencia": { "type": [ "null", "string" ], "format": "date" }, "informacoesComplementares": { "type": [ "null", "string" ] }, "numeroPedido": { "type": [ "null", "string" ] }, "serieId": { "type": [ "null", "string" ], "format": "uuid" }, "evento": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AtividadeEventoNfseRequest" } ] }, "obra": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ObraNfseRequest" } ] } } }, "EmitirNotaItemRequest": { "required": [ "produtoId", "quantidade", "valorUnitario" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "desconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pedidoCompra": { "type": [ "null", "string" ] }, "itemPedidoCompra": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "infoAdicional": { "type": [ "null", "string" ] }, "codigoBeneficioFiscal": { "type": [ "null", "string" ] }, "rastro": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/RastroRequest" } }, "devolucaoTributosPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "chaveReferenciada": { "type": [ "null", "string" ] }, "itemReferenciado": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "destinacao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "importacao": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ImportacaoItemRequest" } ] }, "exportacoes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DetExportRequest" } }, "combustivel": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CombustivelRequest" } ] }, "veiculo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VeiculoProdutoRequest" } ] }, "medicamento": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MedicamentoRequest" } ] }, "creditoZfm": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreditoZfmRequest" } ] } } }, "EmitirNotaRequest": { "required": [ "emitenteId", "clienteId", "operacaoId", "data", "itens" ], "type": "object", "properties": { "emitenteId": { "type": "string", "format": "uuid" }, "clienteId": { "type": "string", "format": "uuid" }, "operacaoId": { "type": "string", "format": "uuid" }, "data": { "type": [ "null", "string" ], "format": "date" }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/EmitirNotaItemRequest" } }, "frete": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "seguro": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "outrasDespesas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pagamentos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PagamentoRequest" } }, "transporte": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TransporteRequest" } ] }, "cobranca": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CobrancaRequest" } ] }, "observacoes": { "type": [ "null", "string" ] }, "troco": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "chavesReferenciadas": { "type": [ "null", "array" ], "items": { "type": "string" } }, "autorizadosDownloadXml": { "type": [ "null", "array" ], "items": { "type": "string" } }, "localEntrega": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LocalRequest" } ] }, "localRetirada": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LocalRequest" } ] }, "exportacao": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ExportacaoRequest" } ] }, "intermediador": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IntermediadorRequest" } ] }, "codigoIndicadorOperacao": { "type": [ "null", "string" ] }, "indicadorPresenca": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "tipoImpressao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "serieId": { "type": [ "null", "string" ], "format": "uuid" }, "reemitirNotaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "EmpresaContaRequest": { "required": [ "nome", "cnpj", "semCnpj" ], "type": "object", "properties": { "nome": { "type": [ "null", "string" ] }, "cnpj": { "type": [ "null", "string" ] }, "semCnpj": { "type": "boolean" } } }, "EncerranteRequest": { "required": [ "bico", "bomba", "tanque", "valorInicial", "valorFinal" ], "type": "object", "properties": { "bico": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "bomba": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "tanque": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "valorInicial": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorFinal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "EnderecoDceRequest": { "required": [ "logradouro", "numero", "bairro", "codigoMunicipio", "municipio", "uf", "cep" ], "type": "object", "properties": { "logradouro": { "type": "string" }, "numero": { "type": "string" }, "bairro": { "type": "string" }, "codigoMunicipio": { "type": "string" }, "municipio": { "type": "string" }, "uf": { "type": "string" }, "cep": { "type": "string" }, "complemento": { "type": [ "null", "string" ] }, "fone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "paisCodigo": { "type": [ "null", "string" ] }, "paisNome": { "type": [ "null", "string" ] } } }, "EnderecoDto": { "required": [ "logradouro", "numero", "complemento", "bairro", "codigoMunicipioIbge", "municipio", "uf", "cep" ], "type": "object", "properties": { "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": [ "null", "string" ] }, "bairro": { "type": "string" }, "codigoMunicipioIbge": { "type": "string" }, "municipio": { "type": "string" }, "uf": { "type": "string" }, "cep": { "type": "string" } } }, "EnderecoNfseRequest": { "required": [ "logradouro", "numero", "bairro" ], "type": "object", "properties": { "logradouro": { "type": "string" }, "numero": { "type": "string" }, "bairro": { "type": "string" }, "codigoMunicipio": { "type": [ "null", "string" ] }, "cep": { "type": [ "null", "string" ] }, "complemento": { "type": [ "null", "string" ] }, "paisIso2": { "type": [ "null", "string" ] }, "codigoPostalExterior": { "type": [ "null", "string" ] }, "cidadeExterior": { "type": [ "null", "string" ] }, "estadoExterior": { "type": [ "null", "string" ] } } }, "EnderecoSimplesNfseRequest": { "required": [ "logradouro", "numero", "bairro" ], "type": "object", "properties": { "logradouro": { "type": "string" }, "numero": { "type": "string" }, "bairro": { "type": "string" }, "cep": { "type": [ "null", "string" ] }, "complemento": { "type": [ "null", "string" ] }, "codigoPostalExterior": { "type": [ "null", "string" ] }, "cidadeExterior": { "type": [ "null", "string" ] }, "estadoExterior": { "type": [ "null", "string" ] } } }, "EntrarContaSuporteRequest": { "required": [ "tenantId" ], "type": "object", "properties": { "tenantId": { "type": "string", "format": "uuid" } } }, "EnviarMensagemRequest": { "required": [ "texto" ], "type": "object", "properties": { "texto": { "type": [ "null", "string" ] } } }, "EnviarNotificacaoRequest": { "required": [ "titulo", "corpo", "severidade", "destinatarioUsuarioId", "expiraEmUtc", "tambemPorEmail" ], "type": "object", "properties": { "titulo": { "type": [ "null", "string" ] }, "corpo": { "type": [ "null", "string" ] }, "severidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "destinatarioUsuarioId": { "type": [ "null", "string" ], "format": "uuid" }, "expiraEmUtc": { "type": [ "null", "string" ], "format": "date-time" }, "tambemPorEmail": { "type": "boolean" } } }, "ExportacaoRequest": { "required": [ "ufSaidaPais", "localEmbarque" ], "type": "object", "properties": { "ufSaidaPais": { "type": "string" }, "localEmbarque": { "type": "string" }, "localDespacho": { "type": [ "null", "string" ] } } }, "GerarRegrasOperacaoRequest": { "required": [ "cstIcms", "csosnIcms", "cstPisCofins", "cstIpi", "cstReforma", "cClassTrib" ], "type": "object", "properties": { "cstIcms": { "type": [ "null", "string" ] }, "csosnIcms": { "type": [ "null", "string" ] }, "cstPisCofins": { "type": [ "null", "string" ] }, "cstIpi": { "type": [ "null", "string" ] }, "cstReforma": { "type": [ "null", "string" ] }, "cClassTrib": { "type": [ "null", "string" ] } } }, "IFormFile": { "type": "string", "format": "binary" }, "ImportacaoItemRequest": { "required": [ "declaracoes" ], "type": "object", "properties": { "declaracoes": { "type": "array", "items": { "$ref": "#/components/schemas/DeclaracaoImportacaoRequest" } }, "baseCalculoII": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "despesasAduaneiras": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "valorII": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "iof": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 } } }, "IntegracaoCancelamentoRequest": { "required": [ "referenciaExterna", "chaveAcesso", "justificativa" ], "type": "object", "properties": { "referenciaExterna": { "type": [ "null", "string" ] }, "chaveAcesso": { "type": "string" }, "justificativa": { "type": "string" } } }, "IntegracaoCceRequest": { "required": [ "referenciaExterna", "chaveAcesso", "correcao" ], "type": "object", "properties": { "referenciaExterna": { "type": [ "null", "string" ] }, "chaveAcesso": { "type": "string" }, "correcao": { "type": "string" } } }, "IntegracaoClienteRequest": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": [ "null", "string" ] }, "nomeFantasia": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "telefone": { "type": [ "null", "string" ] }, "inscricaoEstadual": { "type": [ "null", "string" ] }, "indicadorIe": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "tipoPessoa": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "endereco": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IntegracaoEnderecoRequest" } ] }, "paisCodigoBacen": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "IntegracaoDceCancelamentoRequest": { "required": [ "chaveAcesso", "justificativa" ], "type": "object", "properties": { "chaveAcesso": { "type": "string" }, "justificativa": { "type": "string" }, "referenciaExterna": { "type": [ "null", "string" ] } } }, "IntegracaoDceRequest": { "required": [ "cnpjEmitente", "tpEmit", "remetente", "destinatario", "itens" ], "type": "object", "properties": { "cnpjEmitente": { "type": "string" }, "tpEmit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "remetente": { "$ref": "#/components/schemas/PessoaDceRequest" }, "destinatario": { "$ref": "#/components/schemas/PessoaDceRequest" }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDceRequest" } }, "transporte": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TransporteDceRequest" } ] }, "plataforma": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlataformaDceRequest" } ] }, "infoComplementar": { "type": [ "null", "string" ] }, "referenciaExterna": { "type": [ "null", "string" ] }, "serie": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "IntegracaoEmissaoItem": { "required": [ "codigoProduto", "quantidade", "valorUnitario" ], "type": "object", "properties": { "codigoProduto": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "desconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pedidoCompra": { "type": [ "null", "string" ] }, "itemPedidoCompra": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "infoAdicional": { "type": [ "null", "string" ] }, "codigoBeneficioFiscal": { "type": [ "null", "string" ] }, "rastro": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/RastroRequest" } }, "devolucaoTributosPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "chaveReferenciada": { "type": [ "null", "string" ] }, "itemReferenciado": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "destinacao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "importacao": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ImportacaoItemRequest" } ] }, "exportacoes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DetExportRequest" } }, "combustivel": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CombustivelRequest" } ] }, "veiculo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VeiculoProdutoRequest" } ] }, "medicamento": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MedicamentoRequest" } ] }, "creditoZfm": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreditoZfmRequest" } ] } } }, "IntegracaoEmissaoRequest": { "required": [ "referenciaExterna", "cnpjEmitente", "cpfCnpjCliente", "codigoOperacao", "itens" ], "type": "object", "properties": { "referenciaExterna": { "type": [ "null", "string" ] }, "cnpjEmitente": { "type": "string" }, "cpfCnpjCliente": { "type": "string" }, "codigoOperacao": { "type": "string" }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/IntegracaoEmissaoItem" } }, "frete": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "seguro": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "outrasDespesas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pagamentos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PagamentoRequest" } }, "transporte": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TransporteRequest" } ] }, "cobranca": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CobrancaRequest" } ] }, "observacoes": { "type": [ "null", "string" ] }, "troco": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "chavesReferenciadas": { "type": [ "null", "array" ], "items": { "type": "string" } }, "autorizadosDownloadXml": { "type": [ "null", "array" ], "items": { "type": "string" } }, "localEntrega": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LocalRequest" } ] }, "localRetirada": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LocalRequest" } ] }, "exportacao": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ExportacaoRequest" } ] }, "intermediador": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IntermediadorRequest" } ] }, "codigoIndicadorOperacao": { "type": [ "null", "string" ] }, "indicadorPresenca": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "tipoImpressao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "serie": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "cliente": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IntegracaoClienteRequest" } ] } } }, "IntegracaoEnderecoRequest": { "required": [ "logradouro", "numero", "complemento", "bairro", "municipio", "uf", "cep" ], "type": "object", "properties": { "logradouro": { "type": [ "null", "string" ] }, "numero": { "type": [ "null", "string" ] }, "complemento": { "type": [ "null", "string" ] }, "bairro": { "type": [ "null", "string" ] }, "municipio": { "type": [ "null", "string" ] }, "uf": { "type": [ "null", "string" ] }, "cep": { "type": [ "null", "string" ] }, "codigoMunicipioIbge": { "type": [ "null", "string" ] } } }, "IntegracaoInutilizacaoRequest": { "required": [ "referenciaExterna", "cnpjEmitente", "serie", "numeroInicial", "numeroFinal", "justificativa" ], "type": "object", "properties": { "referenciaExterna": { "type": [ "null", "string" ] }, "cnpjEmitente": { "type": "string" }, "serie": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "numeroInicial": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "numeroFinal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "justificativa": { "type": "string" } } }, "IntegracaoNfseCancelamentoRequest": { "required": [ "chaveAcesso", "justificativa" ], "type": "object", "properties": { "chaveAcesso": { "type": "string" }, "justificativa": { "type": "string" }, "motivo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 }, "referenciaExterna": { "type": [ "null", "string" ] } } }, "IntegracaoNfseRequest": { "required": [ "cnpjEmitente", "valorServicos" ], "type": "object", "properties": { "cnpjEmitente": { "type": "string" }, "valorServicos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "referenciaExterna": { "type": [ "null", "string" ] }, "codigoServico": { "type": [ "null", "string" ] }, "cpfCnpjTomador": { "type": [ "null", "string" ] }, "tomador": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PessoaNfseRequest" } ] }, "intermediario": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PessoaNfseRequest" } ] }, "discriminacao": { "type": [ "null", "string" ] }, "codigoTributacaoNacional": { "type": [ "null", "string" ] }, "codigoTributacaoMunicipio": { "type": [ "null", "string" ] }, "aliquotaIss": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "tributacaoIssqn": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "retencaoIssqn": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "tipoImunidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "paisResultado": { "type": [ "null", "string" ] }, "codigoMunicipioPrestacao": { "type": [ "null", "string" ] }, "paisPrestacao": { "type": [ "null", "string" ] }, "descontoIncondicionado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "descontoCondicionado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "deducao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "aplicarRetencoesFederais": { "type": [ "null", "boolean" ] }, "competencia": { "type": [ "null", "string" ], "format": "date" }, "informacoesComplementares": { "type": [ "null", "string" ] }, "numeroPedido": { "type": [ "null", "string" ] }, "serie": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "evento": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AtividadeEventoNfseRequest" } ] }, "obra": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ObraNfseRequest" } ] } } }, "IntermediadorRequest": { "required": [ "cnpj", "idCadIntermediador" ], "type": "object", "properties": { "cnpj": { "type": "string" }, "idCadIntermediador": { "type": "string" } } }, "InutilizarRequest": { "required": [ "emitenteId", "serie", "numeroInicial", "numeroFinal", "justificativa" ], "type": "object", "properties": { "emitenteId": { "type": "string", "format": "uuid" }, "serie": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "numeroInicial": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "numeroFinal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "justificativa": { "type": "string" } } }, "ItemDceRequest": { "required": [ "descricao", "ncm", "quantidade", "valorUnitario" ], "type": "object", "properties": { "descricao": { "type": "string" }, "ncm": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorTotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "infoAdicional": { "type": [ "null", "string" ] } } }, "LocalRequest": { "required": [ "cpfCnpj", "endereco" ], "type": "object", "properties": { "cpfCnpj": { "type": "string" }, "endereco": { "$ref": "#/components/schemas/EnderecoDto" } } }, "MedicamentoRequest": { "required": [ "codigoAnvisa", "valorPmc" ], "type": "object", "properties": { "codigoAnvisa": { "type": "string" }, "valorPmc": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivoIsencao": { "type": [ "null", "string" ] } } }, "ObraNfseRequest": { "type": "object", "properties": { "inscricaoImobiliaria": { "type": [ "null", "string" ] }, "codigoObra": { "type": [ "null", "string" ] }, "codigoCib": { "type": [ "null", "string" ] }, "endereco": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EnderecoSimplesNfseRequest" } ] } } }, "PagamentoRequest": { "required": [ "forma", "valor" ], "type": "object", "properties": { "forma": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "aVista": { "type": "boolean", "default": true } } }, "PerfilRequest": { "required": [ "regime", "atividade", "uf", "aliquotaIcms", "naoCumulativo", "operacaoFiscalId" ], "type": "object", "properties": { "regime": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "atividade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "uf": { "type": [ "null", "string" ] }, "aliquotaIcms": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "naoCumulativo": { "type": [ "null", "boolean" ] }, "operacaoFiscalId": { "type": [ "null", "string" ], "format": "uuid" } } }, "PessoaDceRequest": { "required": [ "nome", "endereco" ], "type": "object", "properties": { "nome": { "type": "string" }, "endereco": { "$ref": "#/components/schemas/EnderecoDceRequest" }, "cnpj": { "type": [ "null", "string" ] }, "cpf": { "type": [ "null", "string" ] }, "idOutros": { "type": [ "null", "string" ] } } }, "PessoaNfseRequest": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": "string" }, "cpfCnpj": { "type": [ "null", "string" ] }, "nif": { "type": [ "null", "string" ] }, "inscricaoMunicipal": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "telefone": { "type": [ "null", "string" ] }, "endereco": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EnderecoNfseRequest" } ] } } }, "PlataformaDceRequest": { "required": [ "cnpj", "nome" ], "type": "object", "properties": { "cnpj": { "type": "string" }, "nome": { "type": "string" }, "site": { "type": [ "null", "string" ] }, "uf": { "type": [ "null", "string" ] } } }, "RastroRequest": { "required": [ "lote", "quantidade", "fabricacao", "validade" ], "type": "object", "properties": { "lote": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "fabricacao": { "type": "string", "format": "date" }, "validade": { "type": "string", "format": "date" }, "codigoAgregacao": { "type": [ "null", "string" ] } } }, "RecomendacaoImpostosRequest": { "required": [ "ncm", "regime", "ufOrigem", "ufDestino" ], "type": "object", "properties": { "ncm": { "type": [ "null", "string" ] }, "regime": { "type": [ "null", "string" ] }, "ufOrigem": { "type": [ "null", "string" ] }, "ufDestino": { "type": [ "null", "string" ] }, "clienteContribuinte": { "type": "boolean", "default": false }, "consumidorFinal": { "type": "boolean", "default": false }, "tipoOperacao": { "type": [ "null", "string" ], "default": "Saida" }, "origem": { "type": [ "null", "string" ] }, "codigoProdutoAnp": { "type": [ "null", "string" ] } } }, "RecuperarNfseRequest": { "required": [ "emitenteId", "serie", "numeroInicial", "numeroFinal" ], "type": "object", "properties": { "emitenteId": { "type": "string", "format": "uuid" }, "serie": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "numeroInicial": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "numeroFinal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "SalvarClienteRequest": { "required": [ "tipoPessoa", "cpfCnpj", "razaoSocial", "nomeFantasia", "inscricaoEstadual", "indicadorIe", "email", "telefone", "endereco", "codigo", "grupoClienteId" ], "type": "object", "properties": { "tipoPessoa": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cpfCnpj": { "type": "string" }, "razaoSocial": { "type": "string" }, "nomeFantasia": { "type": [ "null", "string" ] }, "inscricaoEstadual": { "type": [ "null", "string" ] }, "indicadorIe": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "email": { "type": [ "null", "string" ] }, "telefone": { "type": [ "null", "string" ] }, "endereco": { "$ref": "#/components/schemas/EnderecoDto" }, "codigo": { "type": [ "null", "string" ] }, "grupoClienteId": { "type": [ "null", "string" ], "format": "uuid" }, "paisCodigoBacen": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "paisNome": { "type": [ "null", "string" ] }, "idEstrangeiro": { "type": [ "null", "string" ] }, "inscricaoSuframa": { "type": [ "null", "string" ] }, "emitentes": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "SalvarEmbalagemRequest": { "required": [ "nome", "especie", "peso" ], "type": "object", "properties": { "nome": { "type": "string" }, "especie": { "type": [ "null", "string" ] }, "peso": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "SalvarEmitenteRequest": { "required": [ "razaoSocial", "nomeFantasia", "cnpj", "inscricaoEstadual", "inscricaoMunicipal", "cnae", "regimeTributario", "endereco", "telefone", "email", "ambientePadrao" ], "type": "object", "properties": { "razaoSocial": { "type": "string" }, "nomeFantasia": { "type": [ "null", "string" ] }, "cnpj": { "type": "string" }, "inscricaoEstadual": { "type": "string" }, "inscricaoMunicipal": { "type": [ "null", "string" ] }, "cnae": { "type": [ "null", "string" ] }, "regimeTributario": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "endereco": { "$ref": "#/components/schemas/EnderecoDto" }, "telefone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "ambientePadrao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "modoEmissao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 }, "contingenciaJustificativa": { "type": [ "null", "string" ] }, "padrao": { "type": "boolean", "default": false }, "usaRastreabilidade": { "type": "boolean", "default": false }, "usaImportacao": { "type": "boolean", "default": false }, "usaExportacao": { "type": "boolean", "default": false }, "usaIntermediador": { "type": "boolean", "default": false }, "usaCombustiveis": { "type": "boolean", "default": false }, "usaVeiculos": { "type": "boolean", "default": false }, "usaMedicamentos": { "type": "boolean", "default": false }, "usaZonaFrancaManaus": { "type": "boolean", "default": false }, "usaNfse": { "type": "boolean", "default": false }, "regimeEspecialTributacaoNfse": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 }, "padraoNfse": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 }, "identificadorMunicipioNfse": { "type": [ "null", "string" ] }, "regimeApuracaoSimplesNacionalNfse": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "percentualTributosSimplesNfse": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "percentualTributosFederaisNfse": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "percentualTributosEstaduaisNfse": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "percentualTributosMunicipaisNfse": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "SalvarGrupoNcmRequest": { "required": [ "codigo", "nome", "descricao", "ncms" ], "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "descricao": { "type": [ "null", "string" ] }, "ncms": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "SalvarGrupoRequest": { "required": [ "codigo", "nome", "descricao" ], "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "descricao": { "type": [ "null", "string" ] }, "ncmPadrao": { "type": [ "null", "string" ] }, "cestPadrao": { "type": [ "null", "string" ] } } }, "SalvarOperacaoFiscalRequest": { "required": [ "codigo", "descricao", "tipoOperacao", "finalidade", "consumidorFinal", "cfopDentroEstado", "cfopForaEstado" ], "type": "object", "properties": { "codigo": { "type": "string" }, "descricao": { "type": "string" }, "tipoOperacao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "finalidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "consumidorFinal": { "type": "boolean" }, "cfopDentroEstado": { "type": "string" }, "cfopForaEstado": { "type": "string" } } }, "SalvarProdutoRequest": { "required": [ "codigo", "descricao", "ncm", "cest", "unidadeComercial", "gtin", "valorUnitario", "origemMercadoria", "grupoProdutoId" ], "type": "object", "properties": { "codigo": { "type": "string" }, "descricao": { "type": "string" }, "ncm": { "type": "string" }, "cest": { "type": [ "null", "string" ] }, "unidadeComercial": { "type": "string" }, "gtin": { "type": [ "null", "string" ] }, "valorUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "origemMercadoria": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "grupoProdutoId": { "type": [ "null", "string" ], "format": "uuid" }, "peso": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "emitentes": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "SalvarRegraTributariaRequest": { "required": [ "tributo", "tipoOperacao", "grupoProdutoId", "grupoNcmId", "ncm", "produtoId", "ufOrigem", "ufDestino", "grupoClienteId", "clienteId", "regimeTributario", "consumidorFinal", "vigenciaInicio", "vigenciaFim", "prioridade", "cst", "csosn", "aliquota", "reducaoBasePercent", "reducaoBaseIpiPercent", "mva", "aliquotaInternaDestino", "aliquotaInterestadual", "fcp", "fcpSt", "cstReforma", "cClassTrib", "aliquotaIbsUf", "aliquotaIbsMunicipal", "aliquotaEspecifica" ], "type": "object", "properties": { "tributo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "tipoOperacao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "grupoProdutoId": { "type": [ "null", "string" ], "format": "uuid" }, "grupoNcmId": { "type": [ "null", "string" ], "format": "uuid" }, "ncm": { "type": [ "null", "string" ] }, "produtoId": { "type": [ "null", "string" ], "format": "uuid" }, "ufOrigem": { "type": [ "null", "string" ] }, "ufDestino": { "type": [ "null", "string" ] }, "grupoClienteId": { "type": [ "null", "string" ], "format": "uuid" }, "clienteId": { "type": [ "null", "string" ], "format": "uuid" }, "regimeTributario": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "consumidorFinal": { "type": [ "null", "boolean" ] }, "vigenciaInicio": { "type": "string", "format": "date" }, "vigenciaFim": { "type": [ "null", "string" ], "format": "date" }, "prioridade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cst": { "type": [ "null", "string" ] }, "csosn": { "type": [ "null", "string" ] }, "aliquota": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "reducaoBasePercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "reducaoBaseIpiPercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "mva": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "aliquotaInternaDestino": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "aliquotaInterestadual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "fcp": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "fcpSt": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "cstReforma": { "type": [ "null", "string" ] }, "cClassTrib": { "type": [ "null", "string" ] }, "aliquotaIbsUf": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "aliquotaIbsMunicipal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "aliquotaEspecifica": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "icmsDesonerado": { "type": [ "null", "boolean" ] }, "motivoDesoneracaoIcms": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "indDeduzDesoneracao": { "type": [ "null", "boolean" ] }, "usaBaseDupla": { "type": [ "null", "boolean" ] }, "aliquotaCreditoSn": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "percentualReducaoAdRem": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "motivoReducaoAdRem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "percentualDiferimentoMono": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "percentualDiferimento": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "emitenteId": { "type": [ "null", "string" ], "format": "uuid" }, "operacaoFiscalId": { "type": [ "null", "string" ], "format": "uuid" } } }, "SalvarSerieRequest": { "required": [ "emitenteId", "modelo", "numero", "descricao", "proximoNumero", "padrao" ], "type": "object", "properties": { "emitenteId": { "type": "string", "format": "uuid" }, "modelo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "numero": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "descricao": { "type": [ "null", "string" ] }, "proximoNumero": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "padrao": { "type": "boolean" } } }, "SalvarServicoPrestadoRequest": { "required": [ "codigo", "descricao", "itemListaServico" ], "type": "object", "properties": { "codigo": { "type": "string" }, "descricao": { "type": "string" }, "itemListaServico": { "type": "string" }, "codigoTributacaoNacional": { "type": [ "null", "string" ] }, "codigoTributacaoMunicipio": { "type": [ "null", "string" ] }, "codigoNbs": { "type": [ "null", "string" ] }, "cnae": { "type": [ "null", "string" ] }, "aliquotaIss": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "tributacaoIssqn": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 }, "tipoImunidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "retencaoIssqn": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 }, "valorPadrao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "aplicarRetencoesFederais": { "type": "boolean", "default": false }, "aliquotaPis": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0.65 }, "aliquotaCofins": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 3 }, "aliquotaIr": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 1.5 }, "aliquotaCsll": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 1 }, "aliquotaInss": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "ativo": { "type": "boolean", "default": true }, "emitentes": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "SalvarTransportadoraRequest": { "required": [ "cpfCnpj", "razaoSocial", "inscricaoEstadual", "endereco", "municipio", "uf" ], "type": "object", "properties": { "cpfCnpj": { "type": "string" }, "razaoSocial": { "type": "string" }, "inscricaoEstadual": { "type": [ "null", "string" ] }, "endereco": { "type": [ "null", "string" ] }, "municipio": { "type": [ "null", "string" ] }, "uf": { "type": [ "null", "string" ] }, "emitentes": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "SimularItemRequest": { "required": [ "produtoId", "quantidade", "valorUnitario" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "desconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "destinacao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "codigoAnp": { "type": [ "null", "string" ] } } }, "SimularRequest": { "required": [ "emitenteId", "clienteId", "operacaoId", "data", "itens" ], "type": "object", "properties": { "emitenteId": { "type": "string", "format": "uuid" }, "clienteId": { "type": "string", "format": "uuid" }, "operacaoId": { "type": "string", "format": "uuid" }, "data": { "type": [ "null", "string" ], "format": "date" }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/SimularItemRequest" } }, "frete": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "seguro": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "outrasDespesas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "SugerirNcmRequest": { "required": [ "descricao" ], "type": "object", "properties": { "descricao": { "type": [ "null", "string" ] } } }, "TransportadoraRequest": { "required": [ "cnpjCpf", "nome", "inscricaoEstadual", "endereco", "municipio", "uf" ], "type": "object", "properties": { "cnpjCpf": { "type": [ "null", "string" ] }, "nome": { "type": [ "null", "string" ] }, "inscricaoEstadual": { "type": [ "null", "string" ] }, "endereco": { "type": [ "null", "string" ] }, "municipio": { "type": [ "null", "string" ] }, "uf": { "type": [ "null", "string" ] } } }, "TransporteDceRequest": { "required": [ "modalidade" ], "type": "object", "properties": { "modalidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "cnpjTransportadora": { "type": [ "null", "string" ] } } }, "TransporteRequest": { "type": "object", "properties": { "modFrete": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 9 }, "transportadora": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TransportadoraRequest" } ] }, "volumes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/VolumeRequest" } }, "veiculo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VeiculoTransporteRequest" } ] } } }, "VeiculoProdutoRequest": { "required": [ "chassi" ], "type": "object", "properties": { "chassi": { "type": "string" }, "codigoCor": { "type": [ "null", "string" ] }, "descricaoCor": { "type": [ "null", "string" ] }, "potencia": { "type": [ "null", "string" ] }, "cilindradas": { "type": [ "null", "string" ] }, "pesoLiquido": { "type": [ "null", "string" ] }, "pesoBruto": { "type": [ "null", "string" ] }, "numeroSerie": { "type": [ "null", "string" ] }, "tipoCombustivel": { "type": [ "null", "string" ] }, "numeroMotor": { "type": [ "null", "string" ] }, "capacidadeMaximaTracao": { "type": [ "null", "string" ] }, "distancia": { "type": [ "null", "string" ] }, "anoModelo": { "type": [ "null", "string" ] }, "anoFabricacao": { "type": [ "null", "string" ] }, "tipoPintura": { "type": [ "null", "string" ] }, "tipoVeiculo": { "type": [ "null", "string" ] }, "especieVeiculo": { "type": [ "null", "string" ] }, "condicaoVin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "condicaoVeiculo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "codigoMarcaModelo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "corDenatran": { "type": [ "null", "string" ] }, "lotacao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "tipoRestricao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "tipoOperacao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "VeiculoTransporteRequest": { "required": [ "placa" ], "type": "object", "properties": { "placa": { "type": "string" }, "uf": { "type": [ "null", "string" ] }, "rntc": { "type": [ "null", "string" ] } } }, "VolumeItemRequest": { "required": [ "produtoId", "quantidade" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "VolumeRequest": { "required": [ "quantidade", "especie", "marca", "numeracao", "pesoLiquido", "pesoBruto" ], "type": "object", "properties": { "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "especie": { "type": [ "null", "string" ] }, "marca": { "type": [ "null", "string" ] }, "numeracao": { "type": [ "null", "string" ] }, "pesoLiquido": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pesoBruto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "embalagemId": { "type": [ "null", "string" ], "format": "uuid" }, "itens": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/VolumeItemRequest" } } } }, "WebhookConfigRequest": { "required": [ "url", "segredo" ], "type": "object", "properties": { "url": { "type": [ "null", "string" ] }, "segredo": { "type": [ "null", "string" ] } } } } }, "tags": [ { "name": "API de integração", "description": "Contrato estável para sistemas integrados (ERP, e-commerce): cadastros por upsert, emissão e eventos assíncronos com webhook, downloads por chave. Autenticação pela chave de API no header `X-Api-Key`. Guia em [/devs](/devs)." }, { "name": "Portal (uso interno)", "description": "Rotas que a interface web do portal usa com o cookie da sessão. Documentadas por transparência: não fazem parte do contrato de integração e podem mudar sem aviso." }, { "name": "Autenticação", "description": "Login (Google, Microsoft ou código por e-mail) e logout do portal." }, { "name": "Webhooks", "description": "Eventos recebidos de parceiros (ex.: Stripe). Não são chamados por integradores." }, { "name": "Páginas públicas e saúde", "description": "Central de ajuda, documentação, termos, página de status e verificação de saúde." } ] }