diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dbc223f..3fadd2f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -127,6 +127,9 @@ jobs: openapi-validation: name: OpenAPI Validation runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write steps: - name: Checkout code diff --git a/CHANGELOG.md b/CHANGELOG.md index a21175f..210b913 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,59 @@ Todas as mudanças notáveis neste projeto serão documentadas neste arquivo. O formato é baseado em [Keep a Changelog](https://keepachangelog.com/pt-BR/1.0.0/), e este projeto adere ao [Versionamento Semântico](https://semver.org/lang/pt-BR/). +## [3.2.0] - 2026-04-25 + +### 🔒 Correções de Segurança + +Atualização de dependências de desenvolvimento para resolver vulnerabilidades reportadas pelo `npm audit`. **Nenhuma alteração no comportamento em runtime** — todas as vulnerabilidades estavam em ferramentas de build/teste, não distribuídas no pacote publicado. + +- **Resolvidas 14 vulnerabilidades** (7 high, 7 moderate) em devDependencies: + - `undici` (alto): GHSA-g9mf-h72j-4rw9, GHSA-2mjp-6q6p-2qxm, GHSA-vrm6-8vpv-qv8q, GHSA-v9p9-hfj2-hcw8, GHSA-4992-7rv2-5pvq (via `openapi-typescript`) + - `minimatch` (alto): GHSA-3ppc-4f35-3m26, GHSA-7r86-cg39-jmmj, GHSA-23c5-xmqv-rm74 (via `@typescript-eslint`) + - `esbuild` (moderado): GHSA-67mh-4wv8-2f99 (via `vitest`) +- **Resultado**: `npm audit` agora reporta **0 vulnerabilidades** + +### 🔧 Atualizações de Dependências (devDependencies) + +- `@typescript-eslint/eslint-plugin`: `^6.21.0` → `^8.59.0` +- `@typescript-eslint/parser`: `^6.21.0` → `^8.59.0` +- `vitest`: `^1.6.1` → `^3.2.4` +- `@vitest/coverage-v8`: `^1.6.1` → `^3.2.4` +- `@vitest/ui`: `^1.6.1` → `^3.2.4` +- `openapi-typescript`: `^6.7.0` → `^7.13.0` + +> **Nota**: Vitest foi atualizado para 3.2.4 (não 4.x) para manter compatibilidade com Node 18 — vitest 4 depende do `rolldown`, que requer Node 20+. O esbuild patcheado já está disponível na linha 3.x via Vite. + +### 🛠️ Pipeline de Geração de Tipos + +Adaptação do script `scripts/generate-types.ts` para a nova API do `openapi-typescript` v7: + +- Migração para nova assinatura: `openapiTS()` agora retorna AST e usa `astToString()` para conversão +- Input convertido para `URL` via `pathToFileURL` (exigência do v7) +- Opção `immutableTypes` renomeada para `immutable`; opção `exportType` removida (agora é padrão) +- Adicionada configuração Redocly (`createConfig`) para tolerar specs legados que falhariam na validação estrita do v7 + +### 🧪 Testes + +Ajustes em testes (nenhum teste foi adicionado/removido): + +- 30 chamadas em testes de integração migradas da assinatura `it(name, fn, opts)` para a nova `it(name, opts, fn)` (compatível com vitest 3.x e futura migração para 4.x) +- Mock de `FormData` em `tests/unit/companies.test.ts` ajustado para usar `function` ao invés de arrow function (boa prática de mock de construtor) +- **606 testes passando**, 47 skipped (mesma cobertura de antes), validados em Node 18, 20 e 22 + +### 📝 Spec OpenAPI + +- **`openapi/spec/nf-servico-v1.yaml`**: `operationId` do endpoint `GET /v1/companies/{company_id}/serviceinvoices/external/{id}` renomeado de `ServiceInvoices_idGet` para `ServiceInvoices_externalIdGet`. Resolve duplicata real no spec — `openapi-typescript` v6 silenciosamente fundia as duas operações distintas em uma só. Esta mudança é apenas em metadata de geração de código, **não afeta o comportamento da API**. + +### ⚠️ Possível Impacto em Tipos Gerados + +Usuários que referenciam tipos gerados internos (ex.: `operations["ServiceInvoices_idGet"]` em `src/generated/`) podem precisar de pequenos ajustes: + +- Para o endpoint `/serviceinvoices/external/{id}`: usar `operations["ServiceInvoices_externalIdGet"]` (anteriormente fundido com `ServiceInvoices_idGet`) +- A maioria dos consumidores que usa apenas `NfeClient` e seus métodos públicos **não é afetada** + +--- + ## [3.1.0] - 2026-02-22 ### 🎉 Expansão Massiva de Recursos - 10 Novos Recursos Implementados diff --git a/VERSION b/VERSION index fd2a018..944880f 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -3.1.0 +3.2.0 diff --git a/openapi/spec/nf-servico-v1.yaml b/openapi/spec/nf-servico-v1.yaml index a4a8534..ed59a13 100644 --- a/openapi/spec/nf-servico-v1.yaml +++ b/openapi/spec/nf-servico-v1.yaml @@ -4063,7 +4063,7 @@ paths: - ServiceInvoices summary: Obter os detalhes de uma Nota Fiscal de Serviço (NFSE) através do ID externo (externalId) description: Você precisará do API Key da Empresa - operationId: ServiceInvoices_idGet + operationId: ServiceInvoices_externalIdGet parameters: - name: company_id in: path diff --git a/package-lock.json b/package-lock.json index ae95745..ad74f5b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,31 +1,31 @@ { "name": "nfe-io", - "version": "v3.0.2", + "version": "v3.2.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "nfe-io", - "version": "v3.0.2", + "version": "v3.2.0", "license": "MIT", "devDependencies": { "@types/node": "^20.10.0", - "@typescript-eslint/eslint-plugin": "^6.13.0", - "@typescript-eslint/parser": "^6.13.0", - "@vitest/coverage-v8": "^1.0.0", - "@vitest/ui": "^1.0.0", + "@typescript-eslint/eslint-plugin": "^8.59.0", + "@typescript-eslint/parser": "^8.59.0", + "@vitest/coverage-v8": "^3.2.4", + "@vitest/ui": "^3.2.4", "dotenv": "~17.2.3", - "eslint": "^8.56.0", + "eslint": "^8.57.1", "eslint-config-prettier": "^9.1.0", "eslint-plugin-prettier": "^5.1.0", - "openapi-typescript": "^6.7.0", + "openapi-typescript": "^7.13.0", "prettier": "^3.2.0", - "rimraf": "^5.0.0", - "tsup": "^8.0.0", + "rimraf": "^5.0.10", + "tsup": "^8.5.0", "tsx": "^4.7.0", - "typedoc": "^0.25.0", + "typedoc": "^0.25.13", "typescript": "^5.3.0", - "vitest": "^1.0.0", + "vitest": "^3.2.4", "yaml": "^2.3.4" }, "engines": { @@ -46,6 +46,28 @@ "node": ">=6.0.0" } }, + "node_modules/@babel/code-frame": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", + "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.28.5", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/code-frame/node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true, + "license": "MIT" + }, "node_modules/@babel/helper-string-parser": { "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", @@ -67,13 +89,13 @@ } }, "node_modules/@babel/parser": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.28.5.tgz", - "integrity": "sha512-KKBU1VGYR7ORr3At5HAtUQ+TV3SzRCXmA/8OdDZiLDBIZxVyzXuztPjfLd3BV1PRAQGCMWWSHYhL0F8d5uHBDQ==", + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.2.tgz", + "integrity": "sha512-4GgRzy/+fsBa72/RZVJmGKPmZu9Byn8o4MoLpmNe1m8ZfYnz5emHLQz3U4gLud6Zwl0RZIcgiLD7Uq7ySFuDLA==", "dev": true, "license": "MIT", "dependencies": { - "@babel/types": "^7.28.5" + "@babel/types": "^7.29.0" }, "bin": { "parser": "bin/babel-parser.js" @@ -83,9 +105,9 @@ } }, "node_modules/@babel/types": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.28.5.tgz", - "integrity": "sha512-qQ5m48eI/MFLQ5PxQj4PFaprjyCTLI37ElWMmNs0K8Lk3dVeOdNpB3ks8jc7yM5CDmVC73eMVk/trk3fgmrUpA==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.0.tgz", + "integrity": "sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A==", "dev": true, "license": "MIT", "dependencies": { @@ -97,16 +119,19 @@ } }, "node_modules/@bcoe/v8-coverage": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz", - "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-1.0.2.tgz", + "integrity": "sha512-6zABk/ECA/QYSCQ1NGiVwwbQerUCZ+TQbp64Q3AgmfNvurHH0j8TtXa1qbShXA6qqkpAj4V5W8pP6mLe1mcMqA==", "dev": true, - "license": "MIT" + "license": "MIT", + "engines": { + "node": ">=18" + } }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.12.tgz", - "integrity": "sha512-Hhmwd6CInZ3dwpuGTF8fJG6yoWmsToE+vYgD4nytZVxcu1ulHpUQRAB1UJ8+N1Am3Mz4+xOByoQoSZf4D+CpkA==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.7.tgz", + "integrity": "sha512-EKX3Qwmhz1eMdEJokhALr0YiD0lhQNwDqkPYyPhiSwKrh7/4KRjQc04sZ8db+5DVVnZ1LmbNDI1uAMPEUBnQPg==", "cpu": [ "ppc64" ], @@ -121,9 +146,9 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.12.tgz", - "integrity": "sha512-VJ+sKvNA/GE7Ccacc9Cha7bpS8nyzVv0jdVgwNDaR4gDMC/2TTRc33Ip8qrNYUcpkOHUT5OZ0bUcNNVZQ9RLlg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.7.tgz", + "integrity": "sha512-jbPXvB4Yj2yBV7HUfE2KHe4GJX51QplCN1pGbYjvsyCZbQmies29EoJbkEc+vYuU5o45AfQn37vZlyXy4YJ8RQ==", "cpu": [ "arm" ], @@ -138,9 +163,9 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.12.tgz", - "integrity": "sha512-6AAmLG7zwD1Z159jCKPvAxZd4y/VTO0VkprYy+3N2FtJ8+BQWFXU+OxARIwA46c5tdD9SsKGZ/1ocqBS/gAKHg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.7.tgz", + "integrity": "sha512-62dPZHpIXzvChfvfLJow3q5dDtiNMkwiRzPylSCfriLvZeq0a1bWChrGx/BbUbPwOrsWKMn8idSllklzBy+dgQ==", "cpu": [ "arm64" ], @@ -155,9 +180,9 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.12.tgz", - "integrity": "sha512-5jbb+2hhDHx5phYR2By8GTWEzn6I9UqR11Kwf22iKbNpYrsmRB18aX/9ivc5cabcUiAT/wM+YIZ6SG9QO6a8kg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.7.tgz", + "integrity": "sha512-x5VpMODneVDb70PYV2VQOmIUUiBtY3D3mPBG8NxVk5CogneYhkR7MmM3yR/uMdITLrC1ml/NV1rj4bMJuy9MCg==", "cpu": [ "x64" ], @@ -172,9 +197,9 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.12.tgz", - "integrity": "sha512-N3zl+lxHCifgIlcMUP5016ESkeQjLj/959RxxNYIthIg+CQHInujFuXeWbWMgnTo4cp5XVHqFPmpyu9J65C1Yg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.7.tgz", + "integrity": "sha512-5lckdqeuBPlKUwvoCXIgI2D9/ABmPq3Rdp7IfL70393YgaASt7tbju3Ac+ePVi3KDH6N2RqePfHnXkaDtY9fkw==", "cpu": [ "arm64" ], @@ -189,9 +214,9 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.12.tgz", - "integrity": "sha512-HQ9ka4Kx21qHXwtlTUVbKJOAnmG1ipXhdWTmNXiPzPfWKpXqASVcWdnf2bnL73wgjNrFXAa3yYvBSd9pzfEIpA==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.7.tgz", + "integrity": "sha512-rYnXrKcXuT7Z+WL5K980jVFdvVKhCHhUwid+dDYQpH+qu+TefcomiMAJpIiC2EM3Rjtq0sO3StMV/+3w3MyyqQ==", "cpu": [ "x64" ], @@ -206,9 +231,9 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.12.tgz", - "integrity": "sha512-gA0Bx759+7Jve03K1S0vkOu5Lg/85dou3EseOGUes8flVOGxbhDDh/iZaoek11Y8mtyKPGF3vP8XhnkDEAmzeg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.7.tgz", + "integrity": "sha512-B48PqeCsEgOtzME2GbNM2roU29AMTuOIN91dsMO30t+Ydis3z/3Ngoj5hhnsOSSwNzS+6JppqWsuhTp6E82l2w==", "cpu": [ "arm64" ], @@ -223,9 +248,9 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.12.tgz", - "integrity": "sha512-TGbO26Yw2xsHzxtbVFGEXBFH0FRAP7gtcPE7P5yP7wGy7cXK2oO7RyOhL5NLiqTlBh47XhmIUXuGciXEqYFfBQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.7.tgz", + "integrity": "sha512-jOBDK5XEjA4m5IJK3bpAQF9/Lelu/Z9ZcdhTRLf4cajlB+8VEhFFRjWgfy3M1O4rO2GQ/b2dLwCUGpiF/eATNQ==", "cpu": [ "x64" ], @@ -240,9 +265,9 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.12.tgz", - "integrity": "sha512-lPDGyC1JPDou8kGcywY0YILzWlhhnRjdof3UlcoqYmS9El818LLfJJc3PXXgZHrHCAKs/Z2SeZtDJr5MrkxtOw==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.7.tgz", + "integrity": "sha512-RkT/YXYBTSULo3+af8Ib0ykH8u2MBh57o7q/DAs3lTJlyVQkgQvlrPTnjIzzRPQyavxtPtfg0EopvDyIt0j1rA==", "cpu": [ "arm" ], @@ -257,9 +282,9 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.12.tgz", - "integrity": "sha512-8bwX7a8FghIgrupcxb4aUmYDLp8pX06rGh5HqDT7bB+8Rdells6mHvrFHHW2JAOPZUbnjUpKTLg6ECyzvas2AQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.7.tgz", + "integrity": "sha512-RZPHBoxXuNnPQO9rvjh5jdkRmVizktkT7TCDkDmQ0W2SwHInKCAV95GRuvdSvA7w4VMwfCjUiPwDi0ZO6Nfe9A==", "cpu": [ "arm64" ], @@ -274,9 +299,9 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.12.tgz", - "integrity": "sha512-0y9KrdVnbMM2/vG8KfU0byhUN+EFCny9+8g202gYqSSVMonbsCfLjUO+rCci7pM0WBEtz+oK/PIwHkzxkyharA==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.7.tgz", + "integrity": "sha512-GA48aKNkyQDbd3KtkplYWT102C5sn/EZTY4XROkxONgruHPU72l+gW+FfF8tf2cFjeHaRbWpOYa/uRBz/Xq1Pg==", "cpu": [ "ia32" ], @@ -291,9 +316,9 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.12.tgz", - "integrity": "sha512-h///Lr5a9rib/v1GGqXVGzjL4TMvVTv+s1DPoxQdz7l/AYv6LDSxdIwzxkrPW438oUXiDtwM10o9PmwS/6Z0Ng==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.7.tgz", + "integrity": "sha512-a4POruNM2oWsD4WKvBSEKGIiWQF8fZOAsycHOt6JBpZ+JN2n2JH9WAv56SOyu9X5IqAjqSIPTaJkqN8F7XOQ5Q==", "cpu": [ "loong64" ], @@ -308,9 +333,9 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.12.tgz", - "integrity": "sha512-iyRrM1Pzy9GFMDLsXn1iHUm18nhKnNMWscjmp4+hpafcZjrr2WbT//d20xaGljXDBYHqRcl8HnxbX6uaA/eGVw==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.7.tgz", + "integrity": "sha512-KabT5I6StirGfIz0FMgl1I+R1H73Gp0ofL9A3nG3i/cYFJzKHhouBV5VWK1CSgKvVaG4q1RNpCTR2LuTVB3fIw==", "cpu": [ "mips64el" ], @@ -325,9 +350,9 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.12.tgz", - "integrity": "sha512-9meM/lRXxMi5PSUqEXRCtVjEZBGwB7P/D4yT8UG/mwIdze2aV4Vo6U5gD3+RsoHXKkHCfSxZKzmDssVlRj1QQA==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.7.tgz", + "integrity": "sha512-gRsL4x6wsGHGRqhtI+ifpN/vpOFTQtnbsupUF5R5YTAg+y/lKelYR1hXbnBdzDjGbMYjVJLJTd2OFmMewAgwlQ==", "cpu": [ "ppc64" ], @@ -342,9 +367,9 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.12.tgz", - "integrity": "sha512-Zr7KR4hgKUpWAwb1f3o5ygT04MzqVrGEGXGLnj15YQDJErYu/BGg+wmFlIDOdJp0PmB0lLvxFIOXZgFRrdjR0w==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.7.tgz", + "integrity": "sha512-hL25LbxO1QOngGzu2U5xeXtxXcW+/GvMN3ejANqXkxZ/opySAZMrc+9LY/WyjAan41unrR3YrmtTsUpwT66InQ==", "cpu": [ "riscv64" ], @@ -359,9 +384,9 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.12.tgz", - "integrity": "sha512-MsKncOcgTNvdtiISc/jZs/Zf8d0cl/t3gYWX8J9ubBnVOwlk65UIEEvgBORTiljloIWnBzLs4qhzPkJcitIzIg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.7.tgz", + "integrity": "sha512-2k8go8Ycu1Kb46vEelhu1vqEP+UeRVj2zY1pSuPdgvbd5ykAw82Lrro28vXUrRmzEsUV0NzCf54yARIK8r0fdw==", "cpu": [ "s390x" ], @@ -376,9 +401,9 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.12.tgz", - "integrity": "sha512-uqZMTLr/zR/ed4jIGnwSLkaHmPjOjJvnm6TVVitAa08SLS9Z0VM8wIRx7gWbJB5/J54YuIMInDquWyYvQLZkgw==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.7.tgz", + "integrity": "sha512-hzznmADPt+OmsYzw1EE33ccA+HPdIqiCRq7cQeL1Jlq2gb1+OyWBkMCrYGBJ+sxVzve2ZJEVeePbLM2iEIZSxA==", "cpu": [ "x64" ], @@ -393,9 +418,9 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.12.tgz", - "integrity": "sha512-xXwcTq4GhRM7J9A8Gv5boanHhRa/Q9KLVmcyXHCTaM4wKfIpWkdXiMog/KsnxzJ0A1+nD+zoecuzqPmCRyBGjg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.7.tgz", + "integrity": "sha512-b6pqtrQdigZBwZxAn1UpazEisvwaIDvdbMbmrly7cDTMFnw/+3lVxxCTGOrkPVnsYIosJJXAsILG9XcQS+Yu6w==", "cpu": [ "arm64" ], @@ -410,9 +435,9 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.12.tgz", - "integrity": "sha512-Ld5pTlzPy3YwGec4OuHh1aCVCRvOXdH8DgRjfDy/oumVovmuSzWfnSJg+VtakB9Cm0gxNO9BzWkj6mtO1FMXkQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.7.tgz", + "integrity": "sha512-OfatkLojr6U+WN5EDYuoQhtM+1xco+/6FSzJJnuWiUw5eVcicbyK3dq5EeV/QHT1uy6GoDhGbFpprUiHUYggrw==", "cpu": [ "x64" ], @@ -427,9 +452,9 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.12.tgz", - "integrity": "sha512-fF96T6KsBo/pkQI950FARU9apGNTSlZGsv1jZBAlcLL1MLjLNIWPBkj5NlSz8aAzYKg+eNqknrUJ24QBybeR5A==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.7.tgz", + "integrity": "sha512-AFuojMQTxAz75Fo8idVcqoQWEHIXFRbOc1TrVcFSgCZtQfSdc1RXgB3tjOn/krRHENUB4j00bfGjyl2mJrU37A==", "cpu": [ "arm64" ], @@ -444,9 +469,9 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.12.tgz", - "integrity": "sha512-MZyXUkZHjQxUvzK7rN8DJ3SRmrVrke8ZyRusHlP+kuwqTcfWLyqMOE3sScPPyeIXN/mDJIfGXvcMqCgYKekoQw==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.7.tgz", + "integrity": "sha512-+A1NJmfM8WNDv5CLVQYJ5PshuRm/4cI6WMZRg1by1GwPIQPCTs1GLEUHwiiQGT5zDdyLiRM/l1G0Pv54gvtKIg==", "cpu": [ "x64" ], @@ -461,9 +486,9 @@ } }, "node_modules/@esbuild/openharmony-arm64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.25.12.tgz", - "integrity": "sha512-rm0YWsqUSRrjncSXGA7Zv78Nbnw4XL6/dzr20cyrQf7ZmRcsovpcRBdhD43Nuk3y7XIoW2OxMVvwuRvk9XdASg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.7.tgz", + "integrity": "sha512-+KrvYb/C8zA9CU/g0sR6w2RBw7IGc5J2BPnc3dYc5VJxHCSF1yNMxTV5LQ7GuKteQXZtspjFbiuW5/dOj7H4Yw==", "cpu": [ "arm64" ], @@ -478,9 +503,9 @@ } }, "node_modules/@esbuild/sunos-x64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.12.tgz", - "integrity": "sha512-3wGSCDyuTHQUzt0nV7bocDy72r2lI33QL3gkDNGkod22EsYl04sMf0qLb8luNKTOmgF/eDEDP5BFNwoBKH441w==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.7.tgz", + "integrity": "sha512-ikktIhFBzQNt/QDyOL580ti9+5mL/YZeUPKU2ivGtGjdTYoqz6jObj6nOMfhASpS4GU4Q/Clh1QtxWAvcYKamA==", "cpu": [ "x64" ], @@ -495,9 +520,9 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.12.tgz", - "integrity": "sha512-rMmLrur64A7+DKlnSuwqUdRKyd3UE7oPJZmnljqEptesKM8wx9J8gx5u0+9Pq0fQQW8vqeKebwNXdfOyP+8Bsg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.7.tgz", + "integrity": "sha512-7yRhbHvPqSpRUV7Q20VuDwbjW5kIMwTHpptuUzV+AA46kiPze5Z7qgt6CLCK3pWFrHeNfDd1VKgyP4O+ng17CA==", "cpu": [ "arm64" ], @@ -512,9 +537,9 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.12.tgz", - "integrity": "sha512-HkqnmmBoCbCwxUKKNPBixiWDGCpQGVsrQfJoVGYLPT41XWF8lHuE5N6WhVia2n4o5QK5M4tYr21827fNhi4byQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.7.tgz", + "integrity": "sha512-SmwKXe6VHIyZYbBLJrhOoCJRB/Z1tckzmgTLfFYOfpMAx63BJEaL9ExI8x7v0oAO3Zh6D/Oi1gVxEYr5oUCFhw==", "cpu": [ "ia32" ], @@ -529,9 +554,9 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.12.tgz", - "integrity": "sha512-alJC0uCZpTFrSL0CCDjcgleBXPnCrEAhTBILpeAp7M/OFgoqtAetfBzX0xM00MUsVVPpVjlPuMbREqnZCXaTnA==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.7.tgz", + "integrity": "sha512-56hiAJPhwQ1R4i+21FVF7V8kSD5zZTdHcVuRFMW0hn753vVfQN8xlx4uOPT4xoGH0Z/oVATuR82AiqSTDIpaHg==", "cpu": [ "x64" ], @@ -546,9 +571,9 @@ } }, "node_modules/@eslint-community/eslint-utils": { - "version": "4.9.0", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.9.0.tgz", - "integrity": "sha512-ayVFHdtZ+hsq1t2Dy24wCmGXGe4q9Gu3smhLYALJrr473ZH27MsnSL+LKUlimp4BWJqMDMLmPpx/Q9R3OAlL4g==", + "version": "4.9.1", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.9.1.tgz", + "integrity": "sha512-phrYmNiYppR7znFEdqgfWHXR6NCkZEK7hwWDHZUjit/2/U0r6XvkDl0SYnoM51Hq7FhCGdLDT6zxCCOY1hexsQ==", "dev": true, "license": "MIT", "dependencies": { @@ -599,9 +624,9 @@ } }, "node_modules/@eslint/eslintrc/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "version": "1.1.14", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.14.tgz", + "integrity": "sha512-MWPGfDxnyzKU7rNOW9SP/c50vi3xrmrua/+6hfPbCS2ABNWfx24vPidzvC7krjU/RTo235sV776ymlsMtGKj8g==", "dev": true, "license": "MIT", "dependencies": { @@ -610,9 +635,9 @@ } }, "node_modules/@eslint/eslintrc/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, "license": "ISC", "dependencies": { @@ -632,16 +657,6 @@ "node": "^12.22.0 || ^14.17.0 || >=16.0.0" } }, - "node_modules/@fastify/busboy": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.1.1.tgz", - "integrity": "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - } - }, "node_modules/@humanwhocodes/config-array": { "version": "0.13.0", "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.13.0.tgz", @@ -659,9 +674,9 @@ } }, "node_modules/@humanwhocodes/config-array/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "version": "1.1.14", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.14.tgz", + "integrity": "sha512-MWPGfDxnyzKU7rNOW9SP/c50vi3xrmrua/+6hfPbCS2ABNWfx24vPidzvC7krjU/RTo235sV776ymlsMtGKj8g==", "dev": true, "license": "MIT", "dependencies": { @@ -670,9 +685,9 @@ } }, "node_modules/@humanwhocodes/config-array/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, "license": "ISC", "dependencies": { @@ -736,13 +751,13 @@ } }, "node_modules/@isaacs/cliui/node_modules/strip-ansi": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", - "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", + "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", "dev": true, "license": "MIT", "dependencies": { - "ansi-regex": "^6.0.1" + "ansi-regex": "^6.2.2" }, "engines": { "node": ">=12" @@ -752,28 +767,15 @@ } }, "node_modules/@istanbuljs/schema": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz", - "integrity": "sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA==", + "version": "0.1.6", + "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.6.tgz", + "integrity": "sha512-+Sg6GCR/wy1oSmQDFq4LQDAhm3ETKnorxN+y5nbLULOR3P0c14f2Wurzj3/xqPXtasLFfHd5iRFQ7AJt4KH2cw==", "dev": true, "license": "MIT", "engines": { "node": ">=8" } }, - "node_modules/@jest/schemas": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz", - "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@sinclair/typebox": "^0.27.8" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, "node_modules/@jridgewell/gen-mapping": { "version": "0.3.13", "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz", @@ -882,10 +884,76 @@ "dev": true, "license": "MIT" }, + "node_modules/@redocly/ajv": { + "version": "8.11.2", + "resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.11.2.tgz", + "integrity": "sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js-replace": "^1.0.1" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/@redocly/ajv/node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true, + "license": "MIT" + }, + "node_modules/@redocly/config": { + "version": "0.22.0", + "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.22.0.tgz", + "integrity": "sha512-gAy93Ddo01Z3bHuVdPWfCwzgfaYgMdaZPcfL7JZ7hWJoK9V0lXDbigTWkhiPFAaLWzbOJ+kbUQG1+XwIm0KRGQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@redocly/openapi-core": { + "version": "1.34.12", + "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.34.12.tgz", + "integrity": "sha512-b32XWsz6enN6K4bx8xWsqUaXTJR/DnYT3lL1CzDYzIYKw243NNlz6fexmr71q/U4HrEcMoJGBvwAfcxOb8ymQw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@redocly/ajv": "8.11.2", + "@redocly/config": "0.22.0", + "colorette": "1.4.0", + "https-proxy-agent": "7.0.6", + "js-levenshtein": "1.1.6", + "js-yaml": "4.1.1", + "minimatch": "5.1.9", + "pluralize": "8.0.0", + "yaml-ast-parser": "0.0.43" + }, + "engines": { + "node": ">=18.17.0", + "npm": ">=9.5.0" + } + }, + "node_modules/@redocly/openapi-core/node_modules/minimatch": { + "version": "5.1.9", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.9.tgz", + "integrity": "sha512-7o1wEA2RyMP7Iu7GNba9vc0RWWGACJOCZBJX2GJWip0ikV+wcOsgVuY9uE8CPiyQhkGFSlhuSkZPavN7u1c2Fw==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.53.2.tgz", - "integrity": "sha512-yDPzwsgiFO26RJA4nZo8I+xqzh7sJTZIWQOxn+/XOdPE31lAvLIYCKqjV+lNH/vxE2L2iH3plKxDCRK6i+CwhA==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.60.2.tgz", + "integrity": "sha512-dnlp69efPPg6Uaw2dVqzWRfAWRnYVb1XJ8CyyhIbZeaq4CA5/mLeZ1IEt9QqQxmbdvagjLIm2ZL8BxXv5lH4Yw==", "cpu": [ "arm" ], @@ -897,9 +965,9 @@ ] }, "node_modules/@rollup/rollup-android-arm64": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.53.2.tgz", - "integrity": "sha512-k8FontTxIE7b0/OGKeSN5B6j25EuppBcWM33Z19JoVT7UTXFSo3D9CdU39wGTeb29NO3XxpMNauh09B+Ibw+9g==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.60.2.tgz", + "integrity": "sha512-OqZTwDRDchGRHHm/hwLOL7uVPB9aUvI0am/eQuWMNyFHf5PSEQmyEeYYheA0EPPKUO/l0uigCp+iaTjoLjVoHg==", "cpu": [ "arm64" ], @@ -911,9 +979,9 @@ ] }, "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.53.2.tgz", - "integrity": "sha512-A6s4gJpomNBtJ2yioj8bflM2oogDwzUiMl2yNJ2v9E7++sHrSrsQ29fOfn5DM/iCzpWcebNYEdXpaK4tr2RhfQ==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.60.2.tgz", + "integrity": "sha512-UwRE7CGpvSVEQS8gUMBe1uADWjNnVgP3Iusyda1nSRwNDCsRjnGc7w6El6WLQsXmZTbLZx9cecegumcitNfpmA==", "cpu": [ "arm64" ], @@ -925,9 +993,9 @@ ] }, "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.53.2.tgz", - "integrity": "sha512-e6XqVmXlHrBlG56obu9gDRPW3O3hLxpwHpLsBJvuI8qqnsrtSZ9ERoWUXtPOkY8c78WghyPHZdmPhHLWNdAGEw==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.60.2.tgz", + "integrity": "sha512-gjEtURKLCC5VXm1I+2i1u9OhxFsKAQJKTVB8WvDAHF+oZlq0GTVFOlTlO1q3AlCTE/DF32c16ESvfgqR7343/g==", "cpu": [ "x64" ], @@ -939,9 +1007,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-arm64": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.53.2.tgz", - "integrity": "sha512-v0E9lJW8VsrwPux5Qe5CwmH/CF/2mQs6xU1MF3nmUxmZUCHazCjLgYvToOk+YuuUqLQBio1qkkREhxhc656ViA==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.60.2.tgz", + "integrity": "sha512-Bcl6CYDeAgE70cqZaMojOi/eK63h5Me97ZqAQoh77VPjMysA/4ORQBRGo3rRy45x4MzVlU9uZxs8Uwy7ZaKnBw==", "cpu": [ "arm64" ], @@ -953,9 +1021,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-x64": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.53.2.tgz", - "integrity": "sha512-ClAmAPx3ZCHtp6ysl4XEhWU69GUB1D+s7G9YjHGhIGCSrsg00nEGRRZHmINYxkdoJehde8VIsDC5t9C0gb6yqA==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.60.2.tgz", + "integrity": "sha512-LU+TPda3mAE2QB0/Hp5VyeKJivpC6+tlOXd1VMoXV/YFMvk/MNk5iXeBfB4MQGRWyOYVJ01625vjkr0Az98OJQ==", "cpu": [ "x64" ], @@ -967,9 +1035,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.53.2.tgz", - "integrity": "sha512-EPlb95nUsz6Dd9Qy13fI5kUPXNSljaG9FiJ4YUGU1O/Q77i5DYFW5KR8g1OzTcdZUqQQ1KdDqsTohdFVwCwjqg==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.60.2.tgz", + "integrity": "sha512-2QxQrM+KQ7DAW4o22j+XZ6RKdxjLD7BOWTP0Bv0tmjdyhXSsr2Ul1oJDQqh9Zf5qOwTuTc7Ek83mOFaKnodPjg==", "cpu": [ "arm" ], @@ -981,9 +1049,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.53.2.tgz", - "integrity": "sha512-BOmnVW+khAUX+YZvNfa0tGTEMVVEerOxN0pDk2E6N6DsEIa2Ctj48FOMfNDdrwinocKaC7YXUZ1pHlKpnkja/Q==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.60.2.tgz", + "integrity": "sha512-TbziEu2DVsTEOPif2mKWkMeDMLoYjx95oESa9fkQQK7r/Orta0gnkcDpzwufEcAO2BLBsD7mZkXGFqEdMRRwfw==", "cpu": [ "arm" ], @@ -995,9 +1063,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.53.2.tgz", - "integrity": "sha512-Xt2byDZ+6OVNuREgBXr4+CZDJtrVso5woFtpKdGPhpTPHcNG7D8YXeQzpNbFRxzTVqJf7kvPMCub/pcGUWgBjA==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.60.2.tgz", + "integrity": "sha512-bO/rVDiDUuM2YfuCUwZ1t1cP+/yqjqz+Xf2VtkdppefuOFS2OSeAfgafaHNkFn0t02hEyXngZkxtGqXcXwO8Rg==", "cpu": [ "arm64" ], @@ -1009,9 +1077,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.53.2.tgz", - "integrity": "sha512-+LdZSldy/I9N8+klim/Y1HsKbJ3BbInHav5qE9Iy77dtHC/pibw1SR/fXlWyAk0ThnpRKoODwnAuSjqxFRDHUQ==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.60.2.tgz", + "integrity": "sha512-hr26p7e93Rl0Za+JwW7EAnwAvKkehh12BU1Llm9Ykiibg4uIr2rbpxG9WCf56GuvidlTG9KiiQT/TXT1yAWxTA==", "cpu": [ "arm64" ], @@ -1023,9 +1091,23 @@ ] }, "node_modules/@rollup/rollup-linux-loong64-gnu": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.53.2.tgz", - "integrity": "sha512-8ms8sjmyc1jWJS6WdNSA23rEfdjWB30LH8Wqj0Cqvv7qSHnvw6kgMMXRdop6hkmGPlyYBdRPkjJnj3KCUHV/uQ==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.60.2.tgz", + "integrity": "sha512-pOjB/uSIyDt+ow3k/RcLvUAOGpysT2phDn7TTUB3n75SlIgZzM6NKAqlErPhoFU+npgY3/n+2HYIQVbF70P9/A==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-musl": { + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.60.2.tgz", + "integrity": "sha512-2/w+q8jszv9Ww1c+6uJT3OwqhdmGP2/4T17cu8WuwyUuuaCDDJ2ojdyYwZzCxx0GcsZBhzi3HmH+J5pZNXnd+Q==", "cpu": [ "loong64" ], @@ -1037,9 +1119,23 @@ ] }, "node_modules/@rollup/rollup-linux-ppc64-gnu": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.53.2.tgz", - "integrity": "sha512-3HRQLUQbpBDMmzoxPJYd3W6vrVHOo2cVW8RUo87Xz0JPJcBLBr5kZ1pGcQAhdZgX9VV7NbGNipah1omKKe23/g==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.60.2.tgz", + "integrity": "sha512-11+aL5vKheYgczxtPVVRhdptAM2H7fcDR5Gw4/bTcteuZBlH4oP9f5s9zYO9aGZvoGeBpqXI/9TZZihZ609wKw==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-musl": { + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.60.2.tgz", + "integrity": "sha512-i16fokAGK46IVZuV8LIIwMdtqhin9hfYkCh8pf8iC3QU3LpwL+1FSFGej+O7l3E/AoknL6Dclh2oTdnRMpTzFQ==", "cpu": [ "ppc64" ], @@ -1051,9 +1147,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.53.2.tgz", - "integrity": "sha512-fMjKi+ojnmIvhk34gZP94vjogXNNUKMEYs+EDaB/5TG/wUkoeua7p7VCHnE6T2Tx+iaghAqQX8teQzcvrYpaQA==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.60.2.tgz", + "integrity": "sha512-49FkKS6RGQoriDSK/6E2GkAsAuU5kETFCh7pG4yD/ylj9rKhTmO3elsnmBvRD4PgJPds5W2PkhC82aVwmUcJ7A==", "cpu": [ "riscv64" ], @@ -1065,9 +1161,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-musl": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.53.2.tgz", - "integrity": "sha512-XuGFGU+VwUUV5kLvoAdi0Wz5Xbh2SrjIxCtZj6Wq8MDp4bflb/+ThZsVxokM7n0pcbkEr2h5/pzqzDYI7cCgLQ==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.60.2.tgz", + "integrity": "sha512-mjYNkHPfGpUR00DuM1ZZIgs64Hpf4bWcz9Z41+4Q+pgDx73UwWdAYyf6EG/lRFldmdHHzgrYyge5akFUW0D3mQ==", "cpu": [ "riscv64" ], @@ -1079,9 +1175,9 @@ ] }, "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.53.2.tgz", - "integrity": "sha512-w6yjZF0P+NGzWR3AXWX9zc0DNEGdtvykB03uhonSHMRa+oWA6novflo2WaJr6JZakG2ucsyb+rvhrKac6NIy+w==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.60.2.tgz", + "integrity": "sha512-ALyvJz965BQk8E9Al/JDKKDLH2kfKFLTGMlgkAbbYtZuJt9LU8DW3ZoDMCtQpXAltZxwBHevXz5u+gf0yA0YoA==", "cpu": [ "s390x" ], @@ -1093,9 +1189,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.53.2.tgz", - "integrity": "sha512-yo8d6tdfdeBArzC7T/PnHd7OypfI9cbuZzPnzLJIyKYFhAQ8SvlkKtKBMbXDxe1h03Rcr7u++nFS7tqXz87Gtw==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.60.2.tgz", + "integrity": "sha512-UQjrkIdWrKI626Du8lCQ6MJp/6V1LAo2bOK9OTu4mSn8GGXIkPXk/Vsp4bLHCd9Z9Iz2OTEaokUE90VweJgIYQ==", "cpu": [ "x64" ], @@ -1107,9 +1203,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.53.2.tgz", - "integrity": "sha512-ah59c1YkCxKExPP8O9PwOvs+XRLKwh/mV+3YdKqQ5AMQ0r4M4ZDuOrpWkUaqO7fzAHdINzV9tEVu8vNw48z0lA==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.60.2.tgz", + "integrity": "sha512-bTsRGj6VlSdn/XD4CGyzMnzaBs9bsRxy79eTqTCBsA8TMIEky7qg48aPkvJvFe1HyzQ5oMZdg7AnVlWQSKLTnw==", "cpu": [ "x64" ], @@ -1120,10 +1216,24 @@ "linux" ] }, + "node_modules/@rollup/rollup-openbsd-x64": { + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.60.2.tgz", + "integrity": "sha512-6d4Z3534xitaA1FcMWP7mQPq5zGwBmGbhphh2DwaA1aNIXUu3KTOfwrWpbwI4/Gr0uANo7NTtaykFyO2hPuFLg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ] + }, "node_modules/@rollup/rollup-openharmony-arm64": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.53.2.tgz", - "integrity": "sha512-4VEd19Wmhr+Zy7hbUsFZ6YXEiP48hE//KPLCSVNY5RMGX2/7HZ+QkN55a3atM1C/BZCGIgqN+xrVgtdak2S9+A==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.60.2.tgz", + "integrity": "sha512-NetAg5iO2uN7eB8zE5qrZ3CSil+7IJt4WDFLcC75Ymywq1VZVD6qJ6EvNLjZ3rEm6gB7XW5JdT60c6MN35Z85Q==", "cpu": [ "arm64" ], @@ -1135,9 +1245,9 @@ ] }, "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.53.2.tgz", - "integrity": "sha512-IlbHFYc/pQCgew/d5fslcy1KEaYVCJ44G8pajugd8VoOEI8ODhtb/j8XMhLpwHCMB3yk2J07ctup10gpw2nyMA==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.60.2.tgz", + "integrity": "sha512-NCYhOotpgWZ5kdxCZsv6Iudx0wX8980Q/oW4pNFNihpBKsDbEA1zpkfxJGC0yugsUuyDZ7gL37dbzwhR0VI7pQ==", "cpu": [ "arm64" ], @@ -1149,9 +1259,9 @@ ] }, "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.53.2.tgz", - "integrity": "sha512-lNlPEGgdUfSzdCWU176ku/dQRnA7W+Gp8d+cWv73jYrb8uT7HTVVxq62DUYxjbaByuf1Yk0RIIAbDzp+CnOTFg==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.60.2.tgz", + "integrity": "sha512-RXsaOqXxfoUBQoOgvmmijVxJnW2IGB0eoMO7F8FAjaj0UTywUO/luSqimWBJn04WNgUkeNhh7fs7pESXajWmkg==", "cpu": [ "ia32" ], @@ -1163,9 +1273,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-gnu": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.53.2.tgz", - "integrity": "sha512-S6YojNVrHybQis2lYov1sd+uj7K0Q05NxHcGktuMMdIQ2VixGwAfbJ23NnlvvVV1bdpR2m5MsNBViHJKcA4ADw==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.60.2.tgz", + "integrity": "sha512-qdAzEULD+/hzObedtmV6iBpdL5TIbKVztGiK7O3/KYSf+HIzU257+MX1EXJcyIiDbMAqmbwaufcYPvyRryeZtA==", "cpu": [ "x64" ], @@ -1177,9 +1287,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.53.2.tgz", - "integrity": "sha512-k+/Rkcyx//P6fetPoLMb8pBeqJBNGx81uuf7iljX9++yNBVRDQgD04L+SVXmXmh5ZP4/WOp4mWF0kmi06PW2tA==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.60.2.tgz", + "integrity": "sha512-Nd/SgG27WoA9e+/TdK74KnHz852TLa94ovOYySo/yMPuTmpckK/jIF2jSwS3g7ELSKXK13/cVdmg1Z/DaCWKxA==", "cpu": [ "x64" ], @@ -1190,10 +1300,21 @@ "win32" ] }, - "node_modules/@sinclair/typebox": { - "version": "0.27.8", - "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", - "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", + "node_modules/@types/chai": { + "version": "5.2.3", + "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", + "integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/deep-eql": "*", + "assertion-error": "^2.0.1" + } + }, + "node_modules/@types/deep-eql": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz", + "integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==", "dev": true, "license": "MIT" }, @@ -1204,149 +1325,170 @@ "dev": true, "license": "MIT" }, - "node_modules/@types/json-schema": { - "version": "7.0.15", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", - "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", - "dev": true, - "license": "MIT" - }, "node_modules/@types/node": { - "version": "20.19.25", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.25.tgz", - "integrity": "sha512-ZsJzA5thDQMSQO788d7IocwwQbI8B5OPzmqNvpf3NY/+MHDAS759Wo0gd2WQeXYt5AAAQjzcrTVC6SKCuYgoCQ==", + "version": "20.19.39", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.39.tgz", + "integrity": "sha512-orrrD74MBUyK8jOAD/r0+lfa1I2MO6I+vAkmAWzMYbCcgrN4lCrmK52gRFQq/JRxfYPfonkr4b0jcY7Olqdqbw==", "dev": true, "license": "MIT", "dependencies": { "undici-types": "~6.21.0" } }, - "node_modules/@types/semver": { - "version": "7.7.1", - "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.7.1.tgz", - "integrity": "sha512-FmgJfu+MOcQ370SD0ev7EI8TlCAfKYU+B4m5T3yXc1CiRN94g/SZPtsCkk506aUDtlMnFZvasDwHHUcZUEaYuA==", - "dev": true, - "license": "MIT" - }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-6.21.0.tgz", - "integrity": "sha512-oy9+hTPCUFpngkEZUSzbf9MxI65wbKFoQYsgPdILTfbUldp5ovUuphZVe4i30emU9M/kP+T64Di0mxl7dSw3MA==", + "version": "8.59.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.59.0.tgz", + "integrity": "sha512-HyAZtpdkgZwpq8Sz3FSUvCR4c+ScbuWa9AksK2Jweub7w4M3yTz4O11AqVJzLYjy/B9ZWPyc81I+mOdJU/bDQw==", "dev": true, "license": "MIT", "dependencies": { - "@eslint-community/regexpp": "^4.5.1", - "@typescript-eslint/scope-manager": "6.21.0", - "@typescript-eslint/type-utils": "6.21.0", - "@typescript-eslint/utils": "6.21.0", - "@typescript-eslint/visitor-keys": "6.21.0", - "debug": "^4.3.4", - "graphemer": "^1.4.0", - "ignore": "^5.2.4", + "@eslint-community/regexpp": "^4.12.2", + "@typescript-eslint/scope-manager": "8.59.0", + "@typescript-eslint/type-utils": "8.59.0", + "@typescript-eslint/utils": "8.59.0", + "@typescript-eslint/visitor-keys": "8.59.0", + "ignore": "^7.0.5", "natural-compare": "^1.4.0", - "semver": "^7.5.4", - "ts-api-utils": "^1.0.1" + "ts-api-utils": "^2.5.0" }, "engines": { - "node": "^16.0.0 || >=18.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "@typescript-eslint/parser": "^6.0.0 || ^6.0.0-alpha", - "eslint": "^7.0.0 || ^8.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "@typescript-eslint/parser": "^8.59.0", + "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", + "typescript": ">=4.8.4 <6.1.0" + } + }, + "node_modules/@typescript-eslint/eslint-plugin/node_modules/ignore": { + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-7.0.5.tgz", + "integrity": "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4" } }, "node_modules/@typescript-eslint/parser": { - "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-6.21.0.tgz", - "integrity": "sha512-tbsV1jPne5CkFQCgPBcDOt30ItF7aJoZL997JSF7MhGQqOeT3svWRYxiqlfA5RUdlHN6Fi+EI9bxqbdyAUZjYQ==", + "version": "8.59.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.59.0.tgz", + "integrity": "sha512-TI1XGwKbDpo9tRW8UDIXCOeLk55qe9ZFGs8MTKU6/M08HWTw52DD/IYhfQtOEhEdPhLMT26Ka/x7p70nd3dzDg==", "dev": true, - "license": "BSD-2-Clause", + "license": "MIT", "dependencies": { - "@typescript-eslint/scope-manager": "6.21.0", - "@typescript-eslint/types": "6.21.0", - "@typescript-eslint/typescript-estree": "6.21.0", - "@typescript-eslint/visitor-keys": "6.21.0", - "debug": "^4.3.4" + "@typescript-eslint/scope-manager": "8.59.0", + "@typescript-eslint/types": "8.59.0", + "@typescript-eslint/typescript-estree": "8.59.0", + "@typescript-eslint/visitor-keys": "8.59.0", + "debug": "^4.4.3" }, "engines": { - "node": "^16.0.0 || >=18.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^7.0.0 || ^8.0.0" + "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", + "typescript": ">=4.8.4 <6.1.0" + } + }, + "node_modules/@typescript-eslint/project-service": { + "version": "8.59.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/project-service/-/project-service-8.59.0.tgz", + "integrity": "sha512-Lw5ITrR5s5TbC19YSvlr63ZfLaJoU6vtKTHyB0GQOpX0W7d5/Ir6vUahWi/8Sps/nOukZQ0IB3SmlxZnjaKVnw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/tsconfig-utils": "^8.59.0", + "@typescript-eslint/types": "^8.59.0", + "debug": "^4.4.3" }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "typescript": ">=4.8.4 <6.1.0" } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-6.21.0.tgz", - "integrity": "sha512-OwLUIWZJry80O99zvqXVEioyniJMa+d2GrqpUTqi5/v5D5rOrppJVBPa0yKCblcigC0/aYAzxxqQ1B+DS2RYsg==", + "version": "8.59.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.59.0.tgz", + "integrity": "sha512-UzR16Ut8IpA3Mc4DbgAShlPPkVm8xXMWafXxB0BocaVRHs8ZGakAxGRskF7FId3sdk9lgGD73GSFaWmWFDE4dg==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "6.21.0", - "@typescript-eslint/visitor-keys": "6.21.0" + "@typescript-eslint/types": "8.59.0", + "@typescript-eslint/visitor-keys": "8.59.0" + }, + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/tsconfig-utils": { + "version": "8.59.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.59.0.tgz", + "integrity": "sha512-91Sbl3s4Kb3SybliIY6muFBmHVv+pYXfybC4Oolp3dvk8BvIE3wOPc+403CWIT7mJNkfQRGtdqghzs2+Z91Tqg==", + "dev": true, + "license": "MIT", "engines": { - "node": "^16.0.0 || >=18.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "typescript": ">=4.8.4 <6.1.0" } }, "node_modules/@typescript-eslint/type-utils": { - "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-6.21.0.tgz", - "integrity": "sha512-rZQI7wHfao8qMX3Rd3xqeYSMCL3SoiSQLBATSiVKARdFGCYSRvmViieZjqc58jKgs8Y8i9YvVVhRbHSTA4VBag==", + "version": "8.59.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.59.0.tgz", + "integrity": "sha512-3TRiZaQSltGqGeNrJzzr1+8YcEobKH9rHnqIp/1psfKFmhRQDNMGP5hBufanYTGznwShzVLs3Mz+gDN7HkWfXg==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/typescript-estree": "6.21.0", - "@typescript-eslint/utils": "6.21.0", - "debug": "^4.3.4", - "ts-api-utils": "^1.0.1" + "@typescript-eslint/types": "8.59.0", + "@typescript-eslint/typescript-estree": "8.59.0", + "@typescript-eslint/utils": "8.59.0", + "debug": "^4.4.3", + "ts-api-utils": "^2.5.0" }, "engines": { - "node": "^16.0.0 || >=18.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^7.0.0 || ^8.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", + "typescript": ">=4.8.4 <6.1.0" } }, "node_modules/@typescript-eslint/types": { - "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-6.21.0.tgz", - "integrity": "sha512-1kFmZ1rOm5epu9NZEZm1kckCDGj5UJEf7P1kliH4LKu/RkwpsfqqGmY2OOcUs18lSlQBKLDYBOGxRVtrMN5lpg==", + "version": "8.59.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.59.0.tgz", + "integrity": "sha512-nLzdsT1gdOgFxxxwrlNVUBzSNBEEHJ86bblmk4QAS6stfig7rcJzWKqCyxFy3YRRHXDWEkb2NralA1nOYkkm/A==", "dev": true, "license": "MIT", "engines": { - "node": "^16.0.0 || >=18.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", @@ -1354,78 +1496,127 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-6.21.0.tgz", - "integrity": "sha512-6npJTkZcO+y2/kr+z0hc4HwNfrrP4kNYh57ek7yCNlrBjWQ1Y0OS7jiZTkgumrvkX5HkEKXFZkkdFNkaW2wmUQ==", + "version": "8.59.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.59.0.tgz", + "integrity": "sha512-O9Re9P1BmBLFJyikRbQpLku/QA3/AueZNO9WePLBwQrvkixTmDe8u76B6CYUAITRl/rHawggEqUGn5QIkVRLMw==", "dev": true, - "license": "BSD-2-Clause", + "license": "MIT", "dependencies": { - "@typescript-eslint/types": "6.21.0", - "@typescript-eslint/visitor-keys": "6.21.0", - "debug": "^4.3.4", - "globby": "^11.1.0", - "is-glob": "^4.0.3", - "minimatch": "9.0.3", - "semver": "^7.5.4", - "ts-api-utils": "^1.0.1" + "@typescript-eslint/project-service": "8.59.0", + "@typescript-eslint/tsconfig-utils": "8.59.0", + "@typescript-eslint/types": "8.59.0", + "@typescript-eslint/visitor-keys": "8.59.0", + "debug": "^4.4.3", + "minimatch": "^10.2.2", + "semver": "^7.7.3", + "tinyglobby": "^0.2.15", + "ts-api-utils": "^2.5.0" }, "engines": { - "node": "^16.0.0 || >=18.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "peerDependencies": { + "typescript": ">=4.8.4 <6.1.0" + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/balanced-match": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", + "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": "18 || 20 || >=22" + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/brace-expansion": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.5.tgz", + "integrity": "sha512-VZznLgtwhn+Mact9tfiwx64fA9erHH/MCXEUfB/0bX/6Fz6ny5EGTXYltMocqg4xFAQZtnO3DHWWXi8RiuN7cQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^4.0.2" + }, + "engines": { + "node": "18 || 20 || >=22" + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/minimatch": { + "version": "10.2.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.5.tgz", + "integrity": "sha512-MULkVLfKGYDFYejP07QOurDLLQpcjk7Fw+7jXS2R2czRQzR56yHRveU5NDJEOviH+hETZKSkIk5c+T23GjFUMg==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "brace-expansion": "^5.0.5" + }, + "engines": { + "node": "18 || 20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, "node_modules/@typescript-eslint/utils": { - "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-6.21.0.tgz", - "integrity": "sha512-NfWVaC8HP9T8cbKQxHcsJBY5YE1O33+jpMwN45qzWWaPDZgLIbo12toGMWnmhvCpd3sIxkpDw3Wv1B3dYrbDQQ==", + "version": "8.59.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.59.0.tgz", + "integrity": "sha512-I1R/K7V07XsMJ12Oaxg/O9GfrysGTmCRhvZJBv0RE0NcULMzjqVpR5kRRQjHsz3J/bElU7HwCO7zkqL+MSUz+g==", "dev": true, "license": "MIT", "dependencies": { - "@eslint-community/eslint-utils": "^4.4.0", - "@types/json-schema": "^7.0.12", - "@types/semver": "^7.5.0", - "@typescript-eslint/scope-manager": "6.21.0", - "@typescript-eslint/types": "6.21.0", - "@typescript-eslint/typescript-estree": "6.21.0", - "semver": "^7.5.4" + "@eslint-community/eslint-utils": "^4.9.1", + "@typescript-eslint/scope-manager": "8.59.0", + "@typescript-eslint/types": "8.59.0", + "@typescript-eslint/typescript-estree": "8.59.0" }, "engines": { - "node": "^16.0.0 || >=18.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^7.0.0 || ^8.0.0" + "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", + "typescript": ">=4.8.4 <6.1.0" } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "6.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-6.21.0.tgz", - "integrity": "sha512-JJtkDduxLi9bivAB+cYOVMtbkqdPOhZ+ZI5LC47MIRrDV4Yn2o+ZnW10Nkmr28xRpSpdJ6Sm42Hjf2+REYXm0A==", + "version": "8.59.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.59.0.tgz", + "integrity": "sha512-/uejZt4dSere1bx12WLlPfv8GktzcaDtuJ7s42/HEZ5zGj9oxRaD4bj7qwSunXkf+pbAhFt2zjpHYUiT5lHf0Q==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "6.21.0", - "eslint-visitor-keys": "^3.4.1" + "@typescript-eslint/types": "8.59.0", + "eslint-visitor-keys": "^5.0.0" }, "engines": { - "node": "^16.0.0 || >=18.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" } }, + "node_modules/@typescript-eslint/visitor-keys/node_modules/eslint-visitor-keys": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-5.0.1.tgz", + "integrity": "sha512-tD40eHxA35h0PEIZNeIjkHoDR4YjjJp34biM0mDvplBe//mB+IHCqHDGV7pxF+7MklTvighcCPPZC7ynWyjdTA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": "^20.19.0 || ^22.13.0 || >=24" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, "node_modules/@ungap/structured-clone": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.0.tgz", @@ -1434,162 +1625,180 @@ "license": "ISC" }, "node_modules/@vitest/coverage-v8": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-1.6.1.tgz", - "integrity": "sha512-6YeRZwuO4oTGKxD3bijok756oktHSIm3eczVVzNe3scqzuhLwltIF3S9ZL/vwOVIpURmU6SnZhziXXAfw8/Qlw==", + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-3.2.4.tgz", + "integrity": "sha512-EyF9SXU6kS5Ku/U82E259WSnvg6c8KTjppUncuNdm5QHpe17mwREHnjDzozC8x9MZ0xfBUFSaLkRv4TMA75ALQ==", "dev": true, "license": "MIT", "dependencies": { - "@ampproject/remapping": "^2.2.1", - "@bcoe/v8-coverage": "^0.2.3", - "debug": "^4.3.4", + "@ampproject/remapping": "^2.3.0", + "@bcoe/v8-coverage": "^1.0.2", + "ast-v8-to-istanbul": "^0.3.3", + "debug": "^4.4.1", "istanbul-lib-coverage": "^3.2.2", "istanbul-lib-report": "^3.0.1", - "istanbul-lib-source-maps": "^5.0.4", - "istanbul-reports": "^3.1.6", - "magic-string": "^0.30.5", - "magicast": "^0.3.3", - "picocolors": "^1.0.0", - "std-env": "^3.5.0", - "strip-literal": "^2.0.0", - "test-exclude": "^6.0.0" + "istanbul-lib-source-maps": "^5.0.6", + "istanbul-reports": "^3.1.7", + "magic-string": "^0.30.17", + "magicast": "^0.3.5", + "std-env": "^3.9.0", + "test-exclude": "^7.0.1", + "tinyrainbow": "^2.0.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { - "vitest": "1.6.1" + "@vitest/browser": "3.2.4", + "vitest": "3.2.4" + }, + "peerDependenciesMeta": { + "@vitest/browser": { + "optional": true + } } }, "node_modules/@vitest/expect": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-1.6.1.tgz", - "integrity": "sha512-jXL+9+ZNIJKruofqXuuTClf44eSpcHlgj3CiuNihUF3Ioujtmc0zIa3UJOW5RjDK1YLBJZnWBlPuqhYycLioog==", + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.2.4.tgz", + "integrity": "sha512-Io0yyORnB6sikFlt8QW5K7slY4OjqNX9jmJQ02QDda8lyM6B5oNgVWoSoKPac8/kgnCUzuHQKrSLtu/uOqqrig==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/spy": "1.6.1", - "@vitest/utils": "1.6.1", - "chai": "^4.3.10" + "@types/chai": "^5.2.2", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "tinyrainbow": "^2.0.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, - "node_modules/@vitest/runner": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-1.6.1.tgz", - "integrity": "sha512-3nSnYXkVkf3mXFfE7vVyPmi3Sazhb/2cfZGGs0JRzFsPFvAMBEcrweV1V1GsrstdXeKCTXlJbvnQwGWgEIHmOA==", + "node_modules/@vitest/mocker": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.2.4.tgz", + "integrity": "sha512-46ryTE9RZO/rfDd7pEqFl7etuyzekzEhUbTW3BvmeO/BcCMEgq59BKhek3dXDWgAj4oMK6OZi+vRr1wPW6qjEQ==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/utils": "1.6.1", - "p-limit": "^5.0.0", - "pathe": "^1.1.1" + "@vitest/spy": "3.2.4", + "estree-walker": "^3.0.3", + "magic-string": "^0.30.17" }, "funding": { "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "msw": "^2.4.9", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + }, + "peerDependenciesMeta": { + "msw": { + "optional": true + }, + "vite": { + "optional": true + } } }, - "node_modules/@vitest/runner/node_modules/p-limit": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-5.0.0.tgz", - "integrity": "sha512-/Eaoq+QyLSiXQ4lyYV23f14mZRQcXnxfHrN0vCai+ak9G0pp9iEQukIIZq5NccEvwRB8PUnZT0KsOoDCINS1qQ==", + "node_modules/@vitest/pretty-format": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.2.4.tgz", + "integrity": "sha512-IVNZik8IVRJRTr9fxlitMKeJeXFFFN0JaB9PHPGQ8NKQbGpfjlTx9zO4RefN8gp7eqjNy8nyK3NZmBzOPeIxtA==", "dev": true, "license": "MIT", "dependencies": { - "yocto-queue": "^1.0.0" - }, - "engines": { - "node": ">=18" + "tinyrainbow": "^2.0.0" }, "funding": { - "url": "https://github.com/sponsors/sindresorhus" + "url": "https://opencollective.com/vitest" } }, - "node_modules/@vitest/runner/node_modules/yocto-queue": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.2.tgz", - "integrity": "sha512-4LCcse/U2MHZ63HAJVE+v71o7yOdIe4cZ70Wpf8D/IyjDKYQLV5GD46B+hSTjJsvV5PztjvHoU580EftxjDZFQ==", + "node_modules/@vitest/runner": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.2.4.tgz", + "integrity": "sha512-oukfKT9Mk41LreEW09vt45f8wx7DordoWUZMYdY/cyAk7w5TWkTRCNZYF7sX7n2wB7jyGAl74OxgwhPgKaqDMQ==", "dev": true, "license": "MIT", - "engines": { - "node": ">=12.20" + "dependencies": { + "@vitest/utils": "3.2.4", + "pathe": "^2.0.3", + "strip-literal": "^3.0.0" }, "funding": { - "url": "https://github.com/sponsors/sindresorhus" + "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/snapshot": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-1.6.1.tgz", - "integrity": "sha512-WvidQuWAzU2p95u8GAKlRMqMyN1yOJkGHnx3M1PL9Raf7AQ1kwLKg04ADlCa3+OXUZE7BceOhVZiuWAbzCKcUQ==", + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.2.4.tgz", + "integrity": "sha512-dEYtS7qQP2CjU27QBC5oUOxLE/v5eLkGqPE0ZKEIDGMs4vKWe7IjgLOeauHsR0D5YuuycGRO5oSRXnwnmA78fQ==", "dev": true, "license": "MIT", "dependencies": { - "magic-string": "^0.30.5", - "pathe": "^1.1.1", - "pretty-format": "^29.7.0" + "@vitest/pretty-format": "3.2.4", + "magic-string": "^0.30.17", + "pathe": "^2.0.3" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/spy": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-1.6.1.tgz", - "integrity": "sha512-MGcMmpGkZebsMZhbQKkAf9CX5zGvjkBTqf8Zx3ApYWXr3wG+QvEu2eXWfnIIWYSJExIp4V9FCKDEeygzkYrXMw==", + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.2.4.tgz", + "integrity": "sha512-vAfasCOe6AIK70iP5UD11Ac4siNUNJ9i/9PZ3NKx07sG6sUxeag1LWdNrMWeKKYBLlzuK+Gn65Yd5nyL6ds+nw==", "dev": true, "license": "MIT", "dependencies": { - "tinyspy": "^2.2.0" + "tinyspy": "^4.0.3" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/ui": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/@vitest/ui/-/ui-1.6.1.tgz", - "integrity": "sha512-xa57bCPGuzEFqGjPs3vVLyqareG8DX0uMkr5U/v5vLv5/ZUrBrPL7gzxzTJedEyZxFMfsozwTIbbYfEQVo3kgg==", + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/ui/-/ui-3.2.4.tgz", + "integrity": "sha512-hGISOaP18plkzbWEcP/QvtRW1xDXF2+96HbEX6byqQhAUbiS5oH6/9JwW+QsQCIYON2bI6QZBF+2PvOmrRZ9wA==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/utils": "1.6.1", - "fast-glob": "^3.3.2", - "fflate": "^0.8.1", - "flatted": "^3.2.9", - "pathe": "^1.1.1", - "picocolors": "^1.0.0", - "sirv": "^2.0.4" + "@vitest/utils": "3.2.4", + "fflate": "^0.8.2", + "flatted": "^3.3.3", + "pathe": "^2.0.3", + "sirv": "^3.0.1", + "tinyglobby": "^0.2.14", + "tinyrainbow": "^2.0.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { - "vitest": "1.6.1" + "vitest": "3.2.4" } }, "node_modules/@vitest/utils": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-1.6.1.tgz", - "integrity": "sha512-jOrrUvXM4Av9ZWiG1EajNto0u96kWAhJ1LmPmJhXXQx/32MecEKd10pOLYgS2BQx1TgkGhloPU1ArDW2vvaY6g==", + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.2.4.tgz", + "integrity": "sha512-fB2V0JFrQSMsCo9HiSq3Ezpdv4iYaXRG1Sx8edX3MwxfyNn83mKiGzOcH+Fkxt4MHxr3y42fQi1oeAInqgX2QA==", "dev": true, "license": "MIT", "dependencies": { - "diff-sequences": "^29.6.3", - "estree-walker": "^3.0.3", - "loupe": "^2.3.7", - "pretty-format": "^29.7.0" + "@vitest/pretty-format": "3.2.4", + "loupe": "^3.1.4", + "tinyrainbow": "^2.0.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/acorn": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", - "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", + "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==", "dev": true, "license": "MIT", "bin": { @@ -1609,23 +1818,20 @@ "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" } }, - "node_modules/acorn-walk": { - "version": "8.3.4", - "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.4.tgz", - "integrity": "sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==", + "node_modules/agent-base": { + "version": "7.1.4", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.4.tgz", + "integrity": "sha512-MnA+YT8fwfJPgBx3m60MNqakm30XOkyIoH1y6huTQvC0PwZG7ki8NacLBcrPbNoo8vEZy7Jpuk7+jMO+CUovTQ==", "dev": true, "license": "MIT", - "dependencies": { - "acorn": "^8.11.0" - }, "engines": { - "node": ">=0.4.0" + "node": ">= 14" } }, "node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "version": "6.15.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.15.0.tgz", + "integrity": "sha512-fgFx7Hfoq60ytK2c7DhnF8jIvzYgOMxfugjLOSMHjLIPgenqa7S7oaagATUq99mV6IYvN2tRmC0wnTYX6iPbMw==", "dev": true, "license": "MIT", "dependencies": { @@ -1696,24 +1902,26 @@ "dev": true, "license": "Python-2.0" }, - "node_modules/array-union": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", - "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "node_modules/assertion-error": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", + "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", "dev": true, "license": "MIT", "engines": { - "node": ">=8" + "node": ">=12" } }, - "node_modules/assertion-error": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-1.1.0.tgz", - "integrity": "sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw==", + "node_modules/ast-v8-to-istanbul": { + "version": "0.3.12", + "resolved": "https://registry.npmjs.org/ast-v8-to-istanbul/-/ast-v8-to-istanbul-0.3.12.tgz", + "integrity": "sha512-BRRC8VRZY2R4Z4lFIL35MwNXmwVqBityvOIwETtsCSwvjl0IdgFsy9NhdaA6j74nUdtJJlIypeRhpDam19Wq3g==", "dev": true, "license": "MIT", - "engines": { - "node": "*" + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.31", + "estree-walker": "^3.0.3", + "js-tokens": "^10.0.0" } }, "node_modules/balanced-match": { @@ -1724,28 +1932,15 @@ "license": "MIT" }, "node_modules/brace-expansion": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", - "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.0.tgz", + "integrity": "sha512-TN1kCZAgdgweJhWWpgKYrQaMNHcDULHkWwQIspdtjV4Y5aurRdZpjAqn6yX3FPqTA9ngHCc4hJxMAMgGfve85w==", "dev": true, "license": "MIT", "dependencies": { "balanced-match": "^1.0.0" } }, - "node_modules/braces": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", - "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", - "dev": true, - "license": "MIT", - "dependencies": { - "fill-range": "^7.1.1" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/bundle-require": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/bundle-require/-/bundle-require-5.1.0.tgz", @@ -1783,22 +1978,20 @@ } }, "node_modules/chai": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/chai/-/chai-4.5.0.tgz", - "integrity": "sha512-RITGBfijLkBddZvnn8jdqoTypxvqbOLYQkGGxXzeFjVHvudaPw0HNFD9x928/eUwYWd2dPCugVqspGALTZZQKw==", + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/chai/-/chai-5.3.3.tgz", + "integrity": "sha512-4zNhdJD/iOjSH0A05ea+Ke6MU5mmpQcbQsSOkgdaUMJ9zTlDTD/GYlwohmIE2u0gaxHYiVHEn1Fw9mZ/ktJWgw==", "dev": true, "license": "MIT", "dependencies": { - "assertion-error": "^1.1.0", - "check-error": "^1.0.3", - "deep-eql": "^4.1.3", - "get-func-name": "^2.0.2", - "loupe": "^2.3.6", - "pathval": "^1.1.1", - "type-detect": "^4.1.0" + "assertion-error": "^2.0.1", + "check-error": "^2.1.1", + "deep-eql": "^5.0.1", + "loupe": "^3.1.0", + "pathval": "^2.0.0" }, "engines": { - "node": ">=4" + "node": ">=18" } }, "node_modules/chalk": { @@ -1818,17 +2011,21 @@ "url": "https://github.com/chalk/chalk?sponsor=1" } }, + "node_modules/change-case": { + "version": "5.4.4", + "resolved": "https://registry.npmjs.org/change-case/-/change-case-5.4.4.tgz", + "integrity": "sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==", + "dev": true, + "license": "MIT" + }, "node_modules/check-error": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.3.tgz", - "integrity": "sha512-iKEoDYaRmd1mxM90a2OEfWhjsjPpYPuQ+lMYsoxB126+t8fw7ySEO48nmDg5COTjxDI65/Y2OWpeEHk3ZOe8zg==", + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.3.tgz", + "integrity": "sha512-PAJdDJusoxnwm1VwW07VWwUN1sl7smmC3OKggvndJFadxxDRyFJBX/ggnu/KE4kQAB7a3Dp8f/YXC1FlUprWmA==", "dev": true, "license": "MIT", - "dependencies": { - "get-func-name": "^2.0.2" - }, "engines": { - "node": "*" + "node": ">= 16" } }, "node_modules/chokidar": { @@ -1867,6 +2064,13 @@ "dev": true, "license": "MIT" }, + "node_modules/colorette": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-1.4.0.tgz", + "integrity": "sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g==", + "dev": true, + "license": "MIT" + }, "node_modules/commander": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/commander/-/commander-4.1.1.tgz", @@ -1935,14 +2139,11 @@ } }, "node_modules/deep-eql": { - "version": "4.1.4", - "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-4.1.4.tgz", - "integrity": "sha512-SUwdGfqdKOwxCPeVYjwSyRpJ7Z+fhpwIAtmCUdZIWZ/YP5R9WAsyuSgpLVDi9bjWoN2LXHNss/dk3urXtdQxGg==", + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", + "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", "dev": true, "license": "MIT", - "dependencies": { - "type-detect": "^4.0.0" - }, "engines": { "node": ">=6" } @@ -1954,29 +2155,6 @@ "dev": true, "license": "MIT" }, - "node_modules/diff-sequences": { - "version": "29.6.3", - "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-29.6.3.tgz", - "integrity": "sha512-EjePK1srD3P08o2j4f0ExnylqRs5B9tJjcp9t1krH2qRi8CCdsYfwe9JgSLurFBWwq4uOlipzfk5fHNvwFKr8Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/dir-glob": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", - "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", - "dev": true, - "license": "MIT", - "dependencies": { - "path-type": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/doctrine": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", @@ -1991,9 +2169,9 @@ } }, "node_modules/dotenv": { - "version": "17.2.3", - "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-17.2.3.tgz", - "integrity": "sha512-JVUnt+DUIzu87TABbhPmNfVdBDt18BLOWjMUFJMSi/Qqg7NTYtabbvSNJGOJ7afbRuv9D/lngizHtP7QyLQ+9w==", + "version": "17.2.4", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-17.2.4.tgz", + "integrity": "sha512-mudtfb4zRB4bVvdj0xRo+e6duH1csJRM8IukBqfTRvHotn9+LBXB8ynAidP9zHqoRC/fsllXgk4kCKlR21fIhw==", "dev": true, "license": "BSD-2-Clause", "engines": { @@ -2017,10 +2195,17 @@ "dev": true, "license": "MIT" }, + "node_modules/es-module-lexer": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", + "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "dev": true, + "license": "MIT" + }, "node_modules/esbuild": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.12.tgz", - "integrity": "sha512-bbPBYYrtZbkt6Os6FiTLCTFxvq4tt3JKall1vRwshA3fdVztsLAatFaZobhkBC8/BrPetoa0oksYoKXoG4ryJg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.7.tgz", + "integrity": "sha512-IxpibTjyVnmrIQo5aqNpCgoACA/dTKLTlhMHihVHhdkxKyPO1uBBthumT0rdHmcsk9uMonIWS0m4FljWzILh3w==", "dev": true, "hasInstallScript": true, "license": "MIT", @@ -2031,32 +2216,32 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.25.12", - "@esbuild/android-arm": "0.25.12", - "@esbuild/android-arm64": "0.25.12", - "@esbuild/android-x64": "0.25.12", - "@esbuild/darwin-arm64": "0.25.12", - "@esbuild/darwin-x64": "0.25.12", - "@esbuild/freebsd-arm64": "0.25.12", - "@esbuild/freebsd-x64": "0.25.12", - "@esbuild/linux-arm": "0.25.12", - "@esbuild/linux-arm64": "0.25.12", - "@esbuild/linux-ia32": "0.25.12", - "@esbuild/linux-loong64": "0.25.12", - "@esbuild/linux-mips64el": "0.25.12", - "@esbuild/linux-ppc64": "0.25.12", - "@esbuild/linux-riscv64": "0.25.12", - "@esbuild/linux-s390x": "0.25.12", - "@esbuild/linux-x64": "0.25.12", - "@esbuild/netbsd-arm64": "0.25.12", - "@esbuild/netbsd-x64": "0.25.12", - "@esbuild/openbsd-arm64": "0.25.12", - "@esbuild/openbsd-x64": "0.25.12", - "@esbuild/openharmony-arm64": "0.25.12", - "@esbuild/sunos-x64": "0.25.12", - "@esbuild/win32-arm64": "0.25.12", - "@esbuild/win32-ia32": "0.25.12", - "@esbuild/win32-x64": "0.25.12" + "@esbuild/aix-ppc64": "0.27.7", + "@esbuild/android-arm": "0.27.7", + "@esbuild/android-arm64": "0.27.7", + "@esbuild/android-x64": "0.27.7", + "@esbuild/darwin-arm64": "0.27.7", + "@esbuild/darwin-x64": "0.27.7", + "@esbuild/freebsd-arm64": "0.27.7", + "@esbuild/freebsd-x64": "0.27.7", + "@esbuild/linux-arm": "0.27.7", + "@esbuild/linux-arm64": "0.27.7", + "@esbuild/linux-ia32": "0.27.7", + "@esbuild/linux-loong64": "0.27.7", + "@esbuild/linux-mips64el": "0.27.7", + "@esbuild/linux-ppc64": "0.27.7", + "@esbuild/linux-riscv64": "0.27.7", + "@esbuild/linux-s390x": "0.27.7", + "@esbuild/linux-x64": "0.27.7", + "@esbuild/netbsd-arm64": "0.27.7", + "@esbuild/netbsd-x64": "0.27.7", + "@esbuild/openbsd-arm64": "0.27.7", + "@esbuild/openbsd-x64": "0.27.7", + "@esbuild/openharmony-arm64": "0.27.7", + "@esbuild/sunos-x64": "0.27.7", + "@esbuild/win32-arm64": "0.27.7", + "@esbuild/win32-ia32": "0.27.7", + "@esbuild/win32-x64": "0.27.7" } }, "node_modules/escape-string-regexp": { @@ -2143,14 +2328,14 @@ } }, "node_modules/eslint-plugin-prettier": { - "version": "5.5.4", - "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-5.5.4.tgz", - "integrity": "sha512-swNtI95SToIz05YINMA6Ox5R057IMAmWZ26GqPxusAp1TZzj+IdY9tXNWWD3vkF/wEqydCONcwjTFpxybBqZsg==", + "version": "5.5.5", + "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-5.5.5.tgz", + "integrity": "sha512-hscXkbqUZ2sPithAuLm5MXL+Wph+U7wHngPBv9OMWwlP8iaflyxpjTYZkmdgB4/vPIhemRlBEoLrH7UC1n7aUw==", "dev": true, "license": "MIT", "dependencies": { - "prettier-linter-helpers": "^1.0.0", - "synckit": "^0.11.7" + "prettier-linter-helpers": "^1.0.1", + "synckit": "^0.11.12" }, "engines": { "node": "^14.18.0 || >=16.0.0" @@ -2204,9 +2389,9 @@ } }, "node_modules/eslint/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "version": "1.1.14", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.14.tgz", + "integrity": "sha512-MWPGfDxnyzKU7rNOW9SP/c50vi3xrmrua/+6hfPbCS2ABNWfx24vPidzvC7krjU/RTo235sV776ymlsMtGKj8g==", "dev": true, "license": "MIT", "dependencies": { @@ -2215,9 +2400,9 @@ } }, "node_modules/eslint/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, "license": "ISC", "dependencies": { @@ -2246,9 +2431,9 @@ } }, "node_modules/esquery": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", - "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.7.0.tgz", + "integrity": "sha512-Ap6G0WQwcU/LHsvLwON1fAQX9Zp0A2Y6Y/cJBl9r/JbW90Zyg4/zbG6zzKa2OTALELarYHmKu0GhpM5EO+7T0g==", "dev": true, "license": "BSD-3-Clause", "dependencies": { @@ -2301,28 +2486,14 @@ "node": ">=0.10.0" } }, - "node_modules/execa": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/execa/-/execa-8.0.1.tgz", - "integrity": "sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg==", + "node_modules/expect-type": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", + "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", "dev": true, - "license": "MIT", - "dependencies": { - "cross-spawn": "^7.0.3", - "get-stream": "^8.0.1", - "human-signals": "^5.0.0", - "is-stream": "^3.0.0", - "merge-stream": "^2.0.0", - "npm-run-path": "^5.1.0", - "onetime": "^6.0.0", - "signal-exit": "^4.1.0", - "strip-final-newline": "^3.0.0" - }, + "license": "Apache-2.0", "engines": { - "node": ">=16.17" - }, - "funding": { - "url": "https://github.com/sindresorhus/execa?sponsor=1" + "node": ">=12.0.0" } }, "node_modules/fast-deep-equal": { @@ -2339,36 +2510,6 @@ "dev": true, "license": "Apache-2.0" }, - "node_modules/fast-glob": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", - "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@nodelib/fs.stat": "^2.0.2", - "@nodelib/fs.walk": "^1.2.3", - "glob-parent": "^5.1.2", - "merge2": "^1.3.0", - "micromatch": "^4.0.8" - }, - "engines": { - "node": ">=8.6.0" - } - }, - "node_modules/fast-glob/node_modules/glob-parent": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "dev": true, - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, "node_modules/fast-json-stable-stringify": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", @@ -2384,15 +2525,33 @@ "license": "MIT" }, "node_modules/fastq": { - "version": "1.19.1", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.1.tgz", - "integrity": "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ==", + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", + "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", "dev": true, "license": "ISC", "dependencies": { "reusify": "^1.0.4" } }, + "node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, "node_modules/fflate": { "version": "0.8.2", "resolved": "https://registry.npmjs.org/fflate/-/fflate-0.8.2.tgz", @@ -2413,19 +2572,6 @@ "node": "^10.12.0 || >=12.0.0" } }, - "node_modules/fill-range": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", - "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", - "dev": true, - "license": "MIT", - "dependencies": { - "to-regex-range": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/find-up": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", @@ -2471,9 +2617,9 @@ } }, "node_modules/flat-cache/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "version": "1.1.14", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.14.tgz", + "integrity": "sha512-MWPGfDxnyzKU7rNOW9SP/c50vi3xrmrua/+6hfPbCS2ABNWfx24vPidzvC7krjU/RTo235sV776ymlsMtGKj8g==", "dev": true, "license": "MIT", "dependencies": { @@ -2485,7 +2631,7 @@ "version": "7.2.3", "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", + "deprecated": "Old versions of glob are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me", "dev": true, "license": "ISC", "dependencies": { @@ -2504,9 +2650,9 @@ } }, "node_modules/flat-cache/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, "license": "ISC", "dependencies": { @@ -2534,9 +2680,9 @@ } }, "node_modules/flatted": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.3.tgz", - "integrity": "sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg==", + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.4.2.tgz", + "integrity": "sha512-PjDse7RzhcPkIJwy5t7KPWQSZ9cAbzQXcafsetQoD7sOJRQlGikNbx7yZp2OotDnJyrDcbyRq3Ttb18iYOqkxA==", "dev": true, "license": "ISC" }, @@ -2579,33 +2725,10 @@ "node": "^8.16.0 || ^10.6.0 || >=11.0.0" } }, - "node_modules/get-func-name": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.2.tgz", - "integrity": "sha512-8vXOvuE167CtIc3OyItco7N/dpRtBbYOsPsXCz7X/PMnlGjYjSGuZJgM1Y7mmew7BKf9BqvLX2tnOVy1BBUsxQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": "*" - } - }, - "node_modules/get-stream": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-8.0.1.tgz", - "integrity": "sha512-VaUJspBffn/LMCJVoMvSAdmscJyS1auj5Zulnn5UoYcY531UWmdwhRWkcGKnGU93m5HSXP9LP2usOryrBtQowA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/get-tsconfig": { - "version": "4.13.0", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.13.0.tgz", - "integrity": "sha512-1VKTZJCwBrvbd+Wn3AOgQP/2Av+TfTCOlE4AcRJE72W1ksZXbAx8PPBR9RzgTeSPzlPMHrbANMH3LbltH73wxQ==", + "version": "4.14.0", + "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.14.0.tgz", + "integrity": "sha512-yTb+8DXzDREzgvYmh6s9vHsSVCHeC0G3PI5bEXNBHtmshPnO+S5O7qgLEOn0I5QvMy6kpZN8K1NKGyilLb93wA==", "dev": true, "license": "MIT", "dependencies": { @@ -2616,9 +2739,10 @@ } }, "node_modules/glob": { - "version": "10.4.5", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.4.5.tgz", - "integrity": "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg==", + "version": "10.5.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-10.5.0.tgz", + "integrity": "sha512-DfXN8DfhJ7NH3Oe7cFmu3NCu1wKbkReJ8TorzSAFbSKrlNaQSKfIzqYqVY8zlbs2NLBbWpRiU52GX2PbaBVNkg==", + "deprecated": "Old versions of glob are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me", "dev": true, "license": "ISC", "dependencies": { @@ -2649,22 +2773,6 @@ "node": ">=10.13.0" } }, - "node_modules/glob/node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/globals": { "version": "13.24.0", "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", @@ -2681,27 +2789,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/globby": { - "version": "11.1.0", - "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", - "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", - "dev": true, - "license": "MIT", - "dependencies": { - "array-union": "^2.1.0", - "dir-glob": "^3.0.1", - "fast-glob": "^3.2.9", - "ignore": "^5.2.0", - "merge2": "^1.4.1", - "slash": "^3.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/graphemer": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", @@ -2726,14 +2813,18 @@ "dev": true, "license": "MIT" }, - "node_modules/human-signals": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-5.0.0.tgz", - "integrity": "sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==", + "node_modules/https-proxy-agent": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz", + "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==", "dev": true, - "license": "Apache-2.0", + "license": "MIT", + "dependencies": { + "agent-base": "^7.1.2", + "debug": "4" + }, "engines": { - "node": ">=16.17.0" + "node": ">= 14" } }, "node_modules/ignore": { @@ -2773,6 +2864,19 @@ "node": ">=0.8.19" } }, + "node_modules/index-to-position": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/index-to-position/-/index-to-position-1.2.0.tgz", + "integrity": "sha512-Yg7+ztRkqslMAS2iFaU+Oa4KTSidr63OsFGlOrJoW981kIYO3CGCS3wA95P1mUi/IVSJkn0D479KTJpVpvFNuw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -2825,16 +2929,6 @@ "node": ">=0.10.0" } }, - "node_modules/is-number": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.12.0" - } - }, "node_modules/is-path-inside": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", @@ -2845,19 +2939,6 @@ "node": ">=8" } }, - "node_modules/is-stream": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz", - "integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", @@ -2945,17 +3026,27 @@ "node": ">=10" } }, + "node_modules/js-levenshtein": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/js-levenshtein/-/js-levenshtein-1.1.6.tgz", + "integrity": "sha512-X2BB11YZtrRqY4EnQcLX5Rh373zbK4alC1FW7D7MBhL2gtcC17cTnr6DmfHZeS0s2rTHjUTMMHfG7gO8SSdw+g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/js-tokens": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz", - "integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==", + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-10.0.0.tgz", + "integrity": "sha512-lM/UBzQmfJRo9ABXbPWemivdCW8V2G8FHaHdypQaIy523snUjog0W71ayWXTjiR+ixeMyVHN2XcpnTd/liPg/Q==", "dev": true, "license": "MIT" }, "node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", + "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", "dev": true, "license": "MIT", "dependencies": { @@ -3047,23 +3138,6 @@ "node": "^12.20.0 || ^14.13.1 || >=16.0.0" } }, - "node_modules/local-pkg": { - "version": "0.5.1", - "resolved": "https://registry.npmjs.org/local-pkg/-/local-pkg-0.5.1.tgz", - "integrity": "sha512-9rrA30MRRP3gBD3HTGnC6cDFpaE1kVDWxWgqWJUN0RvDNAo+Nz/9GxB+nHOH0ifbVFy0hSA1V6vFDvnx54lTEQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "mlly": "^1.7.3", - "pkg-types": "^1.2.1" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/antfu" - } - }, "node_modules/locate-path": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", @@ -3087,22 +3161,12 @@ "dev": true, "license": "MIT" }, - "node_modules/lodash.sortby": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/lodash.sortby/-/lodash.sortby-4.7.0.tgz", - "integrity": "sha512-HDWXG8isMntAyRF5vZ7xKuEvOhT4AhlRt/3czTSjvGUxjYCBVRQY48ViDHyfYz9VIoBkW4TMGQNapx+l3RUwdA==", - "dev": true, - "license": "MIT" - }, "node_modules/loupe": { - "version": "2.3.7", - "resolved": "https://registry.npmjs.org/loupe/-/loupe-2.3.7.tgz", - "integrity": "sha512-zSMINGVYkdpYSOBmLi0D1Uo7JU9nVdQKrHxC8eYlV+9YKK9WePqAlL7lSlorG/U2Fw1w0hTBmaa/jrQ3UbPHtA==", + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.1.tgz", + "integrity": "sha512-CdzqowRJCeLU72bHvWqwRBBlLcMEtIvGrlvef74kMnV2AolS9Y8xUv1I0U/MNAWMhBlKIoyuEgoJ0t/bbwHbLQ==", "dev": true, - "license": "MIT", - "dependencies": { - "get-func-name": "^2.0.1" - } + "license": "MIT" }, "node_modules/lru-cache": { "version": "10.4.3", @@ -3169,58 +3233,14 @@ "node": ">= 12" } }, - "node_modules/merge-stream": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", - "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", - "dev": true, - "license": "MIT" - }, - "node_modules/merge2": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 8" - } - }, - "node_modules/micromatch": { - "version": "4.0.8", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", - "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", - "dev": true, - "license": "MIT", - "dependencies": { - "braces": "^3.0.3", - "picomatch": "^2.3.1" - }, - "engines": { - "node": ">=8.6" - } - }, - "node_modules/mimic-fn": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-4.0.0.tgz", - "integrity": "sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/minimatch": { - "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", + "version": "9.0.9", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.9.tgz", + "integrity": "sha512-OBwBN9AL4dqmETlpS2zasx+vTeWclWzkblfZk7KTA5j3jeOONz/tRCnZomUyvNg83wL5Zv9Ss6HMJXAgL8R2Yg==", "dev": true, "license": "ISC", "dependencies": { - "brace-expansion": "^2.0.1" + "brace-expansion": "^2.0.2" }, "engines": { "node": ">=16 || 14 >=14.17" @@ -3230,35 +3250,28 @@ } }, "node_modules/minipass": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", - "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.3.tgz", + "integrity": "sha512-tEBHqDnIoM/1rXME1zgka9g6Q2lcoCkxHLuc7ODJ5BxbP5d4c2Z5cGgtXAku59200Cx7diuHTOYfSBD8n6mm8A==", "dev": true, - "license": "ISC", + "license": "BlueOak-1.0.0", "engines": { "node": ">=16 || 14 >=14.17" } }, "node_modules/mlly": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/mlly/-/mlly-1.8.0.tgz", - "integrity": "sha512-l8D9ODSRWLe2KHJSifWGwBqpTZXIXTeo8mlKjY+E2HAakaTeNpqAyBZ8GSqLzHgw4XmHmC8whvpjJNMbFZN7/g==", + "version": "1.8.2", + "resolved": "https://registry.npmjs.org/mlly/-/mlly-1.8.2.tgz", + "integrity": "sha512-d+ObxMQFmbt10sretNDytwt85VrbkhhUA/JBGm1MPaWJ65Cl4wOgLaB1NYvJSZ0Ef03MMEU/0xpPMXUIQ29UfA==", "dev": true, "license": "MIT", "dependencies": { - "acorn": "^8.15.0", + "acorn": "^8.16.0", "pathe": "^2.0.3", "pkg-types": "^1.3.1", - "ufo": "^1.6.1" + "ufo": "^1.6.3" } }, - "node_modules/mlly/node_modules/pathe": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", - "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", - "dev": true, - "license": "MIT" - }, "node_modules/mrmime": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/mrmime/-/mrmime-2.0.1.tgz", @@ -3314,35 +3327,6 @@ "dev": true, "license": "MIT" }, - "node_modules/npm-run-path": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.3.0.tgz", - "integrity": "sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "path-key": "^4.0.0" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/npm-run-path/node_modules/path-key": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-4.0.0.tgz", - "integrity": "sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/object-assign": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", @@ -3363,48 +3347,35 @@ "wrappy": "1" } }, - "node_modules/onetime": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/onetime/-/onetime-6.0.0.tgz", - "integrity": "sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "mimic-fn": "^4.0.0" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/openapi-typescript": { - "version": "6.7.6", - "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-6.7.6.tgz", - "integrity": "sha512-c/hfooPx+RBIOPM09GSxABOZhYPblDoyaGhqBkD/59vtpN21jEuWKDlM0KYTvqJVlSYjKs0tBcIdeXKChlSPtw==", + "node_modules/openapi-typescript": { + "version": "7.13.0", + "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-7.13.0.tgz", + "integrity": "sha512-EFP392gcqXS7ntPvbhBzbF8TyBA+baIYEm791Hy5YkjDYKTnk/Tn5OQeKm5BIZvJihpp8Zzr4hzx0Irde1LNGQ==", "dev": true, "license": "MIT", "dependencies": { + "@redocly/openapi-core": "^1.34.6", "ansi-colors": "^4.1.3", - "fast-glob": "^3.3.2", - "js-yaml": "^4.1.0", - "supports-color": "^9.4.0", - "undici": "^5.28.4", + "change-case": "^5.4.4", + "parse-json": "^8.3.0", + "supports-color": "^10.2.2", "yargs-parser": "^21.1.1" }, "bin": { "openapi-typescript": "bin/cli.js" + }, + "peerDependencies": { + "typescript": "^5.x" } }, "node_modules/openapi-typescript/node_modules/supports-color": { - "version": "9.4.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-9.4.0.tgz", - "integrity": "sha512-VL+lNrEoIXww1coLPOmiEmK/0sGigko5COxI09KzHc2VJXJsQ37UaQ+8quuxjDeA7+KnLGTWRyOXSLLR2Wb4jw==", + "version": "10.2.2", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-10.2.2.tgz", + "integrity": "sha512-SS+jx45GF1QjgEXQx4NJZV9ImqmO2NPz5FNsIHrsDjh2YsHnawpan7SNQ1o8NuhrbHZy9AZhIoCUiCeaW/C80g==", "dev": true, "license": "MIT", "engines": { - "node": ">=12" + "node": ">=18" }, "funding": { "url": "https://github.com/chalk/supports-color?sponsor=1" @@ -3480,6 +3451,37 @@ "node": ">=6" } }, + "node_modules/parse-json": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-8.3.0.tgz", + "integrity": "sha512-ybiGyvspI+fAoRQbIPRddCcSTV9/LsJbf0e/S85VLowVGzRmokfneg2kwVW/KU5rOXrPSbF1qAKPMgNTqqROQQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.26.2", + "index-to-position": "^1.1.0", + "type-fest": "^4.39.1" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/parse-json/node_modules/type-fest": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.41.0.tgz", + "integrity": "sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA==", + "dev": true, + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/path-exists": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", @@ -3527,31 +3529,21 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/path-type": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", - "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, "node_modules/pathe": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/pathe/-/pathe-1.1.2.tgz", - "integrity": "sha512-whLdWMYL2TwI08hn8/ZqAbrVemu0LNaNNJZX73O6qaIdCTfXutsLhMkjdENX0qhsQ9uIimo4/aQOmXkoon2nDQ==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", + "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", "dev": true, "license": "MIT" }, "node_modules/pathval": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.1.tgz", - "integrity": "sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.1.tgz", + "integrity": "sha512-//nshmD55c46FuFw26xV/xFAaB5HF9Xdap7HJBBnrKdAd6/GxDBaNA1870O79+9ueg61cZLSVc+OaFlfmObYVQ==", "dev": true, "license": "MIT", "engines": { - "node": "*" + "node": ">= 14.16" } }, "node_modules/picocolors": { @@ -3562,13 +3554,13 @@ "license": "ISC" }, "node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", + "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", "dev": true, "license": "MIT", "engines": { - "node": ">=8.6" + "node": ">=12" }, "funding": { "url": "https://github.com/sponsors/jonschlinkert" @@ -3596,17 +3588,20 @@ "pathe": "^2.0.1" } }, - "node_modules/pkg-types/node_modules/pathe": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", - "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", + "node_modules/pluralize": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", + "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", "dev": true, - "license": "MIT" + "license": "MIT", + "engines": { + "node": ">=4" + } }, "node_modules/postcss": { - "version": "8.5.6", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.6.tgz", - "integrity": "sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==", + "version": "8.5.10", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.10.tgz", + "integrity": "sha512-pMMHxBOZKFU6HgAZ4eyGnwXF/EvPGGqUr0MnZ5+99485wwW41kW91A4LOGxSHhgugZmSChL5AlElNdwlNgcnLQ==", "dev": true, "funding": [ { @@ -3686,9 +3681,9 @@ } }, "node_modules/prettier": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.6.2.tgz", - "integrity": "sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ==", + "version": "3.8.3", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.8.3.tgz", + "integrity": "sha512-7igPTM53cGHMW8xWuVTydi2KO233VFiTNyF5hLJqpilHfmn8C8gPf+PS7dUT64YcXFbiMGZxS9pCSxL/Dxm/Jw==", "dev": true, "license": "MIT", "bin": { @@ -3702,9 +3697,9 @@ } }, "node_modules/prettier-linter-helpers": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz", - "integrity": "sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/prettier-linter-helpers/-/prettier-linter-helpers-1.0.1.tgz", + "integrity": "sha512-SxToR7P8Y2lWmv/kTzVLC1t/GDI2WGjMwNhLLE9qtH8Q13C+aEmuRlzDst4Up4s0Wc8sF2M+J57iB3cMLqftfg==", "dev": true, "license": "MIT", "dependencies": { @@ -3714,34 +3709,6 @@ "node": ">=6.0.0" } }, - "node_modules/pretty-format": { - "version": "29.7.0", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.7.0.tgz", - "integrity": "sha512-Pdlw/oPxN+aXdmM9R00JVC9WVFoCLTKJvDVLgmJ+qAffBMxsV85l/Lu7sNx4zSzPyoL2euImuEwHhOXdEgNFZQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@jest/schemas": "^29.6.3", - "ansi-styles": "^5.0.0", - "react-is": "^18.0.0" - }, - "engines": { - "node": "^14.15.0 || ^16.10.0 || >=18.0.0" - } - }, - "node_modules/pretty-format/node_modules/ansi-styles": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", - "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, "node_modules/punycode": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", @@ -3773,13 +3740,6 @@ ], "license": "MIT" }, - "node_modules/react-is": { - "version": "18.3.1", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz", - "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==", - "dev": true, - "license": "MIT" - }, "node_modules/readdirp": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-4.1.2.tgz", @@ -3794,6 +3754,16 @@ "url": "https://paulmillr.com/funding/" } }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/resolve-from": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", @@ -3842,9 +3812,9 @@ } }, "node_modules/rollup": { - "version": "4.53.2", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.53.2.tgz", - "integrity": "sha512-MHngMYwGJVi6Fmnk6ISmnk7JAHRNF0UkuucA0CUW3N3a4KnONPEZz+vUanQP/ZC/iY1Qkf3bwPWzyY84wEks1g==", + "version": "4.60.2", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.60.2.tgz", + "integrity": "sha512-J9qZyW++QK/09NyN/zeO0dG/1GdGfyp9lV8ajHnRVLfo/uFsbji5mHnDgn/qYdUHyCkM2N+8VyspgZclfAh0eQ==", "dev": true, "license": "MIT", "dependencies": { @@ -3858,28 +3828,31 @@ "npm": ">=8.0.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.53.2", - "@rollup/rollup-android-arm64": "4.53.2", - "@rollup/rollup-darwin-arm64": "4.53.2", - "@rollup/rollup-darwin-x64": "4.53.2", - "@rollup/rollup-freebsd-arm64": "4.53.2", - "@rollup/rollup-freebsd-x64": "4.53.2", - "@rollup/rollup-linux-arm-gnueabihf": "4.53.2", - "@rollup/rollup-linux-arm-musleabihf": "4.53.2", - "@rollup/rollup-linux-arm64-gnu": "4.53.2", - "@rollup/rollup-linux-arm64-musl": "4.53.2", - "@rollup/rollup-linux-loong64-gnu": "4.53.2", - "@rollup/rollup-linux-ppc64-gnu": "4.53.2", - "@rollup/rollup-linux-riscv64-gnu": "4.53.2", - "@rollup/rollup-linux-riscv64-musl": "4.53.2", - "@rollup/rollup-linux-s390x-gnu": "4.53.2", - "@rollup/rollup-linux-x64-gnu": "4.53.2", - "@rollup/rollup-linux-x64-musl": "4.53.2", - "@rollup/rollup-openharmony-arm64": "4.53.2", - "@rollup/rollup-win32-arm64-msvc": "4.53.2", - "@rollup/rollup-win32-ia32-msvc": "4.53.2", - "@rollup/rollup-win32-x64-gnu": "4.53.2", - "@rollup/rollup-win32-x64-msvc": "4.53.2", + "@rollup/rollup-android-arm-eabi": "4.60.2", + "@rollup/rollup-android-arm64": "4.60.2", + "@rollup/rollup-darwin-arm64": "4.60.2", + "@rollup/rollup-darwin-x64": "4.60.2", + "@rollup/rollup-freebsd-arm64": "4.60.2", + "@rollup/rollup-freebsd-x64": "4.60.2", + "@rollup/rollup-linux-arm-gnueabihf": "4.60.2", + "@rollup/rollup-linux-arm-musleabihf": "4.60.2", + "@rollup/rollup-linux-arm64-gnu": "4.60.2", + "@rollup/rollup-linux-arm64-musl": "4.60.2", + "@rollup/rollup-linux-loong64-gnu": "4.60.2", + "@rollup/rollup-linux-loong64-musl": "4.60.2", + "@rollup/rollup-linux-ppc64-gnu": "4.60.2", + "@rollup/rollup-linux-ppc64-musl": "4.60.2", + "@rollup/rollup-linux-riscv64-gnu": "4.60.2", + "@rollup/rollup-linux-riscv64-musl": "4.60.2", + "@rollup/rollup-linux-s390x-gnu": "4.60.2", + "@rollup/rollup-linux-x64-gnu": "4.60.2", + "@rollup/rollup-linux-x64-musl": "4.60.2", + "@rollup/rollup-openbsd-x64": "4.60.2", + "@rollup/rollup-openharmony-arm64": "4.60.2", + "@rollup/rollup-win32-arm64-msvc": "4.60.2", + "@rollup/rollup-win32-ia32-msvc": "4.60.2", + "@rollup/rollup-win32-x64-gnu": "4.60.2", + "@rollup/rollup-win32-x64-msvc": "4.60.2", "fsevents": "~2.3.2" } }, @@ -3908,9 +3881,9 @@ } }, "node_modules/semver": { - "version": "7.7.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", - "integrity": "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", + "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", "dev": true, "license": "ISC", "bin": { @@ -3977,9 +3950,9 @@ } }, "node_modules/sirv": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/sirv/-/sirv-2.0.4.tgz", - "integrity": "sha512-94Bdh3cC2PKrbgSOUqTiGPWVZeSiXfKOVZNJniWoqrWrRkB1CJzBU3NEbiTsPcYy1lDsANA/THzS+9WBiy5nfQ==", + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/sirv/-/sirv-3.0.2.tgz", + "integrity": "sha512-2wcC/oGxHis/BoHkkPwldgiPSYcpZK3JU28WoMVv55yHJgcZ8rlXvuG9iZggz+sU1d4bRgIGASwyWqjxu3FM0g==", "dev": true, "license": "MIT", "dependencies": { @@ -3988,31 +3961,17 @@ "totalist": "^3.0.0" }, "engines": { - "node": ">= 10" - } - }, - "node_modules/slash": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", - "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" + "node": ">=18" } }, "node_modules/source-map": { - "version": "0.8.0-beta.0", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.8.0-beta.0.tgz", - "integrity": "sha512-2ymg6oRBpebeZi9UUNsgQ89bhx01TcTkmNTGnNO88imTmbSgy4nfujrgVEFKWpMTEGA11EDkTt7mqObTPdigIA==", - "deprecated": "The work that was done in this beta branch won't be included in future versions", + "version": "0.7.6", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.6.tgz", + "integrity": "sha512-i5uvt8C3ikiWeNZSVZNWcfZPItFQOsYTUAOkcUPGd8DqDy1uOUikjt5dG+uRlwyvR108Fb9DOd4GvXfT0N2/uQ==", "dev": true, "license": "BSD-3-Clause", - "dependencies": { - "whatwg-url": "^7.0.0" - }, "engines": { - "node": ">= 8" + "node": ">= 12" } }, "node_modules/source-map-js": { @@ -4094,13 +4053,13 @@ } }, "node_modules/string-width/node_modules/strip-ansi": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", - "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", + "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", "dev": true, "license": "MIT", "dependencies": { - "ansi-regex": "^6.0.1" + "ansi-regex": "^6.2.2" }, "engines": { "node": ">=12" @@ -4136,19 +4095,6 @@ "node": ">=8" } }, - "node_modules/strip-final-newline": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-3.0.0.tgz", - "integrity": "sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/strip-json-comments": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", @@ -4163,9 +4109,9 @@ } }, "node_modules/strip-literal": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-2.1.1.tgz", - "integrity": "sha512-631UJ6O00eNGfMiWG78ck80dfBab8X6IVFB51jZK5Icd7XAs60Z5y7QdSd/wGIklnWvRbUNloVzhOKKmutxQ6Q==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-3.1.0.tgz", + "integrity": "sha512-8r3mkIM/2+PpjHoOtiAW8Rg3jJLHaV7xPwG+YRGrv6FP0wwk/toTpATxWYOW0BKdWwl82VT2tFYi5DlROa0Mxg==", "dev": true, "license": "MIT", "dependencies": { @@ -4175,19 +4121,26 @@ "url": "https://github.com/sponsors/antfu" } }, + "node_modules/strip-literal/node_modules/js-tokens": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz", + "integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==", + "dev": true, + "license": "MIT" + }, "node_modules/sucrase": { - "version": "3.35.0", - "resolved": "https://registry.npmjs.org/sucrase/-/sucrase-3.35.0.tgz", - "integrity": "sha512-8EbVDiu9iN/nESwxeSxDKe0dunta1GOlHufmSSXxMD2z2/tMZpDMpvXQGsc+ajGo8y2uYUmixaSRUc/QPoQ0GA==", + "version": "3.35.1", + "resolved": "https://registry.npmjs.org/sucrase/-/sucrase-3.35.1.tgz", + "integrity": "sha512-DhuTmvZWux4H1UOnWMB3sk0sbaCVOoQZjv8u1rDoTV0HTdGem9hkAZtl4JZy8P2z4Bg0nT+YMeOFyVr4zcG5Tw==", "dev": true, "license": "MIT", "dependencies": { "@jridgewell/gen-mapping": "^0.3.2", "commander": "^4.0.0", - "glob": "^10.3.10", "lines-and-columns": "^1.1.6", "mz": "^2.7.0", "pirates": "^4.0.1", + "tinyglobby": "^0.2.11", "ts-interface-checker": "^0.1.9" }, "bin": { @@ -4212,9 +4165,9 @@ } }, "node_modules/synckit": { - "version": "0.11.11", - "resolved": "https://registry.npmjs.org/synckit/-/synckit-0.11.11.tgz", - "integrity": "sha512-MeQTA1r0litLUf0Rp/iisCaL8761lKAZHaimlbGK4j0HysC4PLfqygQj9srcs0m2RdtDYnF8UuYyKpbjHYp7Jw==", + "version": "0.11.12", + "resolved": "https://registry.npmjs.org/synckit/-/synckit-0.11.12.tgz", + "integrity": "sha512-Bh7QjT8/SuKUIfObSXNHNSK6WHo6J1tHCqJsuaFDP7gP0fkzSfTxI8y85JrppZ0h8l0maIgc2tfuZQ6/t3GtnQ==", "dev": true, "license": "MIT", "dependencies": { @@ -4228,64 +4181,57 @@ } }, "node_modules/test-exclude": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", - "integrity": "sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==", + "version": "7.0.2", + "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-7.0.2.tgz", + "integrity": "sha512-u9E6A+ZDYdp7a4WnarkXPZOx8Ilz46+kby6p1yZ8zsGTz9gYa6FIS7lj2oezzNKmtdyyJNNmmXDppga5GB7kSw==", "dev": true, "license": "ISC", "dependencies": { "@istanbuljs/schema": "^0.1.2", - "glob": "^7.1.4", - "minimatch": "^3.0.4" + "glob": "^10.4.1", + "minimatch": "^10.2.2" }, "engines": { - "node": ">=8" + "node": ">=18" } }, - "node_modules/test-exclude/node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "node_modules/test-exclude/node_modules/balanced-match": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", + "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==", "dev": true, "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" + "engines": { + "node": "18 || 20 || >=22" } }, - "node_modules/test-exclude/node_modules/glob": { - "version": "7.2.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", - "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", + "node_modules/test-exclude/node_modules/brace-expansion": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.5.tgz", + "integrity": "sha512-VZznLgtwhn+Mact9tfiwx64fA9erHH/MCXEUfB/0bX/6Fz6ny5EGTXYltMocqg4xFAQZtnO3DHWWXi8RiuN7cQ==", "dev": true, - "license": "ISC", + "license": "MIT", "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.1.1", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" + "balanced-match": "^4.0.2" }, "engines": { - "node": "*" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" + "node": "18 || 20 || >=22" } }, "node_modules/test-exclude/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "10.2.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.5.tgz", + "integrity": "sha512-MULkVLfKGYDFYejP07QOurDLLQpcjk7Fw+7jXS2R2czRQzR56yHRveU5NDJEOviH+hETZKSkIk5c+T23GjFUMg==", "dev": true, - "license": "ISC", + "license": "BlueOak-1.0.0", "dependencies": { - "brace-expansion": "^1.1.7" + "brace-expansion": "^5.0.5" }, "engines": { - "node": "*" + "node": "18 || 20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, "node_modules/text-table": { @@ -4333,14 +4279,14 @@ "license": "MIT" }, "node_modules/tinyglobby": { - "version": "0.2.15", - "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", - "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "version": "0.2.16", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.16.tgz", + "integrity": "sha512-pn99VhoACYR8nFHhxqix+uvsbXineAasWm5ojXoN8xEwK5Kd3/TrhNn1wByuD52UxWRLy8pu+kRMniEi6Eq9Zg==", "dev": true, "license": "MIT", "dependencies": { "fdir": "^6.5.0", - "picomatch": "^4.0.3" + "picomatch": "^4.0.4" }, "engines": { "node": ">=12.0.0" @@ -4349,41 +4295,20 @@ "url": "https://github.com/sponsors/SuperchupuDev" } }, - "node_modules/tinyglobby/node_modules/fdir": { - "version": "6.5.0", - "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", - "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12.0.0" - }, - "peerDependencies": { - "picomatch": "^3 || ^4" - }, - "peerDependenciesMeta": { - "picomatch": { - "optional": true - } - } - }, - "node_modules/tinyglobby/node_modules/picomatch": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", - "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "node_modules/tinypool": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", + "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", "dev": true, "license": "MIT", "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" + "node": "^18.0.0 || >=20.0.0" } }, - "node_modules/tinypool": { - "version": "0.8.4", - "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-0.8.4.tgz", - "integrity": "sha512-i11VH5gS6IFeLY3gMBQ00/MmLncVP7JLXOw1vlgkytLmJK7QnEr7NXf0LBdxfmNPAeyetukOk0bOYrJrFGjYJQ==", + "node_modules/tinyrainbow": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", + "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", "dev": true, "license": "MIT", "engines": { @@ -4391,28 +4316,15 @@ } }, "node_modules/tinyspy": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-2.2.1.tgz", - "integrity": "sha512-KYad6Vy5VDWV4GH3fjpseMQ/XU2BhIYP7Vzd0LG44qRWm/Yt2WCOTicFdvmgo6gWaqooMQCawTtILVQJupKu7A==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-4.0.4.tgz", + "integrity": "sha512-azl+t0z7pw/z958Gy9svOTuzqIk6xq+NSheJzn5MMWtWTFywIacg2wUlzKFGtt3cthx0r2SxMK0yzJOR0IES7Q==", "dev": true, "license": "MIT", "engines": { "node": ">=14.0.0" } }, - "node_modules/to-regex-range": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-number": "^7.0.0" - }, - "engines": { - "node": ">=8.0" - } - }, "node_modules/totalist": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/totalist/-/totalist-3.0.1.tgz", @@ -4423,16 +4335,6 @@ "node": ">=6" } }, - "node_modules/tr46": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-1.0.1.tgz", - "integrity": "sha512-dTpowEjclQ7Kgx5SdBkqRzVhERQXov8/l9Ft9dVM9fmg0W0KQSVaXX9T4i6twCPNtYiZM53lpSSUAwJbFPOHxA==", - "dev": true, - "license": "MIT", - "dependencies": { - "punycode": "^2.1.0" - } - }, "node_modules/tree-kill": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/tree-kill/-/tree-kill-1.2.2.tgz", @@ -4444,16 +4346,16 @@ } }, "node_modules/ts-api-utils": { - "version": "1.4.3", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.4.3.tgz", - "integrity": "sha512-i3eMG77UTMD0hZhgRS562pv83RC6ukSAC2GMNWc+9dieh/+jDM5u5YG+NHX6VNDRHQcHwmsTHctP9LhbC3WxVw==", + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.5.0.tgz", + "integrity": "sha512-OJ/ibxhPlqrMM0UiNHJ/0CKQkoKF243/AEmplt3qpRgkW8VG7IfOS41h7V8TjITqdByHzrjcS/2si+y4lIh8NA==", "dev": true, "license": "MIT", "engines": { - "node": ">=16" + "node": ">=18.12" }, "peerDependencies": { - "typescript": ">=4.2.0" + "typescript": ">=4.8.4" } }, "node_modules/ts-interface-checker": { @@ -4464,9 +4366,9 @@ "license": "Apache-2.0" }, "node_modules/tsup": { - "version": "8.5.0", - "resolved": "https://registry.npmjs.org/tsup/-/tsup-8.5.0.tgz", - "integrity": "sha512-VmBp77lWNQq6PfuMqCHD3xWl22vEoWsKajkF8t+yMBawlUS8JzEI+vOVMeuNZIuMML8qXRizFKi9oD5glKQVcQ==", + "version": "8.5.1", + "resolved": "https://registry.npmjs.org/tsup/-/tsup-8.5.1.tgz", + "integrity": "sha512-xtgkqwdhpKWr3tKPmCkvYmS9xnQK3m3XgxZHwSUjvfTjp7YfXe5tT3GgWi0F2N+ZSMsOeWeZFh7ZZFg5iPhing==", "dev": true, "license": "MIT", "dependencies": { @@ -4475,14 +4377,14 @@ "chokidar": "^4.0.3", "consola": "^3.4.0", "debug": "^4.4.0", - "esbuild": "^0.25.0", + "esbuild": "^0.27.0", "fix-dts-default-cjs-exports": "^1.0.0", "joycon": "^3.1.1", "picocolors": "^1.1.1", "postcss-load-config": "^6.0.1", "resolve-from": "^5.0.0", "rollup": "^4.34.8", - "source-map": "0.8.0-beta.0", + "source-map": "^0.7.6", "sucrase": "^3.35.0", "tinyexec": "^0.3.2", "tinyglobby": "^0.2.11", @@ -4527,13 +4429,13 @@ } }, "node_modules/tsx": { - "version": "4.20.6", - "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.20.6.tgz", - "integrity": "sha512-ytQKuwgmrrkDTFP4LjR0ToE2nqgy886GpvRSpU0JAnrdBYppuY5rLkRUYPU1yCryb24SsKBTL/hlDQAEFVwtZg==", + "version": "4.21.0", + "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.21.0.tgz", + "integrity": "sha512-5C1sg4USs1lfG0GFb2RLXsdpXqBSEhAaA/0kPL01wxzpMqLILNxIxIOKiILz+cdg/pLnOUxFYOR5yhHU666wbw==", "dev": true, "license": "MIT", "dependencies": { - "esbuild": "~0.25.0", + "esbuild": "~0.27.0", "get-tsconfig": "^4.7.5" }, "bin": { @@ -4559,16 +4461,6 @@ "node": ">= 0.8.0" } }, - "node_modules/type-detect": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.1.0.tgz", - "integrity": "sha512-Acylog8/luQ8L7il+geoSxhEkazvkslg7PSNKOX59mbB9cOveP5aq9h74Y7YU8yDpJwetzQQrfIwtf4Wp4LKcw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } - }, "node_modules/type-fest": { "version": "0.20.2", "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", @@ -4619,25 +4511,12 @@ } }, "node_modules/ufo": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/ufo/-/ufo-1.6.1.tgz", - "integrity": "sha512-9a4/uxlTWJ4+a5i0ooc1rU7C7YOw3wT+UGqdeNNHWnOF9qcMBgLRS+4IYUqbczewFx4mLEig6gawh7X6mFlEkA==", + "version": "1.6.3", + "resolved": "https://registry.npmjs.org/ufo/-/ufo-1.6.3.tgz", + "integrity": "sha512-yDJTmhydvl5lJzBmy/hyOAA0d+aqCBuwl818haVdYCRrWV84o7YyeVm4QlVHStqNrrJSTb6jKuFAVqAFsr+K3Q==", "dev": true, "license": "MIT" }, - "node_modules/undici": { - "version": "5.29.0", - "resolved": "https://registry.npmjs.org/undici/-/undici-5.29.0.tgz", - "integrity": "sha512-raqeBD6NQK4SkWhQzeYKd1KmIG6dllBOTt55Rmkt4HtI9mwdWtJljnrXjAFUBLTSN67HWrOIZ3EPF4kjUw80Bg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@fastify/busboy": "^2.0.0" - }, - "engines": { - "node": ">=14.0" - } - }, "node_modules/undici-types": { "version": "6.21.0", "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz", @@ -4655,22 +4534,32 @@ "punycode": "^2.1.0" } }, + "node_modules/uri-js-replace": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/uri-js-replace/-/uri-js-replace-1.0.1.tgz", + "integrity": "sha512-W+C9NWNLFOoBI2QWDp4UT9pv65r2w5Cx+3sTYFvtMdDBxkKt1syCqsUdSFAChbEe1uK5TfS04wt/nGwmaeIQ0g==", + "dev": true, + "license": "MIT" + }, "node_modules/vite": { - "version": "5.4.21", - "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.21.tgz", - "integrity": "sha512-o5a9xKjbtuhY6Bi5S3+HvbRERmouabWbyUcpXXUA1u+GNUKoROi9byOJ8M0nHbHYHkYICiMlqxkg1KkYmm25Sw==", + "version": "7.3.2", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.2.tgz", + "integrity": "sha512-Bby3NOsna2jsjfLVOHKes8sGwgl4TT0E6vvpYgnAYDIF/tie7MRaFthmKuHx1NSXjiTueXH3do80FMQgvEktRg==", "dev": true, "license": "MIT", "dependencies": { - "esbuild": "^0.21.3", - "postcss": "^8.4.43", - "rollup": "^4.20.0" + "esbuild": "^0.27.0", + "fdir": "^6.5.0", + "picomatch": "^4.0.3", + "postcss": "^8.5.6", + "rollup": "^4.43.0", + "tinyglobby": "^0.2.15" }, "bin": { "vite": "bin/vite.js" }, "engines": { - "node": "^18.0.0 || >=20.0.0" + "node": "^20.19.0 || >=22.12.0" }, "funding": { "url": "https://github.com/vitejs/vite?sponsor=1" @@ -4679,19 +4568,25 @@ "fsevents": "~2.3.3" }, "peerDependencies": { - "@types/node": "^18.0.0 || >=20.0.0", - "less": "*", + "@types/node": "^20.19.0 || >=22.12.0", + "jiti": ">=1.21.0", + "less": "^4.0.0", "lightningcss": "^1.21.0", - "sass": "*", - "sass-embedded": "*", - "stylus": "*", - "sugarss": "*", - "terser": "^5.4.0" + "sass": "^1.70.0", + "sass-embedded": "^1.70.0", + "stylus": ">=0.54.8", + "sugarss": "^5.0.0", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" }, "peerDependenciesMeta": { "@types/node": { "optional": true }, + "jiti": { + "optional": true + }, "less": { "optional": true }, @@ -4712,504 +4607,84 @@ }, "terser": { "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true } } }, "node_modules/vite-node": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-1.6.1.tgz", - "integrity": "sha512-YAXkfvGtuTzwWbDSACdJSg4A4DZiAqckWe90Zapc/sEX3XvHcw1NdurM/6od8J207tSDqNbSsgdCacBgvJKFuA==", + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.2.4.tgz", + "integrity": "sha512-EbKSKh+bh1E1IFxeO0pg1n4dvoOTt0UDiXMd/qn++r98+jPO1xtJilvXldeuQ8giIB5IkpjCgMleHMNEsGH6pg==", "dev": true, "license": "MIT", "dependencies": { "cac": "^6.7.14", - "debug": "^4.3.4", - "pathe": "^1.1.1", - "picocolors": "^1.0.0", - "vite": "^5.0.0" + "debug": "^4.4.1", + "es-module-lexer": "^1.7.0", + "pathe": "^2.0.3", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" }, "bin": { "vite-node": "vite-node.mjs" }, "engines": { - "node": "^18.0.0 || >=20.0.0" + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, - "node_modules/vite/node_modules/@esbuild/aix-ppc64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.21.5.tgz", - "integrity": "sha512-1SDgH6ZSPTlggy1yI6+Dbkiz8xzpHJEVAlF/AM1tHPLsf5STom9rwtjE4hKAF20FfXXNTFqEYXyJNWh1GiZedQ==", - "cpu": [ - "ppc64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "aix" - ], + "node_modules/vitest": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.2.4.tgz", + "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "^5.2.2", + "@vitest/expect": "3.2.4", + "@vitest/mocker": "3.2.4", + "@vitest/pretty-format": "^3.2.4", + "@vitest/runner": "3.2.4", + "@vitest/snapshot": "3.2.4", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "debug": "^4.4.1", + "expect-type": "^1.2.1", + "magic-string": "^0.30.17", + "pathe": "^2.0.3", + "picomatch": "^4.0.2", + "std-env": "^3.9.0", + "tinybench": "^2.9.0", + "tinyexec": "^0.3.2", + "tinyglobby": "^0.2.14", + "tinypool": "^1.1.1", + "tinyrainbow": "^2.0.0", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0", + "vite-node": "3.2.4", + "why-is-node-running": "^2.3.0" + }, + "bin": { + "vitest": "vitest.mjs" + }, "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/android-arm": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.21.5.tgz", - "integrity": "sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==", - "cpu": [ - "arm" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/android-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.21.5.tgz", - "integrity": "sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/android-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.21.5.tgz", - "integrity": "sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/darwin-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.21.5.tgz", - "integrity": "sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/darwin-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.21.5.tgz", - "integrity": "sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/freebsd-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.21.5.tgz", - "integrity": "sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/freebsd-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.21.5.tgz", - "integrity": "sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-arm": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.21.5.tgz", - "integrity": "sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==", - "cpu": [ - "arm" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.21.5.tgz", - "integrity": "sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-ia32": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.21.5.tgz", - "integrity": "sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==", - "cpu": [ - "ia32" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-loong64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.21.5.tgz", - "integrity": "sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==", - "cpu": [ - "loong64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-mips64el": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.21.5.tgz", - "integrity": "sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==", - "cpu": [ - "mips64el" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-ppc64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.21.5.tgz", - "integrity": "sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==", - "cpu": [ - "ppc64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-riscv64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.21.5.tgz", - "integrity": "sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==", - "cpu": [ - "riscv64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-s390x": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.21.5.tgz", - "integrity": "sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==", - "cpu": [ - "s390x" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.21.5.tgz", - "integrity": "sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/netbsd-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.21.5.tgz", - "integrity": "sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "netbsd" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/openbsd-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.21.5.tgz", - "integrity": "sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "openbsd" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/sunos-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.21.5.tgz", - "integrity": "sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "sunos" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/win32-arm64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.21.5.tgz", - "integrity": "sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/win32-ia32": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.21.5.tgz", - "integrity": "sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==", - "cpu": [ - "ia32" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/@esbuild/win32-x64": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.21.5.tgz", - "integrity": "sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=12" - } - }, - "node_modules/vite/node_modules/esbuild": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.21.5.tgz", - "integrity": "sha512-mg3OPMV4hXywwpoDxu3Qda5xCKQi+vCTZq8S9J/EpkhB2HzKXq4SNFZE3+NK93JYxc8VMSep+lOUSC/RVKaBqw==", - "dev": true, - "hasInstallScript": true, - "license": "MIT", - "bin": { - "esbuild": "bin/esbuild" - }, - "engines": { - "node": ">=12" - }, - "optionalDependencies": { - "@esbuild/aix-ppc64": "0.21.5", - "@esbuild/android-arm": "0.21.5", - "@esbuild/android-arm64": "0.21.5", - "@esbuild/android-x64": "0.21.5", - "@esbuild/darwin-arm64": "0.21.5", - "@esbuild/darwin-x64": "0.21.5", - "@esbuild/freebsd-arm64": "0.21.5", - "@esbuild/freebsd-x64": "0.21.5", - "@esbuild/linux-arm": "0.21.5", - "@esbuild/linux-arm64": "0.21.5", - "@esbuild/linux-ia32": "0.21.5", - "@esbuild/linux-loong64": "0.21.5", - "@esbuild/linux-mips64el": "0.21.5", - "@esbuild/linux-ppc64": "0.21.5", - "@esbuild/linux-riscv64": "0.21.5", - "@esbuild/linux-s390x": "0.21.5", - "@esbuild/linux-x64": "0.21.5", - "@esbuild/netbsd-x64": "0.21.5", - "@esbuild/openbsd-x64": "0.21.5", - "@esbuild/sunos-x64": "0.21.5", - "@esbuild/win32-arm64": "0.21.5", - "@esbuild/win32-ia32": "0.21.5", - "@esbuild/win32-x64": "0.21.5" - } - }, - "node_modules/vitest": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-1.6.1.tgz", - "integrity": "sha512-Ljb1cnSJSivGN0LqXd/zmDbWEM0RNNg2t1QW/XUhYl/qPqyu7CsqeWtqQXHVaJsecLPuDoak2oJcZN2QoRIOag==", - "dev": true, - "license": "MIT", - "dependencies": { - "@vitest/expect": "1.6.1", - "@vitest/runner": "1.6.1", - "@vitest/snapshot": "1.6.1", - "@vitest/spy": "1.6.1", - "@vitest/utils": "1.6.1", - "acorn-walk": "^8.3.2", - "chai": "^4.3.10", - "debug": "^4.3.4", - "execa": "^8.0.1", - "local-pkg": "^0.5.0", - "magic-string": "^0.30.5", - "pathe": "^1.1.1", - "picocolors": "^1.0.0", - "std-env": "^3.5.0", - "strip-literal": "^2.0.0", - "tinybench": "^2.5.1", - "tinypool": "^0.8.3", - "vite": "^5.0.0", - "vite-node": "1.6.1", - "why-is-node-running": "^2.2.2" - }, - "bin": { - "vitest": "vitest.mjs" - }, - "engines": { - "node": "^18.0.0 || >=20.0.0" + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "@edge-runtime/vm": "*", - "@types/node": "^18.0.0 || >=20.0.0", - "@vitest/browser": "1.6.1", - "@vitest/ui": "1.6.1", + "@types/debug": "^4.1.12", + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "@vitest/browser": "3.2.4", + "@vitest/ui": "3.2.4", "happy-dom": "*", "jsdom": "*" }, @@ -5217,6 +4692,9 @@ "@edge-runtime/vm": { "optional": true }, + "@types/debug": { + "optional": true + }, "@types/node": { "optional": true }, @@ -5248,25 +4726,6 @@ "dev": true, "license": "MIT" }, - "node_modules/webidl-conversions": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-4.0.2.tgz", - "integrity": "sha512-YQ+BmxuTgd6UXZW3+ICGfyqRyHXVlD5GtQr5+qjiNW7bF0cqrzX500HVXPBOvgXb5YnzDd+h0zqyv61KUD7+Sg==", - "dev": true, - "license": "BSD-2-Clause" - }, - "node_modules/whatwg-url": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-7.1.0.tgz", - "integrity": "sha512-WUu7Rg1DroM7oQvGWfOiAK21n74Gg+T4elXEQYkOhtyLeWiJFoOGLXPKI/9gzIie9CtwVLm8wtw6YJdKyxSjeg==", - "dev": true, - "license": "MIT", - "dependencies": { - "lodash.sortby": "^4.7.0", - "tr46": "^1.0.1", - "webidl-conversions": "^4.0.2" - } - }, "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", @@ -5396,13 +4855,13 @@ } }, "node_modules/wrap-ansi/node_modules/strip-ansi": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.2.tgz", - "integrity": "sha512-gmBGslpoQJtgnMAvOVqGZpEz9dyoKTCzy2nfz/n8aIFhN/jCE/rCmcxabB6jOOHV+0WNnylOxaxBQPSvcWklhA==", + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", + "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", "dev": true, "license": "MIT", "dependencies": { - "ansi-regex": "^6.0.1" + "ansi-regex": "^6.2.2" }, "engines": { "node": ">=12" @@ -5419,9 +4878,9 @@ "license": "ISC" }, "node_modules/yaml": { - "version": "2.8.2", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.2.tgz", - "integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==", + "version": "2.8.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.3.tgz", + "integrity": "sha512-AvbaCLOO2Otw/lW5bmh9d/WEdcDFdQp2Z2ZUH3pX9U2ihyUY0nvLv7J6TrWowklRGPYbB/IuIMfYgxaCPg5Bpg==", "dev": true, "license": "ISC", "bin": { @@ -5434,6 +4893,13 @@ "url": "https://github.com/sponsors/eemeli" } }, + "node_modules/yaml-ast-parser": { + "version": "0.0.43", + "resolved": "https://registry.npmjs.org/yaml-ast-parser/-/yaml-ast-parser-0.0.43.tgz", + "integrity": "sha512-2PTINUwsRqSd+s8XxKaJWQlUuEMHJQyEuh2edBbW8KNJz0SJPwUSD2zRWqezFEdN7IzAgeuYHFUCF7o8zRdZ0A==", + "dev": true, + "license": "Apache-2.0" + }, "node_modules/yargs-parser": { "version": "21.1.1", "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", diff --git a/package.json b/package.json index bc11574..56809bc 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "nfe-io", - "version": "v3.1.0", + "version": "v3.2.0", "description": "Official NFE.io SDK for Node.js - TypeScript native with zero runtime dependencies", "keywords": [ "nfe", @@ -69,26 +69,25 @@ "prepublish:test": "npm run build && npm test -- --run", "release": "npm run build && npm test -- --run && npm publish" }, - "dependencies": {}, "devDependencies": { "@types/node": "^20.10.0", - "@typescript-eslint/eslint-plugin": "^6.13.0", - "@typescript-eslint/parser": "^6.13.0", - "@vitest/coverage-v8": "^1.0.0", - "@vitest/ui": "^1.0.0", - "eslint": "^8.56.0", + "@typescript-eslint/eslint-plugin": "^8.59.0", + "@typescript-eslint/parser": "^8.59.0", + "@vitest/coverage-v8": "^3.2.4", + "@vitest/ui": "^3.2.4", + "dotenv": "~17.2.3", + "eslint": "^8.57.1", "eslint-config-prettier": "^9.1.0", "eslint-plugin-prettier": "^5.1.0", - "openapi-typescript": "^6.7.0", + "openapi-typescript": "^7.13.0", "prettier": "^3.2.0", - "rimraf": "^5.0.0", - "tsup": "^8.0.0", + "rimraf": "^5.0.10", + "tsup": "^8.5.0", "tsx": "^4.7.0", - "typedoc": "^0.25.0", + "typedoc": "^0.25.13", "typescript": "^5.3.0", - "vitest": "^1.0.0", - "yaml": "^2.3.4", - "dotenv": "~17.2.3" + "vitest": "^3.2.4", + "yaml": "^2.3.4" }, "agents": { "skills": [ diff --git a/scripts/generate-types.ts b/scripts/generate-types.ts index 3e74945..ff7f82d 100644 --- a/scripts/generate-types.ts +++ b/scripts/generate-types.ts @@ -16,7 +16,9 @@ import { readdir, writeFile, mkdir, readFile } from 'fs/promises'; import { join, basename, resolve } from 'path'; import { existsSync } from 'fs'; -import openapiTS from 'openapi-typescript'; +import { pathToFileURL } from 'url'; +import openapiTS, { astToString } from 'openapi-typescript'; +import { createConfig } from '@redocly/openapi-core'; // ============================================================================ // Configuration @@ -153,12 +155,23 @@ async function generateTypesForSpec(spec: SpecConfig): Promise { return false; } - // Generate types using openapi-typescript - const output = await openapiTS(spec.inputPath, { - // Options for type generation - exportType: true, - immutableTypes: true, + // Generate types using openapi-typescript (v7+ returns AST) + // Disable Redocly validation rules that openapi-typescript v6 tolerated + // (some legacy NFE.io specs have duplicate operationIds and other minor issues) + const redoclyConfig = await createConfig({ + rules: { + 'operation-operationId-unique': 'off', + 'operation-operationId': 'off', + 'no-identical-paths': 'off', + 'no-ambiguous-paths': 'off', + 'struct': 'off', + }, }); + const ast = await openapiTS(pathToFileURL(spec.inputPath), { + immutable: true, + redocly: redoclyConfig, + }); + const output = astToString(ast); // Wrap output with metadata banner const wrappedOutput = wrapWithMetadata(output, spec); diff --git a/src/generated/calculo-impostos-v1.ts b/src/generated/calculo-impostos-v1.ts index 1ea865f..7c26a65 100644 --- a/src/generated/calculo-impostos-v1.ts +++ b/src/generated/calculo-impostos-v1.ts @@ -4,552 +4,642 @@ * Do not edit this file directly. * * To regenerate: npm run generate - * Last generated: 2026-02-15T17:59:25.411Z + * Last generated: 2026-04-25T23:27:48.962Z * Generator: openapi-typescript */ -/** - * This file was auto-generated by openapi-typescript. - * Do not make direct changes to the file. - */ - - -export type paths = { - "/tax-codes/operation-code": { - /** Listar Códigos de Operação */ - get: { - parameters: { - query?: { - /** @description Índice da página para paginação */ - pageIndex?: number; - /** @description Número de itens por página */ - pageCount?: number; +export interface paths { + readonly "/tax-codes/operation-code": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - responses: { - /** @description OK */ - 200: { - content: { - readonly "application/json": components["schemas"]["TaxCodePaginatedResponse"]; - }; + /** Listar Códigos de Operação */ + readonly get: { + readonly parameters: { + readonly query?: { + /** @description Índice da página para paginação */ + readonly pageIndex?: number; + /** @description Número de itens por página */ + readonly pageCount?: number; + }; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["TaxCodePaginatedResponse"]; + }; + }; + }; }; - }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/tax-codes/acquisition-purpose": { - /** Listar Finalidades de Aquisição */ - get: { - parameters: { - query?: { - /** @description Índice da página para paginação */ - pageIndex?: number; - /** @description Número de itens por página */ - pageCount?: number; + readonly "/tax-codes/acquisition-purpose": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - responses: { - /** @description OK */ - 200: { - content: { - readonly "application/json": components["schemas"]["TaxCodePaginatedResponse"]; - }; + /** Listar Finalidades de Aquisição */ + readonly get: { + readonly parameters: { + readonly query?: { + /** @description Índice da página para paginação */ + readonly pageIndex?: number; + /** @description Número de itens por página */ + readonly pageCount?: number; + }; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["TaxCodePaginatedResponse"]; + }; + }; + }; }; - }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/tax-codes/issuer-tax-profile": { - /** Listar Perfis Fiscais do Emissor */ - get: { - parameters: { - query?: { - /** @description Índice da página para paginação */ - pageIndex?: number; - /** @description Número de itens por página */ - pageCount?: number; + readonly "/tax-codes/issuer-tax-profile": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - responses: { - /** @description OK */ - 200: { - content: { - readonly "application/json": components["schemas"]["TaxCodePaginatedResponse"]; - }; + /** Listar Perfis Fiscais do Emissor */ + readonly get: { + readonly parameters: { + readonly query?: { + /** @description Índice da página para paginação */ + readonly pageIndex?: number; + /** @description Número de itens por página */ + readonly pageCount?: number; + }; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["TaxCodePaginatedResponse"]; + }; + }; + }; }; - }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/tax-codes/recipient-tax-profile": { - /** Listar Perfis Fiscais do Destinatário */ - get: { - parameters: { - query?: { - /** @description Índice da página para paginação */ - pageIndex?: number; - /** @description Número de itens por página */ - pageCount?: number; + readonly "/tax-codes/recipient-tax-profile": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - responses: { - /** @description OK */ - 200: { - content: { - readonly "application/json": components["schemas"]["TaxCodePaginatedResponse"]; - }; + /** Listar Perfis Fiscais do Destinatário */ + readonly get: { + readonly parameters: { + readonly query?: { + /** @description Índice da página para paginação */ + readonly pageIndex?: number; + /** @description Número de itens por página */ + readonly pageCount?: number; + }; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["TaxCodePaginatedResponse"]; + }; + }; + }; }; - }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/tax-rules/{tenantId}/engine/calculate": { - /** Calcula os impostos de uma operação. */ - post: { - parameters: { - path: { - /** @description O identificador da conta. */ - tenantId: string; + readonly "/tax-rules/{tenantId}/engine/calculate": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description A solicitação contendo os detalhes da operação e produtos. */ - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["CalculateRequest"]; - readonly "application/jose": components["schemas"]["CalculateRequest"]; + readonly get?: never; + readonly put?: never; + /** Calcula os impostos de uma operação. */ + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description O identificador da conta. */ + readonly tenantId: string; + }; + readonly cookie?: never; + }; + /** @description A solicitação contendo os detalhes da operação e produtos. */ + readonly requestBody?: { + readonly content: { + readonly "application/json": components["schemas"]["CalculateRequest"]; + readonly "application/jose": components["schemas"]["CalculateRequest"]; + }; + }; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["CalculateResponse"]; + readonly "application/jose": components["schemas"]["CalculateResponse"]; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ProblemDetails"]; + readonly "application/jose": components["schemas"]["ProblemDetails"]; + }; + }; + /** @description Unprocessable Content */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ProblemDetails"]; + readonly "application/jose": components["schemas"]["ProblemDetails"]; + }; + }; + }; }; - }; - responses: { - /** @description OK */ - 200: { - content: { - readonly "application/json": components["schemas"]["CalculateResponse"]; - readonly "application/jose": components["schemas"]["CalculateResponse"]; - }; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + readonly CalculateItemRequest: { + /** @description Identificador do Item */ + readonly id: string; + /** + * Format: int32 + * @description Código interno para determinação de natureza de operação + */ + readonly operationCode: number; + /** @description Finalidade */ + readonly acquisitionPurpose?: string | null; + /** @description Perfil do Emitente para Cálculo de Impostos do Item */ + readonly issuerTaxProfile?: string | null; + /** @description Perfil do Tomador para Cálculo de Impostos do Item */ + readonly recipientTaxProfile?: string | null; + /** @description Código do Produto */ + readonly sku?: string | null; + /** @description Nomenclatura Comum do Mercosul */ + readonly ncm?: string | null; + /** @description Código Especificador da Substituição Tributária */ + readonly cest?: string | null; + /** @description Código do benefício fiscal */ + readonly benefit?: string | null; + /** @description Código EX da TIPI */ + readonly exTipi?: string | null; + readonly origin: components["schemas"]["Origin"]; + /** @description Global Trade Item Number */ + readonly gtin?: string | null; + /** + * Format: double + * @description Quantidade Tributável + */ + readonly quantity: number; + /** + * Format: double + * @description Valor Unitário Tributável + */ + readonly unitAmount: number; + /** + * Format: double + * @description Valor do Frete + */ + readonly freightAmount?: number | null; + /** + * Format: double + * @description Valor do Seguro + */ + readonly insuranceAmount?: number | null; + /** + * Format: double + * @description Valor do Desconto + */ + readonly discountAmount?: number | null; + /** + * Format: double + * @description Outras despesas acessórias + */ + readonly othersAmount?: number | null; + readonly icms?: components["schemas"]["Icms"]; + readonly ii?: components["schemas"]["Ii"]; }; - /** @description Bad Request */ - 400: { - content: { - readonly "application/json": components["schemas"]["ProblemDetails"]; - readonly "application/jose": components["schemas"]["ProblemDetails"]; - }; + readonly CalculateItemResponse: { + /** @description Identificador do Item */ + readonly id?: string | null; + /** + * Format: int32 + * @description Código Fiscal de Operações e Prestações + */ + readonly cfop?: number; + /** @description Código Especificador de Substituição Tributária */ + readonly cest?: string | null; + /** @description Código do benefício fiscal */ + readonly benefit?: string | null; + readonly icms?: components["schemas"]["Icms"]; + readonly icmsUfDest?: components["schemas"]["IcmsUfDest"]; + readonly pis?: components["schemas"]["Pis"]; + readonly cofins?: components["schemas"]["Cofins"]; + readonly ipi?: components["schemas"]["Ipi"]; + readonly ii?: components["schemas"]["Ii"]; + /** @description Informações Adicionais do Produto */ + readonly additionalInformation?: string | null; + /** + * Format: date-time + * @description Data da última alteração da regra + */ + readonly lastModified?: string; + /** @description Registered Product Id */ + readonly productId?: string | null; }; - /** @description Unprocessable Content */ - 422: { - content: { - readonly "application/json": components["schemas"]["ProblemDetails"]; - readonly "application/jose": components["schemas"]["ProblemDetails"]; - }; + readonly CalculateRequest: { + /** @description Identificador da Coleção de Produtos */ + readonly collectionId?: string | null; + readonly issuer: components["schemas"]["CalculateRequestIssuer"]; + readonly recipient: components["schemas"]["CalculateRequestRecipient"]; + readonly operationType: components["schemas"]["OperationType"]; + /** @description Lista de Produtos */ + readonly items: readonly components["schemas"]["CalculateItemRequest"][]; + /** @description Identificador da tipo de requisição (emissão de nota fiscal ou cadastro de produto) */ + readonly isProductRegistration?: boolean; }; - }; - }; - }; -}; - -export type webhooks = Record; - -export type components = { - schemas: { - readonly CalculateItemRequest: { - /** @description Identificador do Item */ - readonly id: string; - /** - * Format: int32 - * @description Código interno para determinação de natureza de operação - */ - readonly operationCode: number; - /** @description Finalidade */ - readonly acquisitionPurpose?: string | null; - /** @description Perfil do Emitente para Cálculo de Impostos do Item */ - readonly issuerTaxProfile?: string | null; - /** @description Perfil do Tomador para Cálculo de Impostos do Item */ - readonly recipientTaxProfile?: string | null; - /** @description Código do Produto */ - readonly sku?: string | null; - /** @description Nomenclatura Comum do Mercosul */ - readonly ncm?: string | null; - /** @description Código Especificador da Substituição Tributária */ - readonly cest?: string | null; - /** @description Código do benefício fiscal */ - readonly benefit?: string | null; - /** @description Código EX da TIPI */ - readonly exTipi?: string | null; - readonly origin: components["schemas"]["Origin"]; - /** @description Global Trade Item Number */ - readonly gtin?: string | null; - /** - * Format: double - * @description Quantidade Tributável - */ - readonly quantity: number; - /** - * Format: double - * @description Valor Unitário Tributável - */ - readonly unitAmount: number; - /** - * Format: double - * @description Valor do Frete - */ - readonly freightAmount?: number | null; - /** - * Format: double - * @description Valor do Seguro - */ - readonly insuranceAmount?: number | null; - /** - * Format: double - * @description Valor do Desconto - */ - readonly discountAmount?: number | null; - /** - * Format: double - * @description Outras despesas acessórias - */ - readonly othersAmount?: number | null; - readonly icms?: components["schemas"]["Icms"]; - readonly ii?: components["schemas"]["Ii"]; - }; - readonly CalculateItemResponse: { - /** @description Identificador do Item */ - readonly id?: string | null; - /** - * Format: int32 - * @description Código Fiscal de Operações e Prestações - */ - readonly cfop?: number; - /** @description Código Especificador de Substituição Tributária */ - readonly cest?: string | null; - /** @description Código do benefício fiscal */ - readonly benefit?: string | null; - readonly icms?: components["schemas"]["Icms"]; - readonly icmsUfDest?: components["schemas"]["IcmsUfDest"]; - readonly pis?: components["schemas"]["Pis"]; - readonly cofins?: components["schemas"]["Cofins"]; - readonly ipi?: components["schemas"]["Ipi"]; - readonly ii?: components["schemas"]["Ii"]; - /** @description Informações Adicionais do Produto */ - readonly additionalInformation?: string | null; - /** - * Format: date-time - * @description Data da última alteração da regra - */ - readonly lastModified?: string; - /** @description Registered Product Id */ - readonly productId?: string | null; - }; - readonly CalculateRequest: { - /** @description Identificador da Coleção de Produtos */ - readonly collectionId?: string | null; - readonly issuer: components["schemas"]["CalculateRequestIssuer"]; - readonly recipient: components["schemas"]["CalculateRequestRecipient"]; - readonly operationType: components["schemas"]["OperationType"]; - /** @description Lista de Produtos */ - readonly items: readonly components["schemas"]["CalculateItemRequest"][]; - /** @description Identificador da tipo de requisição (emissão de nota fiscal ou cadastro de produto) */ - readonly isProductRegistration?: boolean; - }; - readonly CalculateRequestIssuer: { - readonly taxRegime: components["schemas"]["TaxRegime"]; - /** @description Perfil Padrão do Emitente para Cálculo de Impostos */ - readonly taxProfile?: string | null; - readonly state: components["schemas"]["State"]; - }; - readonly CalculateRequestRecipient: { - readonly taxRegime?: components["schemas"]["TaxRegime"]; - /** @description Perfil Padrão do Tomador para Cálculo de Impostos */ - readonly taxProfile?: string | null; - readonly state: components["schemas"]["State"]; - }; - readonly CalculateResponse: { - readonly items?: (readonly components["schemas"]["CalculateItemResponse"][]) | null; - }; - readonly Cofins: { - /** @description Código de Situação Tributária da COFINS */ - readonly cst?: string | null; - /** @description Valor da Base de Cálculo do COFINS */ - readonly vBC?: string | null; - /** @description Alíquota do COFINS (em percentual) */ - readonly pCOFINS?: string | null; - /** @description Valor do COFINS */ - readonly vCOFINS?: string | null; - /** @description Quantidade Vendida */ - readonly qBCProd?: string | null; - /** @description Alíquota do COFINS (em reais) */ - readonly vAliqProd?: string | null; - }; - readonly Icms: { - /** @description Origem da mercadoria */ - readonly orig?: string | null; - /** @description Tributação do ICMS */ - readonly cst?: string | null; - /** @description Código de Situação da Operação – Simples Nacional */ - readonly csosn?: string | null; - /** @description Modalidade de determinação da BC do ICMS */ - readonly modBC?: string | null; - /** @description Valor da BC do ICMS */ - readonly vBC?: string | null; - /** @description Percentual da Redução de BC */ - readonly pRedBC?: string | null; - /** @description Código do benefício fiscal relacionado a redução de base */ - readonly cBenefRBC?: string | null; - /** @description Alíquota do imposto */ - readonly pICMS?: string | null; - /** @description Valor do ICMS */ - readonly vICMS?: string | null; - /** @description Valor do ICMS da Operação */ - readonly vICMSOp?: string | null; - /** @description Modalidade de determinação da BC do ICMS ST */ - readonly modBCST?: string | null; - /** @description Valor da BC do ICMS ST */ - readonly vBCST?: string | null; - /** @description Percentual da Redução de BC do ICMS ST */ - readonly pRedBCST?: string | null; - /** @description Alíquota do imposto do ICMS ST */ - readonly pICMSST?: string | null; - /** @description Valor do ICMS ST */ - readonly vICMSST?: string | null; - /** @description Percentual da margem de valor Adicionado do ICMS ST */ - readonly pMVAST?: string | null; - /** @description Alíquota suportada pelo Consumidor Final */ - readonly pST?: string | null; - /** @description Valor da BC do ICMS ST retido */ - readonly vBCSTRet?: string | null; - /** @description Valor do ICMS ST retido */ - readonly vICMSSTRet?: string | null; - /** @description Valor da Base de Cálculo do FCP */ - readonly vBCFCP?: string | null; - /** @description Percentual do ICMS relativo ao Fundo de Combate à Pobreza(FCP) */ - readonly pFCP?: string | null; - /** @description Valor do Fundo de Combate à Pobreza (FCP) */ - readonly vFCP?: string | null; - /** @description Valor da Base de Cálculo do FCP retido por Substituição Tributária */ - readonly vBCFCPST?: string | null; - /** @description Percentual do FCP retido por Substituição Tributária */ - readonly pFCPST?: string | null; - /** @description Valor do FCP retido por Substituição Tributária */ - readonly vFCPST?: string | null; - /** @description Valor da Base de Cálculo do FCP retido anteriormente */ - readonly vBCFCPSTRet?: string | null; - /** @description Percentual do FCP retido anteriormente por Substituição Tributária */ - readonly pFCPSTRet?: string | null; - /** @description Valor do FCP retido por Substituição Tributária */ - readonly vFCPSTRet?: string | null; - /** @description Valor da base de cálculo efetiva */ - readonly vBCEfet?: string | null; - /** @description Percentual de redução da base de cálculo efetiva */ - readonly pRedBCEfet?: string | null; - /** @description Alíquota do ICMS efetiva */ - readonly pICMSEfet?: string | null; - /** @description Valor do ICMS efetivo */ - readonly vICMSEfet?: string | null; - /** @description Percentual do diferimento */ - readonly pDif?: string | null; - /** @description Valor do ICMS diferido */ - readonly vICMSDif?: string | null; - /** @description Valor do ICMS próprio do Substituto */ - readonly vICMSSubstituto?: string | null; - /** @description Alíquota aplicável de cálculo do crédito (Simples Nacional) */ - readonly pCredSN?: string | null; - /** @description Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 (Simples Nacional) */ - readonly vCredICMSSN?: string | null; - /** @description Percentual do diferimento do ICMS relativo ao Fundo de Combate à Pobreza(FCP) */ - readonly pFCPDif?: string | null; - /** @description Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) diferido */ - readonly vFCPDif?: string | null; - /** @description Valor efetivo do ICMS relativo ao Fundo de Combate à Pobreza(FCP) */ - readonly vFCPEfet?: string | null; - /** @description Valor do ICMS desonerado */ - readonly vICMSDeson?: string | null; - /** @description Motivo da desoneração do ICMS */ - readonly motDesICMS?: string | null; - /** @description Valor do ICMS- ST desonerado */ - readonly vICMSSTDeson?: string | null; - /** @description Motivo da desoneração do ICMS- ST */ - readonly motDesICMSST?: string | null; - /** @description Indica se o valor do ICMS desonerado (vICMSDeson) deduz do valor do item(vProd). */ - readonly indDeduzDeson?: string | null; - }; - readonly IcmsUfDest: { - /** @description Valor da BC do ICMS na UF de destino */ - readonly vBCUFDest?: string | null; - /** @description Valor da BC FCP na UF de destino */ - readonly vBCFCPUFDest?: string | null; - /** - * @description Percentual do ICMS relativo ao Fundo de Combate à - * Pobreza (FCP) na UF de destino - */ - readonly pFCPUFDest?: string | null; - /** @description Alíquota interna da UF de destino */ - readonly pICMSUFDest?: string | null; - /** @description Alíquota interestadual das UF envolvidas */ - readonly pICMSInter?: string | null; - /** @description Percentual provisório de partilha do ICMS Interestadual */ - readonly pICMSInterPart?: string | null; - /** @description Valor da BC FCP na UF de destino */ - readonly vFCPUFDest?: string | null; - /** @description Valor do ICMS Interestadual para a UF de destino */ - readonly vICMSUFDest?: string | null; - /** @description Valor do ICMS Interestadual para a UF do remetente */ - readonly vICMSUFRemet?: string | null; - }; - readonly Ii: { - /** @description Valor BC do Imposto de Importação */ - readonly vBC?: string | null; - /** @description Valor despesas aduaneiras */ - readonly vDespAdu?: string | null; - /** @description Valor Imposto de Importação */ - readonly vII?: string | null; - /** @description Valor Imposto sobre Operações Financeiras */ - readonly vIOF?: string | null; - /** @description Valor dos encargos cambiais */ - readonly vEncCamb?: string | null; - /** @description Alíquota do Simples Nacional aplicável no cálculo do crédito pelo contribuinte destinatário. */ - readonly pCredSN?: string | null; - /** @description Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 (Simples Nacional) */ - readonly vCredICMSSN?: string | null; - /** - * @description Ativação do cálculo do custo de aquisição: - * 0 – Inativo - * 1 – Ativo - */ - readonly infCustoAquis?: string | null; - }; - readonly Ipi: { - /** @description Código de Enquadramento Legal do IPI */ - readonly cEnq?: string | null; - /** @description Código da situação tributária do IPI */ - readonly cst?: string | null; - /** @description Valor da BC do IPI */ - readonly vBC?: string | null; - /** @description Alíquota do IPI */ - readonly pIPI?: string | null; - /** @description Quantidade total na unidade padrão para tributação (somente para os produtos tributados por unidade) */ - readonly qUnid?: string | null; - /** @description Valor por Unidade Tributável */ - readonly vUnid?: string | null; - /** @description Valor do IPI */ - readonly vIPI?: string | null; - }; - /** - * @description

Possible values:

- *
    - *
  • Outgoing: 0 - Saída
    • - *
  • Incoming: 1 - Entrada
    • - *
- * - * @enum {string} - */ - readonly OperationType: "Outgoing" | "Incoming"; - /** - * @description

Possible values:

- *
    - *
  • National: 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8
    • - *
  • ForeignDirectImport: 1 - Estrangeira - Importação direta, exceto a indicada no código 6
    • - *
  • ForeignInternalMarket: 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7
    • - *
  • NationalWith40To70Import: 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%
    • - *
  • NationalPpb: 4 - Nacional, cuja produção tenha sido feita em conformidade com os PPB de que tratam as legislações citadas nos ajustes
    • - *
  • NationalWithLess40Import: 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%
    • - *
  • ForeignDirectImportWithoutNationalSimilar: 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural
    • - *
  • ForeignInternalMarketWithoutNationalSimilar: 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural
    • - *
  • NationalWithGreater70Import: 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%
    • - *
- * - * @enum {string} - */ - readonly Origin: "National" | "ForeignDirectImport" | "ForeignInternalMarket" | "NationalWith40To70Import" | "NationalPpb" | "NationalWithLess40Import" | "ForeignDirectImportWithoutNationalSimilar" | "ForeignInternalMarketWithoutNationalSimilar" | "NationalWithGreater70Import"; - readonly Pis: { - /** @description Código de Situação Tributária do PIS */ - readonly cst?: string | null; - /** @description Valor da Base de Cálculo do PIS */ - readonly vBC?: string | null; - /** @description Alíquota do PIS (em percentual) */ - readonly pPIS?: string | null; - /** @description Valor do PIS */ - readonly vPIS?: string | null; - /** @description Quantidade Vendida */ - readonly qBCProd?: string | null; - /** @description Alíquota do PIS (em reais) */ - readonly vAliqProd?: string | null; - }; - readonly ProblemDetails: { - readonly type?: string | null; - readonly title?: string | null; - /** Format: int32 */ - readonly status?: number | null; - readonly detail?: string | null; - readonly instance?: string | null; - [key: string]: unknown; - }; - /** - * @description

Possible values:

- *
    - *
  • AC: Acre
    • - *
  • AL: Alagoas
    • - *
  • AP: Amapá
    • - *
  • AM: Amazonas
    • - *
  • BA: Bahia
    • - *
  • CE: Ceará
    • - *
  • DF: Distrito Federal
    • - *
  • ES: Espírito Santo
    • - *
  • GO: Goiás
    • - *
  • MA: Maranhão
    • - *
  • MT: Mato Grosso
    • - *
  • MS: Mato Grosso do Sul
    • - *
  • MG: Minas Gerais
    • - *
  • PA: Pará
    • - *
  • PB: Paraíba
    • - *
  • PR: Paraná
    • - *
  • PE: Pernambuco
    • - *
  • PI: Piauí
    • - *
  • RJ: Rio de Janeiro
    • - *
  • RN: Rio Grande do Norte
    • - *
  • RS: Rio Grande do Sul
    • - *
  • RO: Rondônia
    • - *
  • RR: Roraima
    • - *
  • SC: Santa Catarina
    • - *
  • SP: São Paulo
    • - *
  • SE: Sergipe
    • - *
  • TO: Tocantins
    • - *
  • EX: Exterior
    • - *
- * - * @enum {string} - */ - readonly State: "AC" | "AL" | "AP" | "AM" | "BA" | "CE" | "DF" | "ES" | "GO" | "MA" | "MT" | "MS" | "MG" | "PA" | "PB" | "PR" | "PE" | "PI" | "RJ" | "RN" | "RS" | "RO" | "RR" | "SC" | "SP" | "SE" | "TO" | "EX"; - readonly TaxCode: { - readonly code?: string | null; - readonly description?: string | null; - }; - readonly TaxCodePaginatedResponse: { - readonly items?: (readonly components["schemas"]["TaxCode"][]) | null; - /** Format: int32 */ - readonly currentPage?: number; - /** Format: int32 */ - readonly totalPages?: number; - /** Format: int64 */ - readonly totalCount?: number; + readonly CalculateRequestIssuer: { + readonly taxRegime: components["schemas"]["TaxRegime"]; + /** @description Perfil Padrão do Emitente para Cálculo de Impostos */ + readonly taxProfile?: string | null; + readonly state: components["schemas"]["State"]; + }; + readonly CalculateRequestRecipient: { + readonly taxRegime?: components["schemas"]["TaxRegime"]; + /** @description Perfil Padrão do Tomador para Cálculo de Impostos */ + readonly taxProfile?: string | null; + readonly state: components["schemas"]["State"]; + }; + readonly CalculateResponse: { + readonly items?: readonly components["schemas"]["CalculateItemResponse"][] | null; + }; + readonly Cofins: { + /** @description Código de Situação Tributária da COFINS */ + readonly cst?: string | null; + /** @description Valor da Base de Cálculo do COFINS */ + readonly vBC?: string | null; + /** @description Alíquota do COFINS (em percentual) */ + readonly pCOFINS?: string | null; + /** @description Valor do COFINS */ + readonly vCOFINS?: string | null; + /** @description Quantidade Vendida */ + readonly qBCProd?: string | null; + /** @description Alíquota do COFINS (em reais) */ + readonly vAliqProd?: string | null; + }; + readonly Icms: { + /** @description Origem da mercadoria */ + readonly orig?: string | null; + /** @description Tributação do ICMS */ + readonly cst?: string | null; + /** @description Código de Situação da Operação – Simples Nacional */ + readonly csosn?: string | null; + /** @description Modalidade de determinação da BC do ICMS */ + readonly modBC?: string | null; + /** @description Valor da BC do ICMS */ + readonly vBC?: string | null; + /** @description Percentual da Redução de BC */ + readonly pRedBC?: string | null; + /** @description Código do benefício fiscal relacionado a redução de base */ + readonly cBenefRBC?: string | null; + /** @description Alíquota do imposto */ + readonly pICMS?: string | null; + /** @description Valor do ICMS */ + readonly vICMS?: string | null; + /** @description Valor do ICMS da Operação */ + readonly vICMSOp?: string | null; + /** @description Modalidade de determinação da BC do ICMS ST */ + readonly modBCST?: string | null; + /** @description Valor da BC do ICMS ST */ + readonly vBCST?: string | null; + /** @description Percentual da Redução de BC do ICMS ST */ + readonly pRedBCST?: string | null; + /** @description Alíquota do imposto do ICMS ST */ + readonly pICMSST?: string | null; + /** @description Valor do ICMS ST */ + readonly vICMSST?: string | null; + /** @description Percentual da margem de valor Adicionado do ICMS ST */ + readonly pMVAST?: string | null; + /** @description Alíquota suportada pelo Consumidor Final */ + readonly pST?: string | null; + /** @description Valor da BC do ICMS ST retido */ + readonly vBCSTRet?: string | null; + /** @description Valor do ICMS ST retido */ + readonly vICMSSTRet?: string | null; + /** @description Valor da Base de Cálculo do FCP */ + readonly vBCFCP?: string | null; + /** @description Percentual do ICMS relativo ao Fundo de Combate à Pobreza(FCP) */ + readonly pFCP?: string | null; + /** @description Valor do Fundo de Combate à Pobreza (FCP) */ + readonly vFCP?: string | null; + /** @description Valor da Base de Cálculo do FCP retido por Substituição Tributária */ + readonly vBCFCPST?: string | null; + /** @description Percentual do FCP retido por Substituição Tributária */ + readonly pFCPST?: string | null; + /** @description Valor do FCP retido por Substituição Tributária */ + readonly vFCPST?: string | null; + /** @description Valor da Base de Cálculo do FCP retido anteriormente */ + readonly vBCFCPSTRet?: string | null; + /** @description Percentual do FCP retido anteriormente por Substituição Tributária */ + readonly pFCPSTRet?: string | null; + /** @description Valor do FCP retido por Substituição Tributária */ + readonly vFCPSTRet?: string | null; + /** @description Valor da base de cálculo efetiva */ + readonly vBCEfet?: string | null; + /** @description Percentual de redução da base de cálculo efetiva */ + readonly pRedBCEfet?: string | null; + /** @description Alíquota do ICMS efetiva */ + readonly pICMSEfet?: string | null; + /** @description Valor do ICMS efetivo */ + readonly vICMSEfet?: string | null; + /** @description Percentual do diferimento */ + readonly pDif?: string | null; + /** @description Valor do ICMS diferido */ + readonly vICMSDif?: string | null; + /** @description Valor do ICMS próprio do Substituto */ + readonly vICMSSubstituto?: string | null; + /** @description Alíquota aplicável de cálculo do crédito (Simples Nacional) */ + readonly pCredSN?: string | null; + /** @description Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 (Simples Nacional) */ + readonly vCredICMSSN?: string | null; + /** @description Percentual do diferimento do ICMS relativo ao Fundo de Combate à Pobreza(FCP) */ + readonly pFCPDif?: string | null; + /** @description Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) diferido */ + readonly vFCPDif?: string | null; + /** @description Valor efetivo do ICMS relativo ao Fundo de Combate à Pobreza(FCP) */ + readonly vFCPEfet?: string | null; + /** @description Valor do ICMS desonerado */ + readonly vICMSDeson?: string | null; + /** @description Motivo da desoneração do ICMS */ + readonly motDesICMS?: string | null; + /** @description Valor do ICMS- ST desonerado */ + readonly vICMSSTDeson?: string | null; + /** @description Motivo da desoneração do ICMS- ST */ + readonly motDesICMSST?: string | null; + /** @description Indica se o valor do ICMS desonerado (vICMSDeson) deduz do valor do item(vProd). */ + readonly indDeduzDeson?: string | null; + }; + readonly IcmsUfDest: { + /** @description Valor da BC do ICMS na UF de destino */ + readonly vBCUFDest?: string | null; + /** @description Valor da BC FCP na UF de destino */ + readonly vBCFCPUFDest?: string | null; + /** + * @description Percentual do ICMS relativo ao Fundo de Combate à + * Pobreza (FCP) na UF de destino + */ + readonly pFCPUFDest?: string | null; + /** @description Alíquota interna da UF de destino */ + readonly pICMSUFDest?: string | null; + /** @description Alíquota interestadual das UF envolvidas */ + readonly pICMSInter?: string | null; + /** @description Percentual provisório de partilha do ICMS Interestadual */ + readonly pICMSInterPart?: string | null; + /** @description Valor da BC FCP na UF de destino */ + readonly vFCPUFDest?: string | null; + /** @description Valor do ICMS Interestadual para a UF de destino */ + readonly vICMSUFDest?: string | null; + /** @description Valor do ICMS Interestadual para a UF do remetente */ + readonly vICMSUFRemet?: string | null; + }; + readonly Ii: { + /** @description Valor BC do Imposto de Importação */ + readonly vBC?: string | null; + /** @description Valor despesas aduaneiras */ + readonly vDespAdu?: string | null; + /** @description Valor Imposto de Importação */ + readonly vII?: string | null; + /** @description Valor Imposto sobre Operações Financeiras */ + readonly vIOF?: string | null; + /** @description Valor dos encargos cambiais */ + readonly vEncCamb?: string | null; + /** @description Alíquota do Simples Nacional aplicável no cálculo do crédito pelo contribuinte destinatário. */ + readonly pCredSN?: string | null; + /** @description Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 (Simples Nacional) */ + readonly vCredICMSSN?: string | null; + /** + * @description Ativação do cálculo do custo de aquisição: + * 0 – Inativo + * 1 – Ativo + */ + readonly infCustoAquis?: string | null; + }; + readonly Ipi: { + /** @description Código de Enquadramento Legal do IPI */ + readonly cEnq?: string | null; + /** @description Código da situação tributária do IPI */ + readonly cst?: string | null; + /** @description Valor da BC do IPI */ + readonly vBC?: string | null; + /** @description Alíquota do IPI */ + readonly pIPI?: string | null; + /** @description Quantidade total na unidade padrão para tributação (somente para os produtos tributados por unidade) */ + readonly qUnid?: string | null; + /** @description Valor por Unidade Tributável */ + readonly vUnid?: string | null; + /** @description Valor do IPI */ + readonly vIPI?: string | null; + }; + /** + * @description

Possible values:

+ *
    + *
  • Outgoing: 0 - Saída
    • + *
  • Incoming: 1 - Entrada
    • + *
+ * @enum {string} + */ + readonly OperationType: "Outgoing" | "Incoming"; + /** + * @description

Possible values:

+ *
    + *
  • National: 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8
    • + *
  • ForeignDirectImport: 1 - Estrangeira - Importação direta, exceto a indicada no código 6
    • + *
  • ForeignInternalMarket: 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7
    • + *
  • NationalWith40To70Import: 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%
    • + *
  • NationalPpb: 4 - Nacional, cuja produção tenha sido feita em conformidade com os PPB de que tratam as legislações citadas nos ajustes
    • + *
  • NationalWithLess40Import: 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%
    • + *
  • ForeignDirectImportWithoutNationalSimilar: 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural
    • + *
  • ForeignInternalMarketWithoutNationalSimilar: 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural
    • + *
  • NationalWithGreater70Import: 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%
    • + *
+ * @enum {string} + */ + readonly Origin: "National" | "ForeignDirectImport" | "ForeignInternalMarket" | "NationalWith40To70Import" | "NationalPpb" | "NationalWithLess40Import" | "ForeignDirectImportWithoutNationalSimilar" | "ForeignInternalMarketWithoutNationalSimilar" | "NationalWithGreater70Import"; + readonly Pis: { + /** @description Código de Situação Tributária do PIS */ + readonly cst?: string | null; + /** @description Valor da Base de Cálculo do PIS */ + readonly vBC?: string | null; + /** @description Alíquota do PIS (em percentual) */ + readonly pPIS?: string | null; + /** @description Valor do PIS */ + readonly vPIS?: string | null; + /** @description Quantidade Vendida */ + readonly qBCProd?: string | null; + /** @description Alíquota do PIS (em reais) */ + readonly vAliqProd?: string | null; + }; + readonly ProblemDetails: { + readonly type?: string | null; + readonly title?: string | null; + /** Format: int32 */ + readonly status?: number | null; + readonly detail?: string | null; + readonly instance?: string | null; + } & { + readonly [key: string]: unknown; + }; + /** + * @description

Possible values:

+ *
    + *
  • AC: Acre
    • + *
  • AL: Alagoas
    • + *
  • AP: Amapá
    • + *
  • AM: Amazonas
    • + *
  • BA: Bahia
    • + *
  • CE: Ceará
    • + *
  • DF: Distrito Federal
    • + *
  • ES: Espírito Santo
    • + *
  • GO: Goiás
    • + *
  • MA: Maranhão
    • + *
  • MT: Mato Grosso
    • + *
  • MS: Mato Grosso do Sul
    • + *
  • MG: Minas Gerais
    • + *
  • PA: Pará
    • + *
  • PB: Paraíba
    • + *
  • PR: Paraná
    • + *
  • PE: Pernambuco
    • + *
  • PI: Piauí
    • + *
  • RJ: Rio de Janeiro
    • + *
  • RN: Rio Grande do Norte
    • + *
  • RS: Rio Grande do Sul
    • + *
  • RO: Rondônia
    • + *
  • RR: Roraima
    • + *
  • SC: Santa Catarina
    • + *
  • SP: São Paulo
    • + *
  • SE: Sergipe
    • + *
  • TO: Tocantins
    • + *
  • EX: Exterior
    • + *
+ * @enum {string} + */ + readonly State: "AC" | "AL" | "AP" | "AM" | "BA" | "CE" | "DF" | "ES" | "GO" | "MA" | "MT" | "MS" | "MG" | "PA" | "PB" | "PR" | "PE" | "PI" | "RJ" | "RN" | "RS" | "RO" | "RR" | "SC" | "SP" | "SE" | "TO" | "EX"; + readonly TaxCode: { + readonly code?: string | null; + readonly description?: string | null; + }; + readonly TaxCodePaginatedResponse: { + readonly items?: readonly components["schemas"]["TaxCode"][] | null; + /** Format: int32 */ + readonly currentPage?: number; + /** Format: int32 */ + readonly totalPages?: number; + /** Format: int64 */ + readonly totalCount?: number; + }; + /** + * @description

Possible values:

+ *
    + *
  • NationalSimple: Simples Nacional
    • + *
  • RealProfit: Lucro Real
    • + *
  • PresumedProfit: Lucro Presumido
    • + *
  • NationalSimpleSublimitExceeded: Simples Nacional sublimite excedido
    • + *
  • IndividualMicroEnterprise: Microempreendedor Individual
    • + *
  • Exempt: Isento
    • + *
+ * @enum {string} + */ + readonly TaxRegime: "NationalSimple" | "RealProfit" | "PresumedProfit" | "NationalSimpleSublimitExceeded" | "IndividualMicroEnterprise" | "Exempt"; }; - /** - * @description

Possible values:

- *
    - *
  • NationalSimple: Simples Nacional
    • - *
  • RealProfit: Lucro Real
    • - *
  • PresumedProfit: Lucro Presumido
    • - *
  • NationalSimpleSublimitExceeded: Simples Nacional sublimite excedido
    • - *
  • IndividualMicroEnterprise: Microempreendedor Individual
    • - *
  • Exempt: Isento
    • - *
- * - * @enum {string} - */ - readonly TaxRegime: "NationalSimple" | "RealProfit" | "PresumedProfit" | "NationalSimpleSublimitExceeded" | "IndividualMicroEnterprise" | "Exempt"; - }; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; -}; - + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} export type $defs = Record; - -export type external = Record; - export type operations = Record; diff --git a/src/generated/consulta-cte-v2.ts b/src/generated/consulta-cte-v2.ts index 574c5f1..3d58d9c 100644 --- a/src/generated/consulta-cte-v2.ts +++ b/src/generated/consulta-cte-v2.ts @@ -4,452 +4,656 @@ * Do not edit this file directly. * * To regenerate: npm run generate - * Last generated: 2026-02-15T17:59:25.439Z + * Last generated: 2026-04-25T23:27:48.983Z * Generator: openapi-typescript */ -/** - * This file was auto-generated by openapi-typescript. - * Do not make direct changes to the file. - */ - - -export type paths = { - "/v2/companies/{companyId}/inbound/transportationinvoices": { - /** - * Obter as configurações ativas usadas na busca automática de Conhecimento de Transporte Eletrônico (CT-e) - * @description Você precisará do APIKEY para utilização - */ - get: { - parameters: { - path: { - companyId: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.TransportationInvoiceInboundResource"]; - }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: { - readonly "application/json": string; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Não encontrado */ - 404: { - content: { - readonly "application/json": string; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": string; - }; - }; - }; +export interface paths { + readonly "/v2/companies/{companyId}/inbound/transportationinvoices": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Obter as configurações ativas usadas na busca automática de Conhecimento de Transporte Eletrônico (CT-e) + * @description Você precisará do APIKEY para utilização + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + readonly companyId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.TransportationInvoiceInboundResource"]; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + }; + }; + readonly put?: never; + /** + * Ativar busca automática de documentos e Eventos relacionados a Conhecimento de Transporte Eletrônico (CT-e) + * @description Você precisará do APIKEY para utilização + */ + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + readonly companyId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json-patch+json": components["schemas"]["DFe.NetCore.Domain.Resources.EnableTransportationInvoiceInboundResource"]; + readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.EnableTransportationInvoiceInboundResource"]; + readonly "text/json": components["schemas"]["DFe.NetCore.Domain.Resources.EnableTransportationInvoiceInboundResource"]; + readonly "application/*+json": components["schemas"]["DFe.NetCore.Domain.Resources.EnableTransportationInvoiceInboundResource"]; + }; + }; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.TransportationInvoiceInboundResource"]; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + }; + }; + /** + * Inativar busca automática de documentos e Eventos relacionados a Conhecimento de Transporte Eletrônico (CT-e) + * @description Você precisará do APIKEY para utilização + */ + readonly delete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + readonly companyId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.TransportationInvoiceInboundResource"]; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + }; + }; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * Ativar busca automática de documentos e Eventos relacionados a Conhecimento de Transporte Eletrônico (CT-e) - * @description Você precisará do APIKEY para utilização - */ - post: { - parameters: { - path: { - companyId: string; - }; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json-patch+json": components["schemas"]["DFe.NetCore.Domain.Resources.EnableTransportationInvoiceInboundResource"]; - readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.EnableTransportationInvoiceInboundResource"]; - readonly "text/json": components["schemas"]["DFe.NetCore.Domain.Resources.EnableTransportationInvoiceInboundResource"]; - readonly "application/*+json": components["schemas"]["DFe.NetCore.Domain.Resources.EnableTransportationInvoiceInboundResource"]; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.TransportationInvoiceInboundResource"]; - }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: { - readonly "application/json": string; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Não encontrado */ - 404: { - content: { - readonly "application/json": string; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": string; - }; - }; - }; + readonly "/v2/companies/{company_id}/inbound/{access_key}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Obter os detalhes de um CT-e pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + readonly company_id: string; + readonly access_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.MetadataResource"]; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * Inativar busca automática de documentos e Eventos relacionados a Conhecimento de Transporte Eletrônico (CT-e) - * @description Você precisará do APIKEY para utilização - */ - delete: { - parameters: { - path: { - companyId: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.TransportationInvoiceInboundResource"]; - }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: { - readonly "application/json": string; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Não encontrado */ - 404: { - content: { - readonly "application/json": string; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": string; - }; - }; - }; + readonly "/v2/companies/{company_id}/inbound/{access_key}/xml": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Obter o XML de um CT-e pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + readonly company_id: string; + readonly access_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/v2/companies/{company_id}/inbound/{access_key}": { - /** - * Obter os detalhes de um CT-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - get: { - parameters: { - path: { - company_id: string; - access_key: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.MetadataResource"]; - }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: { - readonly "application/json": string; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Não encontrado */ - 404: { - content: { - readonly "application/json": string; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": string; - }; - }; - }; + readonly "/v2/companies/{company_id}/inbound/{access_key}/events/{event_key}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Obter os detalhes de um evento ref. a um CT-e pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + readonly company_id: string; + readonly access_key: string; + readonly event_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.MetadataResource"]; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/v2/companies/{company_id}/inbound/{access_key}/xml": { - /** - * Obter o XML de um CT-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - get: { - parameters: { - path: { - company_id: string; - access_key: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": string; - }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: { - readonly "application/json": string; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Não encontrado */ - 404: { - content: { - readonly "application/json": string; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": string; - }; - }; - }; - }; - }; - "/v2/companies/{company_id}/inbound/{access_key}/events/{event_key}": { - /** - * Obter os detalhes de um evento ref. a um CT-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - get: { - parameters: { - path: { - company_id: string; - access_key: string; - event_key: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": components["schemas"]["DFe.NetCore.Domain.Resources.MetadataResource"]; - }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: { - readonly "application/json": string; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Não encontrado */ - 404: { - content: { - readonly "application/json": string; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": string; - }; - }; - }; - }; - }; - "/v2/companies/{company_id}/inbound/{access_key}/events/{event_key}/xml": { - /** - * Obter o XML de um evento ref. a um CT-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - get: { - parameters: { - path: { - company_id: string; - access_key: string; - event_key: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": string; - }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: { - readonly "application/json": string; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Não encontrado */ - 404: { - content: { - readonly "application/json": string; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": string; - }; - }; - }; + readonly "/v2/companies/{company_id}/inbound/{access_key}/events/{event_key}/xml": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Obter o XML de um evento ref. a um CT-e pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + readonly company_id: string; + readonly access_key: string; + readonly event_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; -}; - +} export type webhooks = Record; - -export type components = { - schemas: { - /** - * Format: int32 - * @enum {integer} - */ - readonly "DFe.NetCore.Domain.Enums.EntityStatus": 0 | 1 | -1; - /** - * Format: int32 - * @enum {integer} - */ - readonly "DFe.NetCore.Domain.Enums.MetadataResourceType": 0 | 1 | 2 | 3 | 4 | 5; - readonly "DFe.NetCore.Domain.Resources.CompanyResource": { - readonly id?: string | null; - readonly federalTaxNumber?: string | null; - readonly state?: string | null; - readonly stateTaxNumber?: string | null; - }; - readonly "DFe.NetCore.Domain.Resources.EnableInboundProductInvoiceResource": { - /** Format: int64 */ - readonly startFromNsu?: number; - /** Format: date-time */ - readonly startFromDate?: string; - readonly automaticManifesting?: components["schemas"]["DFe.NetCore.Domain.Resources.ManifestAutomaticRulesResource"]; - }; - readonly "DFe.NetCore.Domain.Resources.EnableTransportationInvoiceInboundResource": { - /** Format: int64 */ - readonly startFromNsu?: number; - /** Format: date-time */ - readonly startFromDate?: string; - }; - readonly "DFe.NetCore.Domain.Resources.ManifestAutomaticRulesResource": { - /** Format: int32 */ - readonly minutesToWaitAwarenessOperation?: number; - }; - readonly "DFe.NetCore.Domain.Resources.MetadataResource": { - readonly id?: string | null; - /** Format: date-time */ - readonly createdOn?: string | null; - readonly accessKey?: string | null; - readonly parentAccessKey?: string | null; - readonly productInvoices?: (readonly components["schemas"]["DFe.NetCore.Domain.Resources.ProductInvoiceResource"][]) | null; - readonly company?: components["schemas"]["DFe.NetCore.Domain.Resources.CompanyResource"]; - readonly type?: components["schemas"]["DFe.NetCore.Domain.Enums.MetadataResourceType"]; - /** Format: int64 */ - readonly nsu?: number; - /** Format: date-time */ - readonly issuedOn?: string | null; - readonly description?: string | null; - readonly xmlUrl?: string | null; - readonly federalTaxNumberSender?: string | null; - readonly nameSender?: string | null; - readonly totalInvoiceAmount?: string | null; - }; - readonly "DFe.NetCore.Domain.Resources.ProductInvoiceInboundResource": { - /** Format: int64 */ - readonly startFromNsu?: number; - /** Format: date-time */ - readonly startFromDate?: string; - readonly automaticManifesting?: components["schemas"]["DFe.NetCore.Domain.Resources.ManifestAutomaticRulesResource"]; - readonly companyId?: string | null; - readonly status?: components["schemas"]["DFe.NetCore.Domain.Enums.EntityStatus"]; - /** Format: date-time */ - readonly createdOn?: string; - /** Format: date-time */ - readonly modifiedOn?: string | null; - }; - readonly "DFe.NetCore.Domain.Resources.ProductInvoiceResource": { - readonly accessKey?: string | null; - }; - readonly "DFe.NetCore.Domain.Resources.TransportationInvoiceInboundResource": { - /** Format: int64 */ - readonly startFromNsu?: number; - /** Format: date-time */ - readonly startFromDate?: string; - readonly companyId?: string | null; - readonly status?: components["schemas"]["DFe.NetCore.Domain.Enums.EntityStatus"]; - /** Format: date-time */ - readonly createdOn?: string; - /** Format: date-time */ - readonly modifiedOn?: string | null; +export interface components { + schemas: { + /** + * Format: int32 + * @enum {integer} + */ + readonly "DFe.NetCore.Domain.Enums.EntityStatus": 0 | 1 | -1; + /** + * Format: int32 + * @enum {integer} + */ + readonly "DFe.NetCore.Domain.Enums.MetadataResourceType": 0 | 1 | 2 | 3 | 4 | 5; + readonly "DFe.NetCore.Domain.Resources.CompanyResource": { + readonly id?: string | null; + readonly federalTaxNumber?: string | null; + readonly state?: string | null; + readonly stateTaxNumber?: string | null; + }; + readonly "DFe.NetCore.Domain.Resources.EnableInboundProductInvoiceResource": { + /** Format: int64 */ + readonly startFromNsu?: number; + /** Format: date-time */ + readonly startFromDate?: string; + readonly automaticManifesting?: components["schemas"]["DFe.NetCore.Domain.Resources.ManifestAutomaticRulesResource"]; + }; + readonly "DFe.NetCore.Domain.Resources.EnableTransportationInvoiceInboundResource": { + /** Format: int64 */ + readonly startFromNsu?: number; + /** Format: date-time */ + readonly startFromDate?: string; + }; + readonly "DFe.NetCore.Domain.Resources.ManifestAutomaticRulesResource": { + /** Format: int32 */ + readonly minutesToWaitAwarenessOperation?: number; + }; + readonly "DFe.NetCore.Domain.Resources.MetadataResource": { + readonly id?: string | null; + /** Format: date-time */ + readonly createdOn?: string | null; + readonly accessKey?: string | null; + readonly parentAccessKey?: string | null; + readonly productInvoices?: readonly components["schemas"]["DFe.NetCore.Domain.Resources.ProductInvoiceResource"][] | null; + readonly company?: components["schemas"]["DFe.NetCore.Domain.Resources.CompanyResource"]; + readonly type?: components["schemas"]["DFe.NetCore.Domain.Enums.MetadataResourceType"]; + /** Format: int64 */ + readonly nsu?: number; + /** Format: date-time */ + readonly issuedOn?: string | null; + readonly description?: string | null; + readonly xmlUrl?: string | null; + readonly federalTaxNumberSender?: string | null; + readonly nameSender?: string | null; + readonly totalInvoiceAmount?: string | null; + }; + readonly "DFe.NetCore.Domain.Resources.ProductInvoiceInboundResource": { + /** Format: int64 */ + readonly startFromNsu?: number; + /** Format: date-time */ + readonly startFromDate?: string; + readonly automaticManifesting?: components["schemas"]["DFe.NetCore.Domain.Resources.ManifestAutomaticRulesResource"]; + readonly companyId?: string | null; + readonly status?: components["schemas"]["DFe.NetCore.Domain.Enums.EntityStatus"]; + /** Format: date-time */ + readonly createdOn?: string; + /** Format: date-time */ + readonly modifiedOn?: string | null; + }; + readonly "DFe.NetCore.Domain.Resources.ProductInvoiceResource": { + readonly accessKey?: string | null; + }; + readonly "DFe.NetCore.Domain.Resources.TransportationInvoiceInboundResource": { + /** Format: int64 */ + readonly startFromNsu?: number; + /** Format: date-time */ + readonly startFromDate?: string; + readonly companyId?: string | null; + readonly status?: components["schemas"]["DFe.NetCore.Domain.Enums.EntityStatus"]; + /** Format: date-time */ + readonly createdOn?: string; + /** Format: date-time */ + readonly modifiedOn?: string | null; + }; }; - }; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; -}; - + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} export type $defs = Record; - -export type external = Record; - export type operations = Record; diff --git a/src/generated/consulta-nfe-distribuicao-v1.ts b/src/generated/consulta-nfe-distribuicao-v1.ts index 977e2e9..f65a436 100644 --- a/src/generated/consulta-nfe-distribuicao-v1.ts +++ b/src/generated/consulta-nfe-distribuicao-v1.ts @@ -4,1205 +4,1711 @@ * Do not edit this file directly. * * To regenerate: npm run generate - * Last generated: 2026-02-15T17:59:25.479Z + * Last generated: 2026-04-25T23:27:49.018Z * Generator: openapi-typescript */ -/** - * This file was auto-generated by openapi-typescript. - * Do not make direct changes to the file. - */ - - -export type paths = { - "/{access_key}/xml": { - /** - * Obter o XML de um CT-e ou NF-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - get: operations["ObteroXMLdeumCT-eouNF-epelachavedeacessode44dígitos"]; - }; - "/{access_key}/events/{event_key}/xml": { - /** - * Obter o XML de um evento ref. a um CT-e ou NF-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - get: operations["ObteroXMLdeumeventoref.aumCT-eouNF-epelachavedeacessode44dígitos"]; - }; - "/{access_key}/pdf": { - /** - * Obter o PDF de uma NF-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - get: operations["ObteroPDFdeumaNF-epelachavedeacessode44dígitos"]; - }; - "/{access_key}/events/{event_key}": { - /** - * Obter os detalhes de um evento ref. a um CT-e ou NF-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - get: operations["Obterosdetalhesdeumeventoref.aumCT-eouNF-epelachavedeacessode44dígitos"]; - }; - "/productinvoice/{access_key}/events/{event_key}": { - /** - * Obter os detalhes de um evento ref. a um CT-e ou NF-e pela chave de acesso de 44 dígitos1 - * @description Você precisará da APIKEY para utilização - */ - get: operations["Obterosdetalhesdeumeventoref.aumCT-eouNF-epelachavedeacessode44dígitos1"]; - }; - "/{access_key}/manifest": { - /** - * Enviar o evento de ciência da operação pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - post: operations["Enviaroeventodeciênciadaoperaçãopelachavedeacessode44dígitos"]; - }; - "/{access_key}": { - /** - * Obter os detalhes de um CT-e ou NF-e (webhook v1) pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - get: operations["ObterosdetalhesdeumCT-eouNF-e(webhookv1)pelachavedeacessode44dígitos"]; - }; - "/productinvoice/{access_key}": { - /** - * Obter os detalhes de uma NF-e (webhook v2) pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - get: operations["ObterosdetalhesdeumaNF-e(webhookv2)pelachavedeacessode44dígitos"]; - }; - "/productinvoices": { - /** - * Obter detalhes da parametrização do serviço de distribuição (NF-e) - * @description Você precisará do APIKEY para utilização - */ - get: operations["Obterdetalhesdaparametrizaçãodoserviçodedistribuição(NF-e)"]; - /** - * Ativar busca automática de documentos e Eventos relacionados a Nota Fiscal Eletrônica (NF-e) - * @description Você precisará do APIKEY para utilização - */ - post: operations["AtivarbuscaautomáticadedocumentoseEventosrelacionadosaNotaFiscalEletrônica(NF-e)"]; - /** - * Desativar busca automática de documentos e Eventos relacionados a Nota Fiscal Eletrônica (NF-e) - * @description Você precisará do APIKEY para utilização - */ - delete: operations["DesativarbuscaautomáticadedocumentoseEventosrelacionadosaNotaFiscalEletrônica(NF-e)"]; - }; - "/productinvoice/{access_key}/json": { - /** - * Obter o json de uma NF-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - get: operations["ObterojsondeumaNF-epelachavedeacessode44dígitos"]; - }; - "/productinvoice/{access_key_or_nsu}/processwebhook": { - /** - * Reprocessar o webhook pela chave de acesso de 44 dígitos ou pelo NSU - * @description Você precisará da APIKEY para utilização - */ - post: operations["Reprocessarowebhookpelachavedeacessode44dígitosoupeloNSU"]; - }; -}; - -export type webhooks = Record; - -export type components = { - schemas: { - /** - * Sucessonarequisio - * @example { - * "id": "", - * "createdOn": "", - * "accessKey": "", - * "parentAccessKey": "", - * "company": { - * "id": "", - * "federalTaxNumber": "" - * }, - * "issuer": { - * "federalTaxNumber": "", - * "name": "" - * }, - * "buyer": { - * "federalTaxNumber": "", - * "name": "" - * }, - * "transportation": { - * "federalTaxNumber": "", - * "name": "" - * }, - * "links": { - * "xml": "", - * "pdf": "" - * }, - * "xmlUrl": "", - * "federalTaxNumberSender": "", - * "nameSender": "", - * "type": null, - * "nsu": "", - * "nsuParent": "", - * "nfeNumber": "", - * "nfeSerialNumber": "", - * "issuedOn": "", - * "description": "", - * "totalInvoiceAmount": "", - * "operationType": null - * } - */ - readonly Sucessonarequisio: { - readonly id: string; - readonly createdOn: string; - readonly accessKey: string; - readonly parentAccessKey: string; - readonly company: components["schemas"]["Company"]; - readonly issuer: components["schemas"]["Issuer"]; - readonly buyer: components["schemas"]["Buyer"]; - readonly transportation: components["schemas"]["Transportation"]; - readonly links: components["schemas"]["Links"]; - readonly xmlUrl: string; - readonly federalTaxNumberSender: string; - readonly nameSender: string; - readonly type: string | null; - readonly nsu: string; - readonly nsuParent: string; - readonly nfeNumber: string; - readonly nfeSerialNumber: string; - readonly issuedOn: string; - readonly description: string; - readonly totalInvoiceAmount: string; - readonly operationType: string | null; - }; - /** - * Company - * @example { - * "id": "", - * "federalTaxNumber": "" - * } - */ - readonly Company: { - readonly id: string; - readonly federalTaxNumber: string; - }; - /** - * Issuer - * @example { - * "federalTaxNumber": "", - * "name": "" - * } - */ - readonly Issuer: { - readonly federalTaxNumber: string; - readonly name: string; - }; - /** - * Buyer - * @example { - * "federalTaxNumber": "", - * "name": "" - * } - */ - readonly Buyer: { - readonly federalTaxNumber: string; - readonly name: string; - }; - /** - * Transportation - * @example { - * "federalTaxNumber": "", - * "name": "" - * } - */ - readonly Transportation: { - readonly federalTaxNumber: string; - readonly name: string; - }; - /** - * Links - * @example { - * "xml": "", - * "pdf": "" - * } - */ - readonly Links: { - readonly xml: string; - readonly pdf: string; - }; - /** - * AtivarbuscaautomticadedocumentoseEventosrelacionadosaNotaFiscalEletrnicaNF-eRequest - * @example { - * "startFromNsu": "999999", - * "startFromDate": "", - * "environmentSEFAZ": "Production", - * "automaticManifesting": { - * "minutesToWaitAwarenessOperation": "30" - * }, - * "webhookVersion": "2" - * } - */ - readonly "AtivarbuscaautomticadedocumentoseEventosrelacionadosaNotaFiscalEletrnicaNF-eRequest": { - readonly startFromNsu: string; - readonly startFromDate: string; - readonly environmentSEFAZ: string; - readonly automaticManifesting: components["schemas"]["AutomaticManifesting"]; - readonly webhookVersion: string; - }; - /** - * AutomaticManifesting - * @example { - * "minutesToWaitAwarenessOperation": "30" - * } - */ - readonly AutomaticManifesting: { - readonly minutesToWaitAwarenessOperation: string; - }; - /** - * Sucessonarequisio2 - * @example { - * "startFromNsu": "", - * "startFromDate": "", - * "environmentSEFAZ": null, - * "automaticManifesting": { - * "minutesToWaitAwarenessOperation": "" - * }, - * "webhookVersion": "", - * "companyId": "", - * "status": null, - * "createdOn": "", - * "modifiedOn": "" - * } - */ - readonly Sucessonarequisio2: { - readonly startFromNsu: string; - readonly startFromDate: string; - readonly environmentSEFAZ: string | null; - readonly automaticManifesting: components["schemas"]["AutomaticManifesting"]; - readonly webhookVersion: string; - readonly companyId: string; - readonly status: string | null; - readonly createdOn: string; - readonly modifiedOn: string; - }; - /** - * Sucessonarequisio6 - * @example { - * "id": "", - * "createdOn": "", - * "accessKey": "", - * "parentAccessKey": "", - * "productInvoices": [ - * { - * "accessKey": "" - * }, - * { - * "accessKey": "" - * } - * ], - * "company": { - * "id": "", - * "federalTaxNumber": "" - * }, - * "issuer": { - * "federalTaxNumber": "", - * "name": "" - * }, - * "buyer": { - * "federalTaxNumber": "", - * "name": "" - * }, - * "transportation": { - * "federalTaxNumber": "", - * "name": "" - * }, - * "type": null, - * "nsu": "", - * "nfeNumber": "", - * "issuedOn": "", - * "description": "", - * "xmlUrl": "", - * "federalTaxNumberSender": "", - * "nameSender": "", - * "totalInvoiceAmount": "", - * "links": { - * "xml": "", - * "pdf": "" - * } - * } - */ - readonly Sucessonarequisio6: { - readonly id: string; - readonly createdOn: string; - readonly accessKey: string; - readonly parentAccessKey: string; - readonly productInvoices: readonly components["schemas"]["ProductInvoice"][]; - readonly company: components["schemas"]["Company"]; - readonly issuer: components["schemas"]["Issuer"]; - readonly buyer: components["schemas"]["Buyer"]; - readonly transportation: components["schemas"]["Transportation"]; - readonly type: string | null; - readonly nsu: string; - readonly nfeNumber: string; - readonly issuedOn: string; - readonly description: string; - readonly xmlUrl: string; - readonly federalTaxNumberSender: string; - readonly nameSender: string; - readonly totalInvoiceAmount: string; - readonly links: components["schemas"]["Links"]; - }; - /** - * ProductInvoice - * @example { - * "accessKey": "" - * } - */ - readonly ProductInvoice: { - readonly accessKey: string; - }; - }; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; -}; - -export type $defs = Record; - -export type external = Record; - -export type operations = { - - /** - * Obter o XML de um CT-e ou NF-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - "ObteroXMLdeumCT-eouNF-epelachavedeacessode44dígitos": { - parameters: { - header: { - Accept: string; - }; - path: { - /** @description (Required) */ - access_key: string; - }; - }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Bad Request */ - 400: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - }; - content: { +export interface paths { + readonly "/{access_key}/xml": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Forbidden */ - 403: { - headers: { - }; - content: { - }; - }; - /** @description Not Found */ - 404: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - }; - }; - /** - * Obter o XML de um evento ref. a um CT-e ou NF-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - "ObteroXMLdeumeventoref.aumCT-eouNF-epelachavedeacessode44dígitos": { - parameters: { - header: { - Accept: string; - }; - path: { - /** @description (Required) */ - access_key: string; - /** @description (Required) */ - event_key: string; - }; + /** + * Obter o XML de um CT-e ou NF-e pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly get: operations["ObteroXMLdeumCT-eouNF-epelachavedeacessode44d\u00EDgitos"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Bad Request */ - 400: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - }; - content: { + readonly "/{access_key}/events/{event_key}/xml": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Forbidden */ - 403: { - headers: { - }; - content: { - }; - }; - /** @description Not Found */ - 404: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - }; - }; - /** - * Obter o PDF de uma NF-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - "ObteroPDFdeumaNF-epelachavedeacessode44dígitos": { - parameters: { - header: { - Accept: string; - }; - path: { - /** @description (Required) */ - access_key: string; - }; + /** + * Obter o XML de um evento ref. a um CT-e ou NF-e pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly get: operations["ObteroXMLdeumeventoref.aumCT-eouNF-epelachavedeacessode44d\u00EDgitos"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Bad Request */ - 400: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - }; - content: { + readonly "/{access_key}/pdf": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Forbidden */ - 403: { - headers: { - }; - content: { - }; - }; - /** @description Not Found */ - 404: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - }; - }; - /** - * Obter os detalhes de um evento ref. a um CT-e ou NF-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - "Obterosdetalhesdeumeventoref.aumCT-eouNF-epelachavedeacessode44dígitos": { - parameters: { - header: { - Accept: string; - }; - path: { - /** @description (Required) */ - access_key: string; - /** @description (Required) */ - event_key: string; - }; + /** + * Obter o PDF de uma NF-e pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly get: operations["ObteroPDFdeumaNF-epelachavedeacessode44d\u00EDgitos"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": components["schemas"]["Sucessonarequisio"]; - }; - }; - /** @description Bad Request */ - 400: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - }; - content: { + readonly "/{access_key}/events/{event_key}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Forbidden */ - 403: { - headers: { - }; - content: { - }; - }; - /** @description Not Found */ - 404: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - }; - }; - /** - * Obter os detalhes de um evento ref. a um CT-e ou NF-e pela chave de acesso de 44 dígitos1 - * @description Você precisará da APIKEY para utilização - */ - "Obterosdetalhesdeumeventoref.aumCT-eouNF-epelachavedeacessode44dígitos1": { - parameters: { - header: { - Accept: string; - }; - path: { - /** @description (Required) */ - access_key: string; - /** @description (Required) */ - event_key: string; - }; + /** + * Obter os detalhes de um evento ref. a um CT-e ou NF-e pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly get: operations["Obterosdetalhesdeumeventoref.aumCT-eouNF-epelachavedeacessode44d\u00EDgitos"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": components["schemas"]["Sucessonarequisio6"]; - }; - }; - /** @description Bad Request */ - 400: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - }; - content: { + readonly "/productinvoice/{access_key}/events/{event_key}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Forbidden */ - 403: { - headers: { - }; - content: { - }; - }; - /** @description Not Found */ - 404: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; + /** + * Obter os detalhes de um evento ref. a um CT-e ou NF-e pela chave de acesso de 44 dígitos1 + * @description Você precisará da APIKEY para utilização + */ + readonly get: operations["Obterosdetalhesdeumeventoref.aumCT-eouNF-epelachavedeacessode44d\u00EDgitos1"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - /** - * Enviar o evento de ciência da operação pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - "Enviaroeventodeciênciadaoperaçãopelachavedeacessode44dígitos": { - parameters: { - query: { - /** @description Informar o tipo do evento de manifestação do destinatário (default = 210210 "Ciência da Operação) */ - tpEvent: number; - }; - header: { - Accept: string; - }; - path: { - /** @description (Required) Informar a chave de acesso da nota */ - access_key: string; - }; + readonly "/{access_key}/manifest": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Enviar o evento de ciência da operação pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly post: operations["Enviaroeventodeci\u00EAnciadaopera\u00E7\u00E3opelachavedeacessode44d\u00EDgitos"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Bad Request */ - 400: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { + readonly "/{access_key}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - content: { - }; - }; - /** @description Forbidden */ - 403: { - headers: { - }; - content: { - }; - }; - /** @description Not Found */ - 404: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - }; - }; - /** - * Obter os detalhes de um CT-e ou NF-e (webhook v1) pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - "ObterosdetalhesdeumCT-eouNF-e(webhookv1)pelachavedeacessode44dígitos": { - parameters: { - header: { - Accept: string; - }; - path: { - /** @description (Required) */ - access_key: string; - }; + /** + * Obter os detalhes de um CT-e ou NF-e (webhook v1) pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly get: operations["ObterosdetalhesdeumCT-eouNF-e(webhookv1)pelachavedeacessode44d\u00EDgitos"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": components["schemas"]["Sucessonarequisio"]; - }; - }; - /** @description Bad Request */ - 400: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { + readonly "/productinvoice/{access_key}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - content: { - }; - }; - /** @description Forbidden */ - 403: { - headers: { - }; - content: { - }; - }; - /** @description Not Found */ - 404: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - }; - }; - /** - * Obter os detalhes de uma NF-e (webhook v2) pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - "ObterosdetalhesdeumaNF-e(webhookv2)pelachavedeacessode44dígitos": { - parameters: { - header: { - Accept: string; - }; - path: { - /** @description (Required) */ - access_key: string; - }; + /** + * Obter os detalhes de uma NF-e (webhook v2) pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly get: operations["ObterosdetalhesdeumaNF-e(webhookv2)pelachavedeacessode44d\u00EDgitos"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": components["schemas"]["Sucessonarequisio"]; - }; - }; - /** @description Bad Request */ - 400: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - }; - content: { + readonly "/productinvoices": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Forbidden */ - 403: { - headers: { - }; - content: { - }; - }; - /** @description Not Found */ - 404: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - }; - }; - /** - * Obter detalhes da parametrização do serviço de distribuição (NF-e) - * @description Você precisará do APIKEY para utilização - */ - "Obterdetalhesdaparametrizaçãodoserviçodedistribuição(NF-e)": { - parameters: { - header: { - Accept: string; - }; + /** + * Obter detalhes da parametrização do serviço de distribuição (NF-e) + * @description Você precisará do APIKEY para utilização + */ + readonly get: operations["Obterdetalhesdaparametriza\u00E7\u00E3odoservi\u00E7odedistribui\u00E7\u00E3o(NF-e)"]; + readonly put?: never; + /** + * Ativar busca automática de documentos e Eventos relacionados a Nota Fiscal Eletrônica (NF-e) + * @description Você precisará do APIKEY para utilização + */ + readonly post: operations["Ativarbuscaautom\u00E1ticadedocumentoseEventosrelacionadosaNotaFiscalEletr\u00F4nica(NF-e)"]; + /** + * Desativar busca automática de documentos e Eventos relacionados a Nota Fiscal Eletrônica (NF-e) + * @description Você precisará do APIKEY para utilização + */ + readonly delete: operations["Desativarbuscaautom\u00E1ticadedocumentoseEventosrelacionadosaNotaFiscalEletr\u00F4nica(NF-e)"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": components["schemas"]["Sucessonarequisio2"]; + readonly "/productinvoice/{access_key}/json": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Bad Request */ - 400: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - }; - content: { - }; - }; - /** @description Forbidden */ - 403: { - headers: { - }; - content: { - }; - }; - /** @description Not Found */ - 404: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; + /** + * Obter o json de uma NF-e pela chave de acesso de 44 dígitos + * @description Você precisará da APIKEY para utilização + */ + readonly get: operations["ObterojsondeumaNF-epelachavedeacessode44d\u00EDgitos"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - /** - * Ativar busca automática de documentos e Eventos relacionados a Nota Fiscal Eletrônica (NF-e) - * @description Você precisará do APIKEY para utilização - */ - "AtivarbuscaautomáticadedocumentoseEventosrelacionadosaNotaFiscalEletrônica(NF-e)": { - parameters: { - header: { - Accept: string; - }; + readonly "/productinvoice/{access_key_or_nsu}/processwebhook": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Reprocessar o webhook pela chave de acesso de 44 dígitos ou pelo NSU + * @description Você precisará da APIKEY para utilização + */ + readonly post: operations["Reprocessarowebhookpelachavedeacessode44d\u00EDgitosoupeloNSU"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly requestBody: { - readonly content: { +} +export type webhooks = Record; +export interface components { + schemas: { /** + * Sucessonarequisio * @example { - * "startFromNsu": "999999", - * "startFromDate": "", - * "environmentSEFAZ": "Production", - * "automaticManifesting": { - * "minutesToWaitAwarenessOperation": "30" - * }, - * "webhookVersion": "2" - * } + * "id": "", + * "createdOn": "", + * "accessKey": "", + * "parentAccessKey": "", + * "company": { + * "id": "", + * "federalTaxNumber": "" + * }, + * "issuer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "buyer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "transportation": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "links": { + * "xml": "", + * "pdf": "" + * }, + * "xmlUrl": "", + * "federalTaxNumberSender": "", + * "nameSender": "", + * "type": null, + * "nsu": "", + * "nsuParent": "", + * "nfeNumber": "", + * "nfeSerialNumber": "", + * "issuedOn": "", + * "description": "", + * "totalInvoiceAmount": "", + * "operationType": null + * } */ - readonly "application/json": components["schemas"]["AtivarbuscaautomticadedocumentoseEventosrelacionadosaNotaFiscalEletrnicaNF-eRequest"]; - }; - }; - responses: { - /** @description OK */ - 200: { - headers: { + readonly Sucessonarequisio: { + readonly id: string; + readonly createdOn: string; + readonly accessKey: string; + readonly parentAccessKey: string; + readonly company: components["schemas"]["Company"]; + readonly issuer: components["schemas"]["Issuer"]; + readonly buyer: components["schemas"]["Buyer"]; + readonly transportation: components["schemas"]["Transportation"]; + readonly links: components["schemas"]["Links"]; + readonly xmlUrl: string; + readonly federalTaxNumberSender: string; + readonly nameSender: string; + readonly type: string | null; + readonly nsu: string; + readonly nsuParent: string; + readonly nfeNumber: string; + readonly nfeSerialNumber: string; + readonly issuedOn: string; + readonly description: string; + readonly totalInvoiceAmount: string; + readonly operationType: string | null; }; - content: { - readonly "application/json": components["schemas"]["Sucessonarequisio2"]; - }; - }; - /** @description Bad Request */ - 400: { - headers: { + /** + * Company + * @example { + * "id": "", + * "federalTaxNumber": "" + * } + */ + readonly Company: { + readonly id: string; + readonly federalTaxNumber: string; }; - content: { - readonly "application/json": string; + /** + * Issuer + * @example { + * "federalTaxNumber": "", + * "name": "" + * } + */ + readonly Issuer: { + readonly federalTaxNumber: string; + readonly name: string; }; - }; - /** @description Unauthorized */ - 401: { - headers: { + /** + * Buyer + * @example { + * "federalTaxNumber": "", + * "name": "" + * } + */ + readonly Buyer: { + readonly federalTaxNumber: string; + readonly name: string; }; - content: { + /** + * Transportation + * @example { + * "federalTaxNumber": "", + * "name": "" + * } + */ + readonly Transportation: { + readonly federalTaxNumber: string; + readonly name: string; }; - }; - /** @description Forbidden */ - 403: { - headers: { + /** + * Links + * @example { + * "xml": "", + * "pdf": "" + * } + */ + readonly Links: { + readonly xml: string; + readonly pdf: string; }; - content: { + /** + * AtivarbuscaautomticadedocumentoseEventosrelacionadosaNotaFiscalEletrnicaNF-eRequest + * @example { + * "startFromNsu": "999999", + * "startFromDate": "", + * "environmentSEFAZ": "Production", + * "automaticManifesting": { + * "minutesToWaitAwarenessOperation": "30" + * }, + * "webhookVersion": "2" + * } + */ + readonly "AtivarbuscaautomticadedocumentoseEventosrelacionadosaNotaFiscalEletrnicaNF-eRequest": { + readonly startFromNsu: string; + readonly startFromDate: string; + readonly environmentSEFAZ: string; + readonly automaticManifesting: components["schemas"]["AutomaticManifesting"]; + readonly webhookVersion: string; }; - }; - /** @description Not Found */ - 404: { - headers: { + /** + * AutomaticManifesting + * @example { + * "minutesToWaitAwarenessOperation": "30" + * } + */ + readonly AutomaticManifesting: { + readonly minutesToWaitAwarenessOperation: string; }; - content: { - readonly "application/json": string; + /** + * Sucessonarequisio2 + * @example { + * "startFromNsu": "", + * "startFromDate": "", + * "environmentSEFAZ": null, + * "automaticManifesting": { + * "minutesToWaitAwarenessOperation": "" + * }, + * "webhookVersion": "", + * "companyId": "", + * "status": null, + * "createdOn": "", + * "modifiedOn": "" + * } + */ + readonly Sucessonarequisio2: { + readonly startFromNsu: string; + readonly startFromDate: string; + readonly environmentSEFAZ: string | null; + readonly automaticManifesting: components["schemas"]["AutomaticManifesting"]; + readonly webhookVersion: string; + readonly companyId: string; + readonly status: string | null; + readonly createdOn: string; + readonly modifiedOn: string; }; - }; - /** @description Internal Server Error */ - 500: { - headers: { + /** + * Sucessonarequisio6 + * @example { + * "id": "", + * "createdOn": "", + * "accessKey": "", + * "parentAccessKey": "", + * "productInvoices": [ + * { + * "accessKey": "" + * }, + * { + * "accessKey": "" + * } + * ], + * "company": { + * "id": "", + * "federalTaxNumber": "" + * }, + * "issuer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "buyer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "transportation": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "type": null, + * "nsu": "", + * "nfeNumber": "", + * "issuedOn": "", + * "description": "", + * "xmlUrl": "", + * "federalTaxNumberSender": "", + * "nameSender": "", + * "totalInvoiceAmount": "", + * "links": { + * "xml": "", + * "pdf": "" + * } + * } + */ + readonly Sucessonarequisio6: { + readonly id: string; + readonly createdOn: string; + readonly accessKey: string; + readonly parentAccessKey: string; + readonly productInvoices: readonly components["schemas"]["ProductInvoice"][]; + readonly company: components["schemas"]["Company"]; + readonly issuer: components["schemas"]["Issuer"]; + readonly buyer: components["schemas"]["Buyer"]; + readonly transportation: components["schemas"]["Transportation"]; + readonly type: string | null; + readonly nsu: string; + readonly nfeNumber: string; + readonly issuedOn: string; + readonly description: string; + readonly xmlUrl: string; + readonly federalTaxNumberSender: string; + readonly nameSender: string; + readonly totalInvoiceAmount: string; + readonly links: components["schemas"]["Links"]; }; - content: { - readonly "application/json": string; + /** + * ProductInvoice + * @example { + * "accessKey": "" + * } + */ + readonly ProductInvoice: { + readonly accessKey: string; }; - }; - }; - }; - /** - * Desativar busca automática de documentos e Eventos relacionados a Nota Fiscal Eletrônica (NF-e) - * @description Você precisará do APIKEY para utilização - */ - "DesativarbuscaautomáticadedocumentoseEventosrelacionadosaNotaFiscalEletrônica(NF-e)": { - parameters: { - header: { - Accept: string; - }; }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": components["schemas"]["Sucessonarequisio2"]; - }; - }; - /** @description Bad Request */ - 400: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - }; - content: { - }; - }; - /** @description Forbidden */ - 403: { - headers: { - }; - content: { - }; - }; - /** @description Not Found */ - 404: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - }; - content: { - readonly "application/json": string; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + readonly "ObteroXMLdeumCT-eouNF-epelachavedeacessode44d\u00EDgitos": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path: { + /** @description (Required) */ + readonly access_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - }; }; - }; - /** - * Obter o json de uma NF-e pela chave de acesso de 44 dígitos - * @description Você precisará da APIKEY para utilização - */ - "ObterojsondeumaNF-epelachavedeacessode44dígitos": { - parameters: { - header: { - Accept: string; - }; - path: { - /** @description (Required) */ - access_key: string; - }; - }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": components["schemas"]["Sucessonarequisio"]; - }; - }; - /** @description Bad Request */ - 400: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - }; - content: { - }; - }; - /** @description Forbidden */ - 403: { - headers: { - }; - content: { - }; - }; - /** @description Not Found */ - 404: { - headers: { - }; - content: { - readonly "application/json": string; + readonly "ObteroXMLdeumeventoref.aumCT-eouNF-epelachavedeacessode44d\u00EDgitos": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path: { + /** @description (Required) */ + readonly access_key: string; + /** @description (Required) */ + readonly event_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - }; - /** @description Internal Server Error */ - 500: { - headers: { - }; - content: { - readonly "application/json": string; - }; - }; }; - }; - /** - * Reprocessar o webhook pela chave de acesso de 44 dígitos ou pelo NSU - * @description Você precisará da APIKEY para utilização - */ - "Reprocessarowebhookpelachavedeacessode44dígitosoupeloNSU": { - parameters: { - header: { - Accept: string; - }; - path: { - /** @description (Required) */ - access_key_or_nsu: string; - }; - }; - responses: { - /** @description OK */ - 200: { - headers: { - }; - content: { - readonly "application/json": components["schemas"]["Sucessonarequisio6"]; + readonly "ObteroPDFdeumaNF-epelachavedeacessode44d\u00EDgitos": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path: { + /** @description (Required) */ + readonly access_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - }; - /** @description Bad Request */ - 400: { - headers: { + }; + readonly "Obterosdetalhesdeumeventoref.aumCT-eouNF-epelachavedeacessode44d\u00EDgitos": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path: { + /** @description (Required) */ + readonly access_key: string; + /** @description (Required) */ + readonly event_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "", + * "createdOn": "", + * "accessKey": "", + * "parentAccessKey": "", + * "company": { + * "id": "", + * "federalTaxNumber": "" + * }, + * "issuer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "buyer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "transportation": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "links": { + * "xml": "", + * "pdf": "" + * }, + * "xmlUrl": "", + * "federalTaxNumberSender": "", + * "nameSender": "", + * "type": null, + * "nsu": "", + * "nsuParent": "", + * "nfeNumber": "", + * "nfeSerialNumber": "", + * "issuedOn": "", + * "description": "", + * "totalInvoiceAmount": "", + * "operationType": null + * } + */ + readonly "application/json": components["schemas"]["Sucessonarequisio"] & unknown; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - content: { - readonly "application/json": string; + }; + readonly "Obterosdetalhesdeumeventoref.aumCT-eouNF-epelachavedeacessode44d\u00EDgitos1": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path: { + /** @description (Required) */ + readonly access_key: string; + /** @description (Required) */ + readonly event_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "", + * "createdOn": "", + * "accessKey": "", + * "parentAccessKey": "", + * "productInvoices": [ + * { + * "accessKey": "" + * }, + * { + * "accessKey": "" + * } + * ], + * "company": { + * "id": "", + * "federalTaxNumber": "" + * }, + * "issuer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "buyer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "transportation": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "type": null, + * "nsu": "", + * "nfeNumber": "", + * "issuedOn": "", + * "description": "", + * "xmlUrl": "", + * "federalTaxNumberSender": "", + * "nameSender": "", + * "totalInvoiceAmount": "", + * "links": { + * "xml": "", + * "pdf": "" + * } + * } + */ + readonly "application/json": components["schemas"]["Sucessonarequisio6"] & unknown; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - }; - /** @description Unauthorized */ - 401: { - headers: { + }; + readonly "Enviaroeventodeci\u00EAnciadaopera\u00E7\u00E3opelachavedeacessode44d\u00EDgitos": { + readonly parameters: { + readonly query: { + /** @description Informar o tipo do evento de manifestação do destinatário (default = 210210 "Ciência da Operação) */ + readonly tpEvent: number; + }; + readonly header: { + readonly Accept: string; + }; + readonly path: { + /** @description (Required) Informar a chave de acesso da nota */ + readonly access_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - content: { + }; + readonly "ObterosdetalhesdeumCT-eouNF-e(webhookv1)pelachavedeacessode44d\u00EDgitos": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path: { + /** @description (Required) */ + readonly access_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "", + * "createdOn": "", + * "accessKey": "", + * "parentAccessKey": "", + * "company": { + * "id": "", + * "federalTaxNumber": "" + * }, + * "issuer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "buyer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "transportation": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "links": { + * "xml": "", + * "pdf": "" + * }, + * "xmlUrl": "", + * "federalTaxNumberSender": "", + * "nameSender": "", + * "type": null, + * "nsu": "", + * "nsuParent": "", + * "nfeNumber": "", + * "nfeSerialNumber": "", + * "issuedOn": "", + * "description": "", + * "totalInvoiceAmount": "", + * "operationType": null + * } + */ + readonly "application/json": components["schemas"]["Sucessonarequisio"] & unknown; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - }; - /** @description Forbidden */ - 403: { - headers: { + }; + readonly "ObterosdetalhesdeumaNF-e(webhookv2)pelachavedeacessode44d\u00EDgitos": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path: { + /** @description (Required) */ + readonly access_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "", + * "createdOn": "", + * "accessKey": "", + * "parentAccessKey": "", + * "company": { + * "id": "", + * "federalTaxNumber": "" + * }, + * "issuer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "buyer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "transportation": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "links": { + * "xml": "", + * "pdf": "" + * }, + * "xmlUrl": "", + * "federalTaxNumberSender": "", + * "nameSender": "", + * "type": null, + * "nsu": "", + * "nsuParent": "", + * "nfeNumber": "", + * "nfeSerialNumber": "", + * "issuedOn": "", + * "description": "", + * "totalInvoiceAmount": "", + * "operationType": null + * } + */ + readonly "application/json": components["schemas"]["Sucessonarequisio"] & unknown; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - content: { + }; + readonly "Obterdetalhesdaparametriza\u00E7\u00E3odoservi\u00E7odedistribui\u00E7\u00E3o(NF-e)": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** + * @example { + * "startFromNsu": "", + * "startFromDate": "", + * "environmentSEFAZ": null, + * "automaticManifesting": { + * "minutesToWaitAwarenessOperation": "" + * }, + * "webhookVersion": "", + * "companyId": "", + * "status": null, + * "createdOn": "", + * "modifiedOn": "" + * } + */ + readonly "application/json": components["schemas"]["Sucessonarequisio2"] & unknown; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - }; - /** @description Not Found */ - 404: { - headers: { + }; + readonly "Ativarbuscaautom\u00E1ticadedocumentoseEventosrelacionadosaNotaFiscalEletr\u00F4nica(NF-e)": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + /** + * @example { + * "startFromNsu": "999999", + * "startFromDate": "", + * "environmentSEFAZ": "Production", + * "automaticManifesting": { + * "minutesToWaitAwarenessOperation": "30" + * }, + * "webhookVersion": "2" + * } + */ + readonly "application/json": components["schemas"]["AtivarbuscaautomticadedocumentoseEventosrelacionadosaNotaFiscalEletrnicaNF-eRequest"] & unknown; + }; + }; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** + * @example { + * "startFromNsu": "", + * "startFromDate": "", + * "environmentSEFAZ": null, + * "automaticManifesting": { + * "minutesToWaitAwarenessOperation": "" + * }, + * "webhookVersion": "", + * "companyId": "", + * "status": null, + * "createdOn": "", + * "modifiedOn": "" + * } + */ + readonly "application/json": components["schemas"]["Sucessonarequisio2"] & unknown; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - content: { - readonly "application/json": string; + }; + readonly "Desativarbuscaautom\u00E1ticadedocumentoseEventosrelacionadosaNotaFiscalEletr\u00F4nica(NF-e)": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** + * @example { + * "startFromNsu": "", + * "startFromDate": "", + * "environmentSEFAZ": null, + * "automaticManifesting": { + * "minutesToWaitAwarenessOperation": "" + * }, + * "webhookVersion": "", + * "companyId": "", + * "status": null, + * "createdOn": "", + * "modifiedOn": "" + * } + */ + readonly "application/json": components["schemas"]["Sucessonarequisio2"] & unknown; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - }; - /** @description Internal Server Error */ - 500: { - headers: { + }; + readonly "ObterojsondeumaNF-epelachavedeacessode44d\u00EDgitos": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path: { + /** @description (Required) */ + readonly access_key: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "", + * "createdOn": "", + * "accessKey": "", + * "parentAccessKey": "", + * "company": { + * "id": "", + * "federalTaxNumber": "" + * }, + * "issuer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "buyer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "transportation": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "links": { + * "xml": "", + * "pdf": "" + * }, + * "xmlUrl": "", + * "federalTaxNumberSender": "", + * "nameSender": "", + * "type": null, + * "nsu": "", + * "nsuParent": "", + * "nfeNumber": "", + * "nfeSerialNumber": "", + * "issuedOn": "", + * "description": "", + * "totalInvoiceAmount": "", + * "operationType": null + * } + */ + readonly "application/json": components["schemas"]["Sucessonarequisio"] & unknown; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - content: { - readonly "application/json": string; + }; + readonly "Reprocessarowebhookpelachavedeacessode44d\u00EDgitosoupeloNSU": { + readonly parameters: { + readonly query?: never; + readonly header: { + readonly Accept: string; + }; + readonly path: { + /** @description (Required) */ + readonly access_key_or_nsu: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "", + * "createdOn": "", + * "accessKey": "", + * "parentAccessKey": "", + * "productInvoices": [ + * { + * "accessKey": "" + * }, + * { + * "accessKey": "" + * } + * ], + * "company": { + * "id": "", + * "federalTaxNumber": "" + * }, + * "issuer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "buyer": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "transportation": { + * "federalTaxNumber": "", + * "name": "" + * }, + * "type": null, + * "nsu": "", + * "nfeNumber": "", + * "issuedOn": "", + * "description": "", + * "xmlUrl": "", + * "federalTaxNumberSender": "", + * "nameSender": "", + * "totalInvoiceAmount": "", + * "links": { + * "xml": "", + * "pdf": "" + * } + * } + */ + readonly "application/json": components["schemas"]["Sucessonarequisio6"] & unknown; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; + /** @description Internal Server Error */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + /** @example */ + readonly "application/json": string; + }; + }; }; - }; }; - }; -}; +} diff --git a/src/generated/index.ts b/src/generated/index.ts index 9b320e8..9e1c647 100644 --- a/src/generated/index.ts +++ b/src/generated/index.ts @@ -5,7 +5,7 @@ * Types are namespaced by spec to avoid conflicts. * * @generated - * Last updated: 2026-02-15T17:59:25.794Z + * Last updated: 2026-04-25T23:27:49.313Z */ // ============================================================================ diff --git a/src/generated/nf-consumidor-v2.ts b/src/generated/nf-consumidor-v2.ts index db67918..4cabdce 100644 --- a/src/generated/nf-consumidor-v2.ts +++ b/src/generated/nf-consumidor-v2.ts @@ -4,5934 +4,6490 @@ * Do not edit this file directly. * * To regenerate: npm run generate - * Last generated: 2026-02-15T17:59:25.613Z + * Last generated: 2026-04-25T23:27:49.118Z * Generator: openapi-typescript */ -/** - * This file was auto-generated by openapi-typescript. - * Do not make direct changes to the file. - */ - - -export type paths = { - "/v2/companies": { - /** - * Consultar todas as Empresas da Conta - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados das empresas vinculadas a conta. - */ - get: operations["V2CompaniesGet"]; - /** - * Criar uma Empresa - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - */ - post: operations["V2CompaniesPost"]; - }; - "/v2/companies/{company_id}": { - /** - * Consultar uma Empresa pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de uma empresas pelo ID. - */ - get: operations["V2CompaniesByCompany_idGet"]; - /** - * Alterar uma Empresa pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados de uma empresas pelo ID. - */ - put: operations["V2CompaniesByCompany_idPut"]; - /** - * Excluir uma Empresa por ID - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir uma empresas pelo ID, cuidado pois esse processo é irreversível. - */ - delete: operations["V2CompaniesByCompany_idDelete"]; - }; - "/v2/companies/{company_id}/certificates": { - /** - * Consultar um Certificado por seu Status - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através d0 **status do certificado** (__status__). - */ - get: operations["V2CompaniesByCompany_idCertificatesGet"]; - /** - * Upload de um Certificado - * @description ### Informações adicionais - * - * Utilize esta requisição para fazer upload de um **Certificado da ICP-Brasil** do tipo __e-CNPJ A1__ ou __NFE A1__ em uma **Empresa** e vincula-lo para processamentos. - * - * O **Certificado da ICP-Brasil** funciona como uma identidade virtual, para empresas e pessoas, que permite a identificação segura e inequívoca do autor de uma mensagem ou transação feita em meios eletrônicos, como a web. - */ - post: operations["V2CompaniesByCompany_idCertificatesPost"]; - }; - "/v2/companies/{company_id}/certificates/{certificate_thumbprint}": { - /** - * Consultar um Certificado por sua impressão digital - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__). - */ - get: operations["V2CompaniesByCompany_idCertificatesByCertificate_thumbprintGet"]; - /** - * Excluir um Certificado por sua impressão digital - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir o **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__) e desvincula-lo da **Empresa**. - * - * **ATENÇÃO pois esta requisição é irreversível** - */ - delete: operations["V2CompaniesByCompany_idCertificatesByCertificate_thumbprintDelete"]; - }; - "/v2/companies/{company_id}/statetaxes": { - /** - * Listar as Inscrições Estaduais - * @description ### Informações adicionais - * - * Utilize esta requisição para listar as inscrições estaduais na empresa para processar __Documentos Fiscais__. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - get: operations["V2CompaniesByCompany_idStatetaxesGet"]; - /** - * Criar uma Inscrição Estadual - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novas inscrição estadual na empresa para processar __Documentos Fiscais__. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - post: operations["V2CompaniesByCompany_idStatetaxesPost"]; - }; - "/v2/companies/{company_id}/statetaxes/{state_tax_id}": { - /** - * Consultar uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de uma empresas pelo ID. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - get: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idGet"]; - /** - * Alterar uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados de uma Inscrição Estadual pelo ID. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - put: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idPut"]; - /** - * Excluir uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir uma Inscrição Estadual pelo ID, cuidado pois esse processo é irreversível. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - delete: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idDelete"]; - }; - "/v2/companies/{companyId}/consumerinvoices": { - /** - * Listar as Notas Fiscais Eletrônicas (NFCE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar uma lista de notas fiscais de consumidor eletrônica por empresa. - */ - get: { - parameters: { - query?: { - /** @description Ambiente das notas (Production/Test) */ - environment?: components["schemas"]["EnvironmentType"]; - /** @description Id da nota fiscal de início do contador (Default: Empty) */ - startingAfter?: string; - /** @description Id da nota fiscal final do contador (Default: Empty) */ - endingBefore?: string; - /** @description Buscar por parâmetros. ("Elasticsearch string query") Ex: (q=buyer.name:'EMPRESA LTDA') */ - q?: string; - /** @description Limite de resultados na página (Default: 10) */ - limit?: number; - }; - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - }; - }; - responses: { - /** @description Sucesso na consulta em lista */ - 200: { - content: { - readonly "application/json": components["schemas"]["ConsumerInvoicesResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - /** - * Emitir uma Nota Fiscal de Consumidor Eletrônica (NFCE) - * @description ### Informações adicionais - * Utilize esta requisição para enviar uma Nota Fiscal de Consumidor Eletrônica (NFCE) para fila de emissão. - * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo - * não garante a emissão do documento fiscal. - * Para obter um retorno ao final do processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos - * utilizar os WebHooks. - */ - post: { - parameters: { - path: { - /** @description Empresa ID */ - companyId: string; - }; - }; - /** @description Dados da nota fiscal de Consumidor a ser emitida */ - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["ConsumerInvoiceRequest"]; - readonly "text/json": components["schemas"]["ConsumerInvoiceRequest"]; - readonly "application/*+json": components["schemas"]["ConsumerInvoiceRequest"]; - }; - }; - responses: { - /** @description Sucesso ao enfileirar para emissão */ - 200: { - content: { - readonly "application/json": components["schemas"]["ConsumerInvoiceRequest"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/consumerinvoices/{invoiceId}": { - /** - * Consultar por ID uma Nota Fiscal de Consumidor Eletrônica (NFCE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar os dados de uma Nota Fiscal de Consumidor Eletrônica (NFCE) pelo ID. - */ - get: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal de Consumidor Eletrônica que deverá ser retornada */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta */ - 200: { - content: { - readonly "application/json": components["schemas"]["InvoiceResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ - 404: { - content: never; - }; - }; - }; - /** - * Cancelar uma Nota Fiscal de Consumidor Eletrônica (NFCE) - * @description ### Informações adicionais - * Utilize esta requisição para enviar uma Nota Fiscal de Consumidor Eletrônica (NFCE) para fila de cancelamento. - * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo - * não garante o cancelamento do documento fiscal. - * Para obter um retorno ao final do processo de cancelamento de uma Nota Fiscal Eletrônica (NFe), - * recomendamos utilizar os WebHooks. - */ - delete: { - parameters: { - query?: { - /** @description Motivo do cancelamento */ - reason?: string; - }; - path: { - /** @description Empresa ID */ - companyId: string; - /** @description ID da Nota Fiscal de Consumidor que deverá ser cancelada */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso ao enfileirar para cancelamento */ - 204: { - content: { - readonly "application/json": components["schemas"]["RequestCancellationResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/consumerinvoices/{invoiceId}/items": { - /** - * Consultar os produtos por ID uma Nota Fiscal de Consumidor Eletrônica (NFCE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar os dados de uma Nota Fiscal de Consumidor Eletrônica (NFCE) pelo ID. - */ - get: { - parameters: { - query?: { - /** @description Limite de resultados na página (Default: 10) */ - limit?: number; - /** @description Índice de início do contador (Default: 0) */ - startingAfter?: number; - }; - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal de Consumidor Eletrônica que deverá ser retornada */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta */ - 200: { - content: { - readonly "application/json": components["schemas"]["InvoiceItemsResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ - 404: { - content: never; - }; - }; - }; - }; - "/v2/companies/{companyId}/consumerinvoices/{invoiceId}/events": { - /** - * Consultar eventos por ID uma Nota Fiscal de Consumidor Eletrônica (NFCE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar os dados de uma Nota Fiscal de Consumidor Eletrônica (NFCE) pelo ID. - */ - get: { - parameters: { - query?: { - /** @description Limite de resultados na página (Default: 10) */ - limit?: number; - /** @description Índice de início do contador (Default: 0) */ - startingAfter?: number; - }; - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal de Consumidor Eletrônica que deverá ser retornada */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta */ - 200: { - content: { - readonly "application/json": components["schemas"]["InvoiceEventsResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ - 404: { - content: never; - }; - }; - }; - }; - "/v2/companies/{companyId}/consumerinvoices/{invoiceId}/pdf": { - /** - * Consultar PDF do Documento Auxiliar da Nota Fiscal de Consumidor Eletrônica (DANFE-NFC-e) - * @description ### Informações adicionais - * Utilize esta requisição para consultar a URL para o Documento Auxiliar Nota Fiscal de Consumidor Eletrônica (DANFE-NFC-e) - * em formato de arquivo PDF. - */ - get: { - parameters: { - query?: { - force?: boolean; - }; - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal de Consumidor que deverá ser retornado */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta do DANFE-NFC-e */ - 200: { - content: { - readonly "application/json": components["schemas"]["FileResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/consumerinvoices/{invoiceId}/xml": { - /** - * Consultar XML da Nota Fiscal de Consumidor Eletrônica (NFCE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar os dados de uma nota fiscal de Consumidor Eletrônica pelo ID. - */ - get: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal de Consumidor que deverá ser retornado */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta do XML da NFCE */ - 200: { - content: { - readonly "application/json": components["schemas"]["FileResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/consumerinvoices/{invoiceId}/xml/rejection": { - /** - * Consultar XML de rejeição da Nota Fiscal de Consumidor Eletrônica (NFCE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar o motivo da rejeição de uma nota fiscal de Consumidor Eletrônica pelo ID. - */ - get: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal de Consumidor que deverá ser retornado */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta do XML da NFCE */ - 200: { - content: { - readonly "application/json": components["schemas"]["FileResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/consumerinvoices/disablement": { - /** - * Inutilizar números de nota fiscal - * @description ### Informações adicionais - * Caso seja um único número, utilizar o Número inicial e o Número final com o mesmo valor - */ - post: { - parameters: { - path: { - /** @description ID da Empresa */ - companyId: string; - }; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["DisablementResource"]; - readonly "text/json": components["schemas"]["DisablementResource"]; - readonly "application/*+json": components["schemas"]["DisablementResource"]; - }; - }; - responses: { - /** @description Sucesso */ - 200: { - content: { - readonly "application/json": components["schemas"]["DisablementResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/webhooks/eventTypes": { - /** - * Listar os Tipos de Eventos gerados pela plataforma - * @description ### Informações adicionais - * - * Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados - * criando notificações para os webhooks ativos e configurados para receber os eventos. - * - * São identificados seguindo o padrão **Resource.EventAction**, - * onde **Resource**: nome da entidade que gerou o evento; - * **EventAction**: nome do evento e ação criados. - * - * Esse tipos podem ser utilizados como filtro ao criar ou alterar um webhook, - * sendo que o filtro determina quais notificações de eventos e ação serão enviadas - * para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook - * ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros. - */ - get: operations["V2WebhooksEventTypesGet"]; - }; - "/v2/webhooks": { - /** - * Listar os Webhooks - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar uma lista de **Webhooks** cadastrados na Conta Autenticada. - */ - get: operations["V2WebhooksGet"]; - /** - * Criar um Webhook - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novos **Webhooks** para receber as notificações de eventos ocorridos na plataforma. - * - * Na criação do **Webhook** a URL informada no cadastro deve ser responsiva, ou seja, deverá responder *(HTTP Status 200 OK)* a uma requisição *(HTTP POST)* que será feita para testar se a URL está operando como normalmente, caso contrario uma mensagem de erro será retornada. - * - * Um **Webhook** é semelhante a uma assinatura em um *sistema de publicação e assinatura* - * que permite ao assinante indicar *quando*, *como* e *onde* as notificações de eventos deve ser despachadas. - * Um **Webhook** é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos - * que podem ser acionados por eventos gerados através de ações executadas por esse Conta. - * Ou seja, a __Conta da *Empresa A*__ não verá os WebHooks disparados por uma ação executada pelo usuário __Conta da *Empresa B*__. - */ - post: operations["V2WebhooksPost"]; - /** - * Excluir Todos os Webhooks existentes - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir todos os **Webhooks** cadastrados para a Conta Autenticada. - */ - delete: operations["V2WebhooksDelete"]; - }; - "/v2/webhooks/{webhook_id}": { - /** - * Consultar um webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**. - */ - get: operations["V2WebhooksByWebhook_idGet"]; - /** - * Alterar um Webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados do **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. - */ - put: operations["V2WebhooksByWebhook_idPut"]; - /** - * Excluir um Webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir o **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. - * A exclusão do **Webhook** não exime o **Webhook** excluído de receber os notificações de eventos, já ocorridos na plataforma, que ainda estejam em processo de retentativa de envio dos gatilhos. - */ - delete: operations["V2WebhooksByWebhook_idDelete"]; - }; - "/v2/webhooks/{webhook_id}/pings": { - /** - * Criar notificação para Testar um webhook - * @description ### Informações adicionais - * - * Utilize esta requisição para criar uma notificação de teste (ping) em um **Webhook** já cadastrado. - * - * Esta ação irá criar um evento de notificação do tipo ping para o **Webhook** especificado, deste modo você poderá simular o recebimento de uma notificação de teste no **Webhook** cadastrado. - */ - put: operations["V2WebhooksByWebhook_idPingsPut"]; - }; -}; - -export type webhooks = Record; - -export type components = { - schemas: { - readonly ActivityResource: { - /** @description Detalhes do Evento */ - readonly data?: unknown; - /** @description Nome do Evento gerado */ - readonly type?: string | null; - /** - * Format: int32 - * @description Número sequencial do Evento - */ - readonly sequence?: number | null; - }; - /** @description Adições (adi) */ - readonly AdditionResource: { - /** - * Format: int64 - * @description Numero da adição (nAdicao) - */ - readonly code?: number | null; - /** @description Código do fabricante estrangeiro (cFabricante) */ - readonly manufacturer?: string | null; - /** - * Format: double - * @description Valor do desconto do item da DI – Adição (vDescDI) - */ - readonly amount?: number | null; - /** - * Format: int64 - * @description Número do ato concessório de Drawback (nDraw) - */ - readonly drawback?: number | null; - }; - readonly AdditionalInformationResource: { - /** @description Informações Adicionais de Interesse do Fisco (infAdFisco) */ - readonly fisco?: string | null; - /** @description Informações Complementares de interesse do Contribuinte (infCpl) */ - readonly taxpayer?: string | null; - /** @description Informações Complementares de interesse do Contribuinte (infCpl) */ - readonly xmlAuthorized?: (readonly number[]) | null; - readonly effort?: string | null; - readonly order?: string | null; - readonly contract?: string | null; - /** @description Documentos Fiscais Referenciados (refECF) */ - readonly taxDocumentsReference?: (readonly components["schemas"]["TaxDocumentsReferenceResource"][]) | null; - /** @description Observações fiscais (obsCont) */ - readonly taxpayerComments?: (readonly components["schemas"]["TaxpayerCommentsResource"][]) | null; - /** @description Processos referenciados (procRef) */ - readonly referencedProcess?: (readonly components["schemas"]["ReferencedProcessResource"][]) | null; - }; - /** @description Dados do Endereço */ - readonly AddressResource: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state?: string | null; - readonly city?: components["schemas"]["CityResource"]; - /** @description Bairro do Endereço */ - readonly district?: string | null; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string | null; - /** @description Logradouro do Endereço */ - readonly street?: string | null; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number?: string | null; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode?: string | null; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country?: string | null; - /** @description Telefone */ - readonly phone?: string | null; - }; - readonly AuthorizationResource: { - /** Format: date-time */ - readonly receiptOn?: string | null; - readonly accessKey?: string | null; - readonly message?: string | null; - }; - readonly BillResource: { - /** @description Número da Fatura (nFat) */ - readonly number?: string | null; - /** - * Format: double - * @description Valor Original da Fatura (vOrig) - */ - readonly originalAmount?: number | null; - /** - * Format: double - * @description Valor do desconto (vDesc) - */ - readonly discountAmount?: number | null; - /** - * Format: double - * @description Valor Líquido da Fatura (vLiq) - */ - readonly netAmount?: number | null; - }; - readonly BillingResource: { - readonly bill?: components["schemas"]["BillResource"]; - /** @description Grupo Duplicata (dup) */ - readonly duplicates?: (readonly components["schemas"]["DuplicateResource"][]) | null; - }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo de endereço do Destinatário da NF-e - */ - readonly BuyerResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Nome ou Razão Social (xNome) */ - readonly name?: string | null; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number | null; - /** @description Email */ - readonly email?: string | null; - readonly address?: components["schemas"]["AddressResource"]; - readonly type?: components["schemas"]["PersonType"]; - readonly stateTaxNumberIndicator?: components["schemas"]["ReceiverStateTaxIndicator"]; - /** @description Nome fantasia */ - readonly tradeName?: string | null; - readonly taxRegime?: components["schemas"]["TaxRegime"]; - /** @description Inscrição Estadual (IE) */ - readonly stateTaxNumber?: string | null; - }; - readonly CIDEResource: { - /** - * Format: double - * @description BC da CIDE (qBCProd) - */ - readonly bc?: number | null; - /** - * Format: double - * @description Valor da alíquota da CIDE (vAliqProd) - */ - readonly rate?: number | null; - /** - * Format: double - * @description Valor da CIDE (vCIDE) - */ - readonly cideAmount?: number | null; - }; - readonly CardResource: { - /** @description CNPJ da Credenciadora de cartão de crédito e/ou débito (CNPJ) */ - readonly federalTaxNumber?: string | null; - readonly flag?: components["schemas"]["FlagCard"]; - /** @description Número de autorização da operação cartão de crédito e/ou débito (cAut) */ - readonly authorization?: string | null; - readonly integrationPaymentType?: components["schemas"]["IntegrationPaymentType"]; - /** @description CNPJ do beneficiário do pagamento (CNPJReceb) */ - readonly federalTaxNumberRecipient?: string | null; - /** @description Identificador do terminal de pagamento (idTermPag) */ - readonly idPaymentTerminal?: string | null; - }; - readonly CityResource: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code?: string | null; - /** @description Nome do Município */ - readonly name?: string | null; - }; - /** - * @description Grupo do COFINS - * - * ID: S01 - * Pai: M01 - * - * Obs: Informar apenas um dos grupos S02, S03, S04 ou S04 - * com base valor atribuído ao campo S06 – CST do COFINS - */ - readonly CofinsTaxResource: { - /** @description Código de Situação Tributária da COFINS */ - readonly cst?: string | null; - /** - * Format: double - * @description Valor da Base de Cálculo da COFINS (vBC) - */ - readonly baseTax?: number | null; - /** - * Format: double - * @description Alíquota da COFINS (em percentual) (pCOFINS) - */ - readonly rate?: number | null; - /** - * Format: double - * @description Valor da COFINS (vCOFINS) - */ - readonly amount?: number | null; - /** - * Format: double - * @description Quantidade Vendida (qBCProd) - */ - readonly baseTaxProductQuantity?: number | null; - /** - * Format: double - * @description Alíquota da COFINS (em reais) (vAliqProd) - */ - readonly productRate?: number | null; - }; - /** @description Nota Fiscal de Consumidor Eletrônica (NFCe) */ - readonly ConsumerInvoiceRequest: { - /** @description Identificador único */ - readonly id?: string | null; - /** @description Grupo de Formas de Pagamento (pag) */ - readonly payment?: (readonly components["schemas"]["PaymentResource"][]) | null; - /** - * Format: int32 - * @description Série do Documento Fiscal (serie) - */ - readonly serie?: number | null; - /** - * Format: int64 - * @description Número do Documento Fiscal (nNF) - */ - readonly number?: number | null; - /** - * Format: date-time - * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) - * - * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. - * - */ - readonly operationOn?: string | null; - /** @description Descrição da Natureza da Operação (natOp) */ - readonly operationNature?: string | null; - readonly operationType?: components["schemas"]["OperationType"]; - readonly destination?: components["schemas"]["Destination"]; - readonly printType?: components["schemas"]["PrintType"]; - readonly purposeType?: components["schemas"]["PurposeType"]; - readonly consumerType?: components["schemas"]["ConsumerType"]; - readonly presenceType?: components["schemas"]["ConsumerPresenceType"]; - /** - * Format: date-time - * @description Data e Hora da entrada em contingência (dhCont) - * - * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD - * - */ - readonly contingencyOn?: string | null; - /** @description Justificativa da entrada em contingência (xJust) */ - readonly contingencyJustification?: string | null; - readonly buyer?: components["schemas"]["BuyerResource"]; - readonly transport?: components["schemas"]["TransportInformationResource"]; - readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; - /** @description Detalhamento de Produtos e Serviços (det) */ - readonly items: readonly components["schemas"]["InvoiceItemResource"][]; - readonly totals?: components["schemas"]["TotalResource"]; - readonly billing?: components["schemas"]["BillingResource"]; - readonly issuer?: components["schemas"]["IssuerFromRequestResource"]; - readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; - }; - /** @description Notas Fiscais de Consumidor Eletrônicas (NFC-e) */ - readonly ConsumerInvoicesResource: { - /** @description Lista de Notas Fiscais de Consumidor Eletrônicas (NFC-e) */ - readonly consumerInvoices?: (readonly components["schemas"]["InvoiceWithoutEventsResource"][]) | null; - /** @description Identificador de possibilidade de mais itens. */ - readonly hasMore?: boolean; - }; - /** - * @description Indicador de Presença (indPres ) - * @enum {string} - */ - readonly ConsumerPresenceType: "None" | "Presence" | "Internet" | "Telephone" | "Delivery" | "OthersNonPresenceOperation"; - /** - * @description Indica operação com Consumidor final (indFinal) - * @enum {string} - */ - readonly ConsumerType: "FinalConsumer" | "Normal"; - readonly ContingencyDetails: { - readonly authorizer?: components["schemas"]["StateTaxProcessingAuthorizer"]; - /** - * Format: date-time - * @description Data e hora do início da contingência - */ - readonly startedOn?: string; - /** @description Justificativa da entrada em contingência */ - readonly reason?: string | null; - }; - /** @description Identificação do Local de entrega (entrega) */ - readonly DeliveryInformationResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Nome ou Razão Social (xNome) */ - readonly name?: string | null; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number | null; - /** @description Email */ - readonly email?: string | null; - readonly address?: components["schemas"]["AddressResource"]; - readonly type?: components["schemas"]["PersonType"]; - /** @description Inscrição Estadual (IE) */ - readonly stateTaxNumber?: string | null; - }; - /** - * @description Identificador de local de destino da operação (idDest) - * @enum {string} - */ - readonly Destination: "None" | "Internal_Operation" | "Interstate_Operation" | "International_Operation"; - /** @description Dados para inutilizar números de nota fiscal */ - readonly DisablementResource: { - readonly environment?: components["schemas"]["EnvironmentType"]; - /** - * Format: int32 - * @description Série - */ - readonly serie?: number; - readonly state?: components["schemas"]["StateCode"]; - /** - * Format: int32 - * @description Número inicial - */ - readonly beginNumber?: number; - /** - * Format: int32 - * @description Número final (usar o mesmo número inicial se for apenas um número) - */ - readonly lastNumber?: number; - /** @description Motivo da inutilização */ - readonly reason?: string | null; - }; - readonly DocumentElectronicInvoiceResource: { - /** @description Chave de Acesso (refNFe) */ - readonly accessKey?: string | null; - }; - readonly DocumentInvoiceReferenceResource: { - /** - * Format: double - * @description Código da UF (cUF) - */ - readonly state?: number | null; - /** @description Ano / Mês (AAMM) */ - readonly yearMonth?: string | null; - /** @description CNPJ (CNPJ) */ - readonly federalTaxNumber?: string | null; - /** @description Modelo (mod) */ - readonly model?: string | null; - /** @description Série (serie) */ - readonly series?: string | null; - /** @description Número (nNF) */ - readonly number?: string | null; - }; - /** - * @description Indicador de intermediador/marketplace (indIntermed) - * @enum {string} - */ - readonly DuductionIndicator: "NotDeduct" | "Deduce"; - readonly DuplicateResource: { - /** @description Número da Duplicata (nDup) */ - readonly number?: string | null; - /** - * Format: date-time - * @description Data de vencimento (dVenc) - */ - readonly expirationOn?: string | null; - /** - * Format: double - * @description Valor da duplicata (vDup) - */ - readonly amount?: number | null; - }; - readonly EconomicActivityResource: { - readonly type?: components["schemas"]["EconomicActivityType"]; - /** - * Format: int32 - * @description Código da Atividade da Empresa - */ - readonly code?: number | null; - }; - /** @enum {string} */ - readonly EconomicActivityType: "Main" | "Secondary"; - /** @enum {string} */ - readonly EnvironmentType: "None" | "Production" | "Test"; - readonly ErrorResource: { - /** Format: int32 */ - readonly code?: number | null; - readonly message?: string | null; - }; - readonly ErrorsResource: { - readonly errors?: (readonly components["schemas"]["ErrorResource"][]) | null; - }; - /** - * @description Campo será preenchido quando o campo anterior estiver - * preenchido.Informar o motivo da desoneração: - * @enum {string} - */ - readonly ExemptReason: "Agriculture" | "Others" | "DevelopmentEntities"; - readonly ExportDetailResource: { - /** @description Número do ato concessório de Drawback (nDraw) */ - readonly drawback?: string | null; - readonly hintInformation?: components["schemas"]["ExportHintResource"]; - }; - readonly ExportHintResource: { - /** @description Número do Registro de Exportação (nRE) */ - readonly registryId?: string | null; - /** @description Chave de Acesso da NF-e recebida para exportação (chNFe) */ - readonly accessKey?: string | null; - /** - * Format: double - * @description Quantidade do item realmente exportado (qExport) - */ - readonly quantity?: number | null; - }; - readonly ExportResource: { - readonly state?: components["schemas"]["StateCode"]; - /** @description Descrição do Local de Embarque ou de transposição de fronteira (xLocExporta) */ - readonly office?: string | null; - /** @description Informações Complementares de interesse do Contribuinte (xLocDespacho) */ - readonly local?: string | null; - }; - /** @description Arquivo */ - readonly FileResource: { - /** @description Endereço Absoluto URI para o arquivo */ - readonly uri?: string | null; - }; - /** @enum {string} */ - readonly FlagCard: "None" | "Visa" | "Mastercard" | "AmericanExpress" | "Sorocred" | "DinersClub" | "Elo" | "Hipercard" | "Aura" | "Cabal" | "Alelo" | "BanesCard" | "CalCard" | "Credz" | "Discover" | "GoodCard" | "GreenCard" | "Hiper" | "JCB" | "Mais" | "MaxVan" | "Policard" | "RedeCompras" | "Sodexo" | "ValeCard" | "Verocheque" | "VR" | "Ticket" | "Other"; - readonly FuelOriginResource: { - /** - * Format: int32 - * @description Indicador de importação (indImport) - */ - readonly indImport?: number | null; - /** - * Format: int32 - * @description Código da UF (cUFOrig) - */ - readonly cUFOrig?: number | null; - /** - * Format: double - * @description Percentual originário para a UF (pOrig) - */ - readonly pOrig?: number | null; - }; - readonly FuelResource: { - /** @description Código de produto da ANP (cProdANP) */ - readonly codeANP?: string | null; - /** - * Format: double - * @description Percentual de Gás Natural para o produto GLP (cProdANP=210203001) (pMixGN) - */ - readonly percentageNG?: number | null; - /** @description Descrição do produto conforme ANP (descANP) */ - readonly descriptionANP?: string | null; - /** - * Format: double - * @description Percentual do GLP derivado do petróleo no produto GLP (cProdANP=210203001) (pGLP) - */ - readonly percentageGLP?: number | null; - /** - * Format: double - * @description Percentual de Gás Natural Nacional – GLGNn para o produto GLP (cProdANP= 210203001) (pGNn) - */ - readonly percentageNGn?: number | null; - /** - * Format: double - * @description Percentual de Gás Natural Importado – GLGNi para o produto GLP (cProdANP= 210203001) (pGNi) - */ - readonly percentageGNi?: number | null; - /** - * Format: double - * @description Valor de partida (cProdANP=210203001) (vPart) - */ - readonly startingAmount?: number | null; - /** @description Código de autorização / registro do CODIF (CODIF) */ - readonly codif?: string | null; - /** - * Format: double - * @description Quantidade de combustível faturada à temperatura ambiente (qTemp) - */ - readonly amountTemp?: number | null; - /** @description Sigla da UF de consumo (UFCons) */ - readonly stateBuyer?: string | null; - readonly cide?: components["schemas"]["CIDEResource"]; - readonly pump?: components["schemas"]["PumpResource"]; - readonly fuelOrigin?: components["schemas"]["FuelOriginResource"]; - }; - /** - * @description Manual Contribuinte v_5.00 - * Grupo de Valores Totais referentes ao ICMS - */ - readonly ICMSTotalResource: { - /** - * Format: double - * @description Base de Cálculo do ICMS (vBC) - */ - readonly baseTax?: number | null; - /** - * Format: double - * @description Valor Total do ICMS (vICMS) - */ - readonly icmsAmount?: number | null; - /** - * Format: double - * @description Valor ICMS Total desonerado (vICMSDeson) - */ - readonly icmsExemptAmount?: number | null; - /** - * Format: double - * @description Base de Cálculo do ICMS Substituição Tributária (vBCST) - */ - readonly stCalculationBasisAmount?: number | null; - /** - * Format: double - * @description Valor Total do ICMS ST (vST) - */ - readonly stAmount?: number | null; - /** - * Format: double - * @description Valor Total dos produtos e serviços (vProd) - */ - readonly productAmount?: number | null; - /** - * Format: double - * @description Valor Total do Frete (vFrete) - */ - readonly freightAmount?: number | null; - /** - * Format: double - * @description Valor Total do Seguro (vSeg) - */ - readonly insuranceAmount?: number | null; - /** - * Format: double - * @description Valor Total do Desconto (vDesc) - */ - readonly discountAmount?: number | null; - /** - * Format: double - * @description Valor Total do Imposto de Importação (vII) - */ - readonly iiAmount?: number | null; - /** - * Format: double - * @description Valor Total do IPI (vIPI) - */ - readonly ipiAmount?: number | null; - /** - * Format: double - * @description Valor do PIS (vPIS) - */ - readonly pisAmount?: number | null; - /** - * Format: double - * @description Valor do COFINS (vCOFINS) - */ - readonly cofinsAmount?: number | null; - /** - * Format: double - * @description Outras Despesas acessórias (vOutro) - */ - readonly othersAmount?: number | null; - /** - * Format: double - * @description Valor Total da NF-e (vNF) - */ - readonly invoiceAmount?: number | null; - /** - * Format: double - * @description Valor Total ICMS FCP UF Destino (vFCPUFDest) - */ - readonly fcpufDestinationAmount?: number | null; - /** - * Format: double - * @description Valor Total ICMS Interestadual UF Destino (vICMSUFDest) - */ - readonly icmsufDestinationAmount?: number | null; - /** - * Format: double - * @description Valor Total ICMS Interestadual UF Remetente (vICMSUFRemet) - */ - readonly icmsufSenderAmount?: number | null; - /** - * Format: double - * @description Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib) - */ - readonly federalTaxesAmount?: number | null; - /** - * Format: double - * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) - */ - readonly fcpAmount?: number | null; - /** - * Format: double - * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST) - */ - readonly fcpstAmount?: number | null; - /** - * Format: double - * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) - */ - readonly fcpstRetAmount?: number | null; - /** - * Format: double - * @description Valor total do IPI devolvido (vIPIDevol) - */ - readonly ipiDevolAmount?: number | null; - /** - * Format: double - * @description Valor total da quantidade tributada do ICMS monofásico próprio (qBCMono) - */ - readonly qBCMono?: number | null; - /** - * Format: double - * @description Valor total do ICMS monofásico próprio (vICMSMono) - */ - readonly vICMSMono?: number | null; - /** - * Format: double - * @description Valor total da quantidade tributada do ICMS monofásico sujeito a retenção(qBCMonoReten) - */ - readonly qBCMonoReten?: number | null; - /** - * Format: double - * @description Valor total do ICMS monofásico sujeito a retenção (vICMSMonoReten) - */ - readonly vICMSMonoReten?: number | null; - /** - * Format: double - * @description Valor total da quantidade tributada do ICMS monofásico retido anteriormente(qBCMonoRet) - */ - readonly qBCMonoRet?: number | null; - /** - * Format: double - * @description Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) - */ - readonly vICMSMonoRet?: number | null; - }; - /** @description Grupo de Tributação do ICMS de Destino da UF */ - readonly ICMSUFDestinationTaxResource: { - /** - * Format: double - * @description Valor da Base de Cálculo do ICMS na UF de destino (vBCUFDest) - */ - readonly vBCUFDest?: number | null; - /** - * Format: double - * @description Percentual adicional inserido na alíquota interna da UF de destino, relativo ao Fundo de Combate à Pobreza (FCP) naquela UF (pFCPUFDest) - */ - readonly pFCPUFDest?: number | null; - /** - * Format: double - * @description Alíquota adotada nas operações internas na UF de destino para o produto / mercadoria (pICMSUFDest) - */ - readonly pICMSUFDest?: number | null; - /** - * Format: double - * @description Alíquota interestadual das UF envolvidas (pICMSInter) - */ - readonly pICMSInter?: number | null; - /** - * Format: double - * @description Percentual de ICMS Interestadual para a UF de destino (pICMSInterPart) - */ - readonly pICMSInterPart?: number | null; - /** - * Format: double - * @description Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de destino (vFCPUFDest - */ - readonly vFCPUFDest?: number | null; - /** - * Format: double - * @description Valor do ICMS Interestadual para a UF de destino (vICMSUFDest) - */ - readonly vICMSUFDest?: number | null; - /** - * Format: double - * @description Valor do ICMS Interestadual para a UF do remetente (vICMSUFRemet) - */ - readonly vICMSUFRemet?: number | null; - /** - * Format: double - * @description Valor da BC FCP na UF de destino (vBCFCPUFDest) - */ - readonly vBCFCPUFDest?: number | null; - }; - /** - * @description Grupo do Imposto de Importação - * - * Id: P01 - * Pai: O01 - */ - readonly IITaxResource: { - /** @description Valor BC do Imposto de Importação (vBC) */ - readonly baseTax?: string | null; - /** @description Valor despesas aduaneiras (vDespAdu) */ - readonly customsExpenditureAmount?: string | null; - /** - * Format: double - * @description Valor Imposto de Importação (vII) - */ - readonly amount?: number | null; - /** - * Format: double - * @description Valor Imposto sobre Operações Financeiras (vIOF) - */ - readonly iofAmount?: number | null; - /** - * Format: double - * @description Valor dos encargos cambiais - */ - readonly vEnqCamb?: number | null; - }; - /** - * @description - * Grupo do IPI - * - * Informar apenas quando o item for sujeito ao IPI - * - * ID: O01 - * - * Pai: M01 - */ - readonly IPITaxResource: { - /** @description Código da situação tributária do IPI (CST) */ - readonly cst?: string | null; - /** @description Código de Enquadramento Legal do IPI (cEnq) */ - readonly classificationCode?: string | null; - /** - * @description clEnq - * Classe de enquadramento do IPI para Cigarros e Bebidas (clEnq) - */ - readonly classification?: string | null; - /** @description CNPJ do produtor da mercadoria, quando diferente do emitente. Somente para os casos de exportação direta ou indireta (CNPJProd) */ - readonly producerCNPJ?: string | null; - /** @description Código do selo de controle IPI (cSelo) */ - readonly stampCode?: string | null; - /** - * Format: double - * @description Quantidade de selo de controle (qSelo) - */ - readonly stampQuantity?: number | null; - /** - * Format: double - * @description Valor da BC do IPI (vBC) - */ - readonly base?: number | null; - /** - * Format: double - * @description Alíquota do IPI (pIPI) - */ - readonly rate?: number | null; - /** - * Format: double - * @description Quantidade total na unidade padrão para tributação (somente para os produtos tributados por unidade) (qUnid) - */ - readonly unitQuantity?: number | null; - /** - * Format: double - * @description Valor por Unidade Tributável (vUnid) - */ - readonly unitAmount?: number | null; - /** - * Format: double - * @description Valor IPI (vIPI) - */ - readonly amount?: number | null; - }; - readonly ISSQNTotalResource: { - /** - * Format: double - * @description Valor Total Serv.Não Tributados p/ ICMS (vServ) - */ - readonly totalServiceNotTaxedICMS?: number | null; - /** - * Format: double - * @description Base de Cálculo do ISS (vBC) - */ - readonly baseRateISS?: number | null; - /** - * Format: double - * @description Valor Total do ISS (vISS) - */ - readonly totalISS?: number | null; - /** - * Format: double - * @description Valor do PIS sobre Serviços (vPIS) - */ - readonly valueServicePIS?: number | null; - /** - * Format: double - * @description Valor da COFINS sobre Serviços (vCOFINS) - */ - readonly valueServiceCOFINS?: number | null; - /** - * Format: date-time - * @description Data Prestação Serviço (dCompet) - */ - readonly provisionService?: string | null; - /** - * Format: double - * @description Valor Dedução para Redução da BC (vDeducao) - */ - readonly deductionReductionBC?: number | null; - /** - * Format: double - * @description Valor Outras Retenções (vOutro) - */ - readonly valueOtherRetention?: number | null; - /** - * Format: double - * @description Valor Desconto Incondicionado (vDescIncond) - */ - readonly discountUnconditional?: number | null; - /** - * Format: double - * @description Valor Desconto Condicionado (vDescCond) - */ - readonly discountConditioning?: number | null; - /** - * Format: double - * @description Valor Total Retenção ISS (vISSRet) - */ - readonly totalRetentionISS?: number | null; - /** - * Format: double - * @description Código Regime Tributação (cRegTrib) - */ - readonly codeTaxRegime?: number | null; - }; - /** - * @description Grupo do ICMS da Operação própria e ST - * - * ID: N01 - * PAI: M01 - * - * Obs: Informar apenas um dos grupos N02, N03, N04, N05, N06, N07, N08, N09, N10, - * N10a, N10b, N10c, N10d, N10e, N10f, N10g ou N10h com base no conteúdo informado na TAG Tributação do ICMS. (v2.0) - */ - readonly IcmsTaxResource: { - /** @description Origem da mercadoria (orig) */ - readonly origin?: string | null; - /** @description Tributação do ICMS (CST) */ - readonly cst?: string | null; - /** - * @description 101- Tributada pelo Simples Nacional com permissão de crédito. (v.2.0) (CSOSN) - * Código de Situação da Operação – Simples Nacional - */ - readonly csosn?: string | null; - /** - * @description Modalidade de determinação da BC do ICMS (modBC) - * - * Margem Valor Agregado (%) = 0 - * Pauta (valor) = 1 - * Preço Tabelado Máximo (valor) = 2 - * Valor da Operação = 3 - * - */ - readonly baseTaxModality?: string | null; - /** - * Format: double - * @description Valor da BC do ICMS (vBC) - */ - readonly baseTax?: number | null; - /** @description Modalidade de determinação da BC do ICMS ST (modBCST) */ - readonly baseTaxSTModality?: string | null; - /** - * @description pRedBCST - * Percentual da Redução de BC do ICMS ST (pRedBCST) - */ - readonly baseTaxSTReduction?: string | null; - /** - * Format: double - * @description Valor da BC do ICMS ST (vBCST) - */ - readonly baseTaxST?: number | null; - /** - * Format: double - * @description Percentual da Redução de BC (pRedBC) - */ - readonly baseTaxReduction?: number | null; - /** - * Format: double - * @description Alíquota do imposto do ICMS ST (pICMSST) - */ - readonly stRate?: number | null; - /** - * Format: double - * @description Valor do ICMS ST (vICMSST) - */ - readonly stAmount?: number | null; - /** - * Format: double - * @description pMVAST - * Percentual da margem de valor Adicionado do ICMS ST (pMVAST) - */ - readonly stMarginAmount?: number | null; - /** - * Format: double - * @description pICMS - * Alíquota do imposto (pICMS) - */ - readonly rate?: number | null; - /** - * Format: double - * @description Valor do ICMS (vICMS) - * O valor do ICMS desonerado será informado apenas nas operações: - * a) com produtos beneficiados com a desoneração condicional do ICMS. - * b) destinadas à SUFRAMA, informando-se o valor que seria devido se não houvesse isenção. - * c) de venda a órgãos da administração pública direta e suas fundações e - * autarquias com isenção do ICMS. (NT 2011/004) - */ - readonly amount?: number | null; - /** - * Format: double - * @description Percentual da Redução de BC (pICMS) - */ - readonly percentual?: number | null; - /** - * Format: double - * @description Alíquota aplicável de cálculo do crédito (Simples Nacional). (pCredSN) - */ - readonly snCreditRate?: number | null; - /** - * Format: double - * @description Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 Simples Nacional (vCredICMSSN) - */ - readonly snCreditAmount?: number | null; - /** @description Percentual da margem de valor Adicionado do ICMS ST (pMVAST) */ - readonly stMarginAddedAmount?: string | null; - /** @description Valor do ICMS ST retido (vICMSSTRet) */ - readonly stRetentionAmount?: string | null; - /** @description Valor da BC do ICMS ST retido (vBCSTRet) */ - readonly baseSTRetentionAmount?: string | null; - /** - * @description Percentual da BC operação própria (pBCOp) - * Percentual para determinação do valor da Base de Cálculo da operação própria. (v2.0) - */ - readonly baseTaxOperationPercentual?: string | null; - /** - * @description UF para qual é devido o ICMS ST (UFST) - * Sigla da UF para qual é devido o ICMS ST da operação. (v2.0) - */ - readonly ufst?: string | null; - /** @description Motivo Desoneração ICMS */ - readonly amountSTReason?: string | null; - /** @description Valor da BC do ICMS ST retido (vBCSTRet) */ - readonly baseSNRetentionAmount?: string | null; - /** @description Valor do ICMS ST retido (vICMSSTRet) */ - readonly snRetentionAmount?: string | null; - /** @description Valor do ICMS da Operação (vICMSOp) */ - readonly amountOperation?: string | null; - /** @description Percentual do Diferimento (pDif) */ - readonly percentualDeferment?: string | null; - /** @description Valor do ICMS Diferido (vICMSDif) */ - readonly baseDeferred?: string | null; - /** - * Format: double - * @description Valor ICMS Desonerado - */ - readonly exemptAmount?: number | null; - readonly exemptReason?: components["schemas"]["ExemptReason"]; - /** - * Format: double - * @description Valor ICMS Desonerado - */ - readonly exemptAmountST?: number | null; - readonly exemptReasonST?: components["schemas"]["ExemptReason"]; - /** - * Format: double - * @description Percentual do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (pFCP) - */ - readonly fcpRate?: number | null; - /** - * Format: double - * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) - */ - readonly fcpAmount?: number | null; - /** - * Format: double - * @description Percentual do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (pFCPST) - */ - readonly fcpstRate?: number | null; - /** - * Format: double - * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST) - */ - readonly fcpstAmount?: number | null; - /** - * Format: double - * @description Percentual do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (pFCPSTRet) - */ - readonly fcpstRetRate?: number | null; - /** - * Format: double - * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) - */ - readonly fcpstRetAmount?: number | null; - /** - * Format: double - * @description Informar o valor da Base de Cálculo do FCP (vBCFCPST) - */ - readonly baseTaxFCPSTAmount?: number | null; - /** - * Format: double - * @description Valor do ICMS próprio do Substituto (tag: vICMSSubstituto) - */ - readonly substituteAmount?: number | null; - /** - * Format: double - * @description N26a - Alíquota suportada pelo Consumidor Final (pST) - * Deve ser informada a alíquota do cálculo do ICMS-ST, já incluso o FCP caso incida sobre a mercadoria - */ - readonly stFinalConsumerRate?: number | null; - /** - * Format: double - * @description N34 - Percentual de redução da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (pRedBCEfet) - */ - readonly effectiveBaseTaxReductionRate?: number | null; - /** - * Format: double - * @description N35 - Valor da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (vBCEfet) - */ - readonly effectiveBaseTaxAmount?: number | null; - /** - * Format: double - * @description N36 - Alíquota do ICMS efetiva, caso estivesse submetida ao regime comum de tributação (pICMSEFET) - */ - readonly effectiveRate?: number | null; - /** - * Format: double - * @description N37 - Valor do ICMS efetivo, caso estivesse submetida ao regime comum de tributação (vICMSEFET) - */ - readonly effectiveAmount?: number | null; - readonly deductionIndicator?: components["schemas"]["DuductionIndicator"]; - }; - /** @description Declaração Importação (DI) */ - readonly ImportDeclarationResource: { - /** @description Número do Documento de Importação da DI/DSI/DA (nDI) */ - readonly code?: string | null; - /** - * Format: date-time - * @description Data de Registro da DI/DSI/DA (dDI) - */ - readonly registeredOn?: string | null; - /** @description Local de desembaraço (xLocDesemb) */ - readonly customsClearanceName?: string | null; - readonly customsClearanceState?: components["schemas"]["StateCode"]; - /** - * Format: date-time - * @description Data do Desembaraço Aduaneiro (dDesemb) - */ - readonly customsClearancedOn?: string | null; - /** @description Adições (adi) */ - readonly additions?: (readonly components["schemas"]["AdditionResource"][]) | null; - /** @description Código do exportador (cExportador) */ - readonly exporter?: string | null; - readonly internationalTransport?: components["schemas"]["InternationalTransportType"]; - readonly intermediation?: components["schemas"]["IntermediationType"]; - /** @description CNPJ/CPF do adquirente ou do encomendante (CNPJ ou CPF) */ - readonly acquirerFederalTaxNumber?: string | null; - /** @description Sigla da UF do adquirente ou do encomendante (UFTerceiro) */ - readonly stateThird?: string | null; - }; - /** - * @description 1 - Pagamento integrado com o sistema de automação da empresa(Ex.: equipamento TEF, Comércio Eletrônico) - * 2 - Pagamento não integrado com o sistema de automação da empresa(Ex.: equipamento POS); - * @enum {string} - */ - readonly IntegrationPaymentType: "Integrated" | "NotIntegrated"; - /** @description Grupo de Informações do Intermediador da Transação (infIntermed) */ - readonly IntermediateResource: { - /** - * Format: int64 - * @description CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios. (CNPJ) - */ - readonly federalTaxNumber?: number | null; - /** @description Identificador cadastrado no intermediador (idCadIntTran) */ - readonly identifier?: string | null; - }; - /** - * @description Tipo de Intermediação - * @enum {string} - */ - readonly IntermediationType: "None" | "ByOwn" | "ImportOnBehalf" | "ByOrder"; - /** - * @description Tipo Transporte Internacional - * @enum {string} - */ - readonly InternationalTransportType: "None" | "Maritime" | "River" | "Lake" | "Airline" | "Postal" | "Railway" | "Highway" | "Network" | "Own" | "Ficta" | "Courier" | "Handcarry"; - readonly InvoiceEventsResource: { - /** @description Lista de Eventos ocorridos na Nota Fiscal */ - readonly events?: (readonly components["schemas"]["ActivityResource"][]) | null; - /** @description Identificador de possibilidade de mais itens. */ - readonly hasMore?: boolean | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificador da Empresa */ - readonly companyId?: string | null; - }; - readonly InvoiceEventsResourceBase: { - /** @description Lista de Eventos ocorridos na Nota Fiscal */ - readonly events?: (readonly components["schemas"]["ActivityResource"][]) | null; - /** @description Identificador de possibilidade de mais itens. */ - readonly hasMore?: boolean | null; - }; - /** - * @description Manual Contribuinte v_5.00 - * Grupo do detalhamento de Produtos e Serviços da NF-e - */ - readonly InvoiceItemResource: { - /** @description Código do produto ou serviço (cProd) */ - readonly code?: string | null; - /** - * @description GTIN (Global Trade Item Number) do produto, - * antigo código EAN ou código de barras (cEAN) - */ - readonly codeGTIN?: string | null; - /** @description Descrição do produto ou serviço (xProd) */ - readonly description?: string | null; - /** @description Código NCM com 8 dígitos ou 2 dígitos (gênero) (NCM) */ - readonly ncm?: string | null; - /** @description Nomenclatura de Valor aduaneiro e Estatístico (NVE) */ - readonly nve?: (readonly string[]) | null; - /** @description Código Exceção da Tabela de IPI */ - readonly extipi?: string | null; - /** - * Format: int64 - * @description Código Fiscal de Operações e Prestações (CFOP) - */ - readonly cfop?: number | null; - /** @description Unidade Comercial (uCom) */ - readonly unit?: string | null; - /** - * Format: double - * @description Quantidade Comercial (qCom) - */ - readonly quantity?: number | null; - /** - * Format: double - * @description Valor Unitário de Comercialização (vUnCom) - */ - readonly unitAmount?: number | null; - /** - * Format: double - * @description Valor Total Bruto dos Produtos ou Serviços (vProd) - */ - readonly totalAmount?: number | null; - /** - * @description GTIN (Global Trade Item Number) da unidade tributável, - * antigo código EAN ou código de barras (cEANTrib) - */ - readonly codeTaxGTIN?: string | null; - /** @description Unidade Tributável (uTrib) */ - readonly unitTax?: string | null; - /** - * Format: double - * @description Quantidade Tributável (qTrib) - */ - readonly quantityTax?: number | null; - /** - * Format: double - * @description Valor Unitário de tributação (vUnTrib) - */ - readonly taxUnitAmount?: number | null; - /** - * Format: double - * @description Valor Total do Frete (vFrete) - */ - readonly freightAmount?: number | null; - /** - * Format: double - * @description Valor Total do Seguro (vSeg) - */ - readonly insuranceAmount?: number | null; - /** - * Format: double - * @description Valor do Desconto (vDesc) - */ - readonly discountAmount?: number | null; - /** - * Format: double - * @description Outras despesas acessórias (vOutro) - */ - readonly othersAmount?: number | null; - /** - * @description Indica se valor do Item (vProd) - * entra no valor total da NF-e (vProd) (indTot) - */ - readonly totalIndicator?: boolean | null; - /** @description CEST - Código especificador da substituição tributária */ - readonly cest?: string | null; - readonly tax?: components["schemas"]["InvoiceItemTaxResource"]; - /** @description Informações Adicionais do Produto (infAdProd) */ - readonly additionalInformation?: string | null; - /** @description Número do pedido de compra (xPed) */ - readonly numberOrderBuy?: string | null; - /** - * Format: int32 - * @description Item do Pedido de Compra (nItemPed) - */ - readonly itemNumberOrderBuy?: number | null; - /** @description Número de controle da FCI - Ficha de Conteúdo de Importação (nFCI) */ - readonly importControlSheetNumber?: string | null; - readonly fuelDetail?: components["schemas"]["FuelResource"]; - /** @description Código de Benefício Fiscal na UF aplicado ao item (cBenef) */ - readonly benefit?: string | null; - /** @description Declaração Importação (DI) */ - readonly importDeclarations?: (readonly components["schemas"]["ImportDeclarationResource"][]) | null; - /** @description Grupo de informações de exportação para o item (detExport) */ - readonly exportDetails?: (readonly components["schemas"]["ExportDetailResource"][]) | null; - readonly taxDetermination?: components["schemas"]["TaxDeterminationResource"]; - }; - readonly InvoiceItemTaxResource: { - /** - * Format: double - * @description Valor aproximado total de tributos federais, estaduais e municipais (vTotTrib) - */ - readonly totalTax?: number | null; - readonly icms?: components["schemas"]["IcmsTaxResource"]; - readonly ipi?: components["schemas"]["IPITaxResource"]; - readonly ii?: components["schemas"]["IITaxResource"]; - readonly pis?: components["schemas"]["PISTaxResource"]; - readonly cofins?: components["schemas"]["CofinsTaxResource"]; - readonly icmsDestination?: components["schemas"]["ICMSUFDestinationTaxResource"]; - }; - readonly InvoiceItemsResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificador da Empresa */ - readonly companyId?: string | null; - /** @description Identificador da Nota Fiscal */ - readonly id?: string | null; - /** @description Detalhamento de Produtos e Serviços (det) - Lista de Items da Nota Fiscal */ - readonly items?: (readonly components["schemas"]["InvoiceItemResource"][]) | null; - /** @description Identifica se existem mais items a serem consultados */ - readonly hasMore?: boolean | null; - }; - readonly InvoiceResource: { - /** @description Identificador único */ - readonly id?: string | null; - /** - * Format: int32 - * @description Série do Documento Fiscal (serie) - */ - readonly serie?: number | null; - /** - * Format: int64 - * @description Número do Documento Fiscal (nNF) - */ - readonly number?: number | null; - readonly status?: components["schemas"]["InvoiceStatus"]; - readonly authorization?: components["schemas"]["AuthorizationResource"]; - readonly contingencyDetails?: components["schemas"]["ContingencyDetails"]; - /** @description Descrição da Natureza da Operação (natOp) */ - readonly operationNature?: string | null; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string | null; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string | null; - /** - * Format: date-time - * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) - * - * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. - * - */ - readonly operationOn?: string | null; - readonly operationType?: components["schemas"]["OperationType"]; - readonly environmentType?: components["schemas"]["EnvironmentType"]; - readonly purposeType?: components["schemas"]["PurposeType"]; - readonly issuer?: components["schemas"]["IssuerResource"]; - readonly buyer?: components["schemas"]["BuyerResource"]; - readonly totals?: components["schemas"]["TotalResource"]; - readonly transport?: components["schemas"]["TransportInformationResource"]; - readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; - readonly export?: components["schemas"]["ExportResource"]; - readonly billing?: components["schemas"]["BillingResource"]; - /** @description Grupo de Formas de Pagamento (pag) */ - readonly payment?: (readonly components["schemas"]["PaymentResource"][]) | null; - readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; - readonly delivery?: components["schemas"]["DeliveryInformationResource"]; - readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"]; - readonly lastEvents?: components["schemas"]["InvoiceEventsResourceBase"]; - }; - /** @enum {string} */ - readonly InvoiceStatus: "None" | "Created" | "Processing" | "Issued" | "IssuedContingency" | "Cancelled" | "Disabled" | "IssueDenied" | "Error"; - readonly InvoiceWithoutEventsResource: { - /** @description Identificador único */ - readonly id?: string | null; - /** - * Format: int32 - * @description Série do Documento Fiscal (serie) - */ - readonly serie?: number | null; - /** - * Format: int64 - * @description Número do Documento Fiscal (nNF) - */ - readonly number?: number | null; - readonly status?: components["schemas"]["InvoiceStatus"]; - readonly authorization?: components["schemas"]["AuthorizationResource"]; - readonly contingencyDetails?: components["schemas"]["ContingencyDetails"]; - /** @description Descrição da Natureza da Operação (natOp) */ - readonly operationNature?: string | null; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string | null; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string | null; - /** - * Format: date-time - * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) - * - * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. - * - */ - readonly operationOn?: string | null; - readonly operationType?: components["schemas"]["OperationType"]; - readonly environmentType?: components["schemas"]["EnvironmentType"]; - readonly purposeType?: components["schemas"]["PurposeType"]; - readonly issuer?: components["schemas"]["IssuerResource"]; - readonly buyer?: components["schemas"]["BuyerResource"]; - readonly totals?: components["schemas"]["TotalResource"]; - readonly transport?: components["schemas"]["TransportInformationResource"]; - readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; - readonly export?: components["schemas"]["ExportResource"]; - readonly billing?: components["schemas"]["BillingResource"]; - /** @description Grupo de Formas de Pagamento (pag) */ - readonly payment?: (readonly components["schemas"]["PaymentResource"][]) | null; - readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; - readonly delivery?: components["schemas"]["DeliveryInformationResource"]; - readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"]; - }; - readonly IssuerFromRequestResource: { - /** @description IE do Substituto Tributário (IEST) */ - readonly stStateTaxNumber?: string | null; - }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo de identificação do emitente da NF-e - */ - readonly IssuerResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Nome ou Razão Social (xNome) */ - readonly name?: string | null; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number | null; - /** @description Email */ - readonly email?: string | null; - readonly address?: components["schemas"]["AddressResource"]; - readonly type?: components["schemas"]["PersonType"]; - /** @description Nome Fantasia */ - readonly tradeName?: string | null; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate?: string | null; - readonly taxRegime?: components["schemas"]["TaxRegime"]; - readonly specialTaxRegime?: components["schemas"]["SpecialTaxRegime"]; - readonly legalNature?: components["schemas"]["LegalNature"]; - /** @description Atividades da Empresa (CNAE) */ - readonly economicActivities?: (readonly components["schemas"]["EconomicActivityResource"][]) | null; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number | null; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number | null; - /** - * Format: int64 - * @description Inscrição Estadual do Substituto Tributário (IEST) - */ - readonly regionalSTTaxNumber?: number | null; - /** @description Número de Inscrição na Prefeitura (IM/CCM) */ - readonly municipalTaxNumber?: string | null; - /** @description IE do Substituto Tributário (IEST) */ - readonly stStateTaxNumber?: string | null; - }; - /** @enum {string} */ - readonly LegalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @enum {string} */ - readonly OperationType: "Outgoing" | "Incoming"; - /** @description Grupo do PIS */ - readonly PISTaxResource: { - /** @description Código de Situação Tributária do PIS (CST) */ - readonly cst?: string | null; - /** - * Format: double - * @description Valor da Base de Cálculo do PIS (vBC) - */ - readonly baseTax?: number | null; - /** - * Format: double - * @description Alíquota do PIS (em percentual) (pPIS) - */ - readonly rate?: number | null; - /** - * Format: double - * @description Valor do PIS (vPIS) - */ - readonly amount?: number | null; - /** - * Format: double - * @description Quantidade Vendida (qBCProd) - */ - readonly baseTaxProductQuantity?: number | null; - /** - * Format: double - * @description Alíquota do PIS (em reais) (vAliqProd) - */ - readonly productRate?: number | null; - }; - readonly PaymentDetailResource: { - readonly method?: components["schemas"]["PaymentMethod"]; - /** @description Descrição do meio de pagamento (xPag) */ - readonly methodDescription?: string | null; - readonly paymentType?: components["schemas"]["PaymentType"]; - /** - * Format: double - * @description Valor do Pagamento (vPag) - */ - readonly amount?: number | null; - readonly card?: components["schemas"]["CardResource"]; - /** - * Format: date-time - * @description Data do pagamento (dPag) - */ - readonly paymentDate?: string | null; - /** @description CNPJ transacional do pagamento (CNPJPag) */ - readonly federalTaxNumberPag?: string | null; - /** @description UF do CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (UFPag) */ - readonly statePag?: string | null; +export interface paths { + readonly "/v2/companies": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar todas as Empresas da Conta + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar os dados das empresas vinculadas a conta. + */ + readonly get: operations["V2CompaniesGet"]; + readonly put?: never; + /** + * Criar uma Empresa + * @description ### Informações adicionais + * + * Utilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + */ + readonly post: operations["V2CompaniesPost"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @enum {string} */ - readonly PaymentMethod: "Cash" | "Cheque" | "CreditCard" | "DebitCard" | "StoreCredict" | "FoodVouchers" | "MealVouchers" | "GiftVouchers" | "FuelVouchers" | "BankBill" | "BankDeposit" | "InstantPayment" | "WireTransfer" | "Cashback" | "StaticInstantPayment" | "StoreCredit" | "ElectronicPaymentNotInformed" | "WithoutPayment" | "Others"; - readonly PaymentResource: { - /** - * @description YA01a - Grupo Detalhamento da Forma de Pagamento (detPag) - * VERSÃO 4.00 - */ - readonly paymentDetail?: (readonly components["schemas"]["PaymentDetailResource"][]) | null; - /** - * Format: double - * @description Valor do troco (vTroco) - * VERSÃO 4.00 - */ - readonly payBack?: number | null; + readonly "/v2/companies/{company_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar uma Empresa pelo ID + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar os dados de uma empresas pelo ID. + */ + readonly get: operations["V2CompaniesByCompany_idGet"]; + /** + * Alterar uma Empresa pelo ID + * @description ### Informações adicionais + * + * Utilize esta requisição para alterar os dados de uma empresas pelo ID. + */ + readonly put: operations["V2CompaniesByCompany_idPut"]; + readonly post?: never; + /** + * Excluir uma Empresa por ID + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir uma empresas pelo ID, cuidado pois esse processo é irreversível. + */ + readonly delete: operations["V2CompaniesByCompany_idDelete"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @enum {string} */ - readonly PaymentType: "InCash" | "Term"; - /** @enum {string} */ - readonly PersonType: "Undefined" | "NaturalPerson" | "LegalEntity" | "Company" | "Customer"; - /** @enum {string} */ - readonly PrintType: "None" | "NFeNormalPortrait" | "NFeNormalLandscape" | "NFeSimplified" | "DANFE_NFC_E" | "DANFE_NFC_E_MSG_ELETRONICA"; - readonly PumpResource: { - /** - * Format: int32 - * @description Número de identificação do bico utilizado no abastecimento (nBico) - */ - readonly spoutNumber?: number | null; - /** - * Format: int32 - * @description Número de identificação da bomba ao qual o bico está interligado (nBomba) - */ - readonly number?: number | null; - /** - * Format: int32 - * @description Número de identificação do tanque ao qual o bico está interligado (nTanque) - */ - readonly tankNumber?: number | null; - /** - * Format: double - * @description Valor do Encerrante no início do abastecimento (vEncIni) - */ - readonly beginningAmount?: number | null; - /** - * Format: double - * @description Valor do Encerrante no final do abastecimento (vEncFin) - */ - readonly endAmount?: number | null; - /** - * Format: double - * @description Percentual do índice de mistura do Biodiesel (B100) no Óleo Diesel B instituído pelo órgão regulamentador - */ - readonly percentageBio?: number | null; + readonly "/v2/companies/{company_id}/certificates": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar um Certificado por seu Status + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através d0 **status do certificado** (__status__). + */ + readonly get: operations["V2CompaniesByCompany_idCertificatesGet"]; + readonly put?: never; + /** + * Upload de um Certificado + * @description ### Informações adicionais + * + * Utilize esta requisição para fazer upload de um **Certificado da ICP-Brasil** do tipo __e-CNPJ A1__ ou __NFE A1__ em uma **Empresa** e vincula-lo para processamentos. + * + * O **Certificado da ICP-Brasil** funciona como uma identidade virtual, para empresas e pessoas, que permite a identificação segura e inequívoca do autor de uma mensagem ou transação feita em meios eletrônicos, como a web. + */ + readonly post: operations["V2CompaniesByCompany_idCertificatesPost"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @enum {string} */ - readonly PurposeType: "None" | "Normal" | "Complement" | "Adjustment" | "Devolution"; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo Reboque - */ - readonly ReboqueResource: { - /** @description Placa do Veiculo (placa) */ - readonly plate?: string | null; - /** @description UF Veiculo Reboque (UF) */ - readonly uf?: string | null; - /** @description Registro Nacional de Transportador de Carga (ANTT) (RNTC) */ - readonly rntc?: string | null; - /** @description Identificação do Vagão (vagao) */ - readonly wagon?: string | null; - /** @description Identificação da Balsa (balsa) */ - readonly ferry?: string | null; + readonly "/v2/companies/{company_id}/certificates/{certificate_thumbprint}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar um Certificado por sua impressão digital + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__). + */ + readonly get: operations["V2CompaniesByCompany_idCertificatesByCertificate_thumbprintGet"]; + readonly put?: never; + readonly post?: never; + /** + * Excluir um Certificado por sua impressão digital + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir o **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__) e desvincula-lo da **Empresa**. + * + * **ATENÇÃO pois esta requisição é irreversível** + */ + readonly delete: operations["V2CompaniesByCompany_idCertificatesByCertificate_thumbprintDelete"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @enum {string} */ - readonly ReceiverStateTaxIndicator: "None" | "TaxPayer" | "Exempt" | "NonTaxPayer"; - readonly ReferencedProcessResource: { - readonly identifierConcessory?: string | null; - /** Format: int32 */ - readonly identifierOrigin?: number | null; - /** Format: int32 */ - readonly concessionActType?: number | null; + readonly "/v2/companies/{company_id}/statetaxes": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Listar as Inscrições Estaduais + * @description ### Informações adicionais + * + * Utilize esta requisição para listar as inscrições estaduais na empresa para processar __Documentos Fiscais__. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. + */ + readonly get: operations["V2CompaniesByCompany_idStatetaxesGet"]; + readonly put?: never; + /** + * Criar uma Inscrição Estadual + * @description ### Informações adicionais + * + * Utilize esta requisição para criar novas inscrição estadual na empresa para processar __Documentos Fiscais__. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. + */ + readonly post: operations["V2CompaniesByCompany_idStatetaxesPost"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly RequestCancellationResource: { - readonly accountId?: string | null; - readonly companyId?: string | null; - readonly productInvoiceId?: string | null; - readonly reason?: string | null; + readonly "/v2/companies/{company_id}/statetaxes/{state_tax_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar uma Inscrição Estadual pelo ID + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar os dados de uma empresas pelo ID. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. + */ + readonly get: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idGet"]; + /** + * Alterar uma Inscrição Estadual pelo ID + * @description ### Informações adicionais + * + * Utilize esta requisição para alterar os dados de uma Inscrição Estadual pelo ID. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. + */ + readonly put: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idPut"]; + readonly post?: never; + /** + * Excluir uma Inscrição Estadual pelo ID + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir uma Inscrição Estadual pelo ID, cuidado pois esse processo é irreversível. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. + */ + readonly delete: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idDelete"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @enum {string} */ - readonly ShippingModality: "ByIssuer" | "ByReceiver" | "ByThirdParties" | "OwnBySender" | "OwnByBuyer" | "Free"; - /** - * @description Regime especial de tributação - * @enum {string} - */ - readonly SpecialTaxRegime: "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte" | "Automatico"; - /** @enum {string} */ - readonly StateCode: "NA" | "RO" | "AC" | "AM" | "RR" | "PA" | "AP" | "TO" | "MA" | "PI" | "CE" | "RN" | "PB" | "PE" | "AL" | "SE" | "BA" | "MG" | "ES" | "RJ" | "SP" | "PR" | "SC" | "RS" | "MS" | "MT" | "GO" | "DF" | "EX"; - /** @enum {string} */ - readonly StateTaxProcessingAuthorizer: "Normal" | "EPEC"; - readonly TaxCouponInformationResource: { - /** @description Modelo de Documento Fiscal (mod) */ - readonly modelDocumentFiscal?: string | null; - /** @description Número de Ordem Sequencial do ECF (nECF) */ - readonly orderECF?: string | null; - /** - * Format: int32 - * @description Número do Contador de Ordem de Operação (nCOO) - */ - readonly orderCountOperation?: number | null; - }; - readonly TaxDeterminationResource: { - /** - * Format: int32 - * @description Código interno para determinação de natureza de operação - */ - readonly operationCode?: number | null; - /** @description Perfil fiscal do vendedor (origem) - usado para o cálculo automático de impostos */ - readonly issuerTaxProfile?: string | null; - /** @description Perfil fiscal do comprador (destino) - usado para o cálculo automático de impostos */ - readonly buyerTaxProfile?: string | null; - /** @description Origem da mercadoria */ - readonly origin?: string | null; - /** @description Finalidade de aquisição - usado para o cálculo automático de impostos */ - readonly acquisitionPurpose?: string | null; + readonly "/v2/companies/{companyId}/consumerinvoices": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Listar as Notas Fiscais Eletrônicas (NFCE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar uma lista de notas fiscais de consumidor eletrônica por empresa. + */ + readonly get: { + readonly parameters: { + readonly query?: { + /** @description Ambiente das notas (Production/Test) */ + readonly environment?: components["schemas"]["EnvironmentType"]; + /** @description Id da nota fiscal de início do contador (Default: Empty) */ + readonly startingAfter?: string; + /** @description Id da nota fiscal final do contador (Default: Empty) */ + readonly endingBefore?: string; + /** @description Buscar por parâmetros. ("Elasticsearch string query") Ex: (q=buyer.name:'EMPRESA LTDA') */ + readonly q?: string; + /** @description Limite de resultados na página (Default: 10) */ + readonly limit?: number; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta em lista */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ConsumerInvoicesResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + /** + * Emitir uma Nota Fiscal de Consumidor Eletrônica (NFCE) + * @description ### Informações adicionais + * Utilize esta requisição para enviar uma Nota Fiscal de Consumidor Eletrônica (NFCE) para fila de emissão. + * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo + * não garante a emissão do documento fiscal. + * Para obter um retorno ao final do processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos + * utilizar os WebHooks. + */ + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description Empresa ID */ + readonly companyId: string; + }; + readonly cookie?: never; + }; + /** @description Dados da nota fiscal de Consumidor a ser emitida */ + readonly requestBody?: { + readonly content: { + readonly "application/json": components["schemas"]["ConsumerInvoiceRequest"]; + readonly "text/json": components["schemas"]["ConsumerInvoiceRequest"]; + readonly "application/*+json": components["schemas"]["ConsumerInvoiceRequest"]; + }; + }; + readonly responses: { + /** @description Sucesso ao enfileirar para emissão */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ConsumerInvoiceRequest"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly TaxDocumentsReferenceResource: { - readonly taxCouponInformation?: components["schemas"]["TaxCouponInformationResource"]; - readonly documentInvoiceReference?: components["schemas"]["DocumentInvoiceReferenceResource"]; - readonly documentElectronicInvoice?: components["schemas"]["DocumentElectronicInvoiceResource"]; + readonly "/v2/companies/{companyId}/consumerinvoices/{invoiceId}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar por ID uma Nota Fiscal de Consumidor Eletrônica (NFCE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar os dados de uma Nota Fiscal de Consumidor Eletrônica (NFCE) pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal de Consumidor Eletrônica que deverá ser retornada */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["InvoiceResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly put?: never; + readonly post?: never; + /** + * Cancelar uma Nota Fiscal de Consumidor Eletrônica (NFCE) + * @description ### Informações adicionais + * Utilize esta requisição para enviar uma Nota Fiscal de Consumidor Eletrônica (NFCE) para fila de cancelamento. + * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo + * não garante o cancelamento do documento fiscal. + * Para obter um retorno ao final do processo de cancelamento de uma Nota Fiscal Eletrônica (NFe), + * recomendamos utilizar os WebHooks. + */ + readonly delete: { + readonly parameters: { + readonly query?: { + /** @description Motivo do cancelamento */ + readonly reason?: string; + }; + readonly header?: never; + readonly path: { + /** @description Empresa ID */ + readonly companyId: string; + /** @description ID da Nota Fiscal de Consumidor que deverá ser cancelada */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso ao enfileirar para cancelamento */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["RequestCancellationResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * @description Regime de tributação - * @enum {string} - */ - readonly TaxRegime: "None" | "LucroReal" | "LucroPresumido" | "SimplesNacional" | "SimplesNacionalExcessoSublimite" | "MicroempreendedorIndividual" | "Isento"; - readonly TaxpayerCommentsResource: { - /** @description Campo (xCampo) */ - readonly field?: string | null; - /** @description Texto (xTexto) */ - readonly text?: string | null; + readonly "/v2/companies/{companyId}/consumerinvoices/{invoiceId}/items": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar os produtos por ID uma Nota Fiscal de Consumidor Eletrônica (NFCE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar os dados de uma Nota Fiscal de Consumidor Eletrônica (NFCE) pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: { + /** @description Limite de resultados na página (Default: 10) */ + readonly limit?: number; + /** @description Índice de início do contador (Default: 0) */ + readonly startingAfter?: number; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal de Consumidor Eletrônica que deverá ser retornada */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["InvoiceItemsResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly TotalResource: { - readonly icms?: components["schemas"]["ICMSTotalResource"]; - readonly issqn?: components["schemas"]["ISSQNTotalResource"]; + readonly "/v2/companies/{companyId}/consumerinvoices/{invoiceId}/events": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar eventos por ID uma Nota Fiscal de Consumidor Eletrônica (NFCE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar os dados de uma Nota Fiscal de Consumidor Eletrônica (NFCE) pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: { + /** @description Limite de resultados na página (Default: 10) */ + readonly limit?: number; + /** @description Índice de início do contador (Default: 0) */ + readonly startingAfter?: number; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal de Consumidor Eletrônica que deverá ser retornada */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["InvoiceEventsResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo Transportador - */ - readonly TransportGroupResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Nome ou Razão Social (xNome) */ - readonly name?: string | null; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number | null; - /** @description Email */ - readonly email?: string | null; - readonly address?: components["schemas"]["AddressResource"]; - readonly type?: components["schemas"]["PersonType"]; - /** @description Inscrição Estadual do Transportador (IE) */ - readonly stateTaxNumber?: string | null; - /** @description Grupo de Retenção do ICMS do transporte */ - readonly transportRetention?: string | null; + readonly "/v2/companies/{companyId}/consumerinvoices/{invoiceId}/pdf": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar PDF do Documento Auxiliar da Nota Fiscal de Consumidor Eletrônica (DANFE-NFC-e) + * @description ### Informações adicionais + * Utilize esta requisição para consultar a URL para o Documento Auxiliar Nota Fiscal de Consumidor Eletrônica (DANFE-NFC-e) + * em formato de arquivo PDF. + */ + readonly get: { + readonly parameters: { + readonly query?: { + readonly force?: boolean; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal de Consumidor que deverá ser retornado */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do DANFE-NFC-e */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["FileResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo de Informações do Transporte da NF-e - * Id: X01 Pai: A1 - */ - readonly TransportInformationResource: { - readonly freightModality?: components["schemas"]["ShippingModality"]; - readonly transportGroup?: components["schemas"]["TransportGroupResource"]; - readonly reboque?: components["schemas"]["ReboqueResource"]; - readonly volume?: components["schemas"]["VolumeResource"]; - readonly transportVehicle?: components["schemas"]["TransportVehicleResource"]; - /** @description Número dos Lacres */ - readonly sealNumber?: string | null; - readonly transpRate?: components["schemas"]["TransportRateResource"]; + readonly "/v2/companies/{companyId}/consumerinvoices/{invoiceId}/xml": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar XML da Nota Fiscal de Consumidor Eletrônica (NFCE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar os dados de uma nota fiscal de Consumidor Eletrônica pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal de Consumidor que deverá ser retornado */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do XML da NFCE */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["FileResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly TransportRateResource: { - /** - * Format: double - * @description Valor do Serviço (vServ) - */ - readonly serviceAmount?: number | null; - /** - * Format: double - * @description BC da Retenção do ICMS (vBCRet) - */ - readonly bcRetentionAmount?: number | null; - /** - * Format: double - * @description Alíquota da Retenção (pICMSRet) //Change to Rate - */ - readonly icmsRetentionRate?: number | null; - /** - * Format: double - * @description Valor do ICMS Retido (vICMSRet) - */ - readonly icmsRetentionAmount?: number | null; - /** - * Format: int64 - * @description CFOP de Serviço de Transporte (CFOP) - */ - readonly cfop?: number | null; - /** - * Format: int64 - * @description Código do Municipio de ocorrencia do fato gerador do ICMS do Transporte (cMunFG) - */ - readonly cityGeneratorFactCode?: number | null; + readonly "/v2/companies/{companyId}/consumerinvoices/{invoiceId}/xml/rejection": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar XML de rejeição da Nota Fiscal de Consumidor Eletrônica (NFCE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar o motivo da rejeição de uma nota fiscal de Consumidor Eletrônica pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal de Consumidor que deverá ser retornado */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do XML da NFCE */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["FileResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal de Consumidor Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo Veiculo - */ - readonly TransportVehicleResource: { - /** @description Placa do Veiculo (placa) */ - readonly plate?: string | null; - /** @description Sigla da UF (UF) */ - readonly state?: string | null; - /** @description Registro Nacional de Transportador de Carga (ANTT) (RNTC) */ - readonly rntc?: string | null; + readonly "/v2/companies/{companyId}/consumerinvoices/disablement": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Inutilizar números de nota fiscal + * @description ### Informações adicionais + * Caso seja um único número, utilizar o Número inicial e o Número final com o mesmo valor + */ + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly companyId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": components["schemas"]["DisablementResource"]; + readonly "text/json": components["schemas"]["DisablementResource"]; + readonly "application/*+json": components["schemas"]["DisablementResource"]; + }; + }; + readonly responses: { + /** @description Sucesso */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["DisablementResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Volumes - * Id:X26 - */ - readonly VolumeResource: { - /** - * Format: int32 - * @description Quantidade de volumes transportados (qVol) - */ - readonly volumeQuantity?: number | null; - /** @description Espécie dos volumes transportados (esp) */ - readonly species?: string | null; - /** @description Marca dos Volumes Transportados (marca) */ - readonly brand?: string | null; - /** @description Numeração dos Volumes Transportados (nVol) */ - readonly volumeNumeration?: string | null; - /** - * Format: double - * @description Peso Liquido(em Kg) (pesoL) - */ - readonly netWeight?: number | null; - /** - * Format: double - * @description Peso Bruto(em Kg) (pesoB) - */ - readonly grossWeight?: number | null; + readonly "/v2/webhooks/eventTypes": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Listar os Tipos de Eventos gerados pela plataforma + * @description ### Informações adicionais + * + * Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados + * criando notificações para os webhooks ativos e configurados para receber os eventos. + * + * São identificados seguindo o padrão **Resource.EventAction**, + * onde **Resource**: nome da entidade que gerou o evento; + * **EventAction**: nome do evento e ação criados. + * + * Esse tipos podem ser utilizados como filtro ao criar ou alterar um webhook, + * sendo que o filtro determina quais notificações de eventos e ação serão enviadas + * para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook + * ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros. + */ + readonly get: operations["V2WebhooksEventTypesGet"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @description Identificação do Local de retirada (retirada) */ - readonly WithdrawalInformationResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Nome ou Razão Social (xNome) */ - readonly name?: string | null; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number | null; - /** @description Email */ - readonly email?: string | null; - readonly address?: components["schemas"]["AddressResource"]; - readonly type?: components["schemas"]["PersonType"]; - /** @description Inscrição Estadual (IE) */ - readonly stateTaxNumber?: string | null; + readonly "/v2/webhooks": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Listar os Webhooks + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar uma lista de **Webhooks** cadastrados na Conta Autenticada. + */ + readonly get: operations["V2WebhooksGet"]; + readonly put?: never; + /** + * Criar um Webhook + * @description ### Informações adicionais + * + * Utilize esta requisição para criar novos **Webhooks** para receber as notificações de eventos ocorridos na plataforma. + * + * Na criação do **Webhook** a URL informada no cadastro deve ser responsiva, ou seja, deverá responder *(HTTP Status 200 OK)* a uma requisição *(HTTP POST)* que será feita para testar se a URL está operando como normalmente, caso contrario uma mensagem de erro será retornada. + * + * Um **Webhook** é semelhante a uma assinatura em um *sistema de publicação e assinatura* + * que permite ao assinante indicar *quando*, *como* e *onde* as notificações de eventos deve ser despachadas. + * Um **Webhook** é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos + * que podem ser acionados por eventos gerados através de ações executadas por esse Conta. + * Ou seja, a __Conta da *Empresa A*__ não verá os WebHooks disparados por uma ação executada pelo usuário __Conta da *Empresa B*__. + */ + readonly post: operations["V2WebhooksPost"]; + /** + * Excluir Todos os Webhooks existentes + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir todos os **Webhooks** cadastrados para a Conta Autenticada. + */ + readonly delete: operations["V2WebhooksDelete"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; -}; - -export type $defs = Record; - -export type external = Record; - -export type operations = { - - /** - * Consultar todas as Empresas da Conta - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados das empresas vinculadas a conta. - */ - V2CompaniesGet: { - parameters: { - query?: { - /** @description Id de início do contador (Default: Empty) */ - startingAfter?: string; - /** @description Id final do contador (Default: Empty) */ - endingBefore?: string; - /** @description Limite de resultados na página (Default: 10) */ - limit?: number; - }; + readonly "/v2/webhooks/{webhook_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar um webhook existente + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**. + */ + readonly get: operations["V2WebhooksByWebhook_idGet"]; + /** + * Alterar um Webhook existente + * @description ### Informações adicionais + * + * Utilize esta requisição para alterar os dados do **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. + */ + readonly put: operations["V2WebhooksByWebhook_idPut"]; + readonly post?: never; + /** + * Excluir um Webhook existente + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir o **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. + * A exclusão do **Webhook** não exime o **Webhook** excluído de receber os notificações de eventos, já ocorridos na plataforma, que ainda estejam em processo de retentativa de envio dos gatilhos. + */ + readonly delete: operations["V2WebhooksByWebhook_idDelete"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description Sucesso na consulta da Empresa */ - 200: { - content: { - readonly "application/json": { - /** @description Lista de Empresa */ - readonly companies?: readonly ({ - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Lista de Inscrição Estadual */ - readonly stateTaxes?: readonly string[]; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; - /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - })[]; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Empresa não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; + readonly "/v2/webhooks/{webhook_id}/pings": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + /** + * Criar notificação para Testar um webhook + * @description ### Informações adicionais + * + * Utilize esta requisição para criar uma notificação de teste (ping) em um **Webhook** já cadastrado. + * + * Esta ação irá criar um evento de notificação do tipo ping para o **Webhook** especificado, deste modo você poderá simular o recebimento de uma notificação de teste no **Webhook** cadastrado. + */ + readonly put: operations["V2WebhooksByWebhook_idPingsPut"]; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - /** - * Criar uma Empresa - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - */ - V2CompaniesPost: { - /** @description Dados da Empresa a ser criada */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; +} +export type webhooks = Record; +export interface components { + schemas: { + readonly ActivityResource: { + /** @description Detalhes do Evento */ + readonly data?: unknown; + /** @description Nome do Evento gerado */ + readonly type?: string | null; /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - readonly "text/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; + * Format: int32 + * @description Número sequencial do Evento + */ + readonly sequence?: number | null; + }; + /** @description Adições (adi) */ + readonly AdditionResource: { /** * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - readonly "application/*+json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; + * @description Numero da adição (nAdicao) + */ + readonly code?: number | null; + /** @description Código do fabricante estrangeiro (cFabricante) */ + readonly manufacturer?: string | null; /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - }; - }; - responses: { - /** @description Sucesso na criação da Empresa */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Lista de Inscrição Estadual */ - readonly stateTaxes?: readonly string[]; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; - /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Consultar uma Empresa pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de uma empresas pelo ID. - */ - V2CompaniesByCompany_idGet: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - company_id: string; - }; - }; - responses: { - /** @description Sucesso na consulta da Empresa */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Lista de Inscrição Estadual */ - readonly stateTaxes?: readonly string[]; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; - /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Empresa não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Alterar uma Empresa pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados de uma empresas pelo ID. - */ - V2CompaniesByCompany_idPut: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - company_id: string; - }; - }; - /** @description Dados da Empresa a ser alterada */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; + * Format: double + * @description Valor do desconto do item da DI – Adição (vDescDI) + */ + readonly amount?: number | null; /** * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - readonly "text/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; + * @description Número do ato concessório de Drawback (nDraw) + */ + readonly drawback?: number | null; + }; + readonly AdditionalInformationResource: { + /** @description Informações Adicionais de Interesse do Fisco (infAdFisco) */ + readonly fisco?: string | null; + /** @description Informações Complementares de interesse do Contribuinte (infCpl) */ + readonly taxpayer?: string | null; + /** @description Informações Complementares de interesse do Contribuinte (infCpl) */ + readonly xmlAuthorized?: readonly number[] | null; + readonly effort?: string | null; + readonly order?: string | null; + readonly contract?: string | null; + /** @description Documentos Fiscais Referenciados (refECF) */ + readonly taxDocumentsReference?: readonly components["schemas"]["TaxDocumentsReferenceResource"][] | null; + /** @description Observações fiscais (obsCont) */ + readonly taxpayerComments?: readonly components["schemas"]["TaxpayerCommentsResource"][] | null; + /** @description Processos referenciados (procRef) */ + readonly referencedProcess?: readonly components["schemas"]["ReferencedProcessResource"][] | null; + }; + /** @description Dados do Endereço */ + readonly AddressResource: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state?: string | null; + readonly city?: components["schemas"]["CityResource"]; + /** @description Bairro do Endereço */ + readonly district?: string | null; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string | null; + /** @description Logradouro do Endereço */ + readonly street?: string | null; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number?: string | null; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode?: string | null; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country?: string | null; + /** @description Telefone */ + readonly phone?: string | null; + }; + readonly AuthorizationResource: { + /** Format: date-time */ + readonly receiptOn?: string | null; + readonly accessKey?: string | null; + readonly message?: string | null; + }; + readonly BillResource: { + /** @description Número da Fatura (nFat) */ + readonly number?: string | null; /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - readonly "application/*+json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; + * Format: double + * @description Valor Original da Fatura (vOrig) + */ + readonly originalAmount?: number | null; /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - }; - }; - responses: { - /** @description Sucesso na alteração da Empresa */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Lista de Inscrição Estadual */ - readonly stateTaxes?: readonly string[]; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; - /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Empresa não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Excluir uma Empresa por ID - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir uma empresas pelo ID, cuidado pois esse processo é irreversível. - */ - V2CompaniesByCompany_idDelete: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - company_id: string; - }; - }; - responses: { - /** @description Sucesso na exclusão da Empresa */ - 204: { - content: { - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Empresa não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Consultar um Certificado por seu Status - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através d0 **status do certificado** (__status__). - */ - V2CompaniesByCompany_idCertificatesGet: { - parameters: { - query?: { - /** @description Status do certificado */ - status?: "inactive" | "overdue" | "pending" | "active" | "none"; - }; - path: { - /** @description ID da Empresa relacionada ao certificado */ - company_id: string; - }; - }; - responses: { - /** @description Sucesso na consulta */ - 200: { - content: { - readonly "application/json": { - readonly certificates?: readonly ({ - /** @description Nome do certificado (subject distinguished name) */ - readonly subject?: string; - /** - * Format: date-time - * @description Data no horário local após o qual um certificado não é mais válido - */ - readonly validUntil?: string; - /** @description A impressão digital do certificado */ - readonly thumbprint?: string; - /** @description CNPJ da Empresa */ - readonly federalTaxNumber?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; - })[]; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Upload de um Certificado - * @description ### Informações adicionais - * - * Utilize esta requisição para fazer upload de um **Certificado da ICP-Brasil** do tipo __e-CNPJ A1__ ou __NFE A1__ em uma **Empresa** e vincula-lo para processamentos. - * - * O **Certificado da ICP-Brasil** funciona como uma identidade virtual, para empresas e pessoas, que permite a identificação segura e inequívoca do autor de uma mensagem ou transação feita em meios eletrônicos, como a web. - */ - V2CompaniesByCompany_idCertificatesPost: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - }; - }; - readonly requestBody: { - readonly content: { - readonly "multipart/form-data": { - /** - * Format: binary - * @description Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12 - */ - readonly file: string; - /** @description Senha do certificado ICP-Brasil */ - readonly password: string; - }; - readonly "application/form-data": { - /** - * Format: binary - * @description Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12 - */ - readonly file: string; - /** @description Senha do certificado ICP-Brasil */ - readonly password: string; - }; - }; - }; - responses: { - /** @description Sucesso no upload e vinculo com a Empresa */ - 200: { - content: { - readonly "application/json": { - /** @description Certificado */ - readonly certificate?: { - /** @description Nome do certificado (subject distinguished name) */ - readonly subject?: string; - /** - * Format: date-time - * @description Data no horário local após o qual um certificado não é mais válido - */ - readonly validUntil?: string; - /** @description A impressão digital do certificado */ - readonly thumbprint?: string; - /** @description CNPJ da Empresa */ - readonly federalTaxNumber?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Consultar um Certificado por sua impressão digital - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__). - */ - V2CompaniesByCompany_idCertificatesByCertificate_thumbprintGet: { - parameters: { - path: { - /** @description ID da Empresa relacionada ao certificado */ - company_id: string; - /** @description Impressão digital do certificado */ - certificate_thumbprint: string; - }; - }; - responses: { - /** @description Sucesso na consulta */ - 200: { - content: { - readonly "application/json": { - /** @description Certificado */ - readonly certificate?: { - /** @description Nome do certificado (subject distinguished name) */ - readonly subject?: string; - /** - * Format: date-time - * @description Data no horário local após o qual um certificado não é mais válido - */ - readonly validUntil?: string; - /** @description A impressão digital do certificado */ - readonly thumbprint?: string; - /** @description CNPJ da Empresa */ - readonly federalTaxNumber?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Certificado não encontrado */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Excluir um Certificado por sua impressão digital - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir o **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__) e desvincula-lo da **Empresa**. - * - * **ATENÇÃO pois esta requisição é irreversível** - */ - V2CompaniesByCompany_idCertificatesByCertificate_thumbprintDelete: { - parameters: { - path: { - /** @description ID da Empresa relacionada ao certificado */ - company_id: string; - /** @description Impressão digital do certificado */ - certificate_thumbprint: string; - }; - }; - responses: { - /** @description Sucesso na exclusão e desvinculo com a Empresa */ - 204: { - content: { - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Certificado não encontrado */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Listar as Inscrições Estaduais - * @description ### Informações adicionais - * - * Utilize esta requisição para listar as inscrições estaduais na empresa para processar __Documentos Fiscais__. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - V2CompaniesByCompany_idStatetaxesGet: { - parameters: { - query?: { - /** @description Id de início do contador (Default: Empty) */ - startingAfter?: string; - /** @description Id final do contador (Default: Empty) */ - endingBefore?: string; - /** @description Limite de resultados na página (Default: 10) */ - limit?: number; - }; - path: { - /** @description ID da Empresa */ - company_id: string; - }; - }; - responses: { - /** @description Sucesso na criação da Inscrição Estadual */ - 200: { - content: { - readonly "application/json": { - /** @description Lista de Inscriçoes Estaduais */ - readonly stateTaxes?: readonly ({ - /** @description Código da Empresa */ - readonly companyId?: string; - /** @description Account Id */ - readonly accountId?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "inactive" | "none" | "active"; - /** @description Todas as séries para esta Inscrição Estadual */ - readonly series?: readonly number[]; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * Format: int64 - * @description Número do Lote - */ - readonly batchId?: number; - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** - * @description Código do Estado - * @enum {string} - */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; - /** - * @description Ambiente - * @enum {string} - */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; - /** - * Format: int32 - * @description Serie para a emissão NFe - */ - readonly serie: number; - /** - * Format: int64 - * @description Número para a emissão NFe - */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; - /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} - */ - readonly type?: "default" | "nFe" | "nFCe"; - })[]; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Criar uma Inscrição Estadual - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novas inscrição estadual na empresa para processar __Documentos Fiscais__. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - V2CompaniesByCompany_idStatetaxesPost: { - parameters: { - path: { - /** @description ID da Empresa */ - company_id: string; - }; - }; - /** @description Dados da Inscrição Estadual a ser criada */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { + * Format: double + * @description Valor do desconto (vDesc) + */ + readonly discountAmount?: number | null; /** - * @description Código do Estado - * @enum {string} + * Format: double + * @description Valor Líquido da Fatura (vLiq) */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly netAmount?: number | null; + }; + readonly BillingResource: { + readonly bill?: components["schemas"]["BillResource"]; + /** @description Grupo Duplicata (dup) */ + readonly duplicates?: readonly components["schemas"]["DuplicateResource"][] | null; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo de endereço do Destinatário da NF-e + */ + readonly BuyerResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Nome ou Razão Social (xNome) */ + readonly name?: string | null; /** - * @description Ambiente - * @enum {string} + * Format: int64 + * @description CNPJ ou CPF */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly federalTaxNumber?: number | null; + /** @description Email */ + readonly email?: string | null; + readonly address?: components["schemas"]["AddressResource"]; + readonly type?: components["schemas"]["PersonType"]; + readonly stateTaxNumberIndicator?: components["schemas"]["ReceiverStateTaxIndicator"]; + /** @description Nome fantasia */ + readonly tradeName?: string | null; + readonly taxRegime?: components["schemas"]["TaxRegime"]; + /** @description Inscrição Estadual (IE) */ + readonly stateTaxNumber?: string | null; + }; + readonly CIDEResource: { /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: double + * @description BC da CIDE (qBCProd) */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly bc?: number | null; /** - * Format: int32 - * @description Serie para a emissão NFe + * Format: double + * @description Valor da alíquota da CIDE (vAliqProd) */ - readonly serie: number; + readonly rate?: number | null; /** - * Format: int64 - * @description Número para a emissão NFe + * Format: double + * @description Valor da CIDE (vCIDE) */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly cideAmount?: number | null; + }; + readonly CardResource: { + /** @description CNPJ da Credenciadora de cartão de crédito e/ou débito (CNPJ) */ + readonly federalTaxNumber?: string | null; + readonly flag?: components["schemas"]["FlagCard"]; + /** @description Número de autorização da operação cartão de crédito e/ou débito (cAut) */ + readonly authorization?: string | null; + readonly integrationPaymentType?: components["schemas"]["IntegrationPaymentType"]; + /** @description CNPJ do beneficiário do pagamento (CNPJReceb) */ + readonly federalTaxNumberRecipient?: string | null; + /** @description Identificador do terminal de pagamento (idTermPag) */ + readonly idPaymentTerminal?: string | null; + }; + readonly CityResource: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code?: string | null; + /** @description Nome do Município */ + readonly name?: string | null; + }; + /** + * @description Grupo do COFINS + * + * ID: S01 + * Pai: M01 + * + * Obs: Informar apenas um dos grupos S02, S03, S04 ou S04 + * com base valor atribuído ao campo S06 – CST do COFINS + */ + readonly CofinsTaxResource: { + /** @description Código de Situação Tributária da COFINS */ + readonly cst?: string | null; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: double + * @description Valor da Base de Cálculo da COFINS (vBC) */ - readonly type?: "default" | "nFe" | "nFCe"; - }; - }; - readonly "text/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { + readonly baseTax?: number | null; + /** + * Format: double + * @description Alíquota da COFINS (em percentual) (pCOFINS) + */ + readonly rate?: number | null; /** - * @description Código do Estado - * @enum {string} + * Format: double + * @description Valor da COFINS (vCOFINS) */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly amount?: number | null; /** - * @description Ambiente - * @enum {string} + * Format: double + * @description Quantidade Vendida (qBCProd) */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly baseTaxProductQuantity?: number | null; /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: double + * @description Alíquota da COFINS (em reais) (vAliqProd) */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly productRate?: number | null; + }; + /** @description Nota Fiscal de Consumidor Eletrônica (NFCe) */ + readonly ConsumerInvoiceRequest: { + /** @description Identificador único */ + readonly id?: string | null; + /** @description Grupo de Formas de Pagamento (pag) */ + readonly payment?: readonly components["schemas"]["PaymentResource"][] | null; /** * Format: int32 - * @description Serie para a emissão NFe + * @description Série do Documento Fiscal (serie) */ - readonly serie: number; + readonly serie?: number | null; /** * Format: int64 - * @description Número para a emissão NFe + * @description Número do Documento Fiscal (nNF) */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly number?: number | null; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: date-time + * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) + * + * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. + * */ - readonly type?: "default" | "nFe" | "nFCe"; - }; - }; - readonly "application/*+json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { + readonly operationOn?: string | null; + /** @description Descrição da Natureza da Operação (natOp) */ + readonly operationNature?: string | null; + readonly operationType?: components["schemas"]["OperationType"]; + readonly destination?: components["schemas"]["Destination"]; + readonly printType?: components["schemas"]["PrintType"]; + readonly purposeType?: components["schemas"]["PurposeType"]; + readonly consumerType?: components["schemas"]["ConsumerType"]; + readonly presenceType?: components["schemas"]["ConsumerPresenceType"]; /** - * @description Código do Estado - * @enum {string} + * Format: date-time + * @description Data e Hora da entrada em contingência (dhCont) + * + * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD + * */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly contingencyOn?: string | null; + /** @description Justificativa da entrada em contingência (xJust) */ + readonly contingencyJustification?: string | null; + readonly buyer?: components["schemas"]["BuyerResource"]; + readonly transport?: components["schemas"]["TransportInformationResource"]; + readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; + /** @description Detalhamento de Produtos e Serviços (det) */ + readonly items: readonly components["schemas"]["InvoiceItemResource"][]; + readonly totals?: components["schemas"]["TotalResource"]; + readonly billing?: components["schemas"]["BillingResource"]; + readonly issuer?: components["schemas"]["IssuerFromRequestResource"]; + readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; + }; + /** @description Notas Fiscais de Consumidor Eletrônicas (NFC-e) */ + readonly ConsumerInvoicesResource: { + /** @description Lista de Notas Fiscais de Consumidor Eletrônicas (NFC-e) */ + readonly consumerInvoices?: readonly components["schemas"]["InvoiceWithoutEventsResource"][] | null; + /** @description Identificador de possibilidade de mais itens. */ + readonly hasMore?: boolean; + }; + /** + * @description Indicador de Presença (indPres ) + * @enum {string} + */ + readonly ConsumerPresenceType: "None" | "Presence" | "Internet" | "Telephone" | "Delivery" | "OthersNonPresenceOperation"; + /** + * @description Indica operação com Consumidor final (indFinal) + * @enum {string} + */ + readonly ConsumerType: "FinalConsumer" | "Normal"; + readonly ContingencyDetails: { + readonly authorizer?: components["schemas"]["StateTaxProcessingAuthorizer"]; /** - * @description Ambiente - * @enum {string} + * Format: date-time + * @description Data e hora do início da contingência */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly startedOn?: string; + /** @description Justificativa da entrada em contingência */ + readonly reason?: string | null; + }; + /** @description Identificação do Local de entrega (entrega) */ + readonly DeliveryInformationResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Nome ou Razão Social (xNome) */ + readonly name?: string | null; /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: int64 + * @description CNPJ ou CPF */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly federalTaxNumber?: number | null; + /** @description Email */ + readonly email?: string | null; + readonly address?: components["schemas"]["AddressResource"]; + readonly type?: components["schemas"]["PersonType"]; + /** @description Inscrição Estadual (IE) */ + readonly stateTaxNumber?: string | null; + }; + /** + * @description Identificador de local de destino da operação (idDest) + * @enum {string} + */ + readonly Destination: "None" | "Internal_Operation" | "Interstate_Operation" | "International_Operation"; + /** @description Dados para inutilizar números de nota fiscal */ + readonly DisablementResource: { + readonly environment?: components["schemas"]["EnvironmentType"]; /** * Format: int32 - * @description Serie para a emissão NFe + * @description Série */ - readonly serie: number; + readonly serie?: number; + readonly state?: components["schemas"]["StateCode"]; /** - * Format: int64 - * @description Número para a emissão NFe + * Format: int32 + * @description Número inicial */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly beginNumber?: number; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: int32 + * @description Número final (usar o mesmo número inicial se for apenas um número) */ - readonly type?: "default" | "nFe" | "nFCe"; - }; + readonly lastNumber?: number; + /** @description Motivo da inutilização */ + readonly reason?: string | null; }; - }; - }; - responses: { - /** @description Sucesso na criação da Inscrição Estadual */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Código da Empresa */ - readonly companyId?: string; - /** @description Account Id */ - readonly accountId?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "inactive" | "none" | "active"; - /** @description Todas as séries para esta Inscrição Estadual */ - readonly series?: readonly number[]; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * Format: int64 - * @description Número do Lote - */ - readonly batchId?: number; - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** - * @description Código do Estado - * @enum {string} - */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; - /** - * @description Ambiente - * @enum {string} - */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; - /** - * Format: int32 - * @description Serie para a emissão NFe - */ - readonly serie: number; - /** - * Format: int64 - * @description Número para a emissão NFe - */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; - /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} - */ - readonly type?: "default" | "nFe" | "nFCe"; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Consultar uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de uma empresas pelo ID. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - V2CompaniesByCompany_idStatetaxesByState_tax_idGet: { - parameters: { - path: { - /** @description ID da Empresa */ - company_id: string; - /** @description ID da Inscrição Estadual que deverá ser retornado */ - state_tax_id: string; - }; - }; - responses: { - /** @description Sucesso na consulta da Inscrição Estadual */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Código da Empresa */ - readonly companyId?: string; - /** @description Account Id */ - readonly accountId?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "inactive" | "none" | "active"; - /** @description Todas as séries para esta Inscrição Estadual */ - readonly series?: readonly number[]; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * Format: int64 - * @description Número do Lote - */ - readonly batchId?: number; - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** - * @description Código do Estado - * @enum {string} - */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; - /** - * @description Ambiente - * @enum {string} - */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; - /** - * Format: int32 - * @description Serie para a emissão NFe - */ - readonly serie: number; - /** - * Format: int64 - * @description Número para a emissão NFe - */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; - /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} - */ - readonly type?: "default" | "nFe" | "nFCe"; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Inscrição Estadual não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Alterar uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados de uma Inscrição Estadual pelo ID. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - V2CompaniesByCompany_idStatetaxesByState_tax_idPut: { - parameters: { - path: { - /** @description ID da Empresa */ - company_id: string; - /** @description ID da Inscrição Estadual que deverá ser retornado */ - state_tax_id: string; - }; - }; - /** @description Dados da Inscrição Estadual a ser alterada */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; + readonly DocumentElectronicInvoiceResource: { + /** @description Chave de Acesso (refNFe) */ + readonly accessKey?: string | null; + }; + readonly DocumentInvoiceReferenceResource: { /** - * @description Código do Estado - * @enum {string} + * Format: double + * @description Código da UF (cUF) */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly state?: number | null; + /** @description Ano / Mês (AAMM) */ + readonly yearMonth?: string | null; + /** @description CNPJ (CNPJ) */ + readonly federalTaxNumber?: string | null; + /** @description Modelo (mod) */ + readonly model?: string | null; + /** @description Série (serie) */ + readonly series?: string | null; + /** @description Número (nNF) */ + readonly number?: string | null; + }; + /** + * @description Indicador de intermediador/marketplace (indIntermed) + * @enum {string} + */ + readonly DuductionIndicator: "NotDeduct" | "Deduce"; + readonly DuplicateResource: { + /** @description Número da Duplicata (nDup) */ + readonly number?: string | null; /** - * @description Ambiente - * @enum {string} + * Format: date-time + * @description Data de vencimento (dVenc) */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly expirationOn?: string | null; /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: double + * @description Valor da duplicata (vDup) */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly amount?: number | null; + }; + readonly EconomicActivityResource: { + readonly type?: components["schemas"]["EconomicActivityType"]; /** * Format: int32 - * @description Serie para a emissão NFe + * @description Código da Atividade da Empresa */ - readonly serie: number; + readonly code?: number | null; + }; + /** @enum {string} */ + readonly EconomicActivityType: "Main" | "Secondary"; + /** @enum {string} */ + readonly EnvironmentType: "None" | "Production" | "Test"; + readonly ErrorResource: { + /** Format: int32 */ + readonly code?: number | null; + readonly message?: string | null; + }; + readonly ErrorsResource: { + readonly errors?: readonly components["schemas"]["ErrorResource"][] | null; + }; + /** + * @description Campo será preenchido quando o campo anterior estiver + * preenchido.Informar o motivo da desoneração: + * @enum {string} + */ + readonly ExemptReason: "Agriculture" | "Others" | "DevelopmentEntities"; + readonly ExportDetailResource: { + /** @description Número do ato concessório de Drawback (nDraw) */ + readonly drawback?: string | null; + readonly hintInformation?: components["schemas"]["ExportHintResource"]; + }; + readonly ExportHintResource: { + /** @description Número do Registro de Exportação (nRE) */ + readonly registryId?: string | null; + /** @description Chave de Acesso da NF-e recebida para exportação (chNFe) */ + readonly accessKey?: string | null; /** - * Format: int64 - * @description Número para a emissão NFe + * Format: double + * @description Quantidade do item realmente exportado (qExport) */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly quantity?: number | null; + }; + readonly ExportResource: { + readonly state?: components["schemas"]["StateCode"]; + /** @description Descrição do Local de Embarque ou de transposição de fronteira (xLocExporta) */ + readonly office?: string | null; + /** @description Informações Complementares de interesse do Contribuinte (xLocDespacho) */ + readonly local?: string | null; + }; + /** @description Arquivo */ + readonly FileResource: { + /** @description Endereço Absoluto URI para o arquivo */ + readonly uri?: string | null; + }; + /** @enum {string} */ + readonly FlagCard: "None" | "Visa" | "Mastercard" | "AmericanExpress" | "Sorocred" | "DinersClub" | "Elo" | "Hipercard" | "Aura" | "Cabal" | "Alelo" | "BanesCard" | "CalCard" | "Credz" | "Discover" | "GoodCard" | "GreenCard" | "Hiper" | "JCB" | "Mais" | "MaxVan" | "Policard" | "RedeCompras" | "Sodexo" | "ValeCard" | "Verocheque" | "VR" | "Ticket" | "Other"; + readonly FuelOriginResource: { + /** + * Format: int32 + * @description Indicador de importação (indImport) + */ + readonly indImport?: number | null; + /** + * Format: int32 + * @description Código da UF (cUFOrig) + */ + readonly cUFOrig?: number | null; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: double + * @description Percentual originário para a UF (pOrig) */ - readonly type?: "default" | "nFe" | "nFCe"; - }; + readonly pOrig?: number | null; }; - readonly "text/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; + readonly FuelResource: { + /** @description Código de produto da ANP (cProdANP) */ + readonly codeANP?: string | null; /** - * @description Código do Estado - * @enum {string} + * Format: double + * @description Percentual de Gás Natural para o produto GLP (cProdANP=210203001) (pMixGN) */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly percentageNG?: number | null; + /** @description Descrição do produto conforme ANP (descANP) */ + readonly descriptionANP?: string | null; /** - * @description Ambiente - * @enum {string} + * Format: double + * @description Percentual do GLP derivado do petróleo no produto GLP (cProdANP=210203001) (pGLP) */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly percentageGLP?: number | null; /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: double + * @description Percentual de Gás Natural Nacional – GLGNn para o produto GLP (cProdANP= 210203001) (pGNn) */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly percentageNGn?: number | null; /** - * Format: int32 - * @description Serie para a emissão NFe + * Format: double + * @description Percentual de Gás Natural Importado – GLGNi para o produto GLP (cProdANP= 210203001) (pGNi) */ - readonly serie: number; + readonly percentageGNi?: number | null; /** - * Format: int64 - * @description Número para a emissão NFe + * Format: double + * @description Valor de partida (cProdANP=210203001) (vPart) */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly startingAmount?: number | null; + /** @description Código de autorização / registro do CODIF (CODIF) */ + readonly codif?: string | null; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: double + * @description Quantidade de combustível faturada à temperatura ambiente (qTemp) */ - readonly type?: "default" | "nFe" | "nFCe"; - }; - }; - readonly "application/*+json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; + readonly amountTemp?: number | null; + /** @description Sigla da UF de consumo (UFCons) */ + readonly stateBuyer?: string | null; + readonly cide?: components["schemas"]["CIDEResource"]; + readonly pump?: components["schemas"]["PumpResource"]; + readonly fuelOrigin?: components["schemas"]["FuelOriginResource"]; + }; + /** + * @description Manual Contribuinte v_5.00 + * Grupo de Valores Totais referentes ao ICMS + */ + readonly ICMSTotalResource: { /** - * @description Código do Estado - * @enum {string} + * Format: double + * @description Base de Cálculo do ICMS (vBC) */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly baseTax?: number | null; /** - * @description Ambiente - * @enum {string} + * Format: double + * @description Valor Total do ICMS (vICMS) */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly icmsAmount?: number | null; /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: double + * @description Valor ICMS Total desonerado (vICMSDeson) */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly icmsExemptAmount?: number | null; /** - * Format: int32 - * @description Serie para a emissão NFe + * Format: double + * @description Base de Cálculo do ICMS Substituição Tributária (vBCST) */ - readonly serie: number; + readonly stCalculationBasisAmount?: number | null; /** - * Format: int64 - * @description Número para a emissão NFe + * Format: double + * @description Valor Total do ICMS ST (vST) */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly stAmount?: number | null; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: double + * @description Valor Total dos produtos e serviços (vProd) */ - readonly type?: "default" | "nFe" | "nFCe"; - }; - }; - }; - }; - responses: { - /** @description Sucesso na alteração da Inscrição Estadual */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Código da Empresa */ - readonly companyId?: string; - /** @description Account Id */ - readonly accountId?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "inactive" | "none" | "active"; - /** @description Todas as séries para esta Inscrição Estadual */ - readonly series?: readonly number[]; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * Format: int64 - * @description Número do Lote - */ - readonly batchId?: number; - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** - * @description Código do Estado - * @enum {string} - */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; - /** - * @description Ambiente - * @enum {string} - */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; - /** - * Format: int32 - * @description Serie para a emissão NFe - */ - readonly serie: number; - /** - * Format: int64 - * @description Número para a emissão NFe - */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; - /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} - */ - readonly type?: "default" | "nFe" | "nFCe"; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Inscrição Estadual não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Excluir uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir uma Inscrição Estadual pelo ID, cuidado pois esse processo é irreversível. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - V2CompaniesByCompany_idStatetaxesByState_tax_idDelete: { - parameters: { - path: { - /** @description ID da Empresa */ - company_id: string; - /** @description ID da Inscrição Estadual que deverá ser retornado */ - state_tax_id: string; - }; - }; - responses: { - /** @description Sucesso na exclusão da Inscrição Estadual */ - 204: { - content: { - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Inscrição Estadual não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Listar os Tipos de Eventos gerados pela plataforma - * @description ### Informações adicionais - * - * Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados - * criando notificações para os webhooks ativos e configurados para receber os eventos. - * - * São identificados seguindo o padrão **Resource.EventAction**, - * onde **Resource**: nome da entidade que gerou o evento; - * **EventAction**: nome do evento e ação criados. - * - * Esse tipos podem ser utilizados como filtro ao criar ou alterar um webhook, - * sendo que o filtro determina quais notificações de eventos e ação serão enviadas - * para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook - * ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros. - */ - V2WebhooksEventTypesGet: { - responses: { - /** @description Sucesso na consulta do tipos de eventos */ - 200: { - content: { - readonly "application/json": { - /** @description Lista de Evento */ - readonly eventTypes?: readonly { - /** - * @description Identificador do evento, seguem o padrão **Resource.EventAction**. - * Onde **Resource**: nome da entidade que gerou o evento; - * **EventAction**: nome do evento e ação criados. - * Alguns exemplos **Invoice.Issued** ou **Blob.Updated** - */ - readonly id?: string; - /** @description Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. */ - readonly description?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Listar os Webhooks - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar uma lista de **Webhooks** cadastrados na Conta Autenticada. - */ - V2WebhooksGet: { - responses: { - /** @description Sucesso na consulta da lista */ - 200: { - content: { - readonly "application/json": { - /** @description Lista de Web Hook */ - readonly webHooks?: readonly ({ - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} - */ - readonly contentType?: "json" | "form-urlencoded"; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} - */ - readonly status?: "active" | "inactive"; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - })[]; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Criar um Webhook - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novos **Webhooks** para receber as notificações de eventos ocorridos na plataforma. - * - * Na criação do **Webhook** a URL informada no cadastro deve ser responsiva, ou seja, deverá responder *(HTTP Status 200 OK)* a uma requisição *(HTTP POST)* que será feita para testar se a URL está operando como normalmente, caso contrario uma mensagem de erro será retornada. - * - * Um **Webhook** é semelhante a uma assinatura em um *sistema de publicação e assinatura* - * que permite ao assinante indicar *quando*, *como* e *onde* as notificações de eventos deve ser despachadas. - * Um **Webhook** é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos - * que podem ser acionados por eventos gerados através de ações executadas por esse Conta. - * Ou seja, a __Conta da *Empresa A*__ não verá os WebHooks disparados por uma ação executada pelo usuário __Conta da *Empresa B*__. - */ - V2WebhooksPost: { - readonly requestBody?: { - readonly content: { - readonly "application/json-patch+json": { - /** @description Dados para criar um Web Hook */ - readonly webHook?: { + readonly productAmount?: number | null; /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + * Format: double + * @description Valor Total do Frete (vFrete) */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; + readonly freightAmount?: number | null; /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + * Format: double + * @description Valor Total do Seguro (vSeg) */ - readonly secret?: string; + readonly insuranceAmount?: number | null; /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} + * Format: double + * @description Valor Total do Desconto (vDesc) */ - readonly contentType?: "json" | "form-urlencoded"; + readonly discountAmount?: number | null; /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + * Format: double + * @description Valor Total do Imposto de Importação (vII) */ - readonly insecureSsl?: boolean; + readonly iiAmount?: number | null; /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} + * Format: double + * @description Valor Total do IPI (vIPI) */ - readonly status?: "active" | "inactive"; + readonly ipiAmount?: number | null; /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + * Format: double + * @description Valor do PIS (vPIS) */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; + readonly pisAmount?: number | null; /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + * Format: double + * @description Valor do COFINS (vCOFINS) */ - readonly properties?: { - [key: string]: Record; - }; + readonly cofinsAmount?: number | null; /** - * Format: date-time - * @description Data de criação do webhook + * Format: double + * @description Outras Despesas acessórias (vOutro) */ - readonly createdOn?: string; + readonly othersAmount?: number | null; /** - * Format: date-time - * @description Data de modificação do webhook + * Format: double + * @description Valor Total da NF-e (vNF) */ - readonly modifiedOn?: string; - }; - }; - readonly "application/json": { - /** @description Dados para criar um Web Hook */ - readonly webHook?: { + readonly invoiceAmount?: number | null; /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + * Format: double + * @description Valor Total ICMS FCP UF Destino (vFCPUFDest) */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; + readonly fcpufDestinationAmount?: number | null; /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + * Format: double + * @description Valor Total ICMS Interestadual UF Destino (vICMSUFDest) */ - readonly secret?: string; + readonly icmsufDestinationAmount?: number | null; /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} + * Format: double + * @description Valor Total ICMS Interestadual UF Remetente (vICMSUFRemet) */ - readonly contentType?: "json" | "form-urlencoded"; + readonly icmsufSenderAmount?: number | null; /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + * Format: double + * @description Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib) */ - readonly insecureSsl?: boolean; + readonly federalTaxesAmount?: number | null; /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} + * Format: double + * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) */ - readonly status?: "active" | "inactive"; + readonly fcpAmount?: number | null; /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + * Format: double + * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST) */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; + readonly fcpstAmount?: number | null; /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + * Format: double + * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) */ - readonly properties?: { - [key: string]: Record; - }; + readonly fcpstRetAmount?: number | null; /** - * Format: date-time - * @description Data de criação do webhook + * Format: double + * @description Valor total do IPI devolvido (vIPIDevol) */ - readonly createdOn?: string; + readonly ipiDevolAmount?: number | null; /** - * Format: date-time - * @description Data de modificação do webhook + * Format: double + * @description Valor total da quantidade tributada do ICMS monofásico próprio (qBCMono) */ - readonly modifiedOn?: string; - }; - }; - readonly "text/json": { - /** @description Dados para criar um Web Hook */ - readonly webHook?: { + readonly qBCMono?: number | null; /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + * Format: double + * @description Valor total do ICMS monofásico próprio (vICMSMono) */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; + readonly vICMSMono?: number | null; /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + * Format: double + * @description Valor total da quantidade tributada do ICMS monofásico sujeito a retenção(qBCMonoReten) */ - readonly secret?: string; + readonly qBCMonoReten?: number | null; /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} + * Format: double + * @description Valor total do ICMS monofásico sujeito a retenção (vICMSMonoReten) */ - readonly contentType?: "json" | "form-urlencoded"; + readonly vICMSMonoReten?: number | null; /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + * Format: double + * @description Valor total da quantidade tributada do ICMS monofásico retido anteriormente(qBCMonoRet) */ - readonly insecureSsl?: boolean; + readonly qBCMonoRet?: number | null; /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} + * Format: double + * @description Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) */ - readonly status?: "active" | "inactive"; + readonly vICMSMonoRet?: number | null; + }; + /** @description Grupo de Tributação do ICMS de Destino da UF */ + readonly ICMSUFDestinationTaxResource: { /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + * Format: double + * @description Valor da Base de Cálculo do ICMS na UF de destino (vBCUFDest) */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; + readonly vBCUFDest?: number | null; /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + * Format: double + * @description Percentual adicional inserido na alíquota interna da UF de destino, relativo ao Fundo de Combate à Pobreza (FCP) naquela UF (pFCPUFDest) */ - readonly properties?: { - [key: string]: Record; - }; + readonly pFCPUFDest?: number | null; /** - * Format: date-time - * @description Data de criação do webhook + * Format: double + * @description Alíquota adotada nas operações internas na UF de destino para o produto / mercadoria (pICMSUFDest) */ - readonly createdOn?: string; + readonly pICMSUFDest?: number | null; /** - * Format: date-time - * @description Data de modificação do webhook + * Format: double + * @description Alíquota interestadual das UF envolvidas (pICMSInter) */ - readonly modifiedOn?: string; - }; - }; - readonly "application/*+json": { - /** @description Dados para criar um Web Hook */ - readonly webHook?: { + readonly pICMSInter?: number | null; /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + * Format: double + * @description Percentual de ICMS Interestadual para a UF de destino (pICMSInterPart) */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; + readonly pICMSInterPart?: number | null; /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + * Format: double + * @description Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de destino (vFCPUFDest */ - readonly secret?: string; + readonly vFCPUFDest?: number | null; /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} + * Format: double + * @description Valor do ICMS Interestadual para a UF de destino (vICMSUFDest) */ - readonly contentType?: "json" | "form-urlencoded"; + readonly vICMSUFDest?: number | null; /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + * Format: double + * @description Valor do ICMS Interestadual para a UF do remetente (vICMSUFRemet) */ - readonly insecureSsl?: boolean; + readonly vICMSUFRemet?: number | null; /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} + * Format: double + * @description Valor da BC FCP na UF de destino (vBCFCPUFDest) */ - readonly status?: "active" | "inactive"; + readonly vBCFCPUFDest?: number | null; + }; + /** + * @description Grupo do Imposto de Importação + * + * Id: P01 + * Pai: O01 + */ + readonly IITaxResource: { + /** @description Valor BC do Imposto de Importação (vBC) */ + readonly baseTax?: string | null; + /** @description Valor despesas aduaneiras (vDespAdu) */ + readonly customsExpenditureAmount?: string | null; /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + * Format: double + * @description Valor Imposto de Importação (vII) */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; + readonly amount?: number | null; /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + * Format: double + * @description Valor Imposto sobre Operações Financeiras (vIOF) */ - readonly properties?: { - [key: string]: Record; - }; + readonly iofAmount?: number | null; /** - * Format: date-time - * @description Data de criação do webhook + * Format: double + * @description Valor dos encargos cambiais */ - readonly createdOn?: string; + readonly vEnqCamb?: number | null; + }; + /** + * @description Grupo do IPI + * + * Informar apenas quando o item for sujeito ao IPI + * + * ID: O01 + * + * Pai: M01 + */ + readonly IPITaxResource: { + /** @description Código da situação tributária do IPI (CST) */ + readonly cst?: string | null; + /** @description Código de Enquadramento Legal do IPI (cEnq) */ + readonly classificationCode?: string | null; /** - * Format: date-time - * @description Data de modificação do webhook + * @description clEnq + * Classe de enquadramento do IPI para Cigarros e Bebidas (clEnq) */ - readonly modifiedOn?: string; - }; - }; - }; - }; - responses: { - /** @description Sucesso na criação da webhook */ - 201: { - content: { - readonly "application/json": { - /** @description Dados do Web Hook */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} - */ - readonly contentType?: "json" | "form-urlencoded"; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} - */ - readonly status?: "active" | "inactive"; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Webhook não encontrado */ - 404: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Excluir Todos os Webhooks existentes - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir todos os **Webhooks** cadastrados para a Conta Autenticada. - */ - V2WebhooksDelete: { - responses: { - /** @description Sucesso na exclusão dos WebHooks */ - 204: { - content: { - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Consultar um webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**. - */ - V2WebhooksByWebhook_idGet: { - parameters: { - path: { - /** @description ID do webhook a ser consultado */ - webhook_id: string; - }; - }; - responses: { - /** @description Sucesso na consulta do webhook */ - 200: { - content: { - readonly "application/json": { - /** @description Dados do Web Hook */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} - */ - readonly contentType?: "json" | "form-urlencoded"; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} - */ - readonly status?: "active" | "inactive"; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Webhook não encontrado */ - 404: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Alterar um Webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados do **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. - */ - V2WebhooksByWebhook_idPut: { - parameters: { - path: { - /** @description ID do Webhook a ser atualizado */ - webhook_id: string; - }; - }; - /** @description Dados para alterar o Webhook */ - readonly requestBody?: { - readonly content: { - readonly "application/json-patch+json": { - /** @description Dados do Web Hook */ - readonly webHook?: { + readonly classification?: string | null; + /** @description CNPJ do produtor da mercadoria, quando diferente do emitente. Somente para os casos de exportação direta ou indireta (CNPJProd) */ + readonly producerCNPJ?: string | null; + /** @description Código do selo de controle IPI (cSelo) */ + readonly stampCode?: string | null; /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + * Format: double + * @description Quantidade de selo de controle (qSelo) */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; + readonly stampQuantity?: number | null; /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + * Format: double + * @description Valor da BC do IPI (vBC) */ - readonly secret?: string; + readonly base?: number | null; /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} + * Format: double + * @description Alíquota do IPI (pIPI) */ - readonly contentType?: "json" | "form-urlencoded"; + readonly rate?: number | null; /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + * Format: double + * @description Quantidade total na unidade padrão para tributação (somente para os produtos tributados por unidade) (qUnid) */ - readonly insecureSsl?: boolean; + readonly unitQuantity?: number | null; /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} + * Format: double + * @description Valor por Unidade Tributável (vUnid) */ - readonly status?: "active" | "inactive"; + readonly unitAmount?: number | null; /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + * Format: double + * @description Valor IPI (vIPI) */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; + readonly amount?: number | null; + }; + readonly ISSQNTotalResource: { /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + * Format: double + * @description Valor Total Serv.Não Tributados p/ ICMS (vServ) */ - readonly properties?: { - [key: string]: Record; - }; + readonly totalServiceNotTaxedICMS?: number | null; /** - * Format: date-time - * @description Data de criação do webhook + * Format: double + * @description Base de Cálculo do ISS (vBC) + */ + readonly baseRateISS?: number | null; + /** + * Format: double + * @description Valor Total do ISS (vISS) + */ + readonly totalISS?: number | null; + /** + * Format: double + * @description Valor do PIS sobre Serviços (vPIS) + */ + readonly valueServicePIS?: number | null; + /** + * Format: double + * @description Valor da COFINS sobre Serviços (vCOFINS) */ - readonly createdOn?: string; + readonly valueServiceCOFINS?: number | null; /** * Format: date-time - * @description Data de modificação do webhook + * @description Data Prestação Serviço (dCompet) */ - readonly modifiedOn?: string; - }; - }; - readonly "application/json": { - /** @description Dados do Web Hook */ - readonly webHook?: { + readonly provisionService?: string | null; /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + * Format: double + * @description Valor Dedução para Redução da BC (vDeducao) */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; + readonly deductionReductionBC?: number | null; /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + * Format: double + * @description Valor Outras Retenções (vOutro) */ - readonly secret?: string; + readonly valueOtherRetention?: number | null; /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} + * Format: double + * @description Valor Desconto Incondicionado (vDescIncond) */ - readonly contentType?: "json" | "form-urlencoded"; + readonly discountUnconditional?: number | null; /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + * Format: double + * @description Valor Desconto Condicionado (vDescCond) */ - readonly insecureSsl?: boolean; + readonly discountConditioning?: number | null; /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} + * Format: double + * @description Valor Total Retenção ISS (vISSRet) */ - readonly status?: "active" | "inactive"; + readonly totalRetentionISS?: number | null; /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + * Format: double + * @description Código Regime Tributação (cRegTrib) */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; + readonly codeTaxRegime?: number | null; + }; + /** + * @description Grupo do ICMS da Operação própria e ST + * + * ID: N01 + * PAI: M01 + * + * Obs: Informar apenas um dos grupos N02, N03, N04, N05, N06, N07, N08, N09, N10, + * N10a, N10b, N10c, N10d, N10e, N10f, N10g ou N10h com base no conteúdo informado na TAG Tributação do ICMS. (v2.0) + */ + readonly IcmsTaxResource: { + /** @description Origem da mercadoria (orig) */ + readonly origin?: string | null; + /** @description Tributação do ICMS (CST) */ + readonly cst?: string | null; /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + * @description 101- Tributada pelo Simples Nacional com permissão de crédito. (v.2.0) (CSOSN) + * Código de Situação da Operação – Simples Nacional */ - readonly properties?: { - [key: string]: Record; - }; + readonly csosn?: string | null; + /** + * @description Modalidade de determinação da BC do ICMS (modBC) + * + * Margem Valor Agregado (%) = 0 + * Pauta (valor) = 1 + * Preço Tabelado Máximo (valor) = 2 + * Valor da Operação = 3 + * + */ + readonly baseTaxModality?: string | null; + /** + * Format: double + * @description Valor da BC do ICMS (vBC) + */ + readonly baseTax?: number | null; + /** @description Modalidade de determinação da BC do ICMS ST (modBCST) */ + readonly baseTaxSTModality?: string | null; + /** + * @description pRedBCST + * Percentual da Redução de BC do ICMS ST (pRedBCST) + */ + readonly baseTaxSTReduction?: string | null; + /** + * Format: double + * @description Valor da BC do ICMS ST (vBCST) + */ + readonly baseTaxST?: number | null; + /** + * Format: double + * @description Percentual da Redução de BC (pRedBC) + */ + readonly baseTaxReduction?: number | null; + /** + * Format: double + * @description Alíquota do imposto do ICMS ST (pICMSST) + */ + readonly stRate?: number | null; + /** + * Format: double + * @description Valor do ICMS ST (vICMSST) + */ + readonly stAmount?: number | null; + /** + * Format: double + * @description pMVAST + * Percentual da margem de valor Adicionado do ICMS ST (pMVAST) + */ + readonly stMarginAmount?: number | null; + /** + * Format: double + * @description pICMS + * Alíquota do imposto (pICMS) + */ + readonly rate?: number | null; + /** + * Format: double + * @description Valor do ICMS (vICMS) + * O valor do ICMS desonerado será informado apenas nas operações: + * a) com produtos beneficiados com a desoneração condicional do ICMS. + * b) destinadas à SUFRAMA, informando-se o valor que seria devido se não houvesse isenção. + * c) de venda a órgãos da administração pública direta e suas fundações e + * autarquias com isenção do ICMS. (NT 2011/004) + */ + readonly amount?: number | null; + /** + * Format: double + * @description Percentual da Redução de BC (pICMS) + */ + readonly percentual?: number | null; + /** + * Format: double + * @description Alíquota aplicável de cálculo do crédito (Simples Nacional). (pCredSN) + */ + readonly snCreditRate?: number | null; + /** + * Format: double + * @description Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 Simples Nacional (vCredICMSSN) + */ + readonly snCreditAmount?: number | null; + /** @description Percentual da margem de valor Adicionado do ICMS ST (pMVAST) */ + readonly stMarginAddedAmount?: string | null; + /** @description Valor do ICMS ST retido (vICMSSTRet) */ + readonly stRetentionAmount?: string | null; + /** @description Valor da BC do ICMS ST retido (vBCSTRet) */ + readonly baseSTRetentionAmount?: string | null; + /** + * @description Percentual da BC operação própria (pBCOp) + * Percentual para determinação do valor da Base de Cálculo da operação própria. (v2.0) + */ + readonly baseTaxOperationPercentual?: string | null; + /** + * @description UF para qual é devido o ICMS ST (UFST) + * Sigla da UF para qual é devido o ICMS ST da operação. (v2.0) + */ + readonly ufst?: string | null; + /** @description Motivo Desoneração ICMS */ + readonly amountSTReason?: string | null; + /** @description Valor da BC do ICMS ST retido (vBCSTRet) */ + readonly baseSNRetentionAmount?: string | null; + /** @description Valor do ICMS ST retido (vICMSSTRet) */ + readonly snRetentionAmount?: string | null; + /** @description Valor do ICMS da Operação (vICMSOp) */ + readonly amountOperation?: string | null; + /** @description Percentual do Diferimento (pDif) */ + readonly percentualDeferment?: string | null; + /** @description Valor do ICMS Diferido (vICMSDif) */ + readonly baseDeferred?: string | null; + /** + * Format: double + * @description Valor ICMS Desonerado + */ + readonly exemptAmount?: number | null; + readonly exemptReason?: components["schemas"]["ExemptReason"]; + /** + * Format: double + * @description Valor ICMS Desonerado + */ + readonly exemptAmountST?: number | null; + readonly exemptReasonST?: components["schemas"]["ExemptReason"]; + /** + * Format: double + * @description Percentual do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (pFCP) + */ + readonly fcpRate?: number | null; + /** + * Format: double + * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) + */ + readonly fcpAmount?: number | null; + /** + * Format: double + * @description Percentual do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (pFCPST) + */ + readonly fcpstRate?: number | null; + /** + * Format: double + * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST) + */ + readonly fcpstAmount?: number | null; + /** + * Format: double + * @description Percentual do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (pFCPSTRet) + */ + readonly fcpstRetRate?: number | null; + /** + * Format: double + * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) + */ + readonly fcpstRetAmount?: number | null; + /** + * Format: double + * @description Informar o valor da Base de Cálculo do FCP (vBCFCPST) + */ + readonly baseTaxFCPSTAmount?: number | null; + /** + * Format: double + * @description Valor do ICMS próprio do Substituto (tag: vICMSSubstituto) + */ + readonly substituteAmount?: number | null; + /** + * Format: double + * @description N26a - Alíquota suportada pelo Consumidor Final (pST) + * Deve ser informada a alíquota do cálculo do ICMS-ST, já incluso o FCP caso incida sobre a mercadoria + */ + readonly stFinalConsumerRate?: number | null; + /** + * Format: double + * @description N34 - Percentual de redução da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (pRedBCEfet) + */ + readonly effectiveBaseTaxReductionRate?: number | null; + /** + * Format: double + * @description N35 - Valor da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (vBCEfet) + */ + readonly effectiveBaseTaxAmount?: number | null; + /** + * Format: double + * @description N36 - Alíquota do ICMS efetiva, caso estivesse submetida ao regime comum de tributação (pICMSEFET) + */ + readonly effectiveRate?: number | null; + /** + * Format: double + * @description N37 - Valor do ICMS efetivo, caso estivesse submetida ao regime comum de tributação (vICMSEFET) + */ + readonly effectiveAmount?: number | null; + readonly deductionIndicator?: components["schemas"]["DuductionIndicator"]; + }; + /** @description Declaração Importação (DI) */ + readonly ImportDeclarationResource: { + /** @description Número do Documento de Importação da DI/DSI/DA (nDI) */ + readonly code?: string | null; /** * Format: date-time - * @description Data de criação do webhook + * @description Data de Registro da DI/DSI/DA (dDI) */ - readonly createdOn?: string; + readonly registeredOn?: string | null; + /** @description Local de desembaraço (xLocDesemb) */ + readonly customsClearanceName?: string | null; + readonly customsClearanceState?: components["schemas"]["StateCode"]; /** * Format: date-time - * @description Data de modificação do webhook + * @description Data do Desembaraço Aduaneiro (dDesemb) */ - readonly modifiedOn?: string; - }; - }; - readonly "text/json": { - /** @description Dados do Web Hook */ - readonly webHook?: { + readonly customsClearancedOn?: string | null; + /** @description Adições (adi) */ + readonly additions?: readonly components["schemas"]["AdditionResource"][] | null; + /** @description Código do exportador (cExportador) */ + readonly exporter?: string | null; + readonly internationalTransport?: components["schemas"]["InternationalTransportType"]; + readonly intermediation?: components["schemas"]["IntermediationType"]; + /** @description CNPJ/CPF do adquirente ou do encomendante (CNPJ ou CPF) */ + readonly acquirerFederalTaxNumber?: string | null; + /** @description Sigla da UF do adquirente ou do encomendante (UFTerceiro) */ + readonly stateThird?: string | null; + }; + /** + * @description 1 - Pagamento integrado com o sistema de automação da empresa(Ex.: equipamento TEF, Comércio Eletrônico) + * 2 - Pagamento não integrado com o sistema de automação da empresa(Ex.: equipamento POS); + * @enum {string} + */ + readonly IntegrationPaymentType: "Integrated" | "NotIntegrated"; + /** @description Grupo de Informações do Intermediador da Transação (infIntermed) */ + readonly IntermediateResource: { /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + * Format: int64 + * @description CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios. (CNPJ) */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; + readonly federalTaxNumber?: number | null; + /** @description Identificador cadastrado no intermediador (idCadIntTran) */ + readonly identifier?: string | null; + }; + /** + * @description Tipo de Intermediação + * @enum {string} + */ + readonly IntermediationType: "None" | "ByOwn" | "ImportOnBehalf" | "ByOrder"; + /** + * @description Tipo Transporte Internacional + * @enum {string} + */ + readonly InternationalTransportType: "None" | "Maritime" | "River" | "Lake" | "Airline" | "Postal" | "Railway" | "Highway" | "Network" | "Own" | "Ficta" | "Courier" | "Handcarry"; + readonly InvoiceEventsResource: { + /** @description Lista de Eventos ocorridos na Nota Fiscal */ + readonly events?: readonly components["schemas"]["ActivityResource"][] | null; + /** @description Identificador de possibilidade de mais itens. */ + readonly hasMore?: boolean | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificador da Empresa */ + readonly companyId?: string | null; + }; + readonly InvoiceEventsResourceBase: { + /** @description Lista de Eventos ocorridos na Nota Fiscal */ + readonly events?: readonly components["schemas"]["ActivityResource"][] | null; + /** @description Identificador de possibilidade de mais itens. */ + readonly hasMore?: boolean | null; + }; + /** + * @description Manual Contribuinte v_5.00 + * Grupo do detalhamento de Produtos e Serviços da NF-e + */ + readonly InvoiceItemResource: { + /** @description Código do produto ou serviço (cProd) */ + readonly code?: string | null; /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + * @description GTIN (Global Trade Item Number) do produto, + * antigo código EAN ou código de barras (cEAN) */ - readonly secret?: string; + readonly codeGTIN?: string | null; + /** @description Descrição do produto ou serviço (xProd) */ + readonly description?: string | null; + /** @description Código NCM com 8 dígitos ou 2 dígitos (gênero) (NCM) */ + readonly ncm?: string | null; + /** @description Nomenclatura de Valor aduaneiro e Estatístico (NVE) */ + readonly nve?: readonly string[] | null; + /** @description Código Exceção da Tabela de IPI */ + readonly extipi?: string | null; /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} + * Format: int64 + * @description Código Fiscal de Operações e Prestações (CFOP) */ - readonly contentType?: "json" | "form-urlencoded"; + readonly cfop?: number | null; + /** @description Unidade Comercial (uCom) */ + readonly unit?: string | null; /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + * Format: double + * @description Quantidade Comercial (qCom) */ - readonly insecureSsl?: boolean; + readonly quantity?: number | null; /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} + * Format: double + * @description Valor Unitário de Comercialização (vUnCom) */ - readonly status?: "active" | "inactive"; + readonly unitAmount?: number | null; /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + * Format: double + * @description Valor Total Bruto dos Produtos ou Serviços (vProd) */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; + readonly totalAmount?: number | null; /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + * @description GTIN (Global Trade Item Number) da unidade tributável, + * antigo código EAN ou código de barras (cEANTrib) */ - readonly properties?: { - [key: string]: Record; - }; + readonly codeTaxGTIN?: string | null; + /** @description Unidade Tributável (uTrib) */ + readonly unitTax?: string | null; + /** + * Format: double + * @description Quantidade Tributável (qTrib) + */ + readonly quantityTax?: number | null; + /** + * Format: double + * @description Valor Unitário de tributação (vUnTrib) + */ + readonly taxUnitAmount?: number | null; + /** + * Format: double + * @description Valor Total do Frete (vFrete) + */ + readonly freightAmount?: number | null; + /** + * Format: double + * @description Valor Total do Seguro (vSeg) + */ + readonly insuranceAmount?: number | null; + /** + * Format: double + * @description Valor do Desconto (vDesc) + */ + readonly discountAmount?: number | null; + /** + * Format: double + * @description Outras despesas acessórias (vOutro) + */ + readonly othersAmount?: number | null; + /** + * @description Indica se valor do Item (vProd) + * entra no valor total da NF-e (vProd) (indTot) + */ + readonly totalIndicator?: boolean | null; + /** @description CEST - Código especificador da substituição tributária */ + readonly cest?: string | null; + readonly tax?: components["schemas"]["InvoiceItemTaxResource"]; + /** @description Informações Adicionais do Produto (infAdProd) */ + readonly additionalInformation?: string | null; + /** @description Número do pedido de compra (xPed) */ + readonly numberOrderBuy?: string | null; + /** + * Format: int32 + * @description Item do Pedido de Compra (nItemPed) + */ + readonly itemNumberOrderBuy?: number | null; + /** @description Número de controle da FCI - Ficha de Conteúdo de Importação (nFCI) */ + readonly importControlSheetNumber?: string | null; + readonly fuelDetail?: components["schemas"]["FuelResource"]; + /** @description Código de Benefício Fiscal na UF aplicado ao item (cBenef) */ + readonly benefit?: string | null; + /** @description Declaração Importação (DI) */ + readonly importDeclarations?: readonly components["schemas"]["ImportDeclarationResource"][] | null; + /** @description Grupo de informações de exportação para o item (detExport) */ + readonly exportDetails?: readonly components["schemas"]["ExportDetailResource"][] | null; + readonly taxDetermination?: components["schemas"]["TaxDeterminationResource"]; + }; + readonly InvoiceItemTaxResource: { + /** + * Format: double + * @description Valor aproximado total de tributos federais, estaduais e municipais (vTotTrib) + */ + readonly totalTax?: number | null; + readonly icms?: components["schemas"]["IcmsTaxResource"]; + readonly ipi?: components["schemas"]["IPITaxResource"]; + readonly ii?: components["schemas"]["IITaxResource"]; + readonly pis?: components["schemas"]["PISTaxResource"]; + readonly cofins?: components["schemas"]["CofinsTaxResource"]; + readonly icmsDestination?: components["schemas"]["ICMSUFDestinationTaxResource"]; + }; + readonly InvoiceItemsResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificador da Empresa */ + readonly companyId?: string | null; + /** @description Identificador da Nota Fiscal */ + readonly id?: string | null; + /** @description Detalhamento de Produtos e Serviços (det) - Lista de Items da Nota Fiscal */ + readonly items?: readonly components["schemas"]["InvoiceItemResource"][] | null; + /** @description Identifica se existem mais items a serem consultados */ + readonly hasMore?: boolean | null; + }; + readonly InvoiceResource: { + /** @description Identificador único */ + readonly id?: string | null; + /** + * Format: int32 + * @description Série do Documento Fiscal (serie) + */ + readonly serie?: number | null; + /** + * Format: int64 + * @description Número do Documento Fiscal (nNF) + */ + readonly number?: number | null; + readonly status?: components["schemas"]["InvoiceStatus"]; + readonly authorization?: components["schemas"]["AuthorizationResource"]; + readonly contingencyDetails?: components["schemas"]["ContingencyDetails"]; + /** @description Descrição da Natureza da Operação (natOp) */ + readonly operationNature?: string | null; /** * Format: date-time - * @description Data de criação do webhook + * @description Data de criação */ - readonly createdOn?: string; + readonly createdOn?: string | null; /** * Format: date-time - * @description Data de modificação do webhook + * @description Data de modificação */ - readonly modifiedOn?: string; - }; - }; - readonly "application/*+json": { - /** @description Dados do Web Hook */ - readonly webHook?: { + readonly modifiedOn?: string | null; /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + * Format: date-time + * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) + * + * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. + * */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; + readonly operationOn?: string | null; + readonly operationType?: components["schemas"]["OperationType"]; + readonly environmentType?: components["schemas"]["EnvironmentType"]; + readonly purposeType?: components["schemas"]["PurposeType"]; + readonly issuer?: components["schemas"]["IssuerResource"]; + readonly buyer?: components["schemas"]["BuyerResource"]; + readonly totals?: components["schemas"]["TotalResource"]; + readonly transport?: components["schemas"]["TransportInformationResource"]; + readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; + readonly export?: components["schemas"]["ExportResource"]; + readonly billing?: components["schemas"]["BillingResource"]; + /** @description Grupo de Formas de Pagamento (pag) */ + readonly payment?: readonly components["schemas"]["PaymentResource"][] | null; + readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; + readonly delivery?: components["schemas"]["DeliveryInformationResource"]; + readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"]; + readonly lastEvents?: components["schemas"]["InvoiceEventsResourceBase"]; + }; + /** @enum {string} */ + readonly InvoiceStatus: "None" | "Created" | "Processing" | "Issued" | "IssuedContingency" | "Cancelled" | "Disabled" | "IssueDenied" | "Error"; + readonly InvoiceWithoutEventsResource: { + /** @description Identificador único */ + readonly id?: string | null; /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + * Format: int32 + * @description Série do Documento Fiscal (serie) */ - readonly secret?: string; + readonly serie?: number | null; /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} + * Format: int64 + * @description Número do Documento Fiscal (nNF) */ - readonly contentType?: "json" | "form-urlencoded"; + readonly number?: number | null; + readonly status?: components["schemas"]["InvoiceStatus"]; + readonly authorization?: components["schemas"]["AuthorizationResource"]; + readonly contingencyDetails?: components["schemas"]["ContingencyDetails"]; + /** @description Descrição da Natureza da Operação (natOp) */ + readonly operationNature?: string | null; /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + * Format: date-time + * @description Data de criação */ - readonly insecureSsl?: boolean; + readonly createdOn?: string | null; /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} + * Format: date-time + * @description Data de modificação */ - readonly status?: "active" | "inactive"; + readonly modifiedOn?: string | null; /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + * Format: date-time + * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) + * + * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. + * */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; + readonly operationOn?: string | null; + readonly operationType?: components["schemas"]["OperationType"]; + readonly environmentType?: components["schemas"]["EnvironmentType"]; + readonly purposeType?: components["schemas"]["PurposeType"]; + readonly issuer?: components["schemas"]["IssuerResource"]; + readonly buyer?: components["schemas"]["BuyerResource"]; + readonly totals?: components["schemas"]["TotalResource"]; + readonly transport?: components["schemas"]["TransportInformationResource"]; + readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; + readonly export?: components["schemas"]["ExportResource"]; + readonly billing?: components["schemas"]["BillingResource"]; + /** @description Grupo de Formas de Pagamento (pag) */ + readonly payment?: readonly components["schemas"]["PaymentResource"][] | null; + readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; + readonly delivery?: components["schemas"]["DeliveryInformationResource"]; + readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"]; + }; + readonly IssuerFromRequestResource: { + /** @description IE do Substituto Tributário (IEST) */ + readonly stStateTaxNumber?: string | null; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo de identificação do emitente da NF-e + */ + readonly IssuerResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Nome ou Razão Social (xNome) */ + readonly name?: string | null; /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + * Format: int64 + * @description CNPJ ou CPF */ - readonly properties?: { - [key: string]: Record; - }; + readonly federalTaxNumber?: number | null; + /** @description Email */ + readonly email?: string | null; + readonly address?: components["schemas"]["AddressResource"]; + readonly type?: components["schemas"]["PersonType"]; + /** @description Nome Fantasia */ + readonly tradeName?: string | null; /** * Format: date-time - * @description Data de criação do webhook + * @description Data abertura da empresa + */ + readonly openningDate?: string | null; + readonly taxRegime?: components["schemas"]["TaxRegime"]; + readonly specialTaxRegime?: components["schemas"]["SpecialTaxRegime"]; + readonly legalNature?: components["schemas"]["LegalNature"]; + /** @description Atividades da Empresa (CNAE) */ + readonly economicActivities?: readonly components["schemas"]["EconomicActivityResource"][] | null; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number | null; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number | null; + /** + * Format: int64 + * @description Inscrição Estadual do Substituto Tributário (IEST) + */ + readonly regionalSTTaxNumber?: number | null; + /** @description Número de Inscrição na Prefeitura (IM/CCM) */ + readonly municipalTaxNumber?: string | null; + /** @description IE do Substituto Tributário (IEST) */ + readonly stStateTaxNumber?: string | null; + }; + /** @enum {string} */ + readonly LegalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @enum {string} */ + readonly OperationType: "Outgoing" | "Incoming"; + /** @description Grupo do PIS */ + readonly PISTaxResource: { + /** @description Código de Situação Tributária do PIS (CST) */ + readonly cst?: string | null; + /** + * Format: double + * @description Valor da Base de Cálculo do PIS (vBC) + */ + readonly baseTax?: number | null; + /** + * Format: double + * @description Alíquota do PIS (em percentual) (pPIS) + */ + readonly rate?: number | null; + /** + * Format: double + * @description Valor do PIS (vPIS) */ - readonly createdOn?: string; + readonly amount?: number | null; + /** + * Format: double + * @description Quantidade Vendida (qBCProd) + */ + readonly baseTaxProductQuantity?: number | null; + /** + * Format: double + * @description Alíquota do PIS (em reais) (vAliqProd) + */ + readonly productRate?: number | null; + }; + readonly PaymentDetailResource: { + readonly method?: components["schemas"]["PaymentMethod"]; + /** @description Descrição do meio de pagamento (xPag) */ + readonly methodDescription?: string | null; + readonly paymentType?: components["schemas"]["PaymentType"]; + /** + * Format: double + * @description Valor do Pagamento (vPag) + */ + readonly amount?: number | null; + readonly card?: components["schemas"]["CardResource"]; /** * Format: date-time - * @description Data de modificação do webhook + * @description Data do pagamento (dPag) + */ + readonly paymentDate?: string | null; + /** @description CNPJ transacional do pagamento (CNPJPag) */ + readonly federalTaxNumberPag?: string | null; + /** @description UF do CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (UFPag) */ + readonly statePag?: string | null; + }; + /** @enum {string} */ + readonly PaymentMethod: "Cash" | "Cheque" | "CreditCard" | "DebitCard" | "StoreCredict" | "FoodVouchers" | "MealVouchers" | "GiftVouchers" | "FuelVouchers" | "BankBill" | "BankDeposit" | "InstantPayment" | "WireTransfer" | "Cashback" | "StaticInstantPayment" | "StoreCredit" | "ElectronicPaymentNotInformed" | "WithoutPayment" | "Others"; + readonly PaymentResource: { + /** + * @description YA01a - Grupo Detalhamento da Forma de Pagamento (detPag) + * VERSÃO 4.00 + */ + readonly paymentDetail?: readonly components["schemas"]["PaymentDetailResource"][] | null; + /** + * Format: double + * @description Valor do troco (vTroco) + * VERSÃO 4.00 + */ + readonly payBack?: number | null; + }; + /** @enum {string} */ + readonly PaymentType: "InCash" | "Term"; + /** @enum {string} */ + readonly PersonType: "Undefined" | "NaturalPerson" | "LegalEntity" | "Company" | "Customer"; + /** @enum {string} */ + readonly PrintType: "None" | "NFeNormalPortrait" | "NFeNormalLandscape" | "NFeSimplified" | "DANFE_NFC_E" | "DANFE_NFC_E_MSG_ELETRONICA"; + readonly PumpResource: { + /** + * Format: int32 + * @description Número de identificação do bico utilizado no abastecimento (nBico) + */ + readonly spoutNumber?: number | null; + /** + * Format: int32 + * @description Número de identificação da bomba ao qual o bico está interligado (nBomba) + */ + readonly number?: number | null; + /** + * Format: int32 + * @description Número de identificação do tanque ao qual o bico está interligado (nTanque) + */ + readonly tankNumber?: number | null; + /** + * Format: double + * @description Valor do Encerrante no início do abastecimento (vEncIni) + */ + readonly beginningAmount?: number | null; + /** + * Format: double + * @description Valor do Encerrante no final do abastecimento (vEncFin) */ - readonly modifiedOn?: string; - }; + readonly endAmount?: number | null; + /** + * Format: double + * @description Percentual do índice de mistura do Biodiesel (B100) no Óleo Diesel B instituído pelo órgão regulamentador + */ + readonly percentageBio?: number | null; + }; + /** @enum {string} */ + readonly PurposeType: "None" | "Normal" | "Complement" | "Adjustment" | "Devolution"; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo Reboque + */ + readonly ReboqueResource: { + /** @description Placa do Veiculo (placa) */ + readonly plate?: string | null; + /** @description UF Veiculo Reboque (UF) */ + readonly uf?: string | null; + /** @description Registro Nacional de Transportador de Carga (ANTT) (RNTC) */ + readonly rntc?: string | null; + /** @description Identificação do Vagão (vagao) */ + readonly wagon?: string | null; + /** @description Identificação da Balsa (balsa) */ + readonly ferry?: string | null; + }; + /** @enum {string} */ + readonly ReceiverStateTaxIndicator: "None" | "TaxPayer" | "Exempt" | "NonTaxPayer"; + readonly ReferencedProcessResource: { + readonly identifierConcessory?: string | null; + /** Format: int32 */ + readonly identifierOrigin?: number | null; + /** Format: int32 */ + readonly concessionActType?: number | null; + }; + readonly RequestCancellationResource: { + readonly accountId?: string | null; + readonly companyId?: string | null; + readonly productInvoiceId?: string | null; + readonly reason?: string | null; + }; + /** @enum {string} */ + readonly ShippingModality: "ByIssuer" | "ByReceiver" | "ByThirdParties" | "OwnBySender" | "OwnByBuyer" | "Free"; + /** + * @description Regime especial de tributação + * @enum {string} + */ + readonly SpecialTaxRegime: "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte" | "Automatico"; + /** @enum {string} */ + readonly StateCode: "NA" | "RO" | "AC" | "AM" | "RR" | "PA" | "AP" | "TO" | "MA" | "PI" | "CE" | "RN" | "PB" | "PE" | "AL" | "SE" | "BA" | "MG" | "ES" | "RJ" | "SP" | "PR" | "SC" | "RS" | "MS" | "MT" | "GO" | "DF" | "EX"; + /** @enum {string} */ + readonly StateTaxProcessingAuthorizer: "Normal" | "EPEC"; + readonly TaxCouponInformationResource: { + /** @description Modelo de Documento Fiscal (mod) */ + readonly modelDocumentFiscal?: string | null; + /** @description Número de Ordem Sequencial do ECF (nECF) */ + readonly orderECF?: string | null; + /** + * Format: int32 + * @description Número do Contador de Ordem de Operação (nCOO) + */ + readonly orderCountOperation?: number | null; + }; + readonly TaxDeterminationResource: { + /** + * Format: int32 + * @description Código interno para determinação de natureza de operação + */ + readonly operationCode?: number | null; + /** @description Perfil fiscal do vendedor (origem) - usado para o cálculo automático de impostos */ + readonly issuerTaxProfile?: string | null; + /** @description Perfil fiscal do comprador (destino) - usado para o cálculo automático de impostos */ + readonly buyerTaxProfile?: string | null; + /** @description Origem da mercadoria */ + readonly origin?: string | null; + /** @description Finalidade de aquisição - usado para o cálculo automático de impostos */ + readonly acquisitionPurpose?: string | null; + }; + readonly TaxDocumentsReferenceResource: { + readonly taxCouponInformation?: components["schemas"]["TaxCouponInformationResource"]; + readonly documentInvoiceReference?: components["schemas"]["DocumentInvoiceReferenceResource"]; + readonly documentElectronicInvoice?: components["schemas"]["DocumentElectronicInvoiceResource"]; + }; + /** + * @description Regime de tributação + * @enum {string} + */ + readonly TaxRegime: "None" | "LucroReal" | "LucroPresumido" | "SimplesNacional" | "SimplesNacionalExcessoSublimite" | "MicroempreendedorIndividual" | "Isento"; + readonly TaxpayerCommentsResource: { + /** @description Campo (xCampo) */ + readonly field?: string | null; + /** @description Texto (xTexto) */ + readonly text?: string | null; + }; + readonly TotalResource: { + readonly icms?: components["schemas"]["ICMSTotalResource"]; + readonly issqn?: components["schemas"]["ISSQNTotalResource"]; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo Transportador + */ + readonly TransportGroupResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Nome ou Razão Social (xNome) */ + readonly name?: string | null; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number | null; + /** @description Email */ + readonly email?: string | null; + readonly address?: components["schemas"]["AddressResource"]; + readonly type?: components["schemas"]["PersonType"]; + /** @description Inscrição Estadual do Transportador (IE) */ + readonly stateTaxNumber?: string | null; + /** @description Grupo de Retenção do ICMS do transporte */ + readonly transportRetention?: string | null; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo de Informações do Transporte da NF-e + * Id: X01 Pai: A1 + */ + readonly TransportInformationResource: { + readonly freightModality?: components["schemas"]["ShippingModality"]; + readonly transportGroup?: components["schemas"]["TransportGroupResource"]; + readonly reboque?: components["schemas"]["ReboqueResource"]; + readonly volume?: components["schemas"]["VolumeResource"]; + readonly transportVehicle?: components["schemas"]["TransportVehicleResource"]; + /** @description Número dos Lacres */ + readonly sealNumber?: string | null; + readonly transpRate?: components["schemas"]["TransportRateResource"]; + }; + readonly TransportRateResource: { + /** + * Format: double + * @description Valor do Serviço (vServ) + */ + readonly serviceAmount?: number | null; + /** + * Format: double + * @description BC da Retenção do ICMS (vBCRet) + */ + readonly bcRetentionAmount?: number | null; + /** + * Format: double + * @description Alíquota da Retenção (pICMSRet) //Change to Rate + */ + readonly icmsRetentionRate?: number | null; + /** + * Format: double + * @description Valor do ICMS Retido (vICMSRet) + */ + readonly icmsRetentionAmount?: number | null; + /** + * Format: int64 + * @description CFOP de Serviço de Transporte (CFOP) + */ + readonly cfop?: number | null; + /** + * Format: int64 + * @description Código do Municipio de ocorrencia do fato gerador do ICMS do Transporte (cMunFG) + */ + readonly cityGeneratorFactCode?: number | null; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo Veiculo + */ + readonly TransportVehicleResource: { + /** @description Placa do Veiculo (placa) */ + readonly plate?: string | null; + /** @description Sigla da UF (UF) */ + readonly state?: string | null; + /** @description Registro Nacional de Transportador de Carga (ANTT) (RNTC) */ + readonly rntc?: string | null; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Volumes + * Id:X26 + */ + readonly VolumeResource: { + /** + * Format: int32 + * @description Quantidade de volumes transportados (qVol) + */ + readonly volumeQuantity?: number | null; + /** @description Espécie dos volumes transportados (esp) */ + readonly species?: string | null; + /** @description Marca dos Volumes Transportados (marca) */ + readonly brand?: string | null; + /** @description Numeração dos Volumes Transportados (nVol) */ + readonly volumeNumeration?: string | null; + /** + * Format: double + * @description Peso Liquido(em Kg) (pesoL) + */ + readonly netWeight?: number | null; + /** + * Format: double + * @description Peso Bruto(em Kg) (pesoB) + */ + readonly grossWeight?: number | null; + }; + /** @description Identificação do Local de retirada (retirada) */ + readonly WithdrawalInformationResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Nome ou Razão Social (xNome) */ + readonly name?: string | null; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number | null; + /** @description Email */ + readonly email?: string | null; + readonly address?: components["schemas"]["AddressResource"]; + readonly type?: components["schemas"]["PersonType"]; + /** @description Inscrição Estadual (IE) */ + readonly stateTaxNumber?: string | null; }; - }; - }; - responses: { - /** @description Sucesso na atualização da Webhook */ - 200: { - content: { - readonly "application/json": { - /** @description Dados do Web Hook */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. - * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. - * @enum {string} - */ - readonly contentType?: "json" | "form-urlencoded"; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * @description Determina se as notificações são enviadas quando o webhook é acionado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @default 1 - * @enum {string} - */ - readonly status?: "active" | "inactive"; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Webhook não encontrado */ - 404: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; }; - }; - /** - * Excluir um Webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir o **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. - * A exclusão do **Webhook** não exime o **Webhook** excluído de receber os notificações de eventos, já ocorridos na plataforma, que ainda estejam em processo de retentativa de envio dos gatilhos. - */ - V2WebhooksByWebhook_idDelete: { - parameters: { - path: { - /** @description ID do Webhook a ser excluído */ - webhook_id: string; - }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + readonly V2CompaniesGet: { + readonly parameters: { + readonly query?: { + /** @description Id de início do contador (Default: Empty) */ + readonly startingAfter?: string; + /** @description Id final do contador (Default: Empty) */ + readonly endingBefore?: string; + /** @description Limite de resultados na página (Default: 10) */ + readonly limit?: number; + }; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta da Empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Empresa */ + readonly companies?: readonly { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Lista de Inscrição Estadual */ + readonly stateTaxes?: readonly string[]; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }[]; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Empresa não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; }; - responses: { - /** @description Sucesso na exclusão da Webhook */ - 204: { - content: { - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Webhook não encontrado */ - 404: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; + readonly V2CompaniesPost: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** @description Dados da Empresa a ser criada */ + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + readonly "text/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + readonly "application/*+json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na criação da Empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Lista de Inscrição Estadual */ + readonly stateTaxes?: readonly string[]; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; }; - }; - /** - * Criar notificação para Testar um webhook - * @description ### Informações adicionais - * - * Utilize esta requisição para criar uma notificação de teste (ping) em um **Webhook** já cadastrado. - * - * Esta ação irá criar um evento de notificação do tipo ping para o **Webhook** especificado, deste modo você poderá simular o recebimento de uma notificação de teste no **Webhook** cadastrado. - */ - V2WebhooksByWebhook_idPingsPut: { - parameters: { - path: { - /** @description ID do Webhook a ser testado */ - webhook_id: string; - }; + readonly V2CompaniesByCompany_idGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta da Empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Lista de Inscrição Estadual */ + readonly stateTaxes?: readonly string[]; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Empresa não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; }; - responses: { - /** @description Sucesso ao criar notificação de teste */ - 204: { - content: { - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Webhook não encontrado */ - 404: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; + readonly V2CompaniesByCompany_idPut: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + /** @description Dados da Empresa a ser alterada */ + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + readonly "text/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + readonly "application/*+json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na alteração da Empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Lista de Inscrição Estadual */ + readonly stateTaxes?: readonly string[]; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Empresa não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idDelete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão da Empresa */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Empresa não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idCertificatesGet: { + readonly parameters: { + readonly query?: { + /** @description Status do certificado */ + readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa relacionada ao certificado */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly certificates?: readonly { + /** @description Nome do certificado (subject distinguished name) */ + readonly subject?: string; + /** + * Format: date-time + * @description Data no horário local após o qual um certificado não é mais válido + */ + readonly validUntil?: string; + /** @description A impressão digital do certificado */ + readonly thumbprint?: string; + /** @description CNPJ da Empresa */ + readonly federalTaxNumber?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; + }[]; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idCertificatesPost: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "multipart/form-data": { + /** + * Format: binary + * @description Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12 + */ + readonly file: string; + /** @description Senha do certificado ICP-Brasil */ + readonly password: string; + }; + readonly "application/form-data": { + /** + * Format: binary + * @description Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12 + */ + readonly file: string; + /** @description Senha do certificado ICP-Brasil */ + readonly password: string; + }; + }; + }; + readonly responses: { + /** @description Sucesso no upload e vinculo com a Empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Certificado */ + readonly certificate?: { + /** @description Nome do certificado (subject distinguished name) */ + readonly subject?: string; + /** + * Format: date-time + * @description Data no horário local após o qual um certificado não é mais válido + */ + readonly validUntil?: string; + /** @description A impressão digital do certificado */ + readonly thumbprint?: string; + /** @description CNPJ da Empresa */ + readonly federalTaxNumber?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idCertificatesByCertificate_thumbprintGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa relacionada ao certificado */ + readonly company_id: string; + /** @description Impressão digital do certificado */ + readonly certificate_thumbprint: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Certificado */ + readonly certificate?: { + /** @description Nome do certificado (subject distinguished name) */ + readonly subject?: string; + /** + * Format: date-time + * @description Data no horário local após o qual um certificado não é mais válido + */ + readonly validUntil?: string; + /** @description A impressão digital do certificado */ + readonly thumbprint?: string; + /** @description CNPJ da Empresa */ + readonly federalTaxNumber?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Certificado não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idCertificatesByCertificate_thumbprintDelete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa relacionada ao certificado */ + readonly company_id: string; + /** @description Impressão digital do certificado */ + readonly certificate_thumbprint: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão e desvinculo com a Empresa */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Certificado não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idStatetaxesGet: { + readonly parameters: { + readonly query?: { + /** @description Id de início do contador (Default: Empty) */ + readonly startingAfter?: string; + /** @description Id final do contador (Default: Empty) */ + readonly endingBefore?: string; + /** @description Limite de resultados na página (Default: 10) */ + readonly limit?: number; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na criação da Inscrição Estadual */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Inscriçoes Estaduais */ + readonly stateTaxes?: readonly { + /** @description Código da Empresa */ + readonly companyId?: string; + /** @description Account Id */ + readonly accountId?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "inactive" | "none" | "active"; + /** @description Todas as séries para esta Inscrição Estadual */ + readonly series?: readonly number[]; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * Format: int64 + * @description Número do Lote + */ + readonly batchId?: number; + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }[]; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idStatetaxesPost: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + /** @description Dados da Inscrição Estadual a ser criada */ + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + readonly "text/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + readonly "application/*+json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na criação da Inscrição Estadual */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Código da Empresa */ + readonly companyId?: string; + /** @description Account Id */ + readonly accountId?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "inactive" | "none" | "active"; + /** @description Todas as séries para esta Inscrição Estadual */ + readonly series?: readonly number[]; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * Format: int64 + * @description Número do Lote + */ + readonly batchId?: number; + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idStatetaxesByState_tax_idGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly company_id: string; + /** @description ID da Inscrição Estadual que deverá ser retornado */ + readonly state_tax_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta da Inscrição Estadual */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Código da Empresa */ + readonly companyId?: string; + /** @description Account Id */ + readonly accountId?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "inactive" | "none" | "active"; + /** @description Todas as séries para esta Inscrição Estadual */ + readonly series?: readonly number[]; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * Format: int64 + * @description Número do Lote + */ + readonly batchId?: number; + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Inscrição Estadual não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idStatetaxesByState_tax_idPut: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly company_id: string; + /** @description ID da Inscrição Estadual que deverá ser retornado */ + readonly state_tax_id: string; + }; + readonly cookie?: never; + }; + /** @description Dados da Inscrição Estadual a ser alterada */ + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + readonly "text/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + readonly "application/*+json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na alteração da Inscrição Estadual */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Código da Empresa */ + readonly companyId?: string; + /** @description Account Id */ + readonly accountId?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "inactive" | "none" | "active"; + /** @description Todas as séries para esta Inscrição Estadual */ + readonly series?: readonly number[]; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * Format: int64 + * @description Número do Lote + */ + readonly batchId?: number; + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Inscrição Estadual não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idStatetaxesByState_tax_idDelete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly company_id: string; + /** @description ID da Inscrição Estadual que deverá ser retornado */ + readonly state_tax_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão da Inscrição Estadual */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Inscrição Estadual não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2WebhooksEventTypesGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do tipos de eventos */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Evento */ + readonly eventTypes?: readonly { + /** + * @description Identificador do evento, seguem o padrão **Resource.EventAction**. + * Onde **Resource**: nome da entidade que gerou o evento; + * **EventAction**: nome do evento e ação criados. + * Alguns exemplos **Invoice.Issued** ou **Blob.Updated** + */ + readonly id?: string; + /** @description Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. */ + readonly description?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2WebhooksGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta da lista */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Web Hook */ + readonly webHooks?: readonly { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }[]; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2WebhooksPost: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json-patch+json": { + /** @description Dados para criar um Web Hook */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status?: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "application/json": { + /** @description Dados para criar um Web Hook */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status?: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "text/json": { + /** @description Dados para criar um Web Hook */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status?: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "application/*+json": { + /** @description Dados para criar um Web Hook */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status?: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na criação da webhook */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados do Web Hook */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2WebhooksDelete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão dos WebHooks */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2WebhooksByWebhook_idGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do webhook a ser consultado */ + readonly webhook_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do webhook */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados do Web Hook */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2WebhooksByWebhook_idPut: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do Webhook a ser atualizado */ + readonly webhook_id: string; + }; + readonly cookie?: never; + }; + /** @description Dados para alterar o Webhook */ + readonly requestBody?: { + readonly content: { + readonly "application/json-patch+json": { + /** @description Dados do Web Hook */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status?: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "application/json": { + /** @description Dados do Web Hook */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status?: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "text/json": { + /** @description Dados do Web Hook */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status?: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "application/*+json": { + /** @description Dados do Web Hook */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status?: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na atualização da Webhook */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados do Web Hook */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * @description Tipo de mídia usado para serializar as notificações dos eventos que serão entregues. + * Os valores suportados são **json** e **form-urlencoded**, o padrão é **json**. + * @enum {string} + */ + readonly contentType?: "json" | "form-urlencoded"; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * @description Determina se as notificações são enviadas quando o webhook é acionado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @default 1 + * @enum {string} + */ + readonly status: "active" | "inactive"; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2WebhooksByWebhook_idDelete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do Webhook a ser excluído */ + readonly webhook_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão da Webhook */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2WebhooksByWebhook_idPingsPut: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do Webhook a ser testado */ + readonly webhook_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso ao criar notificação de teste */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; }; - }; -}; +} diff --git a/src/generated/nf-produto-v2.ts b/src/generated/nf-produto-v2.ts index e2ed289..407ab8c 100644 --- a/src/generated/nf-produto-v2.ts +++ b/src/generated/nf-produto-v2.ts @@ -4,6366 +4,7167 @@ * Do not edit this file directly. * * To regenerate: npm run generate - * Last generated: 2026-02-15T17:59:25.708Z + * Last generated: 2026-04-25T23:27:49.229Z * Generator: openapi-typescript */ -/** - * This file was auto-generated by openapi-typescript. - * Do not make direct changes to the file. - */ - - -export type paths = { - "/v2/companies": { - /** - * Consultar todas as Empresas da Conta - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados das empresas vinculadas a conta. - */ - get: operations["V2CompaniesGet"]; - /** - * Criar uma Empresa - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - */ - post: operations["V2CompaniesPost"]; - }; - "/v2/companies/{company_id}": { - /** - * Consultar uma Empresa pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de uma empresas pelo ID. - */ - get: operations["V2CompaniesByCompany_idGet"]; - /** - * Alterar uma Empresa pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados de uma empresas pelo ID. - */ - put: operations["V2CompaniesByCompany_idPut"]; - /** - * Excluir uma Empresa por ID - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir uma empresas pelo ID, cuidado pois esse processo é irreversível. - */ - delete: operations["V2CompaniesByCompany_idDelete"]; - }; - "/v2/companies/{company_id}/certificates": { - /** - * Consultar um Certificado por seu Status - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através d0 **status do certificado** (__status__). - */ - get: operations["V2CompaniesByCompany_idCertificatesGet"]; - /** - * Upload de um Certificado - * @description ### Informações adicionais - * - * Utilize esta requisição para fazer upload de um **Certificado da ICP-Brasil** do tipo __e-CNPJ A1__ ou __NFE A1__ em uma **Empresa** e vincula-lo para processamentos. - * - * O **Certificado da ICP-Brasil** funciona como uma identidade virtual, para empresas e pessoas, que permite a identificação segura e inequívoca do autor de uma mensagem ou transação feita em meios eletrônicos, como a web. - */ - post: operations["V2CompaniesByCompany_idCertificatesPost"]; - }; - "/v2/companies/{company_id}/certificates/{certificate_thumbprint}": { - /** - * Consultar um Certificado por sua impressão digital - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__). - */ - get: operations["V2CompaniesByCompany_idCertificatesByCertificate_thumbprintGet"]; - /** - * Excluir um Certificado por sua impressão digital - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir o **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__) e desvincula-lo da **Empresa**. - * - * **ATENÇÃO pois esta requisição é irreversível** - */ - delete: operations["V2CompaniesByCompany_idCertificatesByCertificate_thumbprintDelete"]; - }; - "/v2/companies/{company_id}/statetaxes": { - /** - * Listar as Inscrições Estaduais - * @description ### Informações adicionais - * - * Utilize esta requisição para listar as inscrições estaduais na empresa para processar __Documentos Fiscais__. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - get: operations["V2CompaniesByCompany_idStatetaxesGet"]; - /** - * Criar uma Inscrição Estadual - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novas inscrição estadual na empresa para processar __Documentos Fiscais__. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - post: operations["V2CompaniesByCompany_idStatetaxesPost"]; - }; - "/v2/companies/{company_id}/statetaxes/{state_tax_id}": { - /** - * Consultar uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de uma empresas pelo ID. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - get: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idGet"]; - /** - * Alterar uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados de uma Inscrição Estadual pelo ID. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - put: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idPut"]; - /** - * Excluir uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir uma Inscrição Estadual pelo ID, cuidado pois esse processo é irreversível. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - delete: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idDelete"]; - }; - "/v2/companies/{companyId}/productinvoices": { - /** - * Listar as Notas Fiscais Eletrônicas (NFE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar uma lista de notas fiscais eletrônicas por empresa. - */ - get: { - parameters: { - query: { - /** @description Tipo de Ambiente é obrigatório (Production or Test) */ - environment: components["schemas"]["EnvironmentType"]; - /** @description Id de início do contador (Default: Empty) */ - startingAfter?: string; - /** @description Id de fim do contador (Default: Empty) */ - endingBefore?: string; - /** - * @description Buscar por parâmetros. ("ElasticSearch string query") Ex: (q=buyer.name:'EMPRESA LTDA'). Saiba mais - * em: https://nfe.io/docs/nota-fiscal-eletronica/integracao-api/consulta-elasticsearch - */ - q?: string; - /** @description Limite de resultados na página (Default: 10) */ - limit?: number; - }; - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - }; - }; - responses: { - /** @description Sucesso na consulta em lista */ - 200: { - content: { - readonly "application/json": components["schemas"]["ProductInvoicesResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - /** - * Emitir uma Nota Fiscal Eletrônica (NFE) - * @description ### Informações adicionais - * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de emissão. - * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo - * não garante a emissão do documento fiscal. - * Para obter um retorno ao final do processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos - * utilizar os WebHooks. - */ - post: { - parameters: { - path: { - /** @description Empresa ID */ - companyId: string; - }; - }; - /** @description Dados da nota fiscal a ser emitida */ - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; - readonly "text/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; - readonly "application/*+json": components["schemas"]["ProductInvoiceQueueIssueResource"]; - readonly "application/xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; - readonly "text/xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; - readonly "application/*+xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; - }; - }; - responses: { - /** @description Sucesso ao enfileirar para emissão */ - 202: { - content: { - readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}": { - /** - * Consultar por ID uma Nota Fiscal Eletrônica (NFE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID. - */ - get: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal Eletrônica que deverá ser retornada */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta */ - 200: { - content: { - readonly "application/json": components["schemas"]["InvoiceResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - /** - * Cancelar uma Nota Fiscal Eletrônica (NFE) - * @description ### Informações adicionais - * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de cancelamento. - * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo - * não garante o cancelamento do documento fiscal. - * Para obter um retorno ao final do processo de cancelamento de uma Nota Fiscal Eletrônica (NFe), - * recomendamos utilizar os WebHooks. - */ - delete: { - parameters: { - query?: { - /** @description Motivo do cancelamento */ - reason?: string; - }; - path: { - /** @description Empresa ID */ - companyId: string; - /** @description ID da Nota Fiscal que deverá ser cancelada */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso ao enfileirar para cancelamento */ - 204: { - content: { - readonly "application/json": components["schemas"]["RequestCancellationResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}/items": { - /** - * Consultar os produtos por ID uma Nota Fiscal Eletrônica (NFE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID. - */ - get: { - parameters: { - query?: { - /** @description Limite de resultados na página (Default: 10) */ - limit?: number; - /** @description Índice de início do contador (Default: 0) */ - startingAfter?: number; - }; - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal Eletrônica que deverá ser retornada */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta */ - 200: { - content: { - readonly "application/json": components["schemas"]["InvoiceItemsResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}/events": { - /** - * Consultar eventos por ID uma Nota Fiscal Eletrônica (NFE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID. - */ - get: { - parameters: { - query?: { - /** @description Limite de resultados na página (Default: 10) */ - limit?: number; - /** @description Índice de início do contador (Default: 0) */ - startingAfter?: number; - }; - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal Eletrônica que deverá ser retornada */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta */ - 200: { - content: { - readonly "application/json": components["schemas"]["ProductInvoiceEventsResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}/pdf": { - /** - * Consultar PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar a URL para o Documento Auxiliar Nota Fiscal Eletrônica (DANFE) - * em formato de arquivo PDF. - */ - get: { - parameters: { - query?: { - /** @description Força a geração do pdf independente do FlowStatus */ - force?: boolean; - }; - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal que deverá ser retornado */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta do DANFE */ - 200: { - content: { - readonly "application/json": components["schemas"]["FileResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml": { - /** - * Consultar XML da Nota Fiscal Eletrônica (NFE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar os dados de uma nota fiscal Eletrônica pelo ID. - */ - get: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal que deverá ser retornado */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta do XML da NFE */ - 200: { - content: { - readonly "application/json": components["schemas"]["FileResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml/rejection": { - /** - * Consultar XML de rejeição da Nota Fiscal Eletrônica (NFE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar o motivo da rejeição de uma nota fiscal Eletrônica pelo ID. - */ - get: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal que deverá ser retornado */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta do XML da NFE */ - 200: { - content: { - readonly "application/json": components["schemas"]["FileResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml-rejection": { - /** - * Consultar XML de rejeição da Nota Fiscal Eletrônica (NFE) - * @description ### Informações adicionais - * Utilize esta requisição para consultar o motivo da rejeição de uma nota fiscal Eletrônica pelo ID. - */ - get: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal que deverá ser retornado */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta do XML da NFE */ - 200: { - content: { - readonly "application/json": components["schemas"]["FileResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml-epec": { - /** Consultar XML da autorização em contingência (EPEC) */ - get: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal que deverá ser retornado */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta do XML da NFE */ - 200: { - content: { - readonly "application/json": components["schemas"]["FileResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter": { - /** - * Enviar uma carta de correção para Nota Fiscal Eletrônica (CC-e) - * @description ### Informações adicionais - * Utilize esta requisição para enviar uma carta de correção na Nota Fiscal Eletrônica (NFE). - * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo - * não garante a execução do documento fiscal. - * Para obter um retorno ao final do processo de carta de correção de uma Nota Fiscal Eletrônica (NFe), - * recomendamos utilizar os WebHooks. - */ - put: { - parameters: { - path: { - /** @description Empresa ID */ - companyId: string; - /** @description ID da Nota Fiscal que deverá ser cancelada */ - invoiceId: string; - }; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["QueueEventResource"]; - readonly "text/json": components["schemas"]["QueueEventResource"]; - readonly "application/*+json": components["schemas"]["QueueEventResource"]; - readonly "application/xml": components["schemas"]["QueueEventResource"]; - readonly "text/xml": components["schemas"]["QueueEventResource"]; - readonly "application/*+xml": components["schemas"]["QueueEventResource"]; - }; - }; - responses: { - /** @description Sucesso ao enfileirar para cancelamento */ - 204: { - content: { - readonly "application/json": components["schemas"]["RequestCancellationResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter/pdf": { - /** - * Consultar PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE) de Carta de Correção (CC-e) - * @description ### Informações adicionais - * Utilize esta requisição para consultar a URL para o Documento Auxiliar Nota Fiscal Eletrônica (DANFE) - * em formato de arquivo PDF. - */ - get: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal que deverá ser retornado */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta do DANFE */ - 200: { - content: { - readonly "application/json": components["schemas"]["FileResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter/xml": { - /** - * Consultar XML da Carta de Correção Eletrônica (CC-e) - * @description ### Informações adicionais - * Utilize esta requisição para consultar os dados da carta de correção de uma nota fiscal Eletrônica pelo ID. - */ - get: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - companyId: string; - /** @description ID da Nota Fiscal que deverá ser retornado */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso na consulta do XML da NFE */ - 200: { - content: { - readonly "application/json": components["schemas"]["FileResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/{invoiceId}/disablement": { - /** - * Inutilizar uma Nota Fiscal Eletrônica (NFE) - * @description ### Informações adicionais - * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de inutilização. - * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo - * não garante a inutilização do documento fiscal. - * Para obter um retorno ao final do processo de inutilização de uma Nota Fiscal Eletrônica (NFe), - * recomendamos utilizar os WebHooks. - */ - post: { - parameters: { - query?: { - /** @description Motivo da inutilização */ - reason?: string; - }; - path: { - /** @description Empresa ID */ - companyId: string; - /** @description ID da Nota Fiscal que deverá ser inutilizada */ - invoiceId: string; - }; - }; - responses: { - /** @description Sucesso ao enfileirar para inutilização */ - 204: { - content: { - readonly "application/json": components["schemas"]["RequestCancellationResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/productinvoices/disablement": { - /** - * Inutilizar números de nota fiscal - * @description ### Informações adicionais - * Caso seja um único número, utilizar o Número inicial e o Número final com o mesmo valor - */ - post: { - parameters: { - path: { - /** @description ID da Empresa */ - companyId: string; - }; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["DisablementResource"]; - readonly "text/json": components["schemas"]["DisablementResource"]; - readonly "application/*+json": components["schemas"]["DisablementResource"]; - readonly "application/xml": components["schemas"]["DisablementResource"]; - readonly "text/xml": components["schemas"]["DisablementResource"]; - readonly "application/*+xml": components["schemas"]["DisablementResource"]; - }; - }; - responses: { - /** @description Sucesso */ - 200: { - content: { - readonly "application/json": components["schemas"]["DisablementResource"]; - }; - }; - /** @description Algum parâmetro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Nota Fiscal Eletrônica não encontrada */ - 404: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/companies/{companyId}/statetaxes/{statetaxId}/productinvoices": { - /** - * Emitir uma Nota Fiscal Eletrônica (NFE) Informando um StateTaxId - * @description ### Informações adicionais - * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de emissão. - * **ATENÇÃO**: Cada processamento será feito de forma assíncrona, ou seja, o retorno positivo - * não garante a emissão do documento fiscal. - * Para obter um retorno ao final do processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos - * utilizar os WebHooks. - */ - post: { - parameters: { - path: { - /** @description Empresa ID */ - companyId: string; - /** @description Inscrição Estadual(StateTax) ID */ - statetaxId: string; - }; - }; - /** @description Dados da nota fiscal a ser emitida */ - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; - readonly "text/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; - readonly "application/*+json": components["schemas"]["ProductInvoiceQueueIssueResource"]; - readonly "application/xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; - readonly "text/xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; - readonly "application/*+xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; - }; - }; - responses: { - /** @description Sucesso ao enfileirar para emissão */ - 202: { - content: { - readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Tempo limite de 60s excedido no enfileiramento */ - 408: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": components["schemas"]["ErrorsResource"]; - }; - }; - }; - }; - }; - "/v2/webhooks/eventtypes": { - /** - * Listar os Tipos de Eventos gerados pela plataforma - * @description ### Informações adicionais - * - * Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados - * criando notificações para os webhooks ativos e configurados para receber os eventos. - * - * São identificados seguindo o padrão **Resource.EventAction**, - * onde **Resource**: nome da entidade que gerou o evento; - * **EventAction**: nome do evento e ação criados. - * - * Esse tipos podem ser utilizados como filtro ao criar ou alterar um webhook, - * sendo que o filtro determina quais notificações de eventos e ação serão enviadas - * para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook - * ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros. - */ - get: { - responses: { - /** @description Sucesso na consulta do tipos de eventos */ - 200: { - content: { - readonly "application/json": { - /** @description Lista de Evento */ - readonly eventTypes?: readonly ({ - /** - * @description Identificador do evento, seguem o padrão **Resource.EventAction**. - * Onde **Resource**: nome da entidade que gerou o evento; - * **EventAction**: nome do evento e ação criados. - * Alguns exemplos **Invoice.Issued** ou **Blob.Updated** - */ - readonly id?: string; - /** @description Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. */ - readonly description?: string; - /** - * Format: int32 - * @description WebHook Filter Status - * @enum {integer} - */ - readonly status?: 0 | 1; - })[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - }; - "/v2/webhooks": { - /** - * Listar os Webhooks - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar uma lista de **Webhooks** cadastrados na Conta Autenticada. - */ - get: { - responses: { - /** @description Sucesso na consulta da lista */ - 200: { - content: { - readonly "application/json": { - /** @description Lista de Web Hook */ - readonly webHooks?: readonly ({ - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - })[]; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Criar um Webhook - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novos **Webhooks** para receber as notificações de eventos ocorridos na plataforma. - * - * Na criação do **Webhook** a URL informada no cadastro deve ser responsiva, ou seja, deverá responder *(HTTP Status 200 OK)* a uma requisição *(HTTP POST)* que será feita para testar se a URL está operando como normalmente, caso contrario uma mensagem de erro será retornada. - * - * Um **Webhook** é semelhante a uma assinatura em um *sistema de publicação e assinatura* - * que permite ao assinante indicar *quando*, *como* e *onde* as notificações de eventos deve ser despachadas. - * Um **Webhook** é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos - * que podem ser acionados por eventos gerados através de ações executadas por esse Conta. - * Ou seja, a **Conta da _Empresa A_** não verá os WebHooks disparados por uma ação executada pelo usuário **Conta da _Empresa B_**. - */ - post: { - readonly requestBody?: { - readonly content: { - readonly "application/json-patch+json": { - /** @description Dados para criar um Web Hook */ - readonly webHook?: { - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - readonly "application/json": { - /** @description Dados para criar um Web Hook */ - readonly webHook?: { - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - readonly "text/json": { - /** @description Dados para criar um Web Hook */ - readonly webHook?: { - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - readonly "application/*+json": { - /** @description Dados para criar um Web Hook */ - readonly webHook?: { - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - responses: { - /** @description Sucesso na criação da webhook */ - 201: { - content: { - readonly "application/json": { - /** @description WebHook (Notificação HTTP) */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Webhook não encontrado */ - 404: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Excluir Todos os Webhooks existentes - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir todos os **Webhooks** cadastrados para a Conta Autenticada. - */ - delete: { - responses: { - /** @description Sucesso na exclusão dos WebHooks */ - 204: { - content: { - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - }; - "/v2/webhooks/{webhook_id}": { - /** - * Consultar um webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**. - */ - get: operations["RegistrationLookupAction"]; - /** - * Alterar um Webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados do **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. - */ - put: { - parameters: { - path: { - /** @description ID do Webhook a ser atualizado */ - webhook_id: string; - }; - }; - /** @description Dados para alterar o Webhook */ - readonly requestBody?: { - readonly content: { - readonly "application/json-patch+json": { - /** @description WebHook (Notificação HTTP) */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - readonly "application/json": { - /** @description WebHook (Notificação HTTP) */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - readonly "text/json": { - /** @description WebHook (Notificação HTTP) */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - readonly "application/*+json": { - /** @description WebHook (Notificação HTTP) */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - responses: { - /** @description Sucesso na atualização da Webhook */ - 200: { - content: { - readonly "application/json": { - /** @description WebHook (Notificação HTTP) */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Webhook não encontrado */ - 404: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Excluir um Webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir o **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. - * A exclusão do **Webhook** não exime o **Webhook** excluído de receber os notificações de eventos, já ocorridos na plataforma, que ainda estejam em processo de retentativa de envio dos gatilhos. - */ - delete: { - parameters: { - path: { - /** @description ID do Webhook a ser excluído */ - webhook_id: string; - }; - }; - responses: { - /** @description Sucesso na exclusão da Webhook */ - 204: { - content: { - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Webhook não encontrado */ - 404: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - }; - "/v2/webhooks/{webhook_id}/pings": { - /** - * Criar notificação para Testar um webhook - * @description ### Informações adicionais - * - * Utilize esta requisição para criar uma notificação de teste (ping) em um **Webhook** já cadastrado. - * - * Esta ação irá criar um evento de notificação do tipo ping para o **Webhook** especificado, deste modo você poderá simular o recebimento de uma notificação de teste no **Webhook** cadastrado. - */ - put: { - parameters: { - path: { - /** @description ID do Webhook a ser testado */ - webhook_id: string; - }; - }; - responses: { - /** @description Sucesso ao criar notificação de teste */ - 204: { - content: { - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Webhook não encontrado */ - 404: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - }; -}; - -export type webhooks = Record; - -export type components = { - schemas: { - readonly ActivityResource: { - /** @description Detalhes do Evento */ - readonly data?: unknown; - /** @description Nome do Evento gerado */ - readonly type?: string | null; - /** - * Format: int32 - * @description Número sequencial do Evento - */ - readonly sequence?: number | null; - }; - /** @description Adições (adi) */ - readonly AdditionResource: { - /** - * Format: int64 - * @description Numero da adição (nAdicao) - */ - readonly code?: number | null; - /** @description Código do fabricante estrangeiro (cFabricante) */ - readonly manufacturer?: string | null; - /** - * Format: double - * @description Valor do desconto do item da DI – Adição (vDescDI) - */ - readonly amount?: number | null; - /** - * Format: int64 - * @description Número do ato concessório de Drawback (nDraw) - */ - readonly drawback?: number | null; +export interface paths { + readonly "/v2/companies": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar todas as Empresas da Conta + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar os dados das empresas vinculadas a conta. + */ + readonly get: operations["V2CompaniesGet"]; + readonly put?: never; + /** + * Criar uma Empresa + * @description ### Informações adicionais + * + * Utilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + */ + readonly post: operations["V2CompaniesPost"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly AdditionalInformationResource: { - /** @description Informações Adicionais de Interesse do Fisco (infAdFisco) */ - readonly fisco?: string | null; - /** @description Informações Complementares de interesse do Contribuinte (infCpl) */ - readonly taxpayer?: string | null; - /** @description Informações Complementares de interesse do Contribuinte (infCpl) */ - readonly xmlAuthorized?: (readonly number[]) | null; - readonly effort?: string | null; - readonly order?: string | null; - readonly contract?: string | null; - /** @description Documentos Fiscais Referenciados (refECF) */ - readonly taxDocumentsReference?: (readonly components["schemas"]["TaxDocumentsReferenceResource"][]) | null; - /** @description Observações fiscais (obsCont) */ - readonly taxpayerComments?: (readonly components["schemas"]["TaxpayerCommentsResource"][]) | null; - /** @description Processos referenciados (procRef) */ - readonly referencedProcess?: (readonly components["schemas"]["ReferencedProcessResource"][]) | null; + readonly "/v2/companies/{company_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar uma Empresa pelo ID + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar os dados de uma empresas pelo ID. + */ + readonly get: operations["V2CompaniesByCompany_idGet"]; + /** + * Alterar uma Empresa pelo ID + * @description ### Informações adicionais + * + * Utilize esta requisição para alterar os dados de uma empresas pelo ID. + */ + readonly put: operations["V2CompaniesByCompany_idPut"]; + readonly post?: never; + /** + * Excluir uma Empresa por ID + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir uma empresas pelo ID, cuidado pois esse processo é irreversível. + */ + readonly delete: operations["V2CompaniesByCompany_idDelete"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @description Dados do Endereço */ - readonly AddressResource: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state?: string | null; - readonly city?: components["schemas"]["CityResource"]; - /** @description Bairro do Endereço */ - readonly district?: string | null; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string | null; - /** @description Logradouro do Endereço */ - readonly street?: string | null; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number?: string | null; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode?: string | null; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country?: string | null; - /** @description Telefone */ - readonly phone?: string | null; + readonly "/v2/companies/{company_id}/certificates": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar um Certificado por seu Status + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através d0 **status do certificado** (__status__). + */ + readonly get: operations["V2CompaniesByCompany_idCertificatesGet"]; + readonly put?: never; + /** + * Upload de um Certificado + * @description ### Informações adicionais + * + * Utilize esta requisição para fazer upload de um **Certificado da ICP-Brasil** do tipo __e-CNPJ A1__ ou __NFE A1__ em uma **Empresa** e vincula-lo para processamentos. + * + * O **Certificado da ICP-Brasil** funciona como uma identidade virtual, para empresas e pessoas, que permite a identificação segura e inequívoca do autor de uma mensagem ou transação feita em meios eletrônicos, como a web. + */ + readonly post: operations["V2CompaniesByCompany_idCertificatesPost"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly AuthorizationResource: { - /** Format: date-time */ - readonly receiptOn?: string | null; - readonly accessKey?: string | null; - readonly message?: string | null; + readonly "/v2/companies/{company_id}/certificates/{certificate_thumbprint}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar um Certificado por sua impressão digital + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__). + */ + readonly get: operations["V2CompaniesByCompany_idCertificatesByCertificate_thumbprintGet"]; + readonly put?: never; + readonly post?: never; + /** + * Excluir um Certificado por sua impressão digital + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir o **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__) e desvincula-lo da **Empresa**. + * + * **ATENÇÃO pois esta requisição é irreversível** + */ + readonly delete: operations["V2CompaniesByCompany_idCertificatesByCertificate_thumbprintDelete"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly BillResource: { - /** @description Número da Fatura (nFat) */ - readonly number?: string | null; - /** - * Format: double - * @description Valor Original da Fatura (vOrig) - */ - readonly originalAmount?: number | null; - /** - * Format: double - * @description Valor do desconto (vDesc) - */ - readonly discountAmount?: number | null; - /** - * Format: double - * @description Valor Líquido da Fatura (vLiq) - */ - readonly netAmount?: number | null; + readonly "/v2/companies/{company_id}/statetaxes": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Listar as Inscrições Estaduais + * @description ### Informações adicionais + * + * Utilize esta requisição para listar as inscrições estaduais na empresa para processar __Documentos Fiscais__. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. + */ + readonly get: operations["V2CompaniesByCompany_idStatetaxesGet"]; + readonly put?: never; + /** + * Criar uma Inscrição Estadual + * @description ### Informações adicionais + * + * Utilize esta requisição para criar novas inscrição estadual na empresa para processar __Documentos Fiscais__. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. + */ + readonly post: operations["V2CompaniesByCompany_idStatetaxesPost"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly BillingResource: { - readonly bill?: components["schemas"]["BillResource"]; - /** @description Grupo Duplicata (dup) */ - readonly duplicates?: (readonly components["schemas"]["DuplicateResource"][]) | null; + readonly "/v2/companies/{company_id}/statetaxes/{state_tax_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar uma Inscrição Estadual pelo ID + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar os dados de uma empresas pelo ID. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. + */ + readonly get: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idGet"]; + /** + * Alterar uma Inscrição Estadual pelo ID + * @description ### Informações adicionais + * + * Utilize esta requisição para alterar os dados de uma Inscrição Estadual pelo ID. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. + */ + readonly put: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idPut"]; + readonly post?: never; + /** + * Excluir uma Inscrição Estadual pelo ID + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir uma Inscrição Estadual pelo ID, cuidado pois esse processo é irreversível. + * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. + * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. + */ + readonly delete: operations["V2CompaniesByCompany_idStatetaxesByState_tax_idDelete"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo de endereço do Destinatário da NF-e - */ - readonly BuyerResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Nome ou Razão Social (xNome) */ - readonly name?: string | null; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number | null; - /** @description Email */ - readonly email?: string | null; - readonly address?: components["schemas"]["AddressResource"]; - readonly type?: components["schemas"]["PersonType"]; - readonly stateTaxNumberIndicator?: components["schemas"]["ReceiverStateTaxIndicator"]; - /** @description Nome fantasia */ - readonly tradeName?: string | null; - readonly taxRegime?: components["schemas"]["TaxRegime"]; - /** @description Inscrição Estadual (IE) */ - readonly stateTaxNumber?: string | null; - }; - readonly CIDEResource: { - /** - * Format: double - * @description BC da CIDE (qBCProd) - */ - readonly bc?: number | null; - /** - * Format: double - * @description Valor da alíquota da CIDE (vAliqProd) - */ - readonly rate?: number | null; - /** - * Format: double - * @description Valor da CIDE (vCIDE) - */ - readonly cideAmount?: number | null; - }; - readonly CardResource: { - /** @description CNPJ da Credenciadora de cartão de crédito e/ou débito (CNPJ) */ - readonly federalTaxNumber?: string | null; - readonly flag?: components["schemas"]["FlagCard"]; - /** @description Número de autorização da operação cartão de crédito e/ou débito (cAut) */ - readonly authorization?: string | null; - readonly integrationPaymentType?: components["schemas"]["IntegrationPaymentType"]; - /** @description CNPJ do beneficiário do pagamento (CNPJReceb) */ - readonly federalTaxNumberRecipient?: string | null; - /** @description Identificador do terminal de pagamento (idTermPag) */ - readonly idPaymentTerminal?: string | null; - }; - readonly CityResource: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code?: string | null; - /** @description Nome do Município */ - readonly name?: string | null; - }; - /** - * @description Grupo do COFINS - * - * ID: S01 - * Pai: M01 - * - * Obs: Informar apenas um dos grupos S02, S03, S04 ou S04 - * com base valor atribuído ao campo S06 – CST do COFINS - */ - readonly CofinsTaxResource: { - /** @description Código de Situação Tributária da COFINS */ - readonly cst?: string | null; - /** - * Format: double - * @description Valor da Base de Cálculo da COFINS (vBC) - */ - readonly baseTax?: number | null; - /** - * Format: double - * @description Alíquota da COFINS (em percentual) (pCOFINS) - */ - readonly rate?: number | null; - /** - * Format: double - * @description Valor da COFINS (vCOFINS) - */ - readonly amount?: number | null; - /** - * Format: double - * @description Quantidade Vendida (qBCProd) - */ - readonly baseTaxProductQuantity?: number | null; - /** - * Format: double - * @description Alíquota da COFINS (em reais) (vAliqProd) - */ - readonly productRate?: number | null; - }; - /** - * @description Indicador de Presença (indPres ) - * @enum {string} - */ - readonly ConsumerPresenceType: "None" | "Presence" | "Internet" | "Telephone" | "Delivery" | "OthersNonPresenceOperation"; - /** - * @description Indica operação com Consumidor final (indFinal) - * @enum {string} - */ - readonly ConsumerType: "FinalConsumer" | "Normal"; - readonly ContingencyDetails: { - readonly authorizer?: components["schemas"]["StateTaxProcessingAuthorizer"]; - /** - * Format: date-time - * @description Data e hora do início da contingência - */ - readonly startedOn?: string; - /** @description Justificativa da entrada em contingência */ - readonly reason?: string | null; - }; - /** @description Identificação do Local de entrega (entrega) */ - readonly DeliveryInformationResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Nome ou Razão Social (xNome) */ - readonly name?: string | null; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number | null; - /** @description Email */ - readonly email?: string | null; - readonly address?: components["schemas"]["AddressResource"]; - readonly type?: components["schemas"]["PersonType"]; - /** @description Inscrição Estadual (IE) */ - readonly stateTaxNumber?: string | null; - }; - /** - * @description Identificador de local de destino da operação (idDest) - * @enum {string} - */ - readonly Destination: "None" | "Internal_Operation" | "Interstate_Operation" | "International_Operation"; - /** @description Dados para inutilizar números de nota fiscal */ - readonly DisablementResource: { - readonly environment?: components["schemas"]["EnvironmentType"]; - /** - * Format: int32 - * @description Série - */ - readonly serie?: number; - readonly state?: components["schemas"]["StateCode"]; - /** - * Format: int32 - * @description Número inicial - */ - readonly beginNumber?: number; - /** - * Format: int32 - * @description Número final (usar o mesmo número inicial se for apenas um número) - */ - readonly lastNumber?: number; - /** @description Motivo da inutilização */ - readonly reason?: string | null; - }; - readonly DocumentElectronicInvoiceResource: { - /** @description Chave de Acesso (refNFe) */ - readonly accessKey?: string | null; - }; - readonly DocumentInvoiceReferenceResource: { - /** - * Format: double - * @description Código da UF (cUF) - */ - readonly state?: number | null; - /** @description Ano / Mês (AAMM) */ - readonly yearMonth?: string | null; - /** @description CNPJ (CNPJ) */ - readonly federalTaxNumber?: string | null; - /** @description Modelo (mod) */ - readonly model?: string | null; - /** @description Série (serie) */ - readonly series?: string | null; - /** @description Número (nNF) */ - readonly number?: string | null; - }; - /** - * @description Indicador de intermediador/marketplace (indIntermed) - * @enum {string} - */ - readonly DuductionIndicator: "NotDeduct" | "Deduce"; - readonly DuplicateResource: { - /** @description Número da Duplicata (nDup) */ - readonly number?: string | null; - /** - * Format: date-time - * @description Data de vencimento (dVenc) - */ - readonly expirationOn?: string | null; - /** - * Format: double - * @description Valor da duplicata (vDup) - */ - readonly amount?: number | null; - }; - readonly EconomicActivityResource: { - readonly type?: components["schemas"]["EconomicActivityType"]; - /** - * Format: int32 - * @description Código da Atividade da Empresa - */ - readonly code?: number | null; - }; - /** @enum {string} */ - readonly EconomicActivityType: "Main" | "Secondary"; - /** @enum {string} */ - readonly EnvironmentType: "None" | "Production" | "Test"; - readonly ErrorResource: { - /** Format: int32 */ - readonly code?: number | null; - readonly message?: string | null; - }; - readonly ErrorsResource: { - readonly errors?: (readonly components["schemas"]["ErrorResource"][]) | null; - }; - /** - * @description Campo será preenchido quando o campo anterior estiver - * preenchido.Informar o motivo da desoneração: - * @enum {string} - */ - readonly ExemptReason: "Agriculture" | "Others" | "DevelopmentEntities"; - readonly ExportDetailResource: { - /** @description Número do ato concessório de Drawback (nDraw) */ - readonly drawback?: string | null; - readonly hintInformation?: components["schemas"]["ExportHintResource"]; - }; - readonly ExportHintResource: { - /** @description Número do Registro de Exportação (nRE) */ - readonly registryId?: string | null; - /** @description Chave de Acesso da NF-e recebida para exportação (chNFe) */ - readonly accessKey?: string | null; - /** - * Format: double - * @description Quantidade do item realmente exportado (qExport) - */ - readonly quantity?: number | null; - }; - readonly ExportResource: { - readonly state?: components["schemas"]["StateCode"]; - /** @description Descrição do Local de Embarque ou de transposição de fronteira (xLocExporta) */ - readonly office?: string | null; - /** @description Informações Complementares de interesse do Contribuinte (xLocDespacho) */ - readonly local?: string | null; - }; - /** @description Arquivo */ - readonly FileResource: { - /** @description Endereço Absoluto URI para o arquivo */ - readonly uri?: string | null; - }; - /** @enum {string} */ - readonly FlagCard: "None" | "Visa" | "Mastercard" | "AmericanExpress" | "Sorocred" | "DinersClub" | "Elo" | "Hipercard" | "Aura" | "Cabal" | "Alelo" | "BanesCard" | "CalCard" | "Credz" | "Discover" | "GoodCard" | "GreenCard" | "Hiper" | "JCB" | "Mais" | "MaxVan" | "Policard" | "RedeCompras" | "Sodexo" | "ValeCard" | "Verocheque" | "VR" | "Ticket" | "Other"; - readonly FuelOriginResource: { - /** - * Format: int32 - * @description Indicador de importação (indImport) - */ - readonly indImport?: number | null; - /** - * Format: int32 - * @description Código da UF (cUFOrig) - */ - readonly cUFOrig?: number | null; - /** - * Format: double - * @description Percentual originário para a UF (pOrig) - */ - readonly pOrig?: number | null; - }; - readonly FuelResource: { - /** @description Código de produto da ANP (cProdANP) */ - readonly codeANP?: string | null; - /** - * Format: double - * @description Percentual de Gás Natural para o produto GLP (cProdANP=210203001) (pMixGN) - */ - readonly percentageNG?: number | null; - /** @description Descrição do produto conforme ANP (descANP) */ - readonly descriptionANP?: string | null; - /** - * Format: double - * @description Percentual do GLP derivado do petróleo no produto GLP (cProdANP=210203001) (pGLP) - */ - readonly percentageGLP?: number | null; - /** - * Format: double - * @description Percentual de Gás Natural Nacional – GLGNn para o produto GLP (cProdANP= 210203001) (pGNn) - */ - readonly percentageNGn?: number | null; - /** - * Format: double - * @description Percentual de Gás Natural Importado – GLGNi para o produto GLP (cProdANP= 210203001) (pGNi) - */ - readonly percentageGNi?: number | null; - /** - * Format: double - * @description Valor de partida (cProdANP=210203001) (vPart) - */ - readonly startingAmount?: number | null; - /** @description Código de autorização / registro do CODIF (CODIF) */ - readonly codif?: string | null; - /** - * Format: double - * @description Quantidade de combustível faturada à temperatura ambiente (qTemp) - */ - readonly amountTemp?: number | null; - /** @description Sigla da UF de consumo (UFCons) */ - readonly stateBuyer?: string | null; - readonly cide?: components["schemas"]["CIDEResource"]; - readonly pump?: components["schemas"]["PumpResource"]; - readonly fuelOrigin?: components["schemas"]["FuelOriginResource"]; - }; - /** - * @description Manual Contribuinte v_5.00 - * Grupo de Valores Totais referentes ao ICMS - */ - readonly ICMSTotal: { - /** - * Format: double - * @description Base de Cálculo do ICMS (vBC) - */ - readonly baseTax?: number | null; - /** - * Format: double - * @description Valor Total do ICMS (vICMS) - */ - readonly icmsAmount?: number | null; - /** - * Format: double - * @description Valor ICMS Total desonerado (vICMSDeson) - */ - readonly icmsExemptAmount?: number | null; - /** - * Format: double - * @description Base de Cálculo do ICMS Substituição Tributária (vBCST) - */ - readonly stCalculationBasisAmount?: number | null; - /** - * Format: double - * @description Valor Total do ICMS ST (vST) - */ - readonly stAmount?: number | null; - /** - * Format: double - * @description Valor Total dos produtos e serviços (vProd) - */ - readonly productAmount?: number; - /** - * Format: double - * @description Valor Total do Frete (vFrete) - */ - readonly freightAmount?: number | null; - /** - * Format: double - * @description Valor Total do Seguro (vSeg) - */ - readonly insuranceAmount?: number | null; - /** - * Format: double - * @description Valor Total do Desconto (vDesc) - */ - readonly discountAmount?: number | null; - /** - * Format: double - * @description Valor Total do Imposto de Importação (vII) - */ - readonly iiAmount?: number | null; - /** - * Format: double - * @description Valor Total do IPI (vIPI) - */ - readonly ipiAmount?: number | null; - /** - * Format: double - * @description Valor do PIS (vPIS) - */ - readonly pisAmount?: number | null; - /** - * Format: double - * @description Valor do COFINS (vCOFINS) - */ - readonly cofinsAmount?: number | null; - /** - * Format: double - * @description Outras Despesas acessórias (vOutro) - */ - readonly othersAmount?: number | null; - /** - * Format: double - * @description Valor Total da NF-e (vNF) - */ - readonly invoiceAmount?: number; - /** - * Format: double - * @description Valor Total ICMS FCP UF Destino - */ - readonly fcpufDestinationAmount?: number | null; - /** - * Format: double - * @description Valor Total ICMS Interestadual UF Destino - */ - readonly icmsufDestinationAmount?: number | null; - /** - * Format: double - * @description Valor Total ICMS Interestadual UF Rem. - */ - readonly icmsufSenderAmount?: number | null; - /** - * Format: double - * @description Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib) - */ - readonly federalTaxesAmount?: number; - /** - * Format: double - * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) - */ - readonly fcpAmount?: number | null; - /** - * Format: double - * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) retido por substituição tributária. - */ - readonly fcpstAmount?: number | null; - /** - * Format: double - * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) retido anteriormente por substituição tributária. - */ - readonly fcpstRetAmount?: number | null; - /** - * Format: double - * @description Valor total do IPI devolvido (vIPIDevol) - */ - readonly ipiDevolAmount?: number | null; - /** Format: double */ - readonly qBCMono?: number | null; - /** - * Format: double - * @description Valor total do ICMS monofásico próprio (vICMSMono). - */ - readonly vICMSMono?: number | null; - /** - * Format: double - * @description Valor total da quantidade tributada do ICMS monofásico sujeito a retenção (qBCMonoReten). - */ - readonly qBCMonoReten?: number | null; - /** - * Format: double - * @description Valor total da quantidade tributada do ICMS monofásico retido anteriormente(vICMSMonoReten) - */ - readonly vICMSMonoReten?: number | null; - /** - * Format: double - * @description Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) - */ - readonly qBCMonoRet?: number | null; - /** - * Format: double - * @description Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) - */ - readonly vICMSMonoRet?: number | null; - }; - /** - * @description Manual Contribuinte v_5.00 - * Grupo de Valores Totais referentes ao ICMS - */ - readonly ICMSTotalResource: { - /** - * Format: double - * @description Base de Cálculo do ICMS (vBC) - */ - readonly baseTax?: number | null; - /** - * Format: double - * @description Valor Total do ICMS (vICMS) - */ - readonly icmsAmount?: number | null; - /** - * Format: double - * @description Valor ICMS Total desonerado (vICMSDeson) - */ - readonly icmsExemptAmount?: number | null; - /** - * Format: double - * @description Base de Cálculo do ICMS Substituição Tributária (vBCST) - */ - readonly stCalculationBasisAmount?: number | null; - /** - * Format: double - * @description Valor Total do ICMS ST (vST) - */ - readonly stAmount?: number | null; - /** - * Format: double - * @description Valor Total dos produtos e serviços (vProd) - */ - readonly productAmount?: number | null; - /** - * Format: double - * @description Valor Total do Frete (vFrete) - */ - readonly freightAmount?: number | null; - /** - * Format: double - * @description Valor Total do Seguro (vSeg) - */ - readonly insuranceAmount?: number | null; - /** - * Format: double - * @description Valor Total do Desconto (vDesc) - */ - readonly discountAmount?: number | null; - /** - * Format: double - * @description Valor Total do Imposto de Importação (vII) - */ - readonly iiAmount?: number | null; - /** - * Format: double - * @description Valor Total do IPI (vIPI) - */ - readonly ipiAmount?: number | null; - /** - * Format: double - * @description Valor do PIS (vPIS) - */ - readonly pisAmount?: number | null; - /** - * Format: double - * @description Valor do COFINS (vCOFINS) - */ - readonly cofinsAmount?: number | null; - /** - * Format: double - * @description Outras Despesas acessórias (vOutro) - */ - readonly othersAmount?: number | null; - /** - * Format: double - * @description Valor Total da NF-e (vNF) - */ - readonly invoiceAmount?: number | null; - /** - * Format: double - * @description Valor Total ICMS FCP UF Destino (vFCPUFDest) - */ - readonly fcpufDestinationAmount?: number | null; - /** - * Format: double - * @description Valor Total ICMS Interestadual UF Destino (vICMSUFDest) - */ - readonly icmsufDestinationAmount?: number | null; - /** - * Format: double - * @description Valor Total ICMS Interestadual UF Remetente (vICMSUFRemet) - */ - readonly icmsufSenderAmount?: number | null; - /** - * Format: double - * @description Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib) - */ - readonly federalTaxesAmount?: number | null; - /** - * Format: double - * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) - */ - readonly fcpAmount?: number | null; - /** - * Format: double - * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST) - */ - readonly fcpstAmount?: number | null; - /** - * Format: double - * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) - */ - readonly fcpstRetAmount?: number | null; - /** - * Format: double - * @description Valor total do IPI devolvido (vIPIDevol) - */ - readonly ipiDevolAmount?: number | null; - /** - * Format: double - * @description Valor total da quantidade tributada do ICMS monofásico próprio (qBCMono) - */ - readonly qBCMono?: number | null; - /** - * Format: double - * @description Valor total do ICMS monofásico próprio (vICMSMono) - */ - readonly vICMSMono?: number | null; - /** - * Format: double - * @description Valor total da quantidade tributada do ICMS monofásico sujeito a retenção(qBCMonoReten) - */ - readonly qBCMonoReten?: number | null; - /** - * Format: double - * @description Valor total do ICMS monofásico sujeito a retenção (vICMSMonoReten) - */ - readonly vICMSMonoReten?: number | null; - /** - * Format: double - * @description Valor total da quantidade tributada do ICMS monofásico retido anteriormente(qBCMonoRet) - */ - readonly qBCMonoRet?: number | null; - /** - * Format: double - * @description Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) - */ - readonly vICMSMonoRet?: number | null; - }; - /** @description Grupo de Tributação do ICMS de Destino da UF */ - readonly ICMSUFDestinationTaxResource: { - /** - * Format: double - * @description Valor da Base de Cálculo do ICMS na UF de destino (vBCUFDest) - */ - readonly vBCUFDest?: number | null; - /** - * Format: double - * @description Percentual adicional inserido na alíquota interna da UF de destino, relativo ao Fundo de Combate à Pobreza (FCP) naquela UF (pFCPUFDest) - */ - readonly pFCPUFDest?: number | null; - /** - * Format: double - * @description Alíquota adotada nas operações internas na UF de destino para o produto / mercadoria (pICMSUFDest) - */ - readonly pICMSUFDest?: number | null; - /** - * Format: double - * @description Alíquota interestadual das UF envolvidas (pICMSInter) - */ - readonly pICMSInter?: number | null; - /** - * Format: double - * @description Percentual de ICMS Interestadual para a UF de destino (pICMSInterPart) - */ - readonly pICMSInterPart?: number | null; - /** - * Format: double - * @description Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de destino (vFCPUFDest - */ - readonly vFCPUFDest?: number | null; - /** - * Format: double - * @description Valor do ICMS Interestadual para a UF de destino (vICMSUFDest) - */ - readonly vICMSUFDest?: number | null; - /** - * Format: double - * @description Valor do ICMS Interestadual para a UF do remetente (vICMSUFRemet) - */ - readonly vICMSUFRemet?: number | null; - /** - * Format: double - * @description Valor da BC FCP na UF de destino (vBCFCPUFDest) - */ - readonly vBCFCPUFDest?: number | null; - }; - /** - * @description Grupo do Imposto de Importação - * - * Id: P01 - * Pai: O01 - */ - readonly IITaxResource: { - /** @description Valor BC do Imposto de Importação (vBC) */ - readonly baseTax?: string | null; - /** @description Valor despesas aduaneiras (vDespAdu) */ - readonly customsExpenditureAmount?: string | null; - /** - * Format: double - * @description Valor Imposto de Importação (vII) - */ - readonly amount?: number | null; - /** - * Format: double - * @description Valor Imposto sobre Operações Financeiras (vIOF) - */ - readonly iofAmount?: number | null; - /** - * Format: double - * @description Valor dos encargos cambiais - */ - readonly vEnqCamb?: number | null; - }; - /** - * @description - * Grupo do IPI - * - * Informar apenas quando o item for sujeito ao IPI - * - * ID: O01 - * - * Pai: M01 - */ - readonly IPITaxResource: { - /** @description Código da situação tributária do IPI (CST) */ - readonly cst?: string | null; - /** @description Código de Enquadramento Legal do IPI (cEnq) */ - readonly classificationCode?: string | null; - /** - * @description clEnq - * Classe de enquadramento do IPI para Cigarros e Bebidas (clEnq) - */ - readonly classification?: string | null; - /** @description CNPJ do produtor da mercadoria, quando diferente do emitente. Somente para os casos de exportação direta ou indireta (CNPJProd) */ - readonly producerCNPJ?: string | null; - /** @description Código do selo de controle IPI (cSelo) */ - readonly stampCode?: string | null; - /** - * Format: double - * @description Quantidade de selo de controle (qSelo) - */ - readonly stampQuantity?: number | null; - /** - * Format: double - * @description Valor da BC do IPI (vBC) - */ - readonly base?: number | null; - /** - * Format: double - * @description Alíquota do IPI (pIPI) - */ - readonly rate?: number | null; - /** - * Format: double - * @description Quantidade total na unidade padrão para tributação (somente para os produtos tributados por unidade) (qUnid) - */ - readonly unitQuantity?: number | null; - /** - * Format: double - * @description Valor por Unidade Tributável (vUnid) - */ - readonly unitAmount?: number | null; - /** - * Format: double - * @description Valor IPI (vIPI) - */ - readonly amount?: number | null; - }; - readonly ISSQNTotal: { - /** - * Format: double - * @description Valor Total Serv.Não Tributados p/ ICMS - */ - readonly totalServiceNotTaxedICMS?: number | null; - /** - * Format: double - * @description Base de Cálculo do ISS - */ - readonly baseRateISS?: number | null; - /** - * Format: double - * @description Valor Total do ISS - */ - readonly totalISS?: number | null; - /** - * Format: double - * @description Valor do PIS sobre Serviços - */ - readonly valueServicePIS?: number | null; - /** - * Format: double - * @description Valor da COFINS sobre Serviços - */ - readonly valueServiceCOFINS?: number | null; - /** - * Format: date-time - * @description Data Prestação Serviço - */ - readonly provisionService?: string | null; - /** - * Format: double - * @description Valor Dedução para Redução da BC - */ - readonly deductionReductionBC?: number | null; - /** - * Format: double - * @description Valor Outras Retenções - */ - readonly valueOtherRetention?: number | null; - /** - * Format: double - * @description Valor Desconto Incondicionado - */ - readonly discountUnconditional?: number | null; - /** - * Format: double - * @description Valor Desconto Condicionado - */ - readonly discountConditioning?: number | null; - /** - * Format: double - * @description Valor Total Retenção ISS - */ - readonly totalRetentionISS?: number | null; - /** - * Format: double - * @description Código Regime Tributação - */ - readonly codeTaxRegime?: number | null; - }; - readonly ISSQNTotalResource: { - /** - * Format: double - * @description Valor Total Serv.Não Tributados p/ ICMS (vServ) - */ - readonly totalServiceNotTaxedICMS?: number | null; - /** - * Format: double - * @description Base de Cálculo do ISS (vBC) - */ - readonly baseRateISS?: number | null; - /** - * Format: double - * @description Valor Total do ISS (vISS) - */ - readonly totalISS?: number | null; - /** - * Format: double - * @description Valor do PIS sobre Serviços (vPIS) - */ - readonly valueServicePIS?: number | null; - /** - * Format: double - * @description Valor da COFINS sobre Serviços (vCOFINS) - */ - readonly valueServiceCOFINS?: number | null; - /** - * Format: date-time - * @description Data Prestação Serviço (dCompet) - */ - readonly provisionService?: string | null; - /** - * Format: double - * @description Valor Dedução para Redução da BC (vDeducao) - */ - readonly deductionReductionBC?: number | null; - /** - * Format: double - * @description Valor Outras Retenções (vOutro) - */ - readonly valueOtherRetention?: number | null; - /** - * Format: double - * @description Valor Desconto Incondicionado (vDescIncond) - */ - readonly discountUnconditional?: number | null; - /** - * Format: double - * @description Valor Desconto Condicionado (vDescCond) - */ - readonly discountConditioning?: number | null; - /** - * Format: double - * @description Valor Total Retenção ISS (vISSRet) - */ - readonly totalRetentionISS?: number | null; - /** - * Format: double - * @description Código Regime Tributação (cRegTrib) - */ - readonly codeTaxRegime?: number | null; - }; - /** - * @description Grupo do ICMS da Operação própria e ST - * - * ID: N01 - * PAI: M01 - * - * Obs: Informar apenas um dos grupos N02, N03, N04, N05, N06, N07, N08, N09, N10, - * N10a, N10b, N10c, N10d, N10e, N10f, N10g ou N10h com base no conteúdo informado na TAG Tributação do ICMS. (v2.0) - */ - readonly IcmsTaxResource: { - /** @description Origem da mercadoria (orig) */ - readonly origin?: string | null; - /** @description Tributação do ICMS (CST) */ - readonly cst?: string | null; - /** - * @description 101- Tributada pelo Simples Nacional com permissão de crédito. (v.2.0) (CSOSN) - * Código de Situação da Operação – Simples Nacional - */ - readonly csosn?: string | null; - /** - * @description Modalidade de determinação da BC do ICMS (modBC) - * - * Margem Valor Agregado (%) = 0 - * Pauta (valor) = 1 - * Preço Tabelado Máximo (valor) = 2 - * Valor da Operação = 3 - * - */ - readonly baseTaxModality?: string | null; - /** - * Format: double - * @description Valor da BC do ICMS (vBC) - */ - readonly baseTax?: number | null; - /** @description Modalidade de determinação da BC do ICMS ST (modBCST) */ - readonly baseTaxSTModality?: string | null; - /** - * @description pRedBCST - * Percentual da Redução de BC do ICMS ST (pRedBCST) - */ - readonly baseTaxSTReduction?: string | null; - /** - * Format: double - * @description Valor da BC do ICMS ST (vBCST) - */ - readonly baseTaxST?: number | null; - /** - * Format: double - * @description Percentual da Redução de BC (pRedBC) - */ - readonly baseTaxReduction?: number | null; - /** - * Format: double - * @description Alíquota do imposto do ICMS ST (pICMSST) - */ - readonly stRate?: number | null; - /** - * Format: double - * @description Valor do ICMS ST (vICMSST) - */ - readonly stAmount?: number | null; - /** - * Format: double - * @description pMVAST - * Percentual da margem de valor Adicionado do ICMS ST (pMVAST) - */ - readonly stMarginAmount?: number | null; - /** - * Format: double - * @description pICMS - * Alíquota do imposto (pICMS) - */ - readonly rate?: number | null; - /** - * Format: double - * @description Valor do ICMS (vICMS) - * O valor do ICMS desonerado será informado apenas nas operações: - * a) com produtos beneficiados com a desoneração condicional do ICMS. - * b) destinadas à SUFRAMA, informando-se o valor que seria devido se não houvesse isenção. - * c) de venda a órgãos da administração pública direta e suas fundações e - * autarquias com isenção do ICMS. (NT 2011/004) - */ - readonly amount?: number | null; - /** - * Format: double - * @description Percentual da Redução de BC (pICMS) - */ - readonly percentual?: number | null; - /** - * Format: double - * @description Alíquota aplicável de cálculo do crédito (Simples Nacional). (pCredSN) - */ - readonly snCreditRate?: number | null; - /** - * Format: double - * @description Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 Simples Nacional (vCredICMSSN) - */ - readonly snCreditAmount?: number | null; - /** @description Percentual da margem de valor Adicionado do ICMS ST (pMVAST) */ - readonly stMarginAddedAmount?: string | null; - /** @description Valor do ICMS ST retido (vICMSSTRet) */ - readonly stRetentionAmount?: string | null; - /** @description Valor da BC do ICMS ST retido (vBCSTRet) */ - readonly baseSTRetentionAmount?: string | null; - /** - * @description Percentual da BC operação própria (pBCOp) - * Percentual para determinação do valor da Base de Cálculo da operação própria. (v2.0) - */ - readonly baseTaxOperationPercentual?: string | null; - /** - * @description UF para qual é devido o ICMS ST (UFST) - * Sigla da UF para qual é devido o ICMS ST da operação. (v2.0) - */ - readonly ufst?: string | null; - /** @description Motivo Desoneração ICMS */ - readonly amountSTReason?: string | null; - /** @description Valor da BC do ICMS ST retido (vBCSTRet) */ - readonly baseSNRetentionAmount?: string | null; - /** @description Valor do ICMS ST retido (vICMSSTRet) */ - readonly snRetentionAmount?: string | null; - /** @description Valor do ICMS da Operação (vICMSOp) */ - readonly amountOperation?: string | null; - /** @description Percentual do Diferimento (pDif) */ - readonly percentualDeferment?: string | null; - /** @description Valor do ICMS Diferido (vICMSDif) */ - readonly baseDeferred?: string | null; - /** - * Format: double - * @description Valor ICMS Desonerado - */ - readonly exemptAmount?: number | null; - readonly exemptReason?: components["schemas"]["ExemptReason"]; - /** - * Format: double - * @description Valor ICMS Desonerado - */ - readonly exemptAmountST?: number | null; - readonly exemptReasonST?: components["schemas"]["ExemptReason"]; - /** - * Format: double - * @description Percentual do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (pFCP) - */ - readonly fcpRate?: number | null; - /** - * Format: double - * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) - */ - readonly fcpAmount?: number | null; - /** - * Format: double - * @description Percentual do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (pFCPST) - */ - readonly fcpstRate?: number | null; - /** - * Format: double - * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST) - */ - readonly fcpstAmount?: number | null; - /** - * Format: double - * @description Percentual do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (pFCPSTRet) - */ - readonly fcpstRetRate?: number | null; - /** - * Format: double - * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) - */ - readonly fcpstRetAmount?: number | null; - /** - * Format: double - * @description Informar o valor da Base de Cálculo do FCP (vBCFCPST) - */ - readonly baseTaxFCPSTAmount?: number | null; - /** - * Format: double - * @description Valor do ICMS próprio do Substituto (tag: vICMSSubstituto) - */ - readonly substituteAmount?: number | null; - /** - * Format: double - * @description N26a - Alíquota suportada pelo Consumidor Final (pST) - * Deve ser informada a alíquota do cálculo do ICMS-ST, já incluso o FCP caso incida sobre a mercadoria - */ - readonly stFinalConsumerRate?: number | null; - /** - * Format: double - * @description N34 - Percentual de redução da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (pRedBCEfet) - */ - readonly effectiveBaseTaxReductionRate?: number | null; - /** - * Format: double - * @description N35 - Valor da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (vBCEfet) - */ - readonly effectiveBaseTaxAmount?: number | null; - /** - * Format: double - * @description N36 - Alíquota do ICMS efetiva, caso estivesse submetida ao regime comum de tributação (pICMSEFET) - */ - readonly effectiveRate?: number | null; - /** - * Format: double - * @description N37 - Valor do ICMS efetivo, caso estivesse submetida ao regime comum de tributação (vICMSEFET) - */ - readonly effectiveAmount?: number | null; - readonly deductionIndicator?: components["schemas"]["DuductionIndicator"]; - }; - /** @description Declaração Importação (DI) */ - readonly ImportDeclarationResource: { - /** @description Número do Documento de Importação da DI/DSI/DA (nDI) */ - readonly code?: string | null; - /** - * Format: date-time - * @description Data de Registro da DI/DSI/DA (dDI) - */ - readonly registeredOn?: string | null; - /** @description Local de desembaraço (xLocDesemb) */ - readonly customsClearanceName?: string | null; - readonly customsClearanceState?: components["schemas"]["StateCode"]; - /** - * Format: date-time - * @description Data do Desembaraço Aduaneiro (dDesemb) - */ - readonly customsClearancedOn?: string | null; - /** @description Adições (adi) */ - readonly additions?: (readonly components["schemas"]["AdditionResource"][]) | null; - /** @description Código do exportador (cExportador) */ - readonly exporter?: string | null; - readonly internationalTransport?: components["schemas"]["InternationalTransportType"]; - readonly intermediation?: components["schemas"]["IntermediationType"]; - /** @description CNPJ/CPF do adquirente ou do encomendante (CNPJ ou CPF) */ - readonly acquirerFederalTaxNumber?: string | null; - /** @description Sigla da UF do adquirente ou do encomendante (UFTerceiro) */ - readonly stateThird?: string | null; - }; - /** - * @description 1 - Pagamento integrado com o sistema de automação da empresa(Ex.: equipamento TEF, Comércio Eletrônico) - * 2 - Pagamento não integrado com o sistema de automação da empresa(Ex.: equipamento POS); - * @enum {string} - */ - readonly IntegrationPaymentType: "Integrated" | "NotIntegrated"; - /** @description Grupo de Informações do Intermediador da Transação (infIntermed) */ - readonly IntermediateResource: { - /** - * Format: int64 - * @description CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios. (CNPJ) - */ - readonly federalTaxNumber?: number | null; - /** @description Identificador cadastrado no intermediador (idCadIntTran) */ - readonly identifier?: string | null; + readonly "/v2/companies/{companyId}/productinvoices": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Listar as Notas Fiscais Eletrônicas (NFE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar uma lista de notas fiscais eletrônicas por empresa. + */ + readonly get: { + readonly parameters: { + readonly query: { + /** @description Tipo de Ambiente é obrigatório (Production or Test) */ + readonly environment: components["schemas"]["EnvironmentType"]; + /** @description Id de início do contador (Default: Empty) */ + readonly startingAfter?: string; + /** @description Id de fim do contador (Default: Empty) */ + readonly endingBefore?: string; + /** + * @description Buscar por parâmetros. ("ElasticSearch string query") Ex: (q=buyer.name:'EMPRESA LTDA'). Saiba mais + * em: https://nfe.io/docs/nota-fiscal-eletronica/integracao-api/consulta-elasticsearch + */ + readonly q?: string; + /** @description Limite de resultados na página (Default: 10) */ + readonly limit?: number; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta em lista */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ProductInvoicesResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + /** + * Emitir uma Nota Fiscal Eletrônica (NFE) + * @description ### Informações adicionais + * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de emissão. + * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo + * não garante a emissão do documento fiscal. + * Para obter um retorno ao final do processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos + * utilizar os WebHooks. + */ + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description Empresa ID */ + readonly companyId: string; + }; + readonly cookie?: never; + }; + /** @description Dados da nota fiscal a ser emitida */ + readonly requestBody?: { + readonly content: { + readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; + readonly "text/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; + readonly "application/*+json": components["schemas"]["ProductInvoiceQueueIssueResource"]; + readonly "application/xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; + readonly "text/xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; + readonly "application/*+xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; + }; + }; + readonly responses: { + /** @description Sucesso ao enfileirar para emissão */ + readonly 202: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * @description Tipo de Intermediação - * @enum {string} - */ - readonly IntermediationType: "None" | "ByOwn" | "ImportOnBehalf" | "ByOrder"; - /** - * @description Tipo Transporte Internacional - * @enum {string} - */ - readonly InternationalTransportType: "None" | "Maritime" | "River" | "Lake" | "Airline" | "Postal" | "Railway" | "Highway" | "Network" | "Own" | "Ficta" | "Courier" | "Handcarry"; - readonly InvoiceEventsResourceBase: { - /** @description Lista de Eventos ocorridos na Nota Fiscal */ - readonly events?: (readonly components["schemas"]["ActivityResource"][]) | null; - /** @description Identificador de possibilidade de mais itens. */ - readonly hasMore?: boolean | null; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar por ID uma Nota Fiscal Eletrônica (NFE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal Eletrônica que deverá ser retornada */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["InvoiceResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + /** + * Cancelar uma Nota Fiscal Eletrônica (NFE) + * @description ### Informações adicionais + * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de cancelamento. + * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo + * não garante o cancelamento do documento fiscal. + * Para obter um retorno ao final do processo de cancelamento de uma Nota Fiscal Eletrônica (NFe), + * recomendamos utilizar os WebHooks. + */ + readonly delete: { + readonly parameters: { + readonly query?: { + /** @description Motivo do cancelamento */ + readonly reason?: string; + }; + readonly header?: never; + readonly path: { + /** @description Empresa ID */ + readonly companyId: string; + /** @description ID da Nota Fiscal que deverá ser cancelada */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso ao enfileirar para cancelamento */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["RequestCancellationResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * @description Manual Contribuinte v_5.00 - * Grupo do detalhamento de Produtos e Serviços da NF-e - */ - readonly InvoiceItemResource: { - /** @description Código do produto ou serviço (cProd) */ - readonly code?: string | null; - /** - * @description GTIN (Global Trade Item Number) do produto, - * antigo código EAN ou código de barras (cEAN) - */ - readonly codeGTIN?: string | null; - /** @description Descrição do produto ou serviço (xProd) */ - readonly description?: string | null; - /** @description Código NCM com 8 dígitos ou 2 dígitos (gênero) (NCM) */ - readonly ncm?: string | null; - /** @description Nomenclatura de Valor aduaneiro e Estatístico (NVE) */ - readonly nve?: (readonly string[]) | null; - /** @description Código Exceção da Tabela de IPI */ - readonly extipi?: string | null; - /** - * Format: int64 - * @description Código Fiscal de Operações e Prestações (CFOP) - */ - readonly cfop?: number | null; - /** @description Unidade Comercial (uCom) */ - readonly unit?: string | null; - /** - * Format: double - * @description Quantidade Comercial (qCom) - */ - readonly quantity?: number | null; - /** - * Format: double - * @description Valor Unitário de Comercialização (vUnCom) - */ - readonly unitAmount?: number | null; - /** - * Format: double - * @description Valor Total Bruto dos Produtos ou Serviços (vProd) - */ - readonly totalAmount?: number | null; - /** - * @description GTIN (Global Trade Item Number) da unidade tributável, - * antigo código EAN ou código de barras (cEANTrib) - */ - readonly codeTaxGTIN?: string | null; - /** @description Unidade Tributável (uTrib) */ - readonly unitTax?: string | null; - /** - * Format: double - * @description Quantidade Tributável (qTrib) - */ - readonly quantityTax?: number | null; - /** - * Format: double - * @description Valor Unitário de tributação (vUnTrib) - */ - readonly taxUnitAmount?: number | null; - /** - * Format: double - * @description Valor Total do Frete (vFrete) - */ - readonly freightAmount?: number | null; - /** - * Format: double - * @description Valor Total do Seguro (vSeg) - */ - readonly insuranceAmount?: number | null; - /** - * Format: double - * @description Valor do Desconto (vDesc) - */ - readonly discountAmount?: number | null; - /** - * Format: double - * @description Outras despesas acessórias (vOutro) - */ - readonly othersAmount?: number | null; - /** - * @description Indica se valor do Item (vProd) - * entra no valor total da NF-e (vProd) (indTot) - */ - readonly totalIndicator?: boolean | null; - /** @description CEST - Código especificador da substituição tributária */ - readonly cest?: string | null; - readonly tax?: components["schemas"]["InvoiceItemTaxResource"]; - /** @description Informações Adicionais do Produto (infAdProd) */ - readonly additionalInformation?: string | null; - /** @description Número do pedido de compra (xPed) */ - readonly numberOrderBuy?: string | null; - /** - * Format: int32 - * @description Item do Pedido de Compra (nItemPed) - */ - readonly itemNumberOrderBuy?: number | null; - /** @description Número de controle da FCI - Ficha de Conteúdo de Importação (nFCI) */ - readonly importControlSheetNumber?: string | null; - readonly fuelDetail?: components["schemas"]["FuelResource"]; - /** @description Código de Benefício Fiscal na UF aplicado ao item (cBenef) */ - readonly benefit?: string | null; - /** @description Declaração Importação (DI) */ - readonly importDeclarations?: (readonly components["schemas"]["ImportDeclarationResource"][]) | null; - /** @description Grupo de informações de exportação para o item (detExport) */ - readonly exportDetails?: (readonly components["schemas"]["ExportDetailResource"][]) | null; - readonly taxDetermination?: components["schemas"]["TaxDeterminationResource"]; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}/items": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar os produtos por ID uma Nota Fiscal Eletrônica (NFE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: { + /** @description Limite de resultados na página (Default: 10) */ + readonly limit?: number; + /** @description Índice de início do contador (Default: 0) */ + readonly startingAfter?: number; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal Eletrônica que deverá ser retornada */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["InvoiceItemsResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly InvoiceItemTaxResource: { - /** - * Format: double - * @description Valor aproximado total de tributos federais, estaduais e municipais (vTotTrib) - */ - readonly totalTax?: number | null; - readonly icms?: components["schemas"]["IcmsTaxResource"]; - readonly ipi?: components["schemas"]["IPITaxResource"]; - readonly ii?: components["schemas"]["IITaxResource"]; - readonly pis?: components["schemas"]["PISTaxResource"]; - readonly cofins?: components["schemas"]["CofinsTaxResource"]; - readonly icmsDestination?: components["schemas"]["ICMSUFDestinationTaxResource"]; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}/events": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar eventos por ID uma Nota Fiscal Eletrônica (NFE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar os dados de uma Nota Fiscal Eletrônica (NFE) pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: { + /** @description Limite de resultados na página (Default: 10) */ + readonly limit?: number; + /** @description Índice de início do contador (Default: 0) */ + readonly startingAfter?: number; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal Eletrônica que deverá ser retornada */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ProductInvoiceEventsResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly InvoiceItemsResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificador da Empresa */ - readonly companyId?: string | null; - /** @description Identificador da Nota Fiscal */ - readonly id?: string | null; - /** @description Detalhamento de Produtos e Serviços (det) - Lista de Items da Nota Fiscal */ - readonly items?: (readonly components["schemas"]["InvoiceItemResource"][]) | null; - /** @description Identifica se existem mais items a serem consultados */ - readonly hasMore?: boolean | null; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}/pdf": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar a URL para o Documento Auxiliar Nota Fiscal Eletrônica (DANFE) + * em formato de arquivo PDF. + */ + readonly get: { + readonly parameters: { + readonly query?: { + /** @description Força a geração do pdf independente do FlowStatus */ + readonly force?: boolean; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal que deverá ser retornado */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do DANFE */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["FileResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly InvoiceResource: { - /** @description Identificador único */ - readonly id?: string | null; - /** - * Format: int32 - * @description Série do Documento Fiscal (serie) - */ - readonly serie?: number | null; - /** - * Format: int64 - * @description Número do Documento Fiscal (nNF) - */ - readonly number?: number | null; - readonly status?: components["schemas"]["InvoiceStatus"]; - readonly authorization?: components["schemas"]["AuthorizationResource"]; - readonly contingencyDetails?: components["schemas"]["ContingencyDetails"]; - /** @description Descrição da Natureza da Operação (natOp) */ - readonly operationNature?: string | null; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string | null; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string | null; - /** - * Format: date-time - * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) - * - * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. - * - */ - readonly operationOn?: string | null; - readonly operationType?: components["schemas"]["OperationType"]; - readonly environmentType?: components["schemas"]["EnvironmentType"]; - readonly purposeType?: components["schemas"]["PurposeType"]; - readonly issuer?: components["schemas"]["IssuerResource"]; - readonly buyer?: components["schemas"]["BuyerResource"]; - readonly totals?: components["schemas"]["TotalResource"]; - readonly transport?: components["schemas"]["TransportInformationResource"]; - readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; - readonly export?: components["schemas"]["ExportResource"]; - readonly billing?: components["schemas"]["BillingResource"]; - /** @description Grupo de Formas de Pagamento (pag) */ - readonly payment?: (readonly components["schemas"]["PaymentResource"][]) | null; - readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; - readonly delivery?: components["schemas"]["DeliveryInformationResource"]; - readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"]; - readonly lastEvents?: components["schemas"]["InvoiceEventsResourceBase"]; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar XML da Nota Fiscal Eletrônica (NFE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar os dados de uma nota fiscal Eletrônica pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal que deverá ser retornado */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do XML da NFE */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["FileResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @enum {string} */ - readonly InvoiceStatus: "None" | "Created" | "Processing" | "Issued" | "IssuedContingency" | "Cancelled" | "Disabled" | "IssueDenied" | "Error"; - readonly InvoiceWithoutEventsResource: { - /** @description Identificador único */ - readonly id?: string | null; - /** - * Format: int32 - * @description Série do Documento Fiscal (serie) - */ - readonly serie?: number | null; - /** - * Format: int64 - * @description Número do Documento Fiscal (nNF) - */ - readonly number?: number | null; - readonly status?: components["schemas"]["InvoiceStatus"]; - readonly authorization?: components["schemas"]["AuthorizationResource"]; - readonly contingencyDetails?: components["schemas"]["ContingencyDetails"]; - /** @description Descrição da Natureza da Operação (natOp) */ - readonly operationNature?: string | null; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string | null; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string | null; - /** - * Format: date-time - * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) - * - * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. - * - */ - readonly operationOn?: string | null; - readonly operationType?: components["schemas"]["OperationType"]; - readonly environmentType?: components["schemas"]["EnvironmentType"]; - readonly purposeType?: components["schemas"]["PurposeType"]; - readonly issuer?: components["schemas"]["IssuerResource"]; - readonly buyer?: components["schemas"]["BuyerResource"]; - readonly totals?: components["schemas"]["TotalResource"]; - readonly transport?: components["schemas"]["TransportInformationResource"]; - readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; - readonly export?: components["schemas"]["ExportResource"]; - readonly billing?: components["schemas"]["BillingResource"]; - /** @description Grupo de Formas de Pagamento (pag) */ - readonly payment?: (readonly components["schemas"]["PaymentResource"][]) | null; - readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; - readonly delivery?: components["schemas"]["DeliveryInformationResource"]; - readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"]; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml/rejection": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar XML de rejeição da Nota Fiscal Eletrônica (NFE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar o motivo da rejeição de uma nota fiscal Eletrônica pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal que deverá ser retornado */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do XML da NFE */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["FileResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly IssuerFromRequestResource: { - /** @description IE do Substituto Tributário (IEST) */ - readonly stStateTaxNumber?: string | null; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml-rejection": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar XML de rejeição da Nota Fiscal Eletrônica (NFE) + * @description ### Informações adicionais + * Utilize esta requisição para consultar o motivo da rejeição de uma nota fiscal Eletrônica pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal que deverá ser retornado */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do XML da NFE */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["FileResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo de identificação do emitente da NF-e - */ - readonly IssuerResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Nome ou Razão Social (xNome) */ - readonly name?: string | null; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number | null; - /** @description Email */ - readonly email?: string | null; - readonly address?: components["schemas"]["AddressResource"]; - readonly type?: components["schemas"]["PersonType"]; - /** @description Nome Fantasia */ - readonly tradeName?: string | null; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate?: string | null; - readonly taxRegime?: components["schemas"]["TaxRegime"]; - readonly specialTaxRegime?: components["schemas"]["SpecialTaxRegime"]; - readonly legalNature?: components["schemas"]["LegalNature"]; - /** @description Atividades da Empresa (CNAE) */ - readonly economicActivities?: (readonly components["schemas"]["EconomicActivityResource"][]) | null; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number | null; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number | null; - /** - * Format: int64 - * @description Inscrição Estadual do Substituto Tributário (IEST) - */ - readonly regionalSTTaxNumber?: number | null; - /** @description Número de Inscrição na Prefeitura (IM/CCM) */ - readonly municipalTaxNumber?: string | null; - /** @description IE do Substituto Tributário (IEST) */ - readonly stStateTaxNumber?: string | null; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}/xml-epec": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** Consultar XML da autorização em contingência (EPEC) */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal que deverá ser retornado */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do XML da NFE */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["FileResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @enum {string} */ - readonly LegalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @enum {string} */ - readonly OperationType: "Outgoing" | "Incoming"; - /** @description Grupo do PIS */ - readonly PISTaxResource: { - /** @description Código de Situação Tributária do PIS (CST) */ - readonly cst?: string | null; - /** - * Format: double - * @description Valor da Base de Cálculo do PIS (vBC) - */ - readonly baseTax?: number | null; - /** - * Format: double - * @description Alíquota do PIS (em percentual) (pPIS) - */ - readonly rate?: number | null; - /** - * Format: double - * @description Valor do PIS (vPIS) - */ - readonly amount?: number | null; - /** - * Format: double - * @description Quantidade Vendida (qBCProd) - */ - readonly baseTaxProductQuantity?: number | null; - /** - * Format: double - * @description Alíquota do PIS (em reais) (vAliqProd) - */ - readonly productRate?: number | null; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + /** + * Enviar uma carta de correção para Nota Fiscal Eletrônica (CC-e) + * @description ### Informações adicionais + * Utilize esta requisição para enviar uma carta de correção na Nota Fiscal Eletrônica (NFE). + * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo + * não garante a execução do documento fiscal. + * Para obter um retorno ao final do processo de carta de correção de uma Nota Fiscal Eletrônica (NFe), + * recomendamos utilizar os WebHooks. + */ + readonly put: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description Empresa ID */ + readonly companyId: string; + /** @description ID da Nota Fiscal que deverá ser cancelada */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": components["schemas"]["QueueEventResource"]; + readonly "text/json": components["schemas"]["QueueEventResource"]; + readonly "application/*+json": components["schemas"]["QueueEventResource"]; + readonly "application/xml": components["schemas"]["QueueEventResource"]; + readonly "text/xml": components["schemas"]["QueueEventResource"]; + readonly "application/*+xml": components["schemas"]["QueueEventResource"]; + }; + }; + readonly responses: { + /** @description Sucesso ao enfileirar para cancelamento */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["RequestCancellationResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly PaymentDetailResource: { - readonly method?: components["schemas"]["PaymentMethod"]; - /** @description Descrição do meio de pagamento (xPag) */ - readonly methodDescription?: string | null; - readonly paymentType?: components["schemas"]["PaymentType"]; - /** - * Format: double - * @description Valor do Pagamento (vPag) - */ - readonly amount?: number | null; - readonly card?: components["schemas"]["CardResource"]; - /** - * Format: date-time - * @description Data do pagamento (dPag) - */ - readonly paymentDate?: string | null; - /** @description CNPJ transacional do pagamento (CNPJPag) */ - readonly federalTaxNumberPag?: string | null; - /** @description UF do CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (UFPag) */ - readonly statePag?: string | null; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter/pdf": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar PDF do Documento Auxiliar da Nota Fiscal Eletrônica (DANFE) de Carta de Correção (CC-e) + * @description ### Informações adicionais + * Utilize esta requisição para consultar a URL para o Documento Auxiliar Nota Fiscal Eletrônica (DANFE) + * em formato de arquivo PDF. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal que deverá ser retornado */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do DANFE */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["FileResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @enum {string} */ - readonly PaymentMethod: "Cash" | "Cheque" | "CreditCard" | "DebitCard" | "StoreCredict" | "FoodVouchers" | "MealVouchers" | "GiftVouchers" | "FuelVouchers" | "BankBill" | "BankDeposit" | "InstantPayment" | "WireTransfer" | "Cashback" | "WithoutPayment" | "Others"; - readonly PaymentResource: { - /** - * @description YA01a - Grupo Detalhamento da Forma de Pagamento (detPag) - * VERSÃO 4.00 - */ - readonly paymentDetail?: (readonly components["schemas"]["PaymentDetailResource"][]) | null; - /** - * Format: double - * @description Valor do troco (vTroco) - * VERSÃO 4.00 - */ - readonly payBack?: number | null; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}/correctionletter/xml": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar XML da Carta de Correção Eletrônica (CC-e) + * @description ### Informações adicionais + * Utilize esta requisição para consultar os dados da carta de correção de uma nota fiscal Eletrônica pelo ID. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly companyId: string; + /** @description ID da Nota Fiscal que deverá ser retornado */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do XML da NFE */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["FileResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @enum {string} */ - readonly PaymentType: "InCash" | "Term"; - /** @enum {string} */ - readonly PersonType: "Undefined" | "NaturalPerson" | "LegalEntity" | "Company" | "Customer"; - /** @enum {string} */ - readonly PrintType: "None" | "NFeNormalPortrait" | "NFeNormalLandscape" | "NFeSimplified" | "DANFE_NFC_E" | "DANFE_NFC_E_MSG_ELETRONICA"; - readonly ProductInvoiceEventsResource: { - /** @description Lista de Eventos ocorridos na Nota Fiscal */ - readonly events?: (readonly components["schemas"]["ActivityResource"][]) | null; - /** @description Identificador de possibilidade de mais itens. */ - readonly hasMore?: boolean | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificador da Empresa */ - readonly companyId?: string | null; + readonly "/v2/companies/{companyId}/productinvoices/{invoiceId}/disablement": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Inutilizar uma Nota Fiscal Eletrônica (NFE) + * @description ### Informações adicionais + * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de inutilização. + * **ATENÇÃO**: O processamento será feito de forma assíncrona, ou seja, o retorno positivo + * não garante a inutilização do documento fiscal. + * Para obter um retorno ao final do processo de inutilização de uma Nota Fiscal Eletrônica (NFe), + * recomendamos utilizar os WebHooks. + */ + readonly post: { + readonly parameters: { + readonly query?: { + /** @description Motivo da inutilização */ + readonly reason?: string; + }; + readonly header?: never; + readonly path: { + /** @description Empresa ID */ + readonly companyId: string; + /** @description ID da Nota Fiscal que deverá ser inutilizada */ + readonly invoiceId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso ao enfileirar para inutilização */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["RequestCancellationResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @description Notas Fiscais Eletrônicas (NFe) */ - readonly ProductInvoiceQueueIssueResource: { - /** @description Identificador único */ - readonly id?: string | null; - /** @description Grupo de Formas de Pagamento (pag) */ - readonly payment?: (readonly components["schemas"]["PaymentResource"][]) | null; - /** - * Format: int32 - * @description Série do Documento Fiscal (serie) - */ - readonly serie?: number | null; - /** - * Format: int64 - * @description Número do Documento Fiscal (nNF) - */ - readonly number?: number | null; - /** - * Format: date-time - * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) - * - * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. - * - */ - readonly operationOn?: string | null; - /** @description Descrição da Natureza da Operação (natOp) */ - readonly operationNature?: string | null; - readonly operationType?: components["schemas"]["OperationType"]; - readonly destination?: components["schemas"]["Destination"]; - readonly printType?: components["schemas"]["PrintType"]; - readonly purposeType?: components["schemas"]["PurposeType"]; - readonly consumerType?: components["schemas"]["ConsumerType"]; - readonly presenceType?: components["schemas"]["ConsumerPresenceType"]; - /** - * Format: date-time - * @description Data e Hora da entrada em contingência (dhCont) - * - * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD - * - */ - readonly contingencyOn?: string | null; - /** @description Justificativa da entrada em contingência (xJust) */ - readonly contingencyJustification?: string | null; - readonly buyer?: components["schemas"]["BuyerResource"]; - readonly transport?: components["schemas"]["TransportInformationResource"]; - readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; - readonly export?: components["schemas"]["ExportResource"]; - /** @description Detalhamento de Produtos e Serviços (det) */ - readonly items?: (readonly components["schemas"]["InvoiceItemResource"][]) | null; - readonly billing?: components["schemas"]["BillingResource"]; - readonly issuer?: components["schemas"]["IssuerFromRequestResource"]; - readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; - readonly delivery?: components["schemas"]["DeliveryInformationResource"]; - readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"]; - readonly totals?: components["schemas"]["Total"]; + readonly "/v2/companies/{companyId}/productinvoices/disablement": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Inutilizar números de nota fiscal + * @description ### Informações adicionais + * Caso seja um único número, utilizar o Número inicial e o Número final com o mesmo valor + */ + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly companyId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": components["schemas"]["DisablementResource"]; + readonly "text/json": components["schemas"]["DisablementResource"]; + readonly "application/*+json": components["schemas"]["DisablementResource"]; + readonly "application/xml": components["schemas"]["DisablementResource"]; + readonly "text/xml": components["schemas"]["DisablementResource"]; + readonly "application/*+xml": components["schemas"]["DisablementResource"]; + }; + }; + readonly responses: { + /** @description Sucesso */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["DisablementResource"]; + }; + }; + /** @description Algum parâmetro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Nota Fiscal Eletrônica não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @description Notas Fiscais Eletrônicas (NF-e) */ - readonly ProductInvoicesResource: { - /** @description Lista de Notas Fiscais Eletrônicas (NF-e) */ - readonly productInvoices?: (readonly components["schemas"]["InvoiceWithoutEventsResource"][]) | null; - /** @description Identificador de possibilidade de mais itens. */ - readonly hasMore?: boolean; + readonly "/v2/companies/{companyId}/statetaxes/{statetaxId}/productinvoices": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Emitir uma Nota Fiscal Eletrônica (NFE) Informando um StateTaxId + * @description ### Informações adicionais + * Utilize esta requisição para enviar uma Nota Fiscal Eletrônica (NFE) para fila de emissão. + * **ATENÇÃO**: Cada processamento será feito de forma assíncrona, ou seja, o retorno positivo + * não garante a emissão do documento fiscal. + * Para obter um retorno ao final do processo de emissão de uma Nota Fiscal Eletrônica (NFe), recomendamos + * utilizar os WebHooks. + */ + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description Empresa ID */ + readonly companyId: string; + /** @description Inscrição Estadual(StateTax) ID */ + readonly statetaxId: string; + }; + readonly cookie?: never; + }; + /** @description Dados da nota fiscal a ser emitida */ + readonly requestBody?: { + readonly content: { + readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; + readonly "text/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; + readonly "application/*+json": components["schemas"]["ProductInvoiceQueueIssueResource"]; + readonly "application/xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; + readonly "text/xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; + readonly "application/*+xml": components["schemas"]["ProductInvoiceQueueIssueResource"]; + }; + }; + readonly responses: { + /** @description Sucesso ao enfileirar para emissão */ + readonly 202: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ProductInvoiceQueueIssueResource"]; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Tempo limite de 60s excedido no enfileiramento */ + readonly 408: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["ErrorsResource"]; + }; + }; + }; + }; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly PumpResource: { - /** - * Format: int32 - * @description Número de identificação do bico utilizado no abastecimento (nBico) - */ - readonly spoutNumber?: number | null; - /** - * Format: int32 - * @description Número de identificação da bomba ao qual o bico está interligado (nBomba) - */ - readonly number?: number | null; - /** - * Format: int32 - * @description Número de identificação do tanque ao qual o bico está interligado (nTanque) - */ - readonly tankNumber?: number | null; - /** - * Format: double - * @description Valor do Encerrante no início do abastecimento (vEncIni) - */ - readonly beginningAmount?: number | null; - /** - * Format: double - * @description Valor do Encerrante no final do abastecimento (vEncFin) - */ - readonly endAmount?: number | null; - /** - * Format: double - * @description Percentual do índice de mistura do Biodiesel (B100) no Óleo Diesel B instituído pelo órgão regulamentador - */ - readonly percentageBio?: number | null; + readonly "/v2/webhooks/eventtypes": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Listar os Tipos de Eventos gerados pela plataforma + * @description ### Informações adicionais + * + * Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados + * criando notificações para os webhooks ativos e configurados para receber os eventos. + * + * São identificados seguindo o padrão **Resource.EventAction**, + * onde **Resource**: nome da entidade que gerou o evento; + * **EventAction**: nome do evento e ação criados. + * + * Esse tipos podem ser utilizados como filtro ao criar ou alterar um webhook, + * sendo que o filtro determina quais notificações de eventos e ação serão enviadas + * para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook + * ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do tipos de eventos */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Evento */ + readonly eventTypes?: readonly { + /** + * @description Identificador do evento, seguem o padrão **Resource.EventAction**. + * Onde **Resource**: nome da entidade que gerou o evento; + * **EventAction**: nome do evento e ação criados. + * Alguns exemplos **Invoice.Issued** ou **Blob.Updated** + */ + readonly id?: string; + /** @description Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. */ + readonly description?: string; + /** + * Format: int32 + * @description WebHook Filter Status + * @enum {integer} + */ + readonly status?: 0 | 1; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @enum {string} */ - readonly PurposeType: "None" | "Normal" | "Complement" | "Adjustment" | "Devolution"; - readonly QueueEventResource: { - /** - * @description Justificativa da carta de correção - * O Texto deve conter no mínimo 15 e no máximo 1.000 caracteres - * (os quais não poderão conter acentos e/ou caracteres especiais) - */ - readonly reason?: string | null; + readonly "/v2/webhooks": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Listar os Webhooks + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar uma lista de **Webhooks** cadastrados na Conta Autenticada. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta da lista */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Web Hook */ + readonly webHooks?: readonly { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }[]; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly put?: never; + /** + * Criar um Webhook + * @description ### Informações adicionais + * + * Utilize esta requisição para criar novos **Webhooks** para receber as notificações de eventos ocorridos na plataforma. + * + * Na criação do **Webhook** a URL informada no cadastro deve ser responsiva, ou seja, deverá responder *(HTTP Status 200 OK)* a uma requisição *(HTTP POST)* que será feita para testar se a URL está operando como normalmente, caso contrario uma mensagem de erro será retornada. + * + * Um **Webhook** é semelhante a uma assinatura em um *sistema de publicação e assinatura* + * que permite ao assinante indicar *quando*, *como* e *onde* as notificações de eventos deve ser despachadas. + * Um **Webhook** é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos + * que podem ser acionados por eventos gerados através de ações executadas por esse Conta. + * Ou seja, a **Conta da _Empresa A_** não verá os WebHooks disparados por uma ação executada pelo usuário **Conta da _Empresa B_**. + */ + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json-patch+json": { + /** @description Dados para criar um Web Hook */ + readonly webHook?: { + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "application/json": { + /** @description Dados para criar um Web Hook */ + readonly webHook?: { + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "text/json": { + /** @description Dados para criar um Web Hook */ + readonly webHook?: { + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "application/*+json": { + /** @description Dados para criar um Web Hook */ + readonly webHook?: { + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na criação da webhook */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description WebHook (Notificação HTTP) */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + /** + * Excluir Todos os Webhooks existentes + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir todos os **Webhooks** cadastrados para a Conta Autenticada. + */ + readonly delete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão dos WebHooks */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo Reboque - */ - readonly ReboqueResource: { - /** @description Placa do Veiculo (placa) */ - readonly plate?: string | null; - /** @description UF Veiculo Reboque (UF) */ - readonly uf?: string | null; - /** @description Registro Nacional de Transportador de Carga (ANTT) (RNTC) */ - readonly rntc?: string | null; - /** @description Identificação do Vagão (vagao) */ - readonly wagon?: string | null; - /** @description Identificação da Balsa (balsa) */ - readonly ferry?: string | null; + readonly "/v2/webhooks/{webhook_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Consultar um webhook existente + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**. + */ + readonly get: operations["RegistrationLookupAction"]; + /** + * Alterar um Webhook existente + * @description ### Informações adicionais + * + * Utilize esta requisição para alterar os dados do **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. + */ + readonly put: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do Webhook a ser atualizado */ + readonly webhook_id: string; + }; + readonly cookie?: never; + }; + /** @description Dados para alterar o Webhook */ + readonly requestBody?: { + readonly content: { + readonly "application/json-patch+json": { + /** @description WebHook (Notificação HTTP) */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "application/json": { + /** @description WebHook (Notificação HTTP) */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "text/json": { + /** @description WebHook (Notificação HTTP) */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + readonly "application/*+json": { + /** @description WebHook (Notificação HTTP) */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na atualização da Webhook */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description WebHook (Notificação HTTP) */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly post?: never; + /** + * Excluir um Webhook existente + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir o **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. + * A exclusão do **Webhook** não exime o **Webhook** excluído de receber os notificações de eventos, já ocorridos na plataforma, que ainda estejam em processo de retentativa de envio dos gatilhos. + */ + readonly delete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do Webhook a ser excluído */ + readonly webhook_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão da Webhook */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** @enum {string} */ - readonly ReceiverStateTaxIndicator: "None" | "TaxPayer" | "Exempt" | "NonTaxPayer"; - readonly ReferencedProcessResource: { - readonly identifierConcessory?: string | null; - /** Format: int32 */ - readonly identifierOrigin?: number | null; - /** Format: int32 */ - readonly concessionActType?: number | null; + readonly "/v2/webhooks/{webhook_id}/pings": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + /** + * Criar notificação para Testar um webhook + * @description ### Informações adicionais + * + * Utilize esta requisição para criar uma notificação de teste (ping) em um **Webhook** já cadastrado. + * + * Esta ação irá criar um evento de notificação do tipo ping para o **Webhook** especificado, deste modo você poderá simular o recebimento de uma notificação de teste no **Webhook** cadastrado. + */ + readonly put: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do Webhook a ser testado */ + readonly webhook_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso ao criar notificação de teste */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - readonly RequestCancellationResource: { - readonly accountId?: string | null; - readonly companyId?: string | null; - readonly productInvoiceId?: string | null; - readonly reason?: string | null; - }; - /** @enum {string} */ - readonly ShippingModality: "ByIssuer" | "ByReceiver" | "ByThirdParties" | "OwnBySender" | "OwnByBuyer" | "Free"; - /** - * @description Regime especial de tributação - * @enum {string} - */ - readonly SpecialTaxRegime: "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte" | "Automatico"; - /** @enum {string} */ - readonly StateCode: "NA" | "RO" | "AC" | "AM" | "RR" | "PA" | "AP" | "TO" | "MA" | "PI" | "CE" | "RN" | "PB" | "PE" | "AL" | "SE" | "BA" | "MG" | "ES" | "RJ" | "SP" | "PR" | "SC" | "RS" | "MS" | "MT" | "GO" | "DF" | "EX"; - /** @enum {string} */ - readonly StateTaxProcessingAuthorizer: "Normal" | "EPEC"; - readonly TaxCouponInformationResource: { - /** @description Modelo de Documento Fiscal (mod) */ - readonly modelDocumentFiscal?: string | null; - /** @description Número de Ordem Sequencial do ECF (nECF) */ - readonly orderECF?: string | null; - /** - * Format: int32 - * @description Número do Contador de Ordem de Operação (nCOO) - */ - readonly orderCountOperation?: number | null; - }; - readonly TaxDeterminationResource: { - /** - * Format: int32 - * @description Código interno para determinação de natureza de operação - */ - readonly operationCode?: number | null; - /** @description Perfil fiscal do vendedor (origem) - usado para o cálculo automático de impostos */ - readonly issuerTaxProfile?: string | null; - /** @description Perfil fiscal do comprador (destino) - usado para o cálculo automático de impostos */ - readonly buyerTaxProfile?: string | null; - /** @description Origem da mercadoria */ - readonly origin?: string | null; - /** @description Finalidade de aquisição - usado para o cálculo automático de impostos */ - readonly acquisitionPurpose?: string | null; - }; - readonly TaxDocumentsReferenceResource: { - readonly taxCouponInformation?: components["schemas"]["TaxCouponInformationResource"]; - readonly documentInvoiceReference?: components["schemas"]["DocumentInvoiceReferenceResource"]; - readonly documentElectronicInvoice?: components["schemas"]["DocumentElectronicInvoiceResource"]; - }; - /** - * @description Regime de tributação - * @enum {string} - */ - readonly TaxRegime: "None" | "LucroReal" | "LucroPresumido" | "SimplesNacional" | "SimplesNacionalExcessoSublimite" | "MicroempreendedorIndividual" | "Isento"; - readonly TaxpayerCommentsResource: { - /** @description Campo (xCampo) */ - readonly field?: string | null; - /** @description Texto (xTexto) */ - readonly text?: string | null; - }; - readonly Total: { - readonly icms?: components["schemas"]["ICMSTotal"]; - readonly issqn?: components["schemas"]["ISSQNTotal"]; - }; - readonly TotalResource: { - readonly icms?: components["schemas"]["ICMSTotalResource"]; - readonly issqn?: components["schemas"]["ISSQNTotalResource"]; - }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo Transportador - */ - readonly TransportGroupResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Nome ou Razão Social (xNome) */ - readonly name?: string | null; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number | null; - /** @description Email */ - readonly email?: string | null; - readonly address?: components["schemas"]["AddressResource"]; - readonly type?: components["schemas"]["PersonType"]; - /** @description Inscrição Estadual do Transportador (IE) */ - readonly stateTaxNumber?: string | null; - /** @description Grupo de Retenção do ICMS do transporte */ - readonly transportRetention?: string | null; - }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo de Informações do Transporte da NF-e - * Id: X01 Pai: A1 - */ - readonly TransportInformationResource: { - readonly freightModality?: components["schemas"]["ShippingModality"]; - readonly transportGroup?: components["schemas"]["TransportGroupResource"]; - readonly reboque?: components["schemas"]["ReboqueResource"]; - readonly volume?: components["schemas"]["VolumeResource"]; - readonly transportVehicle?: components["schemas"]["TransportVehicleResource"]; - /** @description Número dos Lacres */ - readonly sealNumber?: string | null; - readonly transpRate?: components["schemas"]["TransportRateResource"]; - }; - readonly TransportRateResource: { - /** - * Format: double - * @description Valor do Serviço (vServ) - */ - readonly serviceAmount?: number | null; - /** - * Format: double - * @description BC da Retenção do ICMS (vBCRet) - */ - readonly bcRetentionAmount?: number | null; - /** - * Format: double - * @description Alíquota da Retenção (pICMSRet) //Change to Rate - */ - readonly icmsRetentionRate?: number | null; - /** - * Format: double - * @description Valor do ICMS Retido (vICMSRet) - */ - readonly icmsRetentionAmount?: number | null; - /** - * Format: int64 - * @description CFOP de Serviço de Transporte (CFOP) - */ - readonly cfop?: number | null; - /** - * Format: int64 - * @description Código do Municipio de ocorrencia do fato gerador do ICMS do Transporte (cMunFG) - */ - readonly cityGeneratorFactCode?: number | null; - }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Grupo Veiculo - */ - readonly TransportVehicleResource: { - /** @description Placa do Veiculo (placa) */ - readonly plate?: string | null; - /** @description Sigla da UF (UF) */ - readonly state?: string | null; - /** @description Registro Nacional de Transportador de Carga (ANTT) (RNTC) */ - readonly rntc?: string | null; - }; - /** - * @description Manual_de_Orientação_Contribuinte_v_5.00 - * Volumes - * Id:X26 - */ - readonly VolumeResource: { - /** - * Format: int32 - * @description Quantidade de volumes transportados (qVol) - */ - readonly volumeQuantity?: number | null; - /** @description Espécie dos volumes transportados (esp) */ - readonly species?: string | null; - /** @description Marca dos Volumes Transportados (marca) */ - readonly brand?: string | null; - /** @description Numeração dos Volumes Transportados (nVol) */ - readonly volumeNumeration?: string | null; - /** - * Format: double - * @description Peso Liquido(em Kg) (pesoL) - */ - readonly netWeight?: number | null; - /** - * Format: double - * @description Peso Bruto(em Kg) (pesoB) - */ - readonly grossWeight?: number | null; - }; - /** @description Identificação do Local de retirada (retirada) */ - readonly WithdrawalInformationResource: { - /** @description Identificador da Conta */ - readonly accountId?: string | null; - /** @description Identificação */ - readonly id?: string | null; - /** @description Nome ou Razão Social (xNome) */ - readonly name?: string | null; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number | null; - /** @description Email */ - readonly email?: string | null; - readonly address?: components["schemas"]["AddressResource"]; - readonly type?: components["schemas"]["PersonType"]; - /** @description Inscrição Estadual (IE) */ - readonly stateTaxNumber?: string | null; - }; - }; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; -}; - -export type $defs = Record; - -export type external = Record; - -export type operations = { - - /** - * Consultar todas as Empresas da Conta - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados das empresas vinculadas a conta. - */ - V2CompaniesGet: { - parameters: { - query?: { - /** @description Id de início do contador (Default: Empty) */ - startingAfter?: string; - /** @description Id final do contador (Default: Empty) */ - endingBefore?: string; - /** @description Limite de resultados na página (Default: 10) */ - limit?: number; - }; - }; - responses: { - /** @description Sucesso na consulta da Empresa */ - 200: { - content: { - readonly "application/json": { - /** @description Lista de Empresa */ - readonly companies?: readonly ({ - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Lista de Inscrição Estadual */ - readonly stateTaxes?: readonly string[]; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; - /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - })[]; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Empresa não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Criar uma Empresa - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - */ - V2CompaniesPost: { - /** @description Dados da Empresa a ser criada */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; +} +export type webhooks = Record; +export interface components { + schemas: { + readonly ActivityResource: { + /** @description Detalhes do Evento */ + readonly data?: unknown; + /** @description Nome do Evento gerado */ + readonly type?: string | null; /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - readonly "text/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; + * Format: int32 + * @description Número sequencial do Evento + */ + readonly sequence?: number | null; + }; + /** @description Adições (adi) */ + readonly AdditionResource: { /** * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - readonly "application/*+json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; + * @description Numero da adição (nAdicao) + */ + readonly code?: number | null; + /** @description Código do fabricante estrangeiro (cFabricante) */ + readonly manufacturer?: string | null; /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - }; - }; - responses: { - /** @description Sucesso na criação da Empresa */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Lista de Inscrição Estadual */ - readonly stateTaxes?: readonly string[]; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; - /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Consultar uma Empresa pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de uma empresas pelo ID. - */ - V2CompaniesByCompany_idGet: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - company_id: string; - }; - }; - responses: { - /** @description Sucesso na consulta da Empresa */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Lista de Inscrição Estadual */ - readonly stateTaxes?: readonly string[]; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; - /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Empresa não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Alterar uma Empresa pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados de uma empresas pelo ID. - */ - V2CompaniesByCompany_idPut: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - company_id: string; - }; - }; - /** @description Dados da Empresa a ser alterada */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; + * Format: double + * @description Valor do desconto do item da DI – Adição (vDescDI) + */ + readonly amount?: number | null; /** * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - readonly "text/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; + * @description Número do ato concessório de Drawback (nDraw) + */ + readonly drawback?: number | null; + }; + readonly AdditionalInformationResource: { + /** @description Informações Adicionais de Interesse do Fisco (infAdFisco) */ + readonly fisco?: string | null; + /** @description Informações Complementares de interesse do Contribuinte (infCpl) */ + readonly taxpayer?: string | null; + /** @description Informações Complementares de interesse do Contribuinte (infCpl) */ + readonly xmlAuthorized?: readonly number[] | null; + readonly effort?: string | null; + readonly order?: string | null; + readonly contract?: string | null; + /** @description Documentos Fiscais Referenciados (refECF) */ + readonly taxDocumentsReference?: readonly components["schemas"]["TaxDocumentsReferenceResource"][] | null; + /** @description Observações fiscais (obsCont) */ + readonly taxpayerComments?: readonly components["schemas"]["TaxpayerCommentsResource"][] | null; + /** @description Processos referenciados (procRef) */ + readonly referencedProcess?: readonly components["schemas"]["ReferencedProcessResource"][] | null; + }; + /** @description Dados do Endereço */ + readonly AddressResource: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state?: string | null; + readonly city?: components["schemas"]["CityResource"]; + /** @description Bairro do Endereço */ + readonly district?: string | null; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string | null; + /** @description Logradouro do Endereço */ + readonly street?: string | null; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number?: string | null; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode?: string | null; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country?: string | null; + /** @description Telefone */ + readonly phone?: string | null; + }; + readonly AuthorizationResource: { + /** Format: date-time */ + readonly receiptOn?: string | null; + readonly accessKey?: string | null; + readonly message?: string | null; + }; + readonly BillResource: { + /** @description Número da Fatura (nFat) */ + readonly number?: string | null; /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - readonly "application/*+json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; + * Format: double + * @description Valor Original da Fatura (vOrig) + */ + readonly originalAmount?: number | null; + /** + * Format: double + * @description Valor do desconto (vDesc) + */ + readonly discountAmount?: number | null; + /** + * Format: double + * @description Valor Líquido da Fatura (vLiq) + */ + readonly netAmount?: number | null; + }; + readonly BillingResource: { + readonly bill?: components["schemas"]["BillResource"]; + /** @description Grupo Duplicata (dup) */ + readonly duplicates?: readonly components["schemas"]["DuplicateResource"][] | null; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo de endereço do Destinatário da NF-e + */ + readonly BuyerResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Nome ou Razão Social (xNome) */ + readonly name?: string | null; /** * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - }; - }; - responses: { - /** @description Sucesso na alteração da Empresa */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Empresa */ - readonly company?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** @description Lista de Inscrição Estadual */ - readonly stateTaxes?: readonly string[]; - /** @description Razão Social */ - readonly name: string; - /** @description Identificador da conta */ - readonly accountId?: string; - /** @description Nome Fantasia */ - readonly tradeName: string; - /** - * Format: int64 - * @description Número de Inscrição Federal (CNPJ) - */ - readonly federalTaxNumber: number; - /** - * @description Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; - /** @description Endereço */ - readonly address: { - /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ - readonly state: string; - /** @description Cidade do Endereço */ - readonly city: { - /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ - readonly code: string; - /** @description Nome do Município */ - readonly name: string; - }; - /** @description Bairro do Endereço */ - readonly district: string; - /** @description Complemento do Endereço, ex.: AP 2, BL A. */ - readonly additionalInformation?: string; - /** @description Logradouro do Endereço */ - readonly street: string; - /** @description Número do Endereço. Usar S/N para "sem número". */ - readonly number: string; - /** @description Cód. Endereço Postal (CEP) */ - readonly postalCode: string; - /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ - readonly country: string; - }; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Empresa não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Excluir uma Empresa por ID - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir uma empresas pelo ID, cuidado pois esse processo é irreversível. - */ - V2CompaniesByCompany_idDelete: { - parameters: { - path: { - /** @description ID da Empresa que deverá ser retornado */ - company_id: string; - }; - }; - responses: { - /** @description Sucesso na exclusão da Empresa */ - 204: { - content: { - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Empresa não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Consultar um Certificado por seu Status - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através d0 **status do certificado** (__status__). - */ - V2CompaniesByCompany_idCertificatesGet: { - parameters: { - query?: { - /** @description Status do certificado */ - status?: "inactive" | "overdue" | "pending" | "active" | "none"; - }; - path: { - /** @description ID da Empresa relacionada ao certificado */ - company_id: string; - }; - }; - responses: { - /** @description Sucesso na consulta */ - 200: { - content: { - readonly "application/json": { - readonly certificates?: readonly ({ - /** @description Nome do certificado (subject distinguished name) */ - readonly subject?: string; - /** - * Format: date-time - * @description Data no horário local após o qual um certificado não é mais válido - */ - readonly validUntil?: string; - /** @description A impressão digital do certificado */ - readonly thumbprint?: string; - /** @description CNPJ da Empresa */ - readonly federalTaxNumber?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; - })[]; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Upload de um Certificado - * @description ### Informações adicionais - * - * Utilize esta requisição para fazer upload de um **Certificado da ICP-Brasil** do tipo __e-CNPJ A1__ ou __NFE A1__ em uma **Empresa** e vincula-lo para processamentos. - * - * O **Certificado da ICP-Brasil** funciona como uma identidade virtual, para empresas e pessoas, que permite a identificação segura e inequívoca do autor de uma mensagem ou transação feita em meios eletrônicos, como a web. - */ - V2CompaniesByCompany_idCertificatesPost: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - }; - }; - readonly requestBody: { - readonly content: { - readonly "multipart/form-data": { - /** - * Format: binary - * @description Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12 - */ - readonly file: string; - /** @description Senha do certificado ICP-Brasil */ - readonly password: string; - }; - readonly "application/form-data": { - /** - * Format: binary - * @description Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12 - */ - readonly file: string; - /** @description Senha do certificado ICP-Brasil */ - readonly password: string; - }; - }; - }; - responses: { - /** @description Sucesso no upload e vinculo com a Empresa */ - 200: { - content: { - readonly "application/json": { - /** @description Certificado */ - readonly certificate?: { - /** @description Nome do certificado (subject distinguished name) */ - readonly subject?: string; - /** - * Format: date-time - * @description Data no horário local após o qual um certificado não é mais válido - */ - readonly validUntil?: string; - /** @description A impressão digital do certificado */ - readonly thumbprint?: string; - /** @description CNPJ da Empresa */ - readonly federalTaxNumber?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Consultar um Certificado por sua impressão digital - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__). - */ - V2CompaniesByCompany_idCertificatesByCertificate_thumbprintGet: { - parameters: { - path: { - /** @description ID da Empresa relacionada ao certificado */ - company_id: string; - /** @description Impressão digital do certificado */ - certificate_thumbprint: string; - }; - }; - responses: { - /** @description Sucesso na consulta */ - 200: { - content: { - readonly "application/json": { - /** @description Certificado */ - readonly certificate?: { - /** @description Nome do certificado (subject distinguished name) */ - readonly subject?: string; - /** - * Format: date-time - * @description Data no horário local após o qual um certificado não é mais válido - */ - readonly validUntil?: string; - /** @description A impressão digital do certificado */ - readonly thumbprint?: string; - /** @description CNPJ da Empresa */ - readonly federalTaxNumber?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Certificado não encontrado */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Excluir um Certificado por sua impressão digital - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir o **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__) e desvincula-lo da **Empresa**. - * - * **ATENÇÃO pois esta requisição é irreversível** - */ - V2CompaniesByCompany_idCertificatesByCertificate_thumbprintDelete: { - parameters: { - path: { - /** @description ID da Empresa relacionada ao certificado */ - company_id: string; - /** @description Impressão digital do certificado */ - certificate_thumbprint: string; - }; - }; - responses: { - /** @description Sucesso na exclusão e desvinculo com a Empresa */ - 204: { - content: { - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Certificado não encontrado */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Listar as Inscrições Estaduais - * @description ### Informações adicionais - * - * Utilize esta requisição para listar as inscrições estaduais na empresa para processar __Documentos Fiscais__. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - V2CompaniesByCompany_idStatetaxesGet: { - parameters: { - query?: { - /** @description Id de início do contador (Default: Empty) */ - startingAfter?: string; - /** @description Id final do contador (Default: Empty) */ - endingBefore?: string; - /** @description Limite de resultados na página (Default: 10) */ - limit?: number; - }; - path: { - /** @description ID da Empresa */ - company_id: string; - }; - }; - responses: { - /** @description Sucesso na criação da Inscrição Estadual */ - 200: { - content: { - readonly "application/json": { - /** @description Lista de Inscriçoes Estaduais */ - readonly stateTaxes?: readonly ({ - /** @description Código da Empresa */ - readonly companyId?: string; - /** @description Account Id */ - readonly accountId?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "inactive" | "none" | "active"; - /** @description Todas as séries para esta Inscrição Estadual */ - readonly series?: readonly number[]; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * Format: int64 - * @description Número do Lote - */ - readonly batchId?: number; - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** - * @description Código do Estado - * @enum {string} - */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; - /** - * @description Ambiente - * @enum {string} - */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; - /** - * Format: int32 - * @description Serie para a emissão NFe - */ - readonly serie: number; - /** - * Format: int64 - * @description Número para a emissão NFe - */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; - /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} - */ - readonly type?: "default" | "nFe" | "nFCe"; - })[]; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Criar uma Inscrição Estadual - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novas inscrição estadual na empresa para processar __Documentos Fiscais__. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - V2CompaniesByCompany_idStatetaxesPost: { - parameters: { - path: { - /** @description ID da Empresa */ - company_id: string; - }; - }; - /** @description Dados da Inscrição Estadual a ser criada */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number | null; + /** @description Email */ + readonly email?: string | null; + readonly address?: components["schemas"]["AddressResource"]; + readonly type?: components["schemas"]["PersonType"]; + readonly stateTaxNumberIndicator?: components["schemas"]["ReceiverStateTaxIndicator"]; + /** @description Nome fantasia */ + readonly tradeName?: string | null; + readonly taxRegime?: components["schemas"]["TaxRegime"]; + /** @description Inscrição Estadual (IE) */ + readonly stateTaxNumber?: string | null; + }; + readonly CIDEResource: { /** - * @description Código do Estado - * @enum {string} + * Format: double + * @description BC da CIDE (qBCProd) */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly bc?: number | null; /** - * @description Ambiente - * @enum {string} + * Format: double + * @description Valor da alíquota da CIDE (vAliqProd) */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly rate?: number | null; /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: double + * @description Valor da CIDE (vCIDE) */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly cideAmount?: number | null; + }; + readonly CardResource: { + /** @description CNPJ da Credenciadora de cartão de crédito e/ou débito (CNPJ) */ + readonly federalTaxNumber?: string | null; + readonly flag?: components["schemas"]["FlagCard"]; + /** @description Número de autorização da operação cartão de crédito e/ou débito (cAut) */ + readonly authorization?: string | null; + readonly integrationPaymentType?: components["schemas"]["IntegrationPaymentType"]; + /** @description CNPJ do beneficiário do pagamento (CNPJReceb) */ + readonly federalTaxNumberRecipient?: string | null; + /** @description Identificador do terminal de pagamento (idTermPag) */ + readonly idPaymentTerminal?: string | null; + }; + readonly CityResource: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code?: string | null; + /** @description Nome do Município */ + readonly name?: string | null; + }; + /** + * @description Grupo do COFINS + * + * ID: S01 + * Pai: M01 + * + * Obs: Informar apenas um dos grupos S02, S03, S04 ou S04 + * com base valor atribuído ao campo S06 – CST do COFINS + */ + readonly CofinsTaxResource: { + /** @description Código de Situação Tributária da COFINS */ + readonly cst?: string | null; /** - * Format: int32 - * @description Serie para a emissão NFe + * Format: double + * @description Valor da Base de Cálculo da COFINS (vBC) + */ + readonly baseTax?: number | null; + /** + * Format: double + * @description Alíquota da COFINS (em percentual) (pCOFINS) + */ + readonly rate?: number | null; + /** + * Format: double + * @description Valor da COFINS (vCOFINS) + */ + readonly amount?: number | null; + /** + * Format: double + * @description Quantidade Vendida (qBCProd) + */ + readonly baseTaxProductQuantity?: number | null; + /** + * Format: double + * @description Alíquota da COFINS (em reais) (vAliqProd) + */ + readonly productRate?: number | null; + }; + /** + * @description Indicador de Presença (indPres ) + * @enum {string} + */ + readonly ConsumerPresenceType: "None" | "Presence" | "Internet" | "Telephone" | "Delivery" | "OthersNonPresenceOperation"; + /** + * @description Indica operação com Consumidor final (indFinal) + * @enum {string} + */ + readonly ConsumerType: "FinalConsumer" | "Normal"; + readonly ContingencyDetails: { + readonly authorizer?: components["schemas"]["StateTaxProcessingAuthorizer"]; + /** + * Format: date-time + * @description Data e hora do início da contingência */ - readonly serie: number; + readonly startedOn?: string; + /** @description Justificativa da entrada em contingência */ + readonly reason?: string | null; + }; + /** @description Identificação do Local de entrega (entrega) */ + readonly DeliveryInformationResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Nome ou Razão Social (xNome) */ + readonly name?: string | null; /** * Format: int64 - * @description Número para a emissão NFe + * @description CNPJ ou CPF */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly federalTaxNumber?: number | null; + /** @description Email */ + readonly email?: string | null; + readonly address?: components["schemas"]["AddressResource"]; + readonly type?: components["schemas"]["PersonType"]; + /** @description Inscrição Estadual (IE) */ + readonly stateTaxNumber?: string | null; + }; + /** + * @description Identificador de local de destino da operação (idDest) + * @enum {string} + */ + readonly Destination: "None" | "Internal_Operation" | "Interstate_Operation" | "International_Operation"; + /** @description Dados para inutilizar números de nota fiscal */ + readonly DisablementResource: { + readonly environment?: components["schemas"]["EnvironmentType"]; + /** + * Format: int32 + * @description Série + */ + readonly serie?: number; + readonly state?: components["schemas"]["StateCode"]; + /** + * Format: int32 + * @description Número inicial + */ + readonly beginNumber?: number; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: int32 + * @description Número final (usar o mesmo número inicial se for apenas um número) */ - readonly type?: "default" | "nFe" | "nFCe"; - }; + readonly lastNumber?: number; + /** @description Motivo da inutilização */ + readonly reason?: string | null; + }; + readonly DocumentElectronicInvoiceResource: { + /** @description Chave de Acesso (refNFe) */ + readonly accessKey?: string | null; }; - readonly "text/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { + readonly DocumentInvoiceReferenceResource: { /** - * @description Código do Estado - * @enum {string} + * Format: double + * @description Código da UF (cUF) */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly state?: number | null; + /** @description Ano / Mês (AAMM) */ + readonly yearMonth?: string | null; + /** @description CNPJ (CNPJ) */ + readonly federalTaxNumber?: string | null; + /** @description Modelo (mod) */ + readonly model?: string | null; + /** @description Série (serie) */ + readonly series?: string | null; + /** @description Número (nNF) */ + readonly number?: string | null; + }; + /** + * @description Indicador de intermediador/marketplace (indIntermed) + * @enum {string} + */ + readonly DuductionIndicator: "NotDeduct" | "Deduce"; + readonly DuplicateResource: { + /** @description Número da Duplicata (nDup) */ + readonly number?: string | null; /** - * @description Ambiente - * @enum {string} + * Format: date-time + * @description Data de vencimento (dVenc) */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly expirationOn?: string | null; /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: double + * @description Valor da duplicata (vDup) */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly amount?: number | null; + }; + readonly EconomicActivityResource: { + readonly type?: components["schemas"]["EconomicActivityType"]; /** * Format: int32 - * @description Serie para a emissão NFe + * @description Código da Atividade da Empresa */ - readonly serie: number; + readonly code?: number | null; + }; + /** @enum {string} */ + readonly EconomicActivityType: "Main" | "Secondary"; + /** @enum {string} */ + readonly EnvironmentType: "None" | "Production" | "Test"; + readonly ErrorResource: { + /** Format: int32 */ + readonly code?: number | null; + readonly message?: string | null; + }; + readonly ErrorsResource: { + readonly errors?: readonly components["schemas"]["ErrorResource"][] | null; + }; + /** + * @description Campo será preenchido quando o campo anterior estiver + * preenchido.Informar o motivo da desoneração: + * @enum {string} + */ + readonly ExemptReason: "Agriculture" | "Others" | "DevelopmentEntities"; + readonly ExportDetailResource: { + /** @description Número do ato concessório de Drawback (nDraw) */ + readonly drawback?: string | null; + readonly hintInformation?: components["schemas"]["ExportHintResource"]; + }; + readonly ExportHintResource: { + /** @description Número do Registro de Exportação (nRE) */ + readonly registryId?: string | null; + /** @description Chave de Acesso da NF-e recebida para exportação (chNFe) */ + readonly accessKey?: string | null; /** - * Format: int64 - * @description Número para a emissão NFe + * Format: double + * @description Quantidade do item realmente exportado (qExport) */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly quantity?: number | null; + }; + readonly ExportResource: { + readonly state?: components["schemas"]["StateCode"]; + /** @description Descrição do Local de Embarque ou de transposição de fronteira (xLocExporta) */ + readonly office?: string | null; + /** @description Informações Complementares de interesse do Contribuinte (xLocDespacho) */ + readonly local?: string | null; + }; + /** @description Arquivo */ + readonly FileResource: { + /** @description Endereço Absoluto URI para o arquivo */ + readonly uri?: string | null; + }; + /** @enum {string} */ + readonly FlagCard: "None" | "Visa" | "Mastercard" | "AmericanExpress" | "Sorocred" | "DinersClub" | "Elo" | "Hipercard" | "Aura" | "Cabal" | "Alelo" | "BanesCard" | "CalCard" | "Credz" | "Discover" | "GoodCard" | "GreenCard" | "Hiper" | "JCB" | "Mais" | "MaxVan" | "Policard" | "RedeCompras" | "Sodexo" | "ValeCard" | "Verocheque" | "VR" | "Ticket" | "Other"; + readonly FuelOriginResource: { + /** + * Format: int32 + * @description Indicador de importação (indImport) + */ + readonly indImport?: number | null; + /** + * Format: int32 + * @description Código da UF (cUFOrig) + */ + readonly cUFOrig?: number | null; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: double + * @description Percentual originário para a UF (pOrig) */ - readonly type?: "default" | "nFe" | "nFCe"; - }; + readonly pOrig?: number | null; }; - readonly "application/*+json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { + readonly FuelResource: { + /** @description Código de produto da ANP (cProdANP) */ + readonly codeANP?: string | null; /** - * @description Código do Estado - * @enum {string} + * Format: double + * @description Percentual de Gás Natural para o produto GLP (cProdANP=210203001) (pMixGN) */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly percentageNG?: number | null; + /** @description Descrição do produto conforme ANP (descANP) */ + readonly descriptionANP?: string | null; /** - * @description Ambiente - * @enum {string} + * Format: double + * @description Percentual do GLP derivado do petróleo no produto GLP (cProdANP=210203001) (pGLP) */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly percentageGLP?: number | null; /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: double + * @description Percentual de Gás Natural Nacional – GLGNn para o produto GLP (cProdANP= 210203001) (pGNn) */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly percentageNGn?: number | null; /** - * Format: int32 - * @description Serie para a emissão NFe + * Format: double + * @description Percentual de Gás Natural Importado – GLGNi para o produto GLP (cProdANP= 210203001) (pGNi) */ - readonly serie: number; + readonly percentageGNi?: number | null; /** - * Format: int64 - * @description Número para a emissão NFe + * Format: double + * @description Valor de partida (cProdANP=210203001) (vPart) */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly startingAmount?: number | null; + /** @description Código de autorização / registro do CODIF (CODIF) */ + readonly codif?: string | null; + /** + * Format: double + * @description Quantidade de combustível faturada à temperatura ambiente (qTemp) + */ + readonly amountTemp?: number | null; + /** @description Sigla da UF de consumo (UFCons) */ + readonly stateBuyer?: string | null; + readonly cide?: components["schemas"]["CIDEResource"]; + readonly pump?: components["schemas"]["PumpResource"]; + readonly fuelOrigin?: components["schemas"]["FuelOriginResource"]; + }; + /** + * @description Manual Contribuinte v_5.00 + * Grupo de Valores Totais referentes ao ICMS + */ + readonly ICMSTotal: { + /** + * Format: double + * @description Base de Cálculo do ICMS (vBC) + */ + readonly baseTax?: number | null; + /** + * Format: double + * @description Valor Total do ICMS (vICMS) + */ + readonly icmsAmount?: number | null; + /** + * Format: double + * @description Valor ICMS Total desonerado (vICMSDeson) + */ + readonly icmsExemptAmount?: number | null; + /** + * Format: double + * @description Base de Cálculo do ICMS Substituição Tributária (vBCST) + */ + readonly stCalculationBasisAmount?: number | null; + /** + * Format: double + * @description Valor Total do ICMS ST (vST) + */ + readonly stAmount?: number | null; + /** + * Format: double + * @description Valor Total dos produtos e serviços (vProd) + */ + readonly productAmount?: number; + /** + * Format: double + * @description Valor Total do Frete (vFrete) + */ + readonly freightAmount?: number | null; + /** + * Format: double + * @description Valor Total do Seguro (vSeg) + */ + readonly insuranceAmount?: number | null; + /** + * Format: double + * @description Valor Total do Desconto (vDesc) + */ + readonly discountAmount?: number | null; + /** + * Format: double + * @description Valor Total do Imposto de Importação (vII) + */ + readonly iiAmount?: number | null; + /** + * Format: double + * @description Valor Total do IPI (vIPI) + */ + readonly ipiAmount?: number | null; + /** + * Format: double + * @description Valor do PIS (vPIS) + */ + readonly pisAmount?: number | null; + /** + * Format: double + * @description Valor do COFINS (vCOFINS) + */ + readonly cofinsAmount?: number | null; + /** + * Format: double + * @description Outras Despesas acessórias (vOutro) + */ + readonly othersAmount?: number | null; + /** + * Format: double + * @description Valor Total da NF-e (vNF) + */ + readonly invoiceAmount?: number; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: double + * @description Valor Total ICMS FCP UF Destino */ - readonly type?: "default" | "nFe" | "nFCe"; - }; + readonly fcpufDestinationAmount?: number | null; + /** + * Format: double + * @description Valor Total ICMS Interestadual UF Destino + */ + readonly icmsufDestinationAmount?: number | null; + /** + * Format: double + * @description Valor Total ICMS Interestadual UF Rem. + */ + readonly icmsufSenderAmount?: number | null; + /** + * Format: double + * @description Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib) + */ + readonly federalTaxesAmount?: number; + /** + * Format: double + * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) + */ + readonly fcpAmount?: number | null; + /** + * Format: double + * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) retido por substituição tributária. + */ + readonly fcpstAmount?: number | null; + /** + * Format: double + * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) retido anteriormente por substituição tributária. + */ + readonly fcpstRetAmount?: number | null; + /** + * Format: double + * @description Valor total do IPI devolvido (vIPIDevol) + */ + readonly ipiDevolAmount?: number | null; + /** Format: double */ + readonly qBCMono?: number | null; + /** + * Format: double + * @description Valor total do ICMS monofásico próprio (vICMSMono). + */ + readonly vICMSMono?: number | null; + /** + * Format: double + * @description Valor total da quantidade tributada do ICMS monofásico sujeito a retenção (qBCMonoReten). + */ + readonly qBCMonoReten?: number | null; + /** + * Format: double + * @description Valor total da quantidade tributada do ICMS monofásico retido anteriormente(vICMSMonoReten) + */ + readonly vICMSMonoReten?: number | null; + /** + * Format: double + * @description Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) + */ + readonly qBCMonoRet?: number | null; + /** + * Format: double + * @description Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) + */ + readonly vICMSMonoRet?: number | null; }; - }; - }; - responses: { - /** @description Sucesso na criação da Inscrição Estadual */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Código da Empresa */ - readonly companyId?: string; - /** @description Account Id */ - readonly accountId?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "inactive" | "none" | "active"; - /** @description Todas as séries para esta Inscrição Estadual */ - readonly series?: readonly number[]; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * Format: int64 - * @description Número do Lote - */ - readonly batchId?: number; - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** - * @description Código do Estado - * @enum {string} - */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; - /** - * @description Ambiente - * @enum {string} - */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; - /** - * Format: int32 - * @description Serie para a emissão NFe - */ - readonly serie: number; - /** - * Format: int64 - * @description Número para a emissão NFe - */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; - /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} - */ - readonly type?: "default" | "nFe" | "nFCe"; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Consultar uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar os dados de uma empresas pelo ID. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - V2CompaniesByCompany_idStatetaxesByState_tax_idGet: { - parameters: { - path: { - /** @description ID da Empresa */ - company_id: string; - /** @description ID da Inscrição Estadual que deverá ser retornado */ - state_tax_id: string; - }; - }; - responses: { - /** @description Sucesso na consulta da Inscrição Estadual */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Código da Empresa */ - readonly companyId?: string; - /** @description Account Id */ - readonly accountId?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "inactive" | "none" | "active"; - /** @description Todas as séries para esta Inscrição Estadual */ - readonly series?: readonly number[]; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * Format: int64 - * @description Número do Lote - */ - readonly batchId?: number; - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** - * @description Código do Estado - * @enum {string} - */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; - /** - * @description Ambiente - * @enum {string} - */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; - /** - * Format: int32 - * @description Serie para a emissão NFe - */ - readonly serie: number; - /** - * Format: int64 - * @description Número para a emissão NFe - */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; - /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} - */ - readonly type?: "default" | "nFe" | "nFCe"; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Inscrição Estadual não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Alterar uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados de uma Inscrição Estadual pelo ID. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - V2CompaniesByCompany_idStatetaxesByState_tax_idPut: { - parameters: { - path: { - /** @description ID da Empresa */ - company_id: string; - /** @description ID da Inscrição Estadual que deverá ser retornado */ - state_tax_id: string; - }; - }; - /** @description Dados da Inscrição Estadual a ser alterada */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; + /** + * @description Manual Contribuinte v_5.00 + * Grupo de Valores Totais referentes ao ICMS + */ + readonly ICMSTotalResource: { /** - * @description Código do Estado - * @enum {string} + * Format: double + * @description Base de Cálculo do ICMS (vBC) */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly baseTax?: number | null; /** - * @description Ambiente - * @enum {string} + * Format: double + * @description Valor Total do ICMS (vICMS) */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly icmsAmount?: number | null; /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: double + * @description Valor ICMS Total desonerado (vICMSDeson) */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly icmsExemptAmount?: number | null; /** - * Format: int32 - * @description Serie para a emissão NFe + * Format: double + * @description Base de Cálculo do ICMS Substituição Tributária (vBCST) */ - readonly serie: number; + readonly stCalculationBasisAmount?: number | null; /** - * Format: int64 - * @description Número para a emissão NFe + * Format: double + * @description Valor Total do ICMS ST (vST) */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly stAmount?: number | null; + /** + * Format: double + * @description Valor Total dos produtos e serviços (vProd) + */ + readonly productAmount?: number | null; + /** + * Format: double + * @description Valor Total do Frete (vFrete) + */ + readonly freightAmount?: number | null; + /** + * Format: double + * @description Valor Total do Seguro (vSeg) + */ + readonly insuranceAmount?: number | null; + /** + * Format: double + * @description Valor Total do Desconto (vDesc) + */ + readonly discountAmount?: number | null; + /** + * Format: double + * @description Valor Total do Imposto de Importação (vII) + */ + readonly iiAmount?: number | null; + /** + * Format: double + * @description Valor Total do IPI (vIPI) + */ + readonly ipiAmount?: number | null; + /** + * Format: double + * @description Valor do PIS (vPIS) + */ + readonly pisAmount?: number | null; + /** + * Format: double + * @description Valor do COFINS (vCOFINS) + */ + readonly cofinsAmount?: number | null; + /** + * Format: double + * @description Outras Despesas acessórias (vOutro) + */ + readonly othersAmount?: number | null; + /** + * Format: double + * @description Valor Total da NF-e (vNF) + */ + readonly invoiceAmount?: number | null; + /** + * Format: double + * @description Valor Total ICMS FCP UF Destino (vFCPUFDest) + */ + readonly fcpufDestinationAmount?: number | null; + /** + * Format: double + * @description Valor Total ICMS Interestadual UF Destino (vICMSUFDest) + */ + readonly icmsufDestinationAmount?: number | null; + /** + * Format: double + * @description Valor Total ICMS Interestadual UF Remetente (vICMSUFRemet) + */ + readonly icmsufSenderAmount?: number | null; + /** + * Format: double + * @description Valor aproximado total de tributos federais, estaduais e municipais. (vTotTrib) + */ + readonly federalTaxesAmount?: number | null; + /** + * Format: double + * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) + */ + readonly fcpAmount?: number | null; + /** + * Format: double + * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST) + */ + readonly fcpstAmount?: number | null; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: double + * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) */ - readonly type?: "default" | "nFe" | "nFCe"; - }; + readonly fcpstRetAmount?: number | null; + /** + * Format: double + * @description Valor total do IPI devolvido (vIPIDevol) + */ + readonly ipiDevolAmount?: number | null; + /** + * Format: double + * @description Valor total da quantidade tributada do ICMS monofásico próprio (qBCMono) + */ + readonly qBCMono?: number | null; + /** + * Format: double + * @description Valor total do ICMS monofásico próprio (vICMSMono) + */ + readonly vICMSMono?: number | null; + /** + * Format: double + * @description Valor total da quantidade tributada do ICMS monofásico sujeito a retenção(qBCMonoReten) + */ + readonly qBCMonoReten?: number | null; + /** + * Format: double + * @description Valor total do ICMS monofásico sujeito a retenção (vICMSMonoReten) + */ + readonly vICMSMonoReten?: number | null; + /** + * Format: double + * @description Valor total da quantidade tributada do ICMS monofásico retido anteriormente(qBCMonoRet) + */ + readonly qBCMonoRet?: number | null; + /** + * Format: double + * @description Valor total do ICMS monofásico retido anteriormente (vICMSMonoRet) + */ + readonly vICMSMonoRet?: number | null; }; - readonly "text/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; + /** @description Grupo de Tributação do ICMS de Destino da UF */ + readonly ICMSUFDestinationTaxResource: { /** - * @description Código do Estado - * @enum {string} + * Format: double + * @description Valor da Base de Cálculo do ICMS na UF de destino (vBCUFDest) */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly vBCUFDest?: number | null; /** - * @description Ambiente - * @enum {string} + * Format: double + * @description Percentual adicional inserido na alíquota interna da UF de destino, relativo ao Fundo de Combate à Pobreza (FCP) naquela UF (pFCPUFDest) */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly pFCPUFDest?: number | null; /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: double + * @description Alíquota adotada nas operações internas na UF de destino para o produto / mercadoria (pICMSUFDest) */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly pICMSUFDest?: number | null; /** - * Format: int32 - * @description Serie para a emissão NFe + * Format: double + * @description Alíquota interestadual das UF envolvidas (pICMSInter) */ - readonly serie: number; + readonly pICMSInter?: number | null; /** - * Format: int64 - * @description Número para a emissão NFe + * Format: double + * @description Percentual de ICMS Interestadual para a UF de destino (pICMSInterPart) */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly pICMSInterPart?: number | null; + /** + * Format: double + * @description Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de destino (vFCPUFDest + */ + readonly vFCPUFDest?: number | null; + /** + * Format: double + * @description Valor do ICMS Interestadual para a UF de destino (vICMSUFDest) + */ + readonly vICMSUFDest?: number | null; + /** + * Format: double + * @description Valor do ICMS Interestadual para a UF do remetente (vICMSUFRemet) + */ + readonly vICMSUFRemet?: number | null; + /** + * Format: double + * @description Valor da BC FCP na UF de destino (vBCFCPUFDest) + */ + readonly vBCFCPUFDest?: number | null; + }; + /** + * @description Grupo do Imposto de Importação + * + * Id: P01 + * Pai: O01 + */ + readonly IITaxResource: { + /** @description Valor BC do Imposto de Importação (vBC) */ + readonly baseTax?: string | null; + /** @description Valor despesas aduaneiras (vDespAdu) */ + readonly customsExpenditureAmount?: string | null; + /** + * Format: double + * @description Valor Imposto de Importação (vII) + */ + readonly amount?: number | null; + /** + * Format: double + * @description Valor Imposto sobre Operações Financeiras (vIOF) + */ + readonly iofAmount?: number | null; + /** + * Format: double + * @description Valor dos encargos cambiais + */ + readonly vEnqCamb?: number | null; + }; + /** + * @description Grupo do IPI + * + * Informar apenas quando o item for sujeito ao IPI + * + * ID: O01 + * + * Pai: M01 + */ + readonly IPITaxResource: { + /** @description Código da situação tributária do IPI (CST) */ + readonly cst?: string | null; + /** @description Código de Enquadramento Legal do IPI (cEnq) */ + readonly classificationCode?: string | null; + /** + * @description clEnq + * Classe de enquadramento do IPI para Cigarros e Bebidas (clEnq) + */ + readonly classification?: string | null; + /** @description CNPJ do produtor da mercadoria, quando diferente do emitente. Somente para os casos de exportação direta ou indireta (CNPJProd) */ + readonly producerCNPJ?: string | null; + /** @description Código do selo de controle IPI (cSelo) */ + readonly stampCode?: string | null; + /** + * Format: double + * @description Quantidade de selo de controle (qSelo) + */ + readonly stampQuantity?: number | null; + /** + * Format: double + * @description Valor da BC do IPI (vBC) + */ + readonly base?: number | null; + /** + * Format: double + * @description Alíquota do IPI (pIPI) + */ + readonly rate?: number | null; + /** + * Format: double + * @description Quantidade total na unidade padrão para tributação (somente para os produtos tributados por unidade) (qUnid) + */ + readonly unitQuantity?: number | null; + /** + * Format: double + * @description Valor por Unidade Tributável (vUnid) + */ + readonly unitAmount?: number | null; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: double + * @description Valor IPI (vIPI) */ - readonly type?: "default" | "nFe" | "nFCe"; - }; + readonly amount?: number | null; }; - readonly "application/*+json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; + readonly ISSQNTotal: { /** - * @description Código do Estado - * @enum {string} + * Format: double + * @description Valor Total Serv.Não Tributados p/ ICMS */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + readonly totalServiceNotTaxedICMS?: number | null; /** - * @description Ambiente - * @enum {string} + * Format: double + * @description Base de Cálculo do ISS */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; + readonly baseRateISS?: number | null; /** - * @description Tipo do regime especial de tributação - * @enum {string} + * Format: double + * @description Valor Total do ISS */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + readonly totalISS?: number | null; /** - * Format: int32 - * @description Serie para a emissão NFe + * Format: double + * @description Valor do PIS sobre Serviços */ - readonly serie: number; + readonly valueServicePIS?: number | null; /** - * Format: int64 - * @description Número para a emissão NFe + * Format: double + * @description Valor da COFINS sobre Serviços */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; + readonly valueServiceCOFINS?: number | null; + /** + * Format: date-time + * @description Data Prestação Serviço + */ + readonly provisionService?: string | null; /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} + * Format: double + * @description Valor Dedução para Redução da BC */ - readonly type?: "default" | "nFe" | "nFCe"; - }; + readonly deductionReductionBC?: number | null; + /** + * Format: double + * @description Valor Outras Retenções + */ + readonly valueOtherRetention?: number | null; + /** + * Format: double + * @description Valor Desconto Incondicionado + */ + readonly discountUnconditional?: number | null; + /** + * Format: double + * @description Valor Desconto Condicionado + */ + readonly discountConditioning?: number | null; + /** + * Format: double + * @description Valor Total Retenção ISS + */ + readonly totalRetentionISS?: number | null; + /** + * Format: double + * @description Código Regime Tributação + */ + readonly codeTaxRegime?: number | null; + }; + readonly ISSQNTotalResource: { + /** + * Format: double + * @description Valor Total Serv.Não Tributados p/ ICMS (vServ) + */ + readonly totalServiceNotTaxedICMS?: number | null; + /** + * Format: double + * @description Base de Cálculo do ISS (vBC) + */ + readonly baseRateISS?: number | null; + /** + * Format: double + * @description Valor Total do ISS (vISS) + */ + readonly totalISS?: number | null; + /** + * Format: double + * @description Valor do PIS sobre Serviços (vPIS) + */ + readonly valueServicePIS?: number | null; + /** + * Format: double + * @description Valor da COFINS sobre Serviços (vCOFINS) + */ + readonly valueServiceCOFINS?: number | null; + /** + * Format: date-time + * @description Data Prestação Serviço (dCompet) + */ + readonly provisionService?: string | null; + /** + * Format: double + * @description Valor Dedução para Redução da BC (vDeducao) + */ + readonly deductionReductionBC?: number | null; + /** + * Format: double + * @description Valor Outras Retenções (vOutro) + */ + readonly valueOtherRetention?: number | null; + /** + * Format: double + * @description Valor Desconto Incondicionado (vDescIncond) + */ + readonly discountUnconditional?: number | null; + /** + * Format: double + * @description Valor Desconto Condicionado (vDescCond) + */ + readonly discountConditioning?: number | null; + /** + * Format: double + * @description Valor Total Retenção ISS (vISSRet) + */ + readonly totalRetentionISS?: number | null; + /** + * Format: double + * @description Código Regime Tributação (cRegTrib) + */ + readonly codeTaxRegime?: number | null; + }; + /** + * @description Grupo do ICMS da Operação própria e ST + * + * ID: N01 + * PAI: M01 + * + * Obs: Informar apenas um dos grupos N02, N03, N04, N05, N06, N07, N08, N09, N10, + * N10a, N10b, N10c, N10d, N10e, N10f, N10g ou N10h com base no conteúdo informado na TAG Tributação do ICMS. (v2.0) + */ + readonly IcmsTaxResource: { + /** @description Origem da mercadoria (orig) */ + readonly origin?: string | null; + /** @description Tributação do ICMS (CST) */ + readonly cst?: string | null; + /** + * @description 101- Tributada pelo Simples Nacional com permissão de crédito. (v.2.0) (CSOSN) + * Código de Situação da Operação – Simples Nacional + */ + readonly csosn?: string | null; + /** + * @description Modalidade de determinação da BC do ICMS (modBC) + * + * Margem Valor Agregado (%) = 0 + * Pauta (valor) = 1 + * Preço Tabelado Máximo (valor) = 2 + * Valor da Operação = 3 + * + */ + readonly baseTaxModality?: string | null; + /** + * Format: double + * @description Valor da BC do ICMS (vBC) + */ + readonly baseTax?: number | null; + /** @description Modalidade de determinação da BC do ICMS ST (modBCST) */ + readonly baseTaxSTModality?: string | null; + /** + * @description pRedBCST + * Percentual da Redução de BC do ICMS ST (pRedBCST) + */ + readonly baseTaxSTReduction?: string | null; + /** + * Format: double + * @description Valor da BC do ICMS ST (vBCST) + */ + readonly baseTaxST?: number | null; + /** + * Format: double + * @description Percentual da Redução de BC (pRedBC) + */ + readonly baseTaxReduction?: number | null; + /** + * Format: double + * @description Alíquota do imposto do ICMS ST (pICMSST) + */ + readonly stRate?: number | null; + /** + * Format: double + * @description Valor do ICMS ST (vICMSST) + */ + readonly stAmount?: number | null; + /** + * Format: double + * @description pMVAST + * Percentual da margem de valor Adicionado do ICMS ST (pMVAST) + */ + readonly stMarginAmount?: number | null; + /** + * Format: double + * @description pICMS + * Alíquota do imposto (pICMS) + */ + readonly rate?: number | null; + /** + * Format: double + * @description Valor do ICMS (vICMS) + * O valor do ICMS desonerado será informado apenas nas operações: + * a) com produtos beneficiados com a desoneração condicional do ICMS. + * b) destinadas à SUFRAMA, informando-se o valor que seria devido se não houvesse isenção. + * c) de venda a órgãos da administração pública direta e suas fundações e + * autarquias com isenção do ICMS. (NT 2011/004) + */ + readonly amount?: number | null; + /** + * Format: double + * @description Percentual da Redução de BC (pICMS) + */ + readonly percentual?: number | null; + /** + * Format: double + * @description Alíquota aplicável de cálculo do crédito (Simples Nacional). (pCredSN) + */ + readonly snCreditRate?: number | null; + /** + * Format: double + * @description Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 Simples Nacional (vCredICMSSN) + */ + readonly snCreditAmount?: number | null; + /** @description Percentual da margem de valor Adicionado do ICMS ST (pMVAST) */ + readonly stMarginAddedAmount?: string | null; + /** @description Valor do ICMS ST retido (vICMSSTRet) */ + readonly stRetentionAmount?: string | null; + /** @description Valor da BC do ICMS ST retido (vBCSTRet) */ + readonly baseSTRetentionAmount?: string | null; + /** + * @description Percentual da BC operação própria (pBCOp) + * Percentual para determinação do valor da Base de Cálculo da operação própria. (v2.0) + */ + readonly baseTaxOperationPercentual?: string | null; + /** + * @description UF para qual é devido o ICMS ST (UFST) + * Sigla da UF para qual é devido o ICMS ST da operação. (v2.0) + */ + readonly ufst?: string | null; + /** @description Motivo Desoneração ICMS */ + readonly amountSTReason?: string | null; + /** @description Valor da BC do ICMS ST retido (vBCSTRet) */ + readonly baseSNRetentionAmount?: string | null; + /** @description Valor do ICMS ST retido (vICMSSTRet) */ + readonly snRetentionAmount?: string | null; + /** @description Valor do ICMS da Operação (vICMSOp) */ + readonly amountOperation?: string | null; + /** @description Percentual do Diferimento (pDif) */ + readonly percentualDeferment?: string | null; + /** @description Valor do ICMS Diferido (vICMSDif) */ + readonly baseDeferred?: string | null; + /** + * Format: double + * @description Valor ICMS Desonerado + */ + readonly exemptAmount?: number | null; + readonly exemptReason?: components["schemas"]["ExemptReason"]; + /** + * Format: double + * @description Valor ICMS Desonerado + */ + readonly exemptAmountST?: number | null; + readonly exemptReasonST?: components["schemas"]["ExemptReason"]; + /** + * Format: double + * @description Percentual do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (pFCP) + */ + readonly fcpRate?: number | null; + /** + * Format: double + * @description Valor Total do FCP - Valor do ICMS relativo ao Fundo de Combate à Pobreza (vFCP) + */ + readonly fcpAmount?: number | null; + /** + * Format: double + * @description Percentual do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (pFCPST) + */ + readonly fcpstRate?: number | null; + /** + * Format: double + * @description Valor Total do FCP retido por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido por substituição tributária (vFCPST) + */ + readonly fcpstAmount?: number | null; + /** + * Format: double + * @description Percentual do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (pFCPSTRet) + */ + readonly fcpstRetRate?: number | null; + /** + * Format: double + * @description Valor Total do FCP retido por anteriormente por ST - Valor do ICMS relativo ao Fundo de Combate à Pobreza retido anteriormente por substituição tributária (vFCPSTRet) + */ + readonly fcpstRetAmount?: number | null; + /** + * Format: double + * @description Informar o valor da Base de Cálculo do FCP (vBCFCPST) + */ + readonly baseTaxFCPSTAmount?: number | null; + /** + * Format: double + * @description Valor do ICMS próprio do Substituto (tag: vICMSSubstituto) + */ + readonly substituteAmount?: number | null; + /** + * Format: double + * @description N26a - Alíquota suportada pelo Consumidor Final (pST) + * Deve ser informada a alíquota do cálculo do ICMS-ST, já incluso o FCP caso incida sobre a mercadoria + */ + readonly stFinalConsumerRate?: number | null; + /** + * Format: double + * @description N34 - Percentual de redução da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (pRedBCEfet) + */ + readonly effectiveBaseTaxReductionRate?: number | null; + /** + * Format: double + * @description N35 - Valor da base de cálculo efetiva, caso estivesse submetida ao regime comum de tributação (vBCEfet) + */ + readonly effectiveBaseTaxAmount?: number | null; + /** + * Format: double + * @description N36 - Alíquota do ICMS efetiva, caso estivesse submetida ao regime comum de tributação (pICMSEFET) + */ + readonly effectiveRate?: number | null; + /** + * Format: double + * @description N37 - Valor do ICMS efetivo, caso estivesse submetida ao regime comum de tributação (vICMSEFET) + */ + readonly effectiveAmount?: number | null; + readonly deductionIndicator?: components["schemas"]["DuductionIndicator"]; + }; + /** @description Declaração Importação (DI) */ + readonly ImportDeclarationResource: { + /** @description Número do Documento de Importação da DI/DSI/DA (nDI) */ + readonly code?: string | null; + /** + * Format: date-time + * @description Data de Registro da DI/DSI/DA (dDI) + */ + readonly registeredOn?: string | null; + /** @description Local de desembaraço (xLocDesemb) */ + readonly customsClearanceName?: string | null; + readonly customsClearanceState?: components["schemas"]["StateCode"]; + /** + * Format: date-time + * @description Data do Desembaraço Aduaneiro (dDesemb) + */ + readonly customsClearancedOn?: string | null; + /** @description Adições (adi) */ + readonly additions?: readonly components["schemas"]["AdditionResource"][] | null; + /** @description Código do exportador (cExportador) */ + readonly exporter?: string | null; + readonly internationalTransport?: components["schemas"]["InternationalTransportType"]; + readonly intermediation?: components["schemas"]["IntermediationType"]; + /** @description CNPJ/CPF do adquirente ou do encomendante (CNPJ ou CPF) */ + readonly acquirerFederalTaxNumber?: string | null; + /** @description Sigla da UF do adquirente ou do encomendante (UFTerceiro) */ + readonly stateThird?: string | null; + }; + /** + * @description 1 - Pagamento integrado com o sistema de automação da empresa(Ex.: equipamento TEF, Comércio Eletrônico) + * 2 - Pagamento não integrado com o sistema de automação da empresa(Ex.: equipamento POS); + * @enum {string} + */ + readonly IntegrationPaymentType: "Integrated" | "NotIntegrated"; + /** @description Grupo de Informações do Intermediador da Transação (infIntermed) */ + readonly IntermediateResource: { + /** + * Format: int64 + * @description CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios. (CNPJ) + */ + readonly federalTaxNumber?: number | null; + /** @description Identificador cadastrado no intermediador (idCadIntTran) */ + readonly identifier?: string | null; + }; + /** + * @description Tipo de Intermediação + * @enum {string} + */ + readonly IntermediationType: "None" | "ByOwn" | "ImportOnBehalf" | "ByOrder"; + /** + * @description Tipo Transporte Internacional + * @enum {string} + */ + readonly InternationalTransportType: "None" | "Maritime" | "River" | "Lake" | "Airline" | "Postal" | "Railway" | "Highway" | "Network" | "Own" | "Ficta" | "Courier" | "Handcarry"; + readonly InvoiceEventsResourceBase: { + /** @description Lista de Eventos ocorridos na Nota Fiscal */ + readonly events?: readonly components["schemas"]["ActivityResource"][] | null; + /** @description Identificador de possibilidade de mais itens. */ + readonly hasMore?: boolean | null; + }; + /** + * @description Manual Contribuinte v_5.00 + * Grupo do detalhamento de Produtos e Serviços da NF-e + */ + readonly InvoiceItemResource: { + /** @description Código do produto ou serviço (cProd) */ + readonly code?: string | null; + /** + * @description GTIN (Global Trade Item Number) do produto, + * antigo código EAN ou código de barras (cEAN) + */ + readonly codeGTIN?: string | null; + /** @description Descrição do produto ou serviço (xProd) */ + readonly description?: string | null; + /** @description Código NCM com 8 dígitos ou 2 dígitos (gênero) (NCM) */ + readonly ncm?: string | null; + /** @description Nomenclatura de Valor aduaneiro e Estatístico (NVE) */ + readonly nve?: readonly string[] | null; + /** @description Código Exceção da Tabela de IPI */ + readonly extipi?: string | null; + /** + * Format: int64 + * @description Código Fiscal de Operações e Prestações (CFOP) + */ + readonly cfop?: number | null; + /** @description Unidade Comercial (uCom) */ + readonly unit?: string | null; + /** + * Format: double + * @description Quantidade Comercial (qCom) + */ + readonly quantity?: number | null; + /** + * Format: double + * @description Valor Unitário de Comercialização (vUnCom) + */ + readonly unitAmount?: number | null; + /** + * Format: double + * @description Valor Total Bruto dos Produtos ou Serviços (vProd) + */ + readonly totalAmount?: number | null; + /** + * @description GTIN (Global Trade Item Number) da unidade tributável, + * antigo código EAN ou código de barras (cEANTrib) + */ + readonly codeTaxGTIN?: string | null; + /** @description Unidade Tributável (uTrib) */ + readonly unitTax?: string | null; + /** + * Format: double + * @description Quantidade Tributável (qTrib) + */ + readonly quantityTax?: number | null; + /** + * Format: double + * @description Valor Unitário de tributação (vUnTrib) + */ + readonly taxUnitAmount?: number | null; + /** + * Format: double + * @description Valor Total do Frete (vFrete) + */ + readonly freightAmount?: number | null; + /** + * Format: double + * @description Valor Total do Seguro (vSeg) + */ + readonly insuranceAmount?: number | null; + /** + * Format: double + * @description Valor do Desconto (vDesc) + */ + readonly discountAmount?: number | null; + /** + * Format: double + * @description Outras despesas acessórias (vOutro) + */ + readonly othersAmount?: number | null; + /** + * @description Indica se valor do Item (vProd) + * entra no valor total da NF-e (vProd) (indTot) + */ + readonly totalIndicator?: boolean | null; + /** @description CEST - Código especificador da substituição tributária */ + readonly cest?: string | null; + readonly tax?: components["schemas"]["InvoiceItemTaxResource"]; + /** @description Informações Adicionais do Produto (infAdProd) */ + readonly additionalInformation?: string | null; + /** @description Número do pedido de compra (xPed) */ + readonly numberOrderBuy?: string | null; + /** + * Format: int32 + * @description Item do Pedido de Compra (nItemPed) + */ + readonly itemNumberOrderBuy?: number | null; + /** @description Número de controle da FCI - Ficha de Conteúdo de Importação (nFCI) */ + readonly importControlSheetNumber?: string | null; + readonly fuelDetail?: components["schemas"]["FuelResource"]; + /** @description Código de Benefício Fiscal na UF aplicado ao item (cBenef) */ + readonly benefit?: string | null; + /** @description Declaração Importação (DI) */ + readonly importDeclarations?: readonly components["schemas"]["ImportDeclarationResource"][] | null; + /** @description Grupo de informações de exportação para o item (detExport) */ + readonly exportDetails?: readonly components["schemas"]["ExportDetailResource"][] | null; + readonly taxDetermination?: components["schemas"]["TaxDeterminationResource"]; + }; + readonly InvoiceItemTaxResource: { + /** + * Format: double + * @description Valor aproximado total de tributos federais, estaduais e municipais (vTotTrib) + */ + readonly totalTax?: number | null; + readonly icms?: components["schemas"]["IcmsTaxResource"]; + readonly ipi?: components["schemas"]["IPITaxResource"]; + readonly ii?: components["schemas"]["IITaxResource"]; + readonly pis?: components["schemas"]["PISTaxResource"]; + readonly cofins?: components["schemas"]["CofinsTaxResource"]; + readonly icmsDestination?: components["schemas"]["ICMSUFDestinationTaxResource"]; + }; + readonly InvoiceItemsResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificador da Empresa */ + readonly companyId?: string | null; + /** @description Identificador da Nota Fiscal */ + readonly id?: string | null; + /** @description Detalhamento de Produtos e Serviços (det) - Lista de Items da Nota Fiscal */ + readonly items?: readonly components["schemas"]["InvoiceItemResource"][] | null; + /** @description Identifica se existem mais items a serem consultados */ + readonly hasMore?: boolean | null; + }; + readonly InvoiceResource: { + /** @description Identificador único */ + readonly id?: string | null; + /** + * Format: int32 + * @description Série do Documento Fiscal (serie) + */ + readonly serie?: number | null; + /** + * Format: int64 + * @description Número do Documento Fiscal (nNF) + */ + readonly number?: number | null; + readonly status?: components["schemas"]["InvoiceStatus"]; + readonly authorization?: components["schemas"]["AuthorizationResource"]; + readonly contingencyDetails?: components["schemas"]["ContingencyDetails"]; + /** @description Descrição da Natureza da Operação (natOp) */ + readonly operationNature?: string | null; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string | null; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string | null; + /** + * Format: date-time + * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) + * + * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. + * + */ + readonly operationOn?: string | null; + readonly operationType?: components["schemas"]["OperationType"]; + readonly environmentType?: components["schemas"]["EnvironmentType"]; + readonly purposeType?: components["schemas"]["PurposeType"]; + readonly issuer?: components["schemas"]["IssuerResource"]; + readonly buyer?: components["schemas"]["BuyerResource"]; + readonly totals?: components["schemas"]["TotalResource"]; + readonly transport?: components["schemas"]["TransportInformationResource"]; + readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; + readonly export?: components["schemas"]["ExportResource"]; + readonly billing?: components["schemas"]["BillingResource"]; + /** @description Grupo de Formas de Pagamento (pag) */ + readonly payment?: readonly components["schemas"]["PaymentResource"][] | null; + readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; + readonly delivery?: components["schemas"]["DeliveryInformationResource"]; + readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"]; + readonly lastEvents?: components["schemas"]["InvoiceEventsResourceBase"]; + }; + /** @enum {string} */ + readonly InvoiceStatus: "None" | "Created" | "Processing" | "Issued" | "IssuedContingency" | "Cancelled" | "Disabled" | "IssueDenied" | "Error"; + readonly InvoiceWithoutEventsResource: { + /** @description Identificador único */ + readonly id?: string | null; + /** + * Format: int32 + * @description Série do Documento Fiscal (serie) + */ + readonly serie?: number | null; + /** + * Format: int64 + * @description Número do Documento Fiscal (nNF) + */ + readonly number?: number | null; + readonly status?: components["schemas"]["InvoiceStatus"]; + readonly authorization?: components["schemas"]["AuthorizationResource"]; + readonly contingencyDetails?: components["schemas"]["ContingencyDetails"]; + /** @description Descrição da Natureza da Operação (natOp) */ + readonly operationNature?: string | null; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string | null; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string | null; + /** + * Format: date-time + * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) + * + * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. + * + */ + readonly operationOn?: string | null; + readonly operationType?: components["schemas"]["OperationType"]; + readonly environmentType?: components["schemas"]["EnvironmentType"]; + readonly purposeType?: components["schemas"]["PurposeType"]; + readonly issuer?: components["schemas"]["IssuerResource"]; + readonly buyer?: components["schemas"]["BuyerResource"]; + readonly totals?: components["schemas"]["TotalResource"]; + readonly transport?: components["schemas"]["TransportInformationResource"]; + readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; + readonly export?: components["schemas"]["ExportResource"]; + readonly billing?: components["schemas"]["BillingResource"]; + /** @description Grupo de Formas de Pagamento (pag) */ + readonly payment?: readonly components["schemas"]["PaymentResource"][] | null; + readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; + readonly delivery?: components["schemas"]["DeliveryInformationResource"]; + readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"]; + }; + readonly IssuerFromRequestResource: { + /** @description IE do Substituto Tributário (IEST) */ + readonly stStateTaxNumber?: string | null; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo de identificação do emitente da NF-e + */ + readonly IssuerResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Nome ou Razão Social (xNome) */ + readonly name?: string | null; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number | null; + /** @description Email */ + readonly email?: string | null; + readonly address?: components["schemas"]["AddressResource"]; + readonly type?: components["schemas"]["PersonType"]; + /** @description Nome Fantasia */ + readonly tradeName?: string | null; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate?: string | null; + readonly taxRegime?: components["schemas"]["TaxRegime"]; + readonly specialTaxRegime?: components["schemas"]["SpecialTaxRegime"]; + readonly legalNature?: components["schemas"]["LegalNature"]; + /** @description Atividades da Empresa (CNAE) */ + readonly economicActivities?: readonly components["schemas"]["EconomicActivityResource"][] | null; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number | null; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number | null; + /** + * Format: int64 + * @description Inscrição Estadual do Substituto Tributário (IEST) + */ + readonly regionalSTTaxNumber?: number | null; + /** @description Número de Inscrição na Prefeitura (IM/CCM) */ + readonly municipalTaxNumber?: string | null; + /** @description IE do Substituto Tributário (IEST) */ + readonly stStateTaxNumber?: string | null; + }; + /** @enum {string} */ + readonly LegalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @enum {string} */ + readonly OperationType: "Outgoing" | "Incoming"; + /** @description Grupo do PIS */ + readonly PISTaxResource: { + /** @description Código de Situação Tributária do PIS (CST) */ + readonly cst?: string | null; + /** + * Format: double + * @description Valor da Base de Cálculo do PIS (vBC) + */ + readonly baseTax?: number | null; + /** + * Format: double + * @description Alíquota do PIS (em percentual) (pPIS) + */ + readonly rate?: number | null; + /** + * Format: double + * @description Valor do PIS (vPIS) + */ + readonly amount?: number | null; + /** + * Format: double + * @description Quantidade Vendida (qBCProd) + */ + readonly baseTaxProductQuantity?: number | null; + /** + * Format: double + * @description Alíquota do PIS (em reais) (vAliqProd) + */ + readonly productRate?: number | null; + }; + readonly PaymentDetailResource: { + readonly method?: components["schemas"]["PaymentMethod"]; + /** @description Descrição do meio de pagamento (xPag) */ + readonly methodDescription?: string | null; + readonly paymentType?: components["schemas"]["PaymentType"]; + /** + * Format: double + * @description Valor do Pagamento (vPag) + */ + readonly amount?: number | null; + readonly card?: components["schemas"]["CardResource"]; + /** + * Format: date-time + * @description Data do pagamento (dPag) + */ + readonly paymentDate?: string | null; + /** @description CNPJ transacional do pagamento (CNPJPag) */ + readonly federalTaxNumberPag?: string | null; + /** @description UF do CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido (UFPag) */ + readonly statePag?: string | null; + }; + /** @enum {string} */ + readonly PaymentMethod: "Cash" | "Cheque" | "CreditCard" | "DebitCard" | "StoreCredict" | "FoodVouchers" | "MealVouchers" | "GiftVouchers" | "FuelVouchers" | "BankBill" | "BankDeposit" | "InstantPayment" | "WireTransfer" | "Cashback" | "WithoutPayment" | "Others"; + readonly PaymentResource: { + /** + * @description YA01a - Grupo Detalhamento da Forma de Pagamento (detPag) + * VERSÃO 4.00 + */ + readonly paymentDetail?: readonly components["schemas"]["PaymentDetailResource"][] | null; + /** + * Format: double + * @description Valor do troco (vTroco) + * VERSÃO 4.00 + */ + readonly payBack?: number | null; + }; + /** @enum {string} */ + readonly PaymentType: "InCash" | "Term"; + /** @enum {string} */ + readonly PersonType: "Undefined" | "NaturalPerson" | "LegalEntity" | "Company" | "Customer"; + /** @enum {string} */ + readonly PrintType: "None" | "NFeNormalPortrait" | "NFeNormalLandscape" | "NFeSimplified" | "DANFE_NFC_E" | "DANFE_NFC_E_MSG_ELETRONICA"; + readonly ProductInvoiceEventsResource: { + /** @description Lista de Eventos ocorridos na Nota Fiscal */ + readonly events?: readonly components["schemas"]["ActivityResource"][] | null; + /** @description Identificador de possibilidade de mais itens. */ + readonly hasMore?: boolean | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificador da Empresa */ + readonly companyId?: string | null; + }; + /** @description Notas Fiscais Eletrônicas (NFe) */ + readonly ProductInvoiceQueueIssueResource: { + /** @description Identificador único */ + readonly id?: string | null; + /** @description Grupo de Formas de Pagamento (pag) */ + readonly payment?: readonly components["schemas"]["PaymentResource"][] | null; + /** + * Format: int32 + * @description Série do Documento Fiscal (serie) + */ + readonly serie?: number | null; + /** + * Format: int64 + * @description Número do Documento Fiscal (nNF) + */ + readonly number?: number | null; + /** + * Format: date-time + * @description Data e Hora de Saída ou da Entrada da Mercadoria/Produto (dhSaiEnt) + * + * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD. + * + */ + readonly operationOn?: string | null; + /** @description Descrição da Natureza da Operação (natOp) */ + readonly operationNature?: string | null; + readonly operationType?: components["schemas"]["OperationType"]; + readonly destination?: components["schemas"]["Destination"]; + readonly printType?: components["schemas"]["PrintType"]; + readonly purposeType?: components["schemas"]["PurposeType"]; + readonly consumerType?: components["schemas"]["ConsumerType"]; + readonly presenceType?: components["schemas"]["ConsumerPresenceType"]; + /** + * Format: date-time + * @description Data e Hora da entrada em contingência (dhCont) + * + * Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD + * + */ + readonly contingencyOn?: string | null; + /** @description Justificativa da entrada em contingência (xJust) */ + readonly contingencyJustification?: string | null; + readonly buyer?: components["schemas"]["BuyerResource"]; + readonly transport?: components["schemas"]["TransportInformationResource"]; + readonly additionalInformation?: components["schemas"]["AdditionalInformationResource"]; + readonly export?: components["schemas"]["ExportResource"]; + /** @description Detalhamento de Produtos e Serviços (det) */ + readonly items?: readonly components["schemas"]["InvoiceItemResource"][] | null; + readonly billing?: components["schemas"]["BillingResource"]; + readonly issuer?: components["schemas"]["IssuerFromRequestResource"]; + readonly transactionIntermediate?: components["schemas"]["IntermediateResource"]; + readonly delivery?: components["schemas"]["DeliveryInformationResource"]; + readonly withdrawal?: components["schemas"]["WithdrawalInformationResource"]; + readonly totals?: components["schemas"]["Total"]; + }; + /** @description Notas Fiscais Eletrônicas (NF-e) */ + readonly ProductInvoicesResource: { + /** @description Lista de Notas Fiscais Eletrônicas (NF-e) */ + readonly productInvoices?: readonly components["schemas"]["InvoiceWithoutEventsResource"][] | null; + /** @description Identificador de possibilidade de mais itens. */ + readonly hasMore?: boolean; + }; + readonly PumpResource: { + /** + * Format: int32 + * @description Número de identificação do bico utilizado no abastecimento (nBico) + */ + readonly spoutNumber?: number | null; + /** + * Format: int32 + * @description Número de identificação da bomba ao qual o bico está interligado (nBomba) + */ + readonly number?: number | null; + /** + * Format: int32 + * @description Número de identificação do tanque ao qual o bico está interligado (nTanque) + */ + readonly tankNumber?: number | null; + /** + * Format: double + * @description Valor do Encerrante no início do abastecimento (vEncIni) + */ + readonly beginningAmount?: number | null; + /** + * Format: double + * @description Valor do Encerrante no final do abastecimento (vEncFin) + */ + readonly endAmount?: number | null; + /** + * Format: double + * @description Percentual do índice de mistura do Biodiesel (B100) no Óleo Diesel B instituído pelo órgão regulamentador + */ + readonly percentageBio?: number | null; + }; + /** @enum {string} */ + readonly PurposeType: "None" | "Normal" | "Complement" | "Adjustment" | "Devolution"; + readonly QueueEventResource: { + /** + * @description Justificativa da carta de correção + * O Texto deve conter no mínimo 15 e no máximo 1.000 caracteres + * (os quais não poderão conter acentos e/ou caracteres especiais) + */ + readonly reason?: string | null; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo Reboque + */ + readonly ReboqueResource: { + /** @description Placa do Veiculo (placa) */ + readonly plate?: string | null; + /** @description UF Veiculo Reboque (UF) */ + readonly uf?: string | null; + /** @description Registro Nacional de Transportador de Carga (ANTT) (RNTC) */ + readonly rntc?: string | null; + /** @description Identificação do Vagão (vagao) */ + readonly wagon?: string | null; + /** @description Identificação da Balsa (balsa) */ + readonly ferry?: string | null; + }; + /** @enum {string} */ + readonly ReceiverStateTaxIndicator: "None" | "TaxPayer" | "Exempt" | "NonTaxPayer"; + readonly ReferencedProcessResource: { + readonly identifierConcessory?: string | null; + /** Format: int32 */ + readonly identifierOrigin?: number | null; + /** Format: int32 */ + readonly concessionActType?: number | null; + }; + readonly RequestCancellationResource: { + readonly accountId?: string | null; + readonly companyId?: string | null; + readonly productInvoiceId?: string | null; + readonly reason?: string | null; + }; + /** @enum {string} */ + readonly ShippingModality: "ByIssuer" | "ByReceiver" | "ByThirdParties" | "OwnBySender" | "OwnByBuyer" | "Free"; + /** + * @description Regime especial de tributação + * @enum {string} + */ + readonly SpecialTaxRegime: "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte" | "Automatico"; + /** @enum {string} */ + readonly StateCode: "NA" | "RO" | "AC" | "AM" | "RR" | "PA" | "AP" | "TO" | "MA" | "PI" | "CE" | "RN" | "PB" | "PE" | "AL" | "SE" | "BA" | "MG" | "ES" | "RJ" | "SP" | "PR" | "SC" | "RS" | "MS" | "MT" | "GO" | "DF" | "EX"; + /** @enum {string} */ + readonly StateTaxProcessingAuthorizer: "Normal" | "EPEC"; + readonly TaxCouponInformationResource: { + /** @description Modelo de Documento Fiscal (mod) */ + readonly modelDocumentFiscal?: string | null; + /** @description Número de Ordem Sequencial do ECF (nECF) */ + readonly orderECF?: string | null; + /** + * Format: int32 + * @description Número do Contador de Ordem de Operação (nCOO) + */ + readonly orderCountOperation?: number | null; + }; + readonly TaxDeterminationResource: { + /** + * Format: int32 + * @description Código interno para determinação de natureza de operação + */ + readonly operationCode?: number | null; + /** @description Perfil fiscal do vendedor (origem) - usado para o cálculo automático de impostos */ + readonly issuerTaxProfile?: string | null; + /** @description Perfil fiscal do comprador (destino) - usado para o cálculo automático de impostos */ + readonly buyerTaxProfile?: string | null; + /** @description Origem da mercadoria */ + readonly origin?: string | null; + /** @description Finalidade de aquisição - usado para o cálculo automático de impostos */ + readonly acquisitionPurpose?: string | null; + }; + readonly TaxDocumentsReferenceResource: { + readonly taxCouponInformation?: components["schemas"]["TaxCouponInformationResource"]; + readonly documentInvoiceReference?: components["schemas"]["DocumentInvoiceReferenceResource"]; + readonly documentElectronicInvoice?: components["schemas"]["DocumentElectronicInvoiceResource"]; + }; + /** + * @description Regime de tributação + * @enum {string} + */ + readonly TaxRegime: "None" | "LucroReal" | "LucroPresumido" | "SimplesNacional" | "SimplesNacionalExcessoSublimite" | "MicroempreendedorIndividual" | "Isento"; + readonly TaxpayerCommentsResource: { + /** @description Campo (xCampo) */ + readonly field?: string | null; + /** @description Texto (xTexto) */ + readonly text?: string | null; + }; + readonly Total: { + readonly icms?: components["schemas"]["ICMSTotal"]; + readonly issqn?: components["schemas"]["ISSQNTotal"]; + }; + readonly TotalResource: { + readonly icms?: components["schemas"]["ICMSTotalResource"]; + readonly issqn?: components["schemas"]["ISSQNTotalResource"]; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo Transportador + */ + readonly TransportGroupResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Nome ou Razão Social (xNome) */ + readonly name?: string | null; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number | null; + /** @description Email */ + readonly email?: string | null; + readonly address?: components["schemas"]["AddressResource"]; + readonly type?: components["schemas"]["PersonType"]; + /** @description Inscrição Estadual do Transportador (IE) */ + readonly stateTaxNumber?: string | null; + /** @description Grupo de Retenção do ICMS do transporte */ + readonly transportRetention?: string | null; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo de Informações do Transporte da NF-e + * Id: X01 Pai: A1 + */ + readonly TransportInformationResource: { + readonly freightModality?: components["schemas"]["ShippingModality"]; + readonly transportGroup?: components["schemas"]["TransportGroupResource"]; + readonly reboque?: components["schemas"]["ReboqueResource"]; + readonly volume?: components["schemas"]["VolumeResource"]; + readonly transportVehicle?: components["schemas"]["TransportVehicleResource"]; + /** @description Número dos Lacres */ + readonly sealNumber?: string | null; + readonly transpRate?: components["schemas"]["TransportRateResource"]; + }; + readonly TransportRateResource: { + /** + * Format: double + * @description Valor do Serviço (vServ) + */ + readonly serviceAmount?: number | null; + /** + * Format: double + * @description BC da Retenção do ICMS (vBCRet) + */ + readonly bcRetentionAmount?: number | null; + /** + * Format: double + * @description Alíquota da Retenção (pICMSRet) //Change to Rate + */ + readonly icmsRetentionRate?: number | null; + /** + * Format: double + * @description Valor do ICMS Retido (vICMSRet) + */ + readonly icmsRetentionAmount?: number | null; + /** + * Format: int64 + * @description CFOP de Serviço de Transporte (CFOP) + */ + readonly cfop?: number | null; + /** + * Format: int64 + * @description Código do Municipio de ocorrencia do fato gerador do ICMS do Transporte (cMunFG) + */ + readonly cityGeneratorFactCode?: number | null; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Grupo Veiculo + */ + readonly TransportVehicleResource: { + /** @description Placa do Veiculo (placa) */ + readonly plate?: string | null; + /** @description Sigla da UF (UF) */ + readonly state?: string | null; + /** @description Registro Nacional de Transportador de Carga (ANTT) (RNTC) */ + readonly rntc?: string | null; + }; + /** + * @description Manual_de_Orientação_Contribuinte_v_5.00 + * Volumes + * Id:X26 + */ + readonly VolumeResource: { + /** + * Format: int32 + * @description Quantidade de volumes transportados (qVol) + */ + readonly volumeQuantity?: number | null; + /** @description Espécie dos volumes transportados (esp) */ + readonly species?: string | null; + /** @description Marca dos Volumes Transportados (marca) */ + readonly brand?: string | null; + /** @description Numeração dos Volumes Transportados (nVol) */ + readonly volumeNumeration?: string | null; + /** + * Format: double + * @description Peso Liquido(em Kg) (pesoL) + */ + readonly netWeight?: number | null; + /** + * Format: double + * @description Peso Bruto(em Kg) (pesoB) + */ + readonly grossWeight?: number | null; + }; + /** @description Identificação do Local de retirada (retirada) */ + readonly WithdrawalInformationResource: { + /** @description Identificador da Conta */ + readonly accountId?: string | null; + /** @description Identificação */ + readonly id?: string | null; + /** @description Nome ou Razão Social (xNome) */ + readonly name?: string | null; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number | null; + /** @description Email */ + readonly email?: string | null; + readonly address?: components["schemas"]["AddressResource"]; + readonly type?: components["schemas"]["PersonType"]; + /** @description Inscrição Estadual (IE) */ + readonly stateTaxNumber?: string | null; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + readonly V2CompaniesGet: { + readonly parameters: { + readonly query?: { + /** @description Id de início do contador (Default: Empty) */ + readonly startingAfter?: string; + /** @description Id final do contador (Default: Empty) */ + readonly endingBefore?: string; + /** @description Limite de resultados na página (Default: 10) */ + readonly limit?: number; + }; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta da Empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Empresa */ + readonly companies?: readonly { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Lista de Inscrição Estadual */ + readonly stateTaxes?: readonly string[]; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }[]; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Empresa não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesPost: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** @description Dados da Empresa a ser criada */ + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + readonly "text/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + readonly "application/*+json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na criação da Empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Lista de Inscrição Estadual */ + readonly stateTaxes?: readonly string[]; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta da Empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Lista de Inscrição Estadual */ + readonly stateTaxes?: readonly string[]; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Empresa não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idPut: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + /** @description Dados da Empresa a ser alterada */ + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + readonly "text/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + readonly "application/*+json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na alteração da Empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Empresa */ + readonly company?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** @description Lista de Inscrição Estadual */ + readonly stateTaxes?: readonly string[]; + /** @description Razão Social */ + readonly name: string; + /** @description Identificador da conta */ + readonly accountId?: string; + /** @description Nome Fantasia */ + readonly tradeName: string; + /** + * Format: int64 + * @description Número de Inscrição Federal (CNPJ) + */ + readonly federalTaxNumber: number; + /** + * @description Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "isento" | "microempreendedorIndividual" | "simplesNacional" | "lucroPresumido" | "lucroReal" | "none"; + /** @description Endereço */ + readonly address: { + /** @description Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2. */ + readonly state: string; + /** @description Cidade do Endereço */ + readonly city: { + /** @description Cód. do Município, segundo o Tabela de Municípios do IBGE */ + readonly code: string; + /** @description Nome do Município */ + readonly name: string; + }; + /** @description Bairro do Endereço */ + readonly district: string; + /** @description Complemento do Endereço, ex.: AP 2, BL A. */ + readonly additionalInformation?: string; + /** @description Logradouro do Endereço */ + readonly street: string; + /** @description Número do Endereço. Usar S/N para "sem número". */ + readonly number: string; + /** @description Cód. Endereço Postal (CEP) */ + readonly postalCode: string; + /** @description País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3. */ + readonly country: string; + }; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Empresa não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idDelete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa que deverá ser retornado */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão da Empresa */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Empresa não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idCertificatesGet: { + readonly parameters: { + readonly query?: { + /** @description Status do certificado */ + readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa relacionada ao certificado */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly certificates?: readonly { + /** @description Nome do certificado (subject distinguished name) */ + readonly subject?: string; + /** + * Format: date-time + * @description Data no horário local após o qual um certificado não é mais válido + */ + readonly validUntil?: string; + /** @description A impressão digital do certificado */ + readonly thumbprint?: string; + /** @description CNPJ da Empresa */ + readonly federalTaxNumber?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; + }[]; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idCertificatesPost: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "multipart/form-data": { + /** + * Format: binary + * @description Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12 + */ + readonly file: string; + /** @description Senha do certificado ICP-Brasil */ + readonly password: string; + }; + readonly "application/form-data": { + /** + * Format: binary + * @description Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12 + */ + readonly file: string; + /** @description Senha do certificado ICP-Brasil */ + readonly password: string; + }; + }; + }; + readonly responses: { + /** @description Sucesso no upload e vinculo com a Empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Certificado */ + readonly certificate?: { + /** @description Nome do certificado (subject distinguished name) */ + readonly subject?: string; + /** + * Format: date-time + * @description Data no horário local após o qual um certificado não é mais válido + */ + readonly validUntil?: string; + /** @description A impressão digital do certificado */ + readonly thumbprint?: string; + /** @description CNPJ da Empresa */ + readonly federalTaxNumber?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idCertificatesByCertificate_thumbprintGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa relacionada ao certificado */ + readonly company_id: string; + /** @description Impressão digital do certificado */ + readonly certificate_thumbprint: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Certificado */ + readonly certificate?: { + /** @description Nome do certificado (subject distinguished name) */ + readonly subject?: string; + /** + * Format: date-time + * @description Data no horário local após o qual um certificado não é mais válido + */ + readonly validUntil?: string; + /** @description A impressão digital do certificado */ + readonly thumbprint?: string; + /** @description CNPJ da Empresa */ + readonly federalTaxNumber?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "inactive" | "overdue" | "pending" | "active" | "none"; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Certificado não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idCertificatesByCertificate_thumbprintDelete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa relacionada ao certificado */ + readonly company_id: string; + /** @description Impressão digital do certificado */ + readonly certificate_thumbprint: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão e desvinculo com a Empresa */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Certificado não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idStatetaxesGet: { + readonly parameters: { + readonly query?: { + /** @description Id de início do contador (Default: Empty) */ + readonly startingAfter?: string; + /** @description Id final do contador (Default: Empty) */ + readonly endingBefore?: string; + /** @description Limite de resultados na página (Default: 10) */ + readonly limit?: number; + }; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na criação da Inscrição Estadual */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Inscriçoes Estaduais */ + readonly stateTaxes?: readonly { + /** @description Código da Empresa */ + readonly companyId?: string; + /** @description Account Id */ + readonly accountId?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "inactive" | "none" | "active"; + /** @description Todas as séries para esta Inscrição Estadual */ + readonly series?: readonly number[]; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * Format: int64 + * @description Número do Lote + */ + readonly batchId?: number; + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }[]; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idStatetaxesPost: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + /** @description Dados da Inscrição Estadual a ser criada */ + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + readonly "text/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + readonly "application/*+json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na criação da Inscrição Estadual */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Código da Empresa */ + readonly companyId?: string; + /** @description Account Id */ + readonly accountId?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "inactive" | "none" | "active"; + /** @description Todas as séries para esta Inscrição Estadual */ + readonly series?: readonly number[]; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * Format: int64 + * @description Número do Lote + */ + readonly batchId?: number; + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idStatetaxesByState_tax_idGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly company_id: string; + /** @description ID da Inscrição Estadual que deverá ser retornado */ + readonly state_tax_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta da Inscrição Estadual */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Código da Empresa */ + readonly companyId?: string; + /** @description Account Id */ + readonly accountId?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "inactive" | "none" | "active"; + /** @description Todas as séries para esta Inscrição Estadual */ + readonly series?: readonly number[]; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * Format: int64 + * @description Número do Lote + */ + readonly batchId?: number; + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Inscrição Estadual não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idStatetaxesByState_tax_idPut: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly company_id: string; + /** @description ID da Inscrição Estadual que deverá ser retornado */ + readonly state_tax_id: string; + }; + readonly cookie?: never; + }; + /** @description Dados da Inscrição Estadual a ser alterada */ + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + readonly "text/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + readonly "application/*+json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na alteração da Inscrição Estadual */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Dados da Inscrição Estadual */ + readonly stateTax?: { + /** @description Código da Empresa */ + readonly companyId?: string; + /** @description Account Id */ + readonly accountId?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "inactive" | "none" | "active"; + /** @description Todas as séries para esta Inscrição Estadual */ + readonly series?: readonly number[]; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação + */ + readonly modifiedOn?: string; + /** + * Format: int64 + * @description Número do Lote + */ + readonly batchId?: number; + /** @description Identificador (gerado automaticamente) */ + readonly id?: string; + /** + * @description Código do Estado + * @enum {string} + */ + readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; + /** + * @description Ambiente + * @enum {string} + */ + readonly environmentType?: "none" | "production" | "test"; + /** @description Inscrição Estadual */ + readonly taxNumber: string; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; + /** + * Format: int32 + * @description Serie para a emissão NFe + */ + readonly serie: number; + /** + * Format: int64 + * @description Número para a emissão NFe + */ + readonly number: number; + /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ + readonly securityCredential?: { + /** + * Format: int32 + * @description Id do código de segurança do contribuinte + */ + readonly id?: number; + /** @description Código de segurança do contribuinte */ + readonly code?: string; + }; + /** + * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe + * @enum {string} + */ + readonly type?: "default" | "nFe" | "nFCe"; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Inscrição Estadual não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly V2CompaniesByCompany_idStatetaxesByState_tax_idDelete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da Empresa */ + readonly company_id: string; + /** @description ID da Inscrição Estadual que deverá ser retornado */ + readonly state_tax_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão da Inscrição Estadual */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Inscrição Estadual não encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly RegistrationLookupAction: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do webhook a ser consultado */ + readonly webhook_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do webhook */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description WebHook (Notificação HTTP) */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: Record; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; }; - }; - }; - responses: { - /** @description Sucesso na alteração da Inscrição Estadual */ - 200: { - content: { - readonly "application/json": { - /** @description Dados da Inscrição Estadual */ - readonly stateTax?: { - /** @description Código da Empresa */ - readonly companyId?: string; - /** @description Account Id */ - readonly accountId?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "inactive" | "none" | "active"; - /** @description Todas as séries para esta Inscrição Estadual */ - readonly series?: readonly number[]; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação - */ - readonly modifiedOn?: string; - /** - * Format: int64 - * @description Número do Lote - */ - readonly batchId?: number; - /** @description Identificador (gerado automaticamente) */ - readonly id?: string; - /** - * @description Código do Estado - * @enum {string} - */ - readonly code?: "rO" | "aC" | "aM" | "rR" | "pA" | "aP" | "tO" | "mA" | "pI" | "cE" | "rN" | "pB" | "pE" | "aL" | "sE" | "bA" | "mG" | "eS" | "rJ" | "sP" | "pR" | "sC" | "rS" | "mS" | "mT" | "gO" | "dF" | "eX" | "nA"; - /** - * @description Ambiente - * @enum {string} - */ - readonly environmentType?: "none" | "production" | "test"; - /** @description Inscrição Estadual */ - readonly taxNumber: string; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "automatico" | "nenhum" | "microempresaMunicipal" | "estimativa" | "sociedadeDeProfissionais" | "cooperativa" | "microempreendedorIndividual" | "microempresarioEmpresaPequenoPorte"; - /** - * Format: int32 - * @description Serie para a emissão NFe - */ - readonly serie: number; - /** - * Format: int64 - * @description Número para a emissão NFe - */ - readonly number: number; - /** @description Código de segurança do contribuinte (necessário para emissão de NFCe) */ - readonly securityCredential?: { - /** - * Format: int32 - * @description Id do código de segurança do contribuinte - */ - readonly id?: number; - /** @description Código de segurança do contribuinte */ - readonly code?: string; - }; - /** - * @description Tipo de emissão que será emitido | 0 - Default, 1 - NFe, 2 - NFCe - * @enum {string} - */ - readonly type?: "default" | "nFe" | "nFCe"; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Inscrição Estadual não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Excluir uma Inscrição Estadual pelo ID - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir uma Inscrição Estadual pelo ID, cuidado pois esse processo é irreversível. - * **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais. - * **Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ. - */ - V2CompaniesByCompany_idStatetaxesByState_tax_idDelete: { - parameters: { - path: { - /** @description ID da Empresa */ - company_id: string; - /** @description ID da Inscrição Estadual que deverá ser retornado */ - state_tax_id: string; - }; - }; - responses: { - /** @description Sucesso na exclusão da Inscrição Estadual */ - 204: { - content: { - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Inscrição Estadual não encontrada */ - 404: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - /** - * Consultar um webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**. - */ - RegistrationLookupAction: { - parameters: { - path: { - /** @description ID do webhook a ser consultado */ - webhook_id: string; - }; - }; - responses: { - /** @description Sucesso na consulta do webhook */ - 200: { - content: { - readonly "application/json": { - /** @description WebHook (Notificação HTTP) */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: Record; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: { - }; - }; - /** @description Accesso proibido */ - 403: { - content: { - }; - }; - /** @description Webhook não encontrado */ - 404: { - content: { - }; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; }; - }; -}; +} diff --git a/src/generated/nf-servico-v1.ts b/src/generated/nf-servico-v1.ts index 3a555d7..ce321bc 100644 --- a/src/generated/nf-servico-v1.ts +++ b/src/generated/nf-servico-v1.ts @@ -4,4594 +4,5791 @@ * Do not edit this file directly. * * To regenerate: npm run generate - * Last generated: 2026-02-15T17:59:25.778Z + * Last generated: 2026-04-25T23:27:49.297Z * Generator: openapi-typescript */ -/** - * This file was auto-generated by openapi-typescript. - * Do not make direct changes to the file. - */ - - -export type paths = { - "/v1/companies": { - /** Listar as empresas ativas de uma conta */ - get: operations["Companies_Get"]; - /** Criar uma empresa */ - post: operations["Companies_Post"]; - }; - "/v1/companies/{company_id_or_tax_number}": { - /** Obter os detalhes de uma empresa */ - get: operations["Companies_idGet"]; - }; - "/v1/companies/{company_id}": { - /** Atualizar uma empresa */ - put: operations["Companies_Put"]; - /** Excluir uma empresa */ - delete: operations["Companies_Delete"]; - }; - "/v1/companies/{company_id}/certificate": { - /** Upload do certificado digital da empresa usando o codificação multipart/form-data. */ - post: operations["Companies_CertificateUpload"]; - }; - "/v1/companies/{company_id}/notifications": { - /** - * Listar as notificações de uma empresa - * @description Utilize esta requisição para consultar uma lista das **Notificações** cadastradas na **Empresa**. - */ - get: operations["CompaniesNotifications_Get"]; - }; - "/v1/companies/{company_id}/notifications/{notification_id}": { - /** - * Consultar uma notificação existente - * @description Utilize esta requisição para consultar uma **Notificação** que esteja cadastrada e tenha o ID igual ao parametro **{notification_id}**. - */ - get: operations["CompaniesNotifications_idGet"]; - /** Excluir uma notificação */ - delete: operations["CompaniesNotifications_Delete"]; - }; - "/v1/companies/{company_id}/notifications/email": { - /** - * Criar notificação via Email da Nota Fiscal de Serviço (NFSE) - * @description Utilize esta requisição para definir se os Tomadores (Clientes) das Notas Fiscais de Serviço (NFSE) - * devem ser notificados via email que a NFSE foi **emitida** ou **cancelada** com sucesso. - */ - post: operations["CompaniesNotifications_Post"]; - }; - "/v1/eventTypes": { - /** - * Listar os Tipos de Eventos gerados pela plataforma - * @description Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados - * criando notificações para os webhooks ativos e configurados para receber os eventos. - * - * São identificados seguindo o padrão do nome do evento. - * - * Esse tipos podem ser utilizados como filtro ao criar ou alterar um webhook, - * sendo que o filtro determina quais notificações de eventos e ação serão enviadas - * para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook - * ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros. - */ - get: operations["EventTypes_GetAll"]; - }; - "/v1/companies/{company_id}/legalpeople": { - /** Listar as pessoas jurídicas ativas */ - get: operations["LegalPeople_Get"]; - }; - "/v1/companies/{company_id}/legalpeople/{id}": { - /** Obter os detalhes de uma pessoa jurídica */ - get: operations["LegalPeople_idGet"]; - }; - "/v1/companies/{company_id}/naturalpeople": { - /** Listar as pessoas físicas ativas */ - get: operations["NaturalPeople_Get"]; - }; - "/v1/companies/{company_id}/naturalpeople/{id}": { - /** Obter os detalhes de uma pessoa física */ - get: operations["NaturalPeople_idGet"]; - }; - "/v1/companies/{company_id}/serviceinvoices": { - /** - * Listar as Notas Fiscais de Serviço (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - get: operations["ServiceInvoices_Get"]; - /** - * Emitir uma Nota Fiscal de Serviço (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - post: operations["ServiceInvoices_Post"]; - }; - "/v1/companies/{company_id}/serviceinvoices/external/{id}": { - /** - * Obter os detalhes de uma Nota Fiscal de Serviço (NFSE) através do ID externo (externalId) - * @description Você precisará do API Key da Empresa - */ - get: operations["ServiceInvoices_idGet"]; - }; - "/v1/companies/{company_id}/serviceinvoices/{id}": { - /** - * Obter os detalhes de uma Nota Fiscal de Serviço (NFSE) - * @description Você precisará do API Key da Empresa - */ - get: operations["ServiceInvoices_idGet"]; - /** - * Cancelar uma Nota Fiscal de Serviços (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - delete: operations["ServiceInvoices_Delete"]; - }; - "/v1/companies/{company_id}/serviceinvoices/{id}/sendemail": { - /** - * Enviar email para o Tomador com a Nota Fiscal de Serviço (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - put: operations["ServiceInvoices_SendEmail"]; - }; - "/v1/companies/{company_id}/serviceinvoices/{id}/pdf": { - /** - * Download do PDF da Nota Fiscal de Serviço (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - get: operations["ServiceInvoices_GetDocumentPdf"]; - }; - "/v1/companies/{company_id}/serviceinvoices/{id}/xml": { - /** - * Download do XML da Nota Fiscal de Serviço (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - get: operations["ServiceInvoices_GetDocumentXml"]; - }; - "/v2/webhooks/eventtypes": { - /** - * Listar os Tipos de Eventos gerados pela plataforma - * @description ### Informações adicionais - * - * Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados - * criando notificações para os webhooks ativos e configurados para receber os eventos. - * - * São identificados seguindo o padrão **Resource.EventAction**, - * onde **Resource**: nome da entidade que gerou o evento; - * **EventAction**: nome do evento e ação criados. - * - * Esse tipos podem ser utilizados como filtro ao criar ou alterar um webhook, - * sendo que o filtro determina quais notificações de eventos e ação serão enviadas - * para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook - * ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros. - */ - get: { - responses: { - /** @description Sucesso na consulta do tipos de eventos */ - 200: { - content: { - readonly "application/json": { - /** @description Lista de Evento */ - readonly eventTypes?: readonly ({ - /** - * @description Identificador do evento, seguem o padrão **Resource.EventAction**. - * Onde **Resource**: nome da entidade que gerou o evento; - * **EventAction**: nome do evento e ação criados. - * Alguns exemplos **Invoice.Issued** ou **Blob.Updated** - */ - readonly id?: string; - /** @description Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. */ - readonly description?: string; - /** - * Format: int32 - * @description WebHook Filter Status - * @enum {integer} - */ - readonly status?: 0 | 1; - })[]; - }; - }; +export interface paths { + readonly "/v1/companies": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; + /** Listar as empresas ativas de uma conta */ + readonly get: operations["Companies_Get"]; + readonly put?: never; + /** Criar uma empresa */ + readonly post: operations["Companies_Post"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/v2/webhooks": { - /** - * Listar os Webhooks - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar uma lista de **Webhooks** cadastrados na Conta Autenticada. - */ - get: { - responses: { - /** @description Sucesso na consulta da lista */ - 200: { - content: { - readonly "application/json": { - /** @description Lista de Web Hook */ - readonly webHooks?: readonly ({ - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: unknown; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - })[]; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; + readonly "/v1/companies/{company_id_or_tax_number}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; + /** Obter os detalhes de uma empresa */ + readonly get: operations["Companies_idGet"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * Criar um Webhook - * @description ### Informações adicionais - * - * Utilize esta requisição para criar novos **Webhooks** para receber as notificações de eventos ocorridos na plataforma. - * - * Na criação do **Webhook** a URL informada no cadastro deve ser responsiva, ou seja, deverá responder *(HTTP Status 200 OK)* a uma requisição *(HTTP POST)* que será feita para testar se a URL está operando como normalmente, caso contrario uma mensagem de erro será retornada. - * - * Um **Webhook** é semelhante a uma assinatura em um *sistema de publicação e assinatura* - * que permite ao assinante indicar *quando*, *como* e *onde* as notificações de eventos deve ser despachadas. - * Um **Webhook** é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos - * que podem ser acionados por eventos gerados através de ações executadas por esse Conta. - * Ou seja, a **Conta da _Empresa A_** não verá os WebHooks disparados por uma ação executada pelo usuário **Conta da _Empresa B_**. - */ - post: { - /** @description Dados para criar um Web Hook */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description Dados para criar um Web Hook */ - readonly webHook?: { - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: unknown; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - responses: { - /** @description Sucesso na criação da webhook */ - 201: { - content: { - readonly "application/json": { - /** @description WebHook (Notificação HTTP) */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: unknown; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Webhook não encontrado */ - 404: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; + readonly "/v1/companies/{company_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; + readonly get?: never; + /** Atualizar uma empresa */ + readonly put: operations["Companies_Put"]; + readonly post?: never; + /** Excluir uma empresa */ + readonly delete: operations["Companies_Delete"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * Excluir Todos os Webhooks existentes - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir todos os **Webhooks** cadastrados para a Conta Autenticada. - */ - delete: { - responses: { - /** @description Sucesso na exclusão dos WebHooks */ - 204: { - content: never; + readonly "/v1/companies/{company_id}/certificate": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; + readonly get?: never; + readonly put?: never; + /** Upload do certificado digital da empresa usando o codificação multipart/form-data. */ + readonly post: operations["Companies_CertificateUpload"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/v2/webhooks/{webhook_id}": { - /** - * Consultar um webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**. - */ - get: operations["RegistrationLookupAction"]; - /** - * Alterar um Webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para alterar os dados do **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. - */ - put: { - parameters: { - path: { - /** @description ID do webhook a ser consultado */ - webhook_id: string; - }; - }; - /** @description Dados para alterar o Webhook */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description WebHook (Notificação HTTP) */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: unknown; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - responses: { - /** @description Sucesso na atualização da Webhook */ - 200: { - content: { - readonly "application/json": { - /** @description WebHook (Notificação HTTP) */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: unknown; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; - }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; + readonly "/v1/companies/{company_id}/notifications": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - /** @description Webhook não encontrado */ - 404: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; + /** + * Listar as notificações de uma empresa + * @description Utilize esta requisição para consultar uma lista das **Notificações** cadastradas na **Empresa**. + */ + readonly get: operations["CompaniesNotifications_Get"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - /** - * Excluir um Webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para excluir o **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. - * A exclusão do **Webhook** não exime o **Webhook** excluído de receber os notificações de eventos, já ocorridos na plataforma, que ainda estejam em processo de retentativa de envio dos gatilhos. - */ - delete: { - parameters: { - path: { - /** @description ID do Webhook a ser excluído */ - webhook_id: string; - }; - }; - responses: { - /** @description Sucesso na exclusão da Webhook */ - 204: { - content: never; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Webhook não encontrado */ - 404: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; + readonly "/v1/companies/{company_id}/notifications/{notification_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; + /** + * Consultar uma notificação existente + * @description Utilize esta requisição para consultar uma **Notificação** que esteja cadastrada e tenha o ID igual ao parametro **{notification_id}**. + */ + readonly get: operations["CompaniesNotifications_idGet"]; + readonly put?: never; + readonly post?: never; + /** Excluir uma notificação */ + readonly delete: operations["CompaniesNotifications_Delete"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/v2/webhooks/{webhook_id}/pings": { - /** - * Criar notificação para Testar um webhook - * @description ### Informações adicionais - * - * Utilize esta requisição para criar uma notificação de teste (ping) em um **Webhook** já cadastrado. - * - * Esta ação irá criar um evento de notificação do tipo ping para o **Webhook** especificado, deste modo você poderá simular o recebimento de uma notificação de teste no **Webhook** cadastrado. - */ - put: { - parameters: { - path: { - /** @description ID do Webhook a ser testado */ - webhook_id: string; + readonly "/v1/companies/{company_id}/notifications/email": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - responses: { - /** @description Sucesso ao criar notificação de teste */ - 204: { - content: never; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Webhook não encontrado */ - 404: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - }; -}; - -export type webhooks = Record; - -export type components = { - schemas: never; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; -}; - -export type $defs = Record; - -export type external = Record; - -export type operations = { - - /** Listar as empresas ativas de uma conta */ - Companies_Get: { - parameters: { - query?: { - /** @description Items por página */ - pageCount?: number; - /** @description Número da página */ - pageIndex?: number; - }; + readonly get?: never; + readonly put?: never; + /** + * Criar notificação via Email da Nota Fiscal de Serviço (NFSE) + * @description Utilize esta requisição para definir se os Tomadores (Clientes) das Notas Fiscais de Serviço (NFSE) + * devem ser notificados via email que a NFSE foi **emitida** ou **cancelada** com sucesso. + */ + readonly post: operations["CompaniesNotifications_Post"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description Consulta realizada com sucesso */ - 200: { - content: { - readonly "application/json": { - readonly companies?: readonly ({ - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name: string; - /** @description Nome fantasia */ - readonly tradeName?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber: number; - /** @description Email */ - readonly email: string; - /** @description Endereço */ - readonly address: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - /** @description Estado */ - readonly state?: string; - }; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; - /** - * @description Código da Natureza Jurídica - * @enum {string} - */ - readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @description Atividades da Empresa */ - readonly economicActivities?: readonly ({ - /** @enum {string} */ - readonly type?: "Main" | "Secondary"; - /** Format: int32 */ - readonly code?: number; - })[]; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number; - /** @description Número de Inscrição na Prefeitura (CCM) */ - readonly municipalTaxNumber: string; - /** @description RPS número serie */ - readonly rpsSerialNumber?: string; - /** - * Format: int64 - * @description RPS número - */ - readonly rpsNumber?: number; - /** - * Format: double - * @description Alíquota do ISS para Simples Nacional - */ - readonly issRate?: number; - /** - * @description Ambiente de processamento - * @enum {string} - */ - readonly environment?: "Development" | "Production" | "Staging"; - /** - * @description Status no sistema - * @enum {string} - */ - readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; - /** - * @description Determinação de imposto federal - * @enum {string} - */ - readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** - * @description Determinação de imposto municipal - * @enum {string} - */ - readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** @description Nome de login */ - readonly loginName?: string; - /** @description Senha de login */ - readonly loginPassword?: string; - /** @description Valor de emissão de autorização */ - readonly authIssueValue?: string; - /** @description Certificado */ - readonly certificate?: { - /** @description Thumbprint certificado */ - readonly thumbprint?: string; - /** - * Format: date-time - * @description Certificado alterado em - */ - readonly modifiedOn?: string; - /** - * Format: date-time - * @description Certificado expira em - */ - readonly expiresOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "Overdue" | "Pending" | "None" | "Active"; - }; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - })[]; - /** Format: int64 */ - readonly totalResults?: number; - /** Format: int32 */ - readonly totalPages?: number; - /** Format: int32 */ - readonly page?: number; - }; + readonly "/v1/eventTypes": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; + /** + * Listar os Tipos de Eventos gerados pela plataforma + * @description Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados + * criando notificações para os webhooks ativos e configurados para receber os eventos. + * + * São identificados seguindo o padrão do nome do evento. + * + * Esse tipos podem ser utilizados como filtro ao criar ou alterar um webhook, + * sendo que o filtro determina quais notificações de eventos e ação serão enviadas + * para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook + * ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros. + */ + readonly get: operations["EventTypes_GetAll"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - /** Criar uma empresa */ - Companies_Post: { - /** @description Dados da empresa */ - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name: string; - /** @description Nome fantasia */ - readonly tradeName?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber: number; - /** @description Email */ - readonly email: string; - /** @description Endereço */ - readonly address: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - /** @description Estado */ - readonly state?: string; - }; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; - /** - * @description Código da Natureza Jurídica - * @enum {string} - */ - readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @description Atividades da Empresa */ - readonly economicActivities?: readonly ({ - /** @enum {string} */ - readonly type?: "Main" | "Secondary"; - /** Format: int32 */ - readonly code?: number; - })[]; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number; - /** @description Número de Inscrição na Prefeitura (CCM) */ - readonly municipalTaxNumber: string; - /** @description RPS número serie */ - readonly rpsSerialNumber?: string; - /** - * Format: int64 - * @description RPS número - */ - readonly rpsNumber?: number; - /** - * Format: double - * @description Alíquota do ISS para Simples Nacional - */ - readonly issRate?: number; - /** - * @description Ambiente de processamento - * @enum {string} - */ - readonly environment?: "Development" | "Production" | "Staging"; - /** - * @description Status no sistema - * @enum {string} - */ - readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; - /** - * @description Determinação de imposto federal - * @enum {string} - */ - readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** - * @description Determinação de imposto municipal - * @enum {string} - */ - readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** @description Nome de login */ - readonly loginName?: string; - /** @description Senha de login */ - readonly loginPassword?: string; - /** @description Valor de emissão de autorização */ - readonly authIssueValue?: string; - /** @description Certificado */ - readonly certificate?: { - /** @description Thumbprint certificado */ - readonly thumbprint?: string; - /** - * Format: date-time - * @description Certificado alterado em - */ - readonly modifiedOn?: string; - /** - * Format: date-time - * @description Certificado expira em - */ - readonly expiresOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "Overdue" | "Pending" | "None" | "Active"; - }; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; + readonly "/v1/companies/{company_id}/legalpeople": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; + /** Listar as pessoas jurídicas ativas */ + readonly get: operations["LegalPeople_Get"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description Sucesso na criação da empresa */ - 201: { - content: { - readonly "application/json": { - readonly companies?: { - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name: string; - /** @description Nome fantasia */ - readonly tradeName?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber: number; - /** @description Email */ - readonly email: string; - /** @description Endereço */ - readonly address: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - /** @description Estado */ - readonly state?: string; - }; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; - /** - * @description Código da Natureza Jurídica - * @enum {string} - */ - readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @description Atividades da Empresa */ - readonly economicActivities?: readonly ({ - /** @enum {string} */ - readonly type?: "Main" | "Secondary"; - /** Format: int32 */ - readonly code?: number; - })[]; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number; - /** @description Número de Inscrição na Prefeitura (CCM) */ - readonly municipalTaxNumber: string; - /** @description RPS número serie */ - readonly rpsSerialNumber?: string; - /** - * Format: int64 - * @description RPS número - */ - readonly rpsNumber?: number; - /** - * Format: double - * @description Alíquota do ISS para Simples Nacional - */ - readonly issRate?: number; - /** - * @description Ambiente de processamento - * @enum {string} - */ - readonly environment?: "Development" | "Production" | "Staging"; - /** - * @description Status no sistema - * @enum {string} - */ - readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; - /** - * @description Determinação de imposto federal - * @enum {string} - */ - readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** - * @description Determinação de imposto municipal - * @enum {string} - */ - readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** @description Nome de login */ - readonly loginName?: string; - /** @description Senha de login */ - readonly loginPassword?: string; - /** @description Valor de emissão de autorização */ - readonly authIssueValue?: string; - /** @description Certificado */ - readonly certificate?: { - /** @description Thumbprint certificado */ - readonly thumbprint?: string; - /** - * Format: date-time - * @description Certificado alterado em - */ - readonly modifiedOn?: string; - /** - * Format: date-time - * @description Certificado expira em - */ - readonly expiresOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "Overdue" | "Pending" | "None" | "Active"; - }; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - }; + readonly "/v1/companies/{company_id}/legalpeople/{id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Já existe uma empresa com o CNPJ informado */ - 409: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** Obter os detalhes de uma empresa */ - Companies_idGet: { - parameters: { - path: { - /** @description ID da empresa ou Inscrição Federal (CNPJ) */ - company_id_or_tax_number: string; - }; + /** Obter os detalhes de uma pessoa jurídica */ + readonly get: operations["LegalPeople_idGet"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": { - readonly companies?: { - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name: string; - /** @description Nome fantasia */ - readonly tradeName?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber: number; - /** @description Email */ - readonly email: string; - /** @description Endereço */ - readonly address: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - /** @description Estado */ - readonly state?: string; - }; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; - /** - * @description Código da Natureza Jurídica - * @enum {string} - */ - readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @description Atividades da Empresa */ - readonly economicActivities?: readonly ({ - /** @enum {string} */ - readonly type?: "Main" | "Secondary"; - /** Format: int32 */ - readonly code?: number; - })[]; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number; - /** @description Número de Inscrição na Prefeitura (CCM) */ - readonly municipalTaxNumber: string; - /** @description RPS número serie */ - readonly rpsSerialNumber?: string; - /** - * Format: int64 - * @description RPS número - */ - readonly rpsNumber?: number; - /** - * Format: double - * @description Alíquota do ISS para Simples Nacional - */ - readonly issRate?: number; - /** - * @description Ambiente de processamento - * @enum {string} - */ - readonly environment?: "Development" | "Production" | "Staging"; - /** - * @description Status no sistema - * @enum {string} - */ - readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; - /** - * @description Determinação de imposto federal - * @enum {string} - */ - readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** - * @description Determinação de imposto municipal - * @enum {string} - */ - readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** @description Nome de login */ - readonly loginName?: string; - /** @description Senha de login */ - readonly loginPassword?: string; - /** @description Valor de emissão de autorização */ - readonly authIssueValue?: string; - /** @description Certificado */ - readonly certificate?: { - /** @description Thumbprint certificado */ - readonly thumbprint?: string; - /** - * Format: date-time - * @description Certificado alterado em - */ - readonly modifiedOn?: string; - /** - * Format: date-time - * @description Certificado expira em - */ - readonly expiresOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "Overdue" | "Pending" | "None" | "Active"; - }; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - }; + readonly "/v1/companies/{company_id}/naturalpeople": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; + /** Listar as pessoas físicas ativas */ + readonly get: operations["NaturalPeople_Get"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - /** Atualizar uma empresa */ - Companies_Put: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - }; - }; - /** @description Dados da empresa */ - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name: string; - /** @description Nome fantasia */ - readonly tradeName?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber: number; - /** @description Email */ - readonly email: string; - /** @description Endereço */ - readonly address: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - /** @description Estado */ - readonly state?: string; - }; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; - /** - * @description Código da Natureza Jurídica - * @enum {string} - */ - readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @description Atividades da Empresa */ - readonly economicActivities?: readonly ({ - /** @enum {string} */ - readonly type?: "Main" | "Secondary"; - /** Format: int32 */ - readonly code?: number; - })[]; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number; - /** @description Número de Inscrição na Prefeitura (CCM) */ - readonly municipalTaxNumber: string; - /** @description RPS número serie */ - readonly rpsSerialNumber?: string; - /** - * Format: int64 - * @description RPS número - */ - readonly rpsNumber?: number; - /** - * Format: double - * @description Alíquota do ISS para Simples Nacional - */ - readonly issRate?: number; - /** - * @description Ambiente de processamento - * @enum {string} - */ - readonly environment?: "Development" | "Production" | "Staging"; - /** - * @description Status no sistema - * @enum {string} - */ - readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; - /** - * @description Determinação de imposto federal - * @enum {string} - */ - readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** - * @description Determinação de imposto municipal - * @enum {string} - */ - readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** @description Nome de login */ - readonly loginName?: string; - /** @description Senha de login */ - readonly loginPassword?: string; - /** @description Valor de emissão de autorização */ - readonly authIssueValue?: string; - /** @description Certificado */ - readonly certificate?: { - /** @description Thumbprint certificado */ - readonly thumbprint?: string; - /** - * Format: date-time - * @description Certificado alterado em - */ - readonly modifiedOn?: string; - /** - * Format: date-time - * @description Certificado expira em - */ - readonly expiresOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "Overdue" | "Pending" | "None" | "Active"; - }; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; + readonly "/v1/companies/{company_id}/naturalpeople/{id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; + /** Obter os detalhes de uma pessoa física */ + readonly get: operations["NaturalPeople_idGet"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description Sucesso na atualização da empresa */ - 200: { - content: { - readonly "application/json": { - readonly companies?: { - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name: string; - /** @description Nome fantasia */ - readonly tradeName?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber: number; - /** @description Email */ - readonly email: string; - /** @description Endereço */ - readonly address: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - /** @description Estado */ - readonly state?: string; - }; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; - /** - * @description Código da Natureza Jurídica - * @enum {string} - */ - readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @description Atividades da Empresa */ - readonly economicActivities?: readonly ({ - /** @enum {string} */ - readonly type?: "Main" | "Secondary"; - /** Format: int32 */ - readonly code?: number; - })[]; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number; - /** @description Número de Inscrição na Prefeitura (CCM) */ - readonly municipalTaxNumber: string; - /** @description RPS número serie */ - readonly rpsSerialNumber?: string; - /** - * Format: int64 - * @description RPS número - */ - readonly rpsNumber?: number; - /** - * Format: double - * @description Alíquota do ISS para Simples Nacional - */ - readonly issRate?: number; - /** - * @description Ambiente de processamento - * @enum {string} - */ - readonly environment?: "Development" | "Production" | "Staging"; - /** - * @description Status no sistema - * @enum {string} - */ - readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; - /** - * @description Determinação de imposto federal - * @enum {string} - */ - readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** - * @description Determinação de imposto municipal - * @enum {string} - */ - readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** @description Nome de login */ - readonly loginName?: string; - /** @description Senha de login */ - readonly loginPassword?: string; - /** @description Valor de emissão de autorização */ - readonly authIssueValue?: string; - /** @description Certificado */ - readonly certificate?: { - /** @description Thumbprint certificado */ - readonly thumbprint?: string; - /** - * Format: date-time - * @description Certificado alterado em - */ - readonly modifiedOn?: string; - /** - * Format: date-time - * @description Certificado expira em - */ - readonly expiresOn?: string; - /** - * @description Status do certificado - * @enum {string} - */ - readonly status?: "Overdue" | "Pending" | "None" | "Active"; - }; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - }; + readonly "/v1/companies/{company_id}/serviceinvoices": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** Excluir uma empresa */ - Companies_Delete: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - }; + /** + * Listar as Notas Fiscais de Serviço (NFSE) + * @description Você precisará do APIKEY da Empresa + */ + readonly get: operations["ServiceInvoices_Get"]; + readonly put?: never; + /** + * Emitir uma Nota Fiscal de Serviço (NFSE) + * @description Você precisará do APIKEY da Empresa + */ + readonly post: operations["ServiceInvoices_Post"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description Sucesso na remoção da empresa */ - 200: { - content: { - readonly "application/json": Record; + readonly "/v1/companies/{company_id}/serviceinvoices/external/{id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description empresa não foi encontrada */ - 404: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; + /** + * Obter os detalhes de uma Nota Fiscal de Serviço (NFSE) através do ID externo (externalId) + * @description Você precisará do API Key da Empresa + */ + readonly get: operations["ServiceInvoices_externalIdGet"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - /** Upload do certificado digital da empresa usando o codificação multipart/form-data. */ - Companies_CertificateUpload: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - }; - }; - /** @description Arquivo do certificado digital com extensao PFX ou P12 */ - readonly requestBody: { - readonly content: { - readonly "multipart/form-data": { - /** Format: binary */ - readonly file?: string; - readonly password?: string; + readonly "/v1/companies/{company_id}/serviceinvoices/{id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; + /** + * Obter os detalhes de uma Nota Fiscal de Serviço (NFSE) + * @description Você precisará do API Key da Empresa + */ + readonly get: operations["ServiceInvoices_idGet"]; + readonly put?: never; + readonly post?: never; + /** + * Cancelar uma Nota Fiscal de Serviços (NFSE) + * @description Você precisará do APIKEY da Empresa + */ + readonly delete: operations["ServiceInvoices_Delete"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description Sucesso na atualização da certificado digital */ - 200: { - content: { - readonly "application/json": string; + readonly "/v1/companies/{company_id}/serviceinvoices/{id}/sendemail": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Empresa não foi encontrada */ - 404: { - content: never; - }; - /** @description Nenhum arquivo foi encontrado na requisição */ - 415: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** - * Listar as notificações de uma empresa - * @description Utilize esta requisição para consultar uma lista das **Notificações** cadastradas na **Empresa**. - */ - CompaniesNotifications_Get: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - }; + readonly get?: never; + /** + * Enviar email para o Tomador com a Nota Fiscal de Serviço (NFSE) + * @description Você precisará do APIKEY da Empresa + */ + readonly put: operations["ServiceInvoices_SendEmail"]; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description Consulta realizada com sucesso */ - 200: { - content: { - readonly "application/json": { - readonly notifications?: readonly ({ - /** @description Identificação */ - readonly id?: string; - /** - * @description Canal de Notificação - * @enum {string} - */ - readonly channel?: "None" | "Email"; - /** @description Filtro de Evento */ - readonly filters?: readonly string[]; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Active" | "Inactive"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - })[]; - }; + readonly "/v1/companies/{company_id}/serviceinvoices/{id}/pdf": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; + /** + * Download do PDF da Nota Fiscal de Serviço (NFSE) + * @description Você precisará do APIKEY da Empresa + */ + readonly get: operations["ServiceInvoices_GetDocumentPdf"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - /** - * Consultar uma notificação existente - * @description Utilize esta requisição para consultar uma **Notificação** que esteja cadastrada e tenha o ID igual ao parametro **{notification_id}**. - */ - CompaniesNotifications_idGet: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - /** @description ID da notificação a ser consultado */ - notification_id: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": { - readonly notification?: { - /** @description Identificação */ - readonly id?: string; - /** - * @description Canal de Notificação - * @enum {string} - */ - readonly channel?: "None" | "Email"; - /** @description Filtro de Evento */ - readonly filters?: readonly string[]; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Active" | "Inactive"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - }; + readonly "/v1/companies/{company_id}/serviceinvoices/{id}/xml": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** Excluir uma notificação */ - CompaniesNotifications_Delete: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - /** @description ID da notificação */ - notification_id: string; - }; + /** + * Download do XML da Nota Fiscal de Serviço (NFSE) + * @description Você precisará do APIKEY da Empresa + */ + readonly get: operations["ServiceInvoices_GetDocumentXml"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description Sucesso na remoção da empresa */ - 200: { - content: { - readonly "application/json": Record; + readonly "/v2/webhooks/eventtypes": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description empresa não foi encontrada */ - 404: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** - * Criar notificação via Email da Nota Fiscal de Serviço (NFSE) - * @description Utilize esta requisição para definir se os Tomadores (Clientes) das Notas Fiscais de Serviço (NFSE) - * devem ser notificados via email que a NFSE foi **emitida** ou **cancelada** com sucesso. - */ - CompaniesNotifications_Post: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - }; - }; - /** @description Dados da notificação */ - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description Lista de filtros de evento sem distinção entre maiúsculas e minúsculas associado a esta notificação. - * Os filtros de evento são usados para determinar em quais eventos essa notificação será acionada. - * Os valores de filtros suportados pode ser consultados através do requisição na API de **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** - * @description Determina se as notificações são enviadas quando o evento é gerado. - * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** - * para receber todas as notificações. - * @enum {string} - */ - readonly status?: "Active" | "Inactive"; + /** + * Listar os Tipos de Eventos gerados pela plataforma + * @description ### Informações adicionais + * + * Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados + * criando notificações para os webhooks ativos e configurados para receber os eventos. + * + * São identificados seguindo o padrão **Resource.EventAction**, + * onde **Resource**: nome da entidade que gerou o evento; + * **EventAction**: nome do evento e ação criados. + * + * Esse tipos podem ser utilizados como filtro ao criar ou alterar um webhook, + * sendo que o filtro determina quais notificações de eventos e ação serão enviadas + * para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook + * ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do tipos de eventos */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Evento */ + readonly eventTypes?: readonly { + /** + * @description Identificador do evento, seguem o padrão **Resource.EventAction**. + * Onde **Resource**: nome da entidade que gerou o evento; + * **EventAction**: nome do evento e ação criados. + * Alguns exemplos **Invoice.Issued** ou **Blob.Updated** + */ + readonly id?: string; + /** @description Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. */ + readonly description?: string; + /** + * Format: int32 + * @description WebHook Filter Status + * @enum {integer} + */ + readonly status?: 0 | 1; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; }; - }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description Sucesso na criação da empresa */ - 201: { - content: { - readonly "application/json": { - readonly notification?: { - /** @description Identificação */ - readonly id?: string; - /** - * @description Canal de Notificação - * @enum {string} - */ - readonly channel?: "None" | "Email"; - /** @description Filtro de Evento */ - readonly filters?: readonly string[]; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Active" | "Inactive"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - }; + readonly "/v2/webhooks": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Já existe uma empresa com o CNPJ informado */ - 409: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** - * Listar os Tipos de Eventos gerados pela plataforma - * @description Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados - * criando notificações para os webhooks ativos e configurados para receber os eventos. - * - * São identificados seguindo o padrão do nome do evento. - * - * Esse tipos podem ser utilizados como filtro ao criar ou alterar um webhook, - * sendo que o filtro determina quais notificações de eventos e ação serão enviadas - * para um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook - * ele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros. - */ - EventTypes_GetAll: { - responses: { - /** @description Sucesso na consulta do tipos de eventos */ - 200: { - content: { - readonly "application/json": { - /** @description Lista de Evento */ - readonly eventTypes?: readonly { - /** - * @description Identificador do evento, seguem o padrão **Resource.EventAction**. - * Onde **Resource**: nome da entidade que gerou o evento; - * **EventAction**: nome do evento e ação criados. - * Alguns exemplos **Invoice.Issued** ou **Blob.Updated** - */ - readonly id?: string; - /** @description Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. */ - readonly description?: string; - }[]; - }; + /** + * Listar os Webhooks + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar uma lista de **Webhooks** cadastrados na Conta Autenticada. + */ + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta da lista */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Web Hook */ + readonly webHooks?: readonly { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: unknown; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }[]; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; }; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** Listar as pessoas jurídicas ativas */ - LegalPeople_Get: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": { - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name: string; - /** @description Nome fantasia */ - readonly tradeName?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number; - /** @description Email */ - readonly email: string; - /** @description Endereço */ - readonly address: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - /** @description Estado */ - readonly state?: string; - }; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate?: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** - * @description Código da Natureza Jurídica - * @enum {string} - */ - readonly legalNature?: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @description Atividades da Empresa */ - readonly economicActivities?: readonly ({ - /** @enum {string} */ - readonly type?: "Main" | "Secondary"; - /** Format: int32 */ - readonly code?: number; - })[]; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number; - /** @description Número de Inscrição na Prefeitura (CCM) */ - readonly municipalTaxNumber?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Inactive" | "None" | "Active"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; + readonly put?: never; + /** + * Criar um Webhook + * @description ### Informações adicionais + * + * Utilize esta requisição para criar novos **Webhooks** para receber as notificações de eventos ocorridos na plataforma. + * + * Na criação do **Webhook** a URL informada no cadastro deve ser responsiva, ou seja, deverá responder *(HTTP Status 200 OK)* a uma requisição *(HTTP POST)* que será feita para testar se a URL está operando como normalmente, caso contrario uma mensagem de erro será retornada. + * + * Um **Webhook** é semelhante a uma assinatura em um *sistema de publicação e assinatura* + * que permite ao assinante indicar *quando*, *como* e *onde* as notificações de eventos deve ser despachadas. + * Um **Webhook** é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos + * que podem ser acionados por eventos gerados através de ações executadas por esse Conta. + * Ou seja, a **Conta da _Empresa A_** não verá os WebHooks disparados por uma ação executada pelo usuário **Conta da _Empresa B_**. + */ + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** @description Dados para criar um Web Hook */ + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description Dados para criar um Web Hook */ + readonly webHook?: { + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: unknown; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na criação da webhook */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description WebHook (Notificação HTTP) */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: unknown; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** Obter os detalhes de uma pessoa jurídica */ - LegalPeople_idGet: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - /** @description ID da pessoa juridica */ - id: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": { - readonly legalPeople?: { - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name: string; - /** @description Nome fantasia */ - readonly tradeName?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number; - /** @description Email */ - readonly email: string; - /** @description Endereço */ - readonly address: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - /** @description Estado */ - readonly state?: string; - }; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate?: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** - * @description Código da Natureza Jurídica - * @enum {string} - */ - readonly legalNature?: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @description Atividades da Empresa */ - readonly economicActivities?: readonly ({ - /** @enum {string} */ - readonly type?: "Main" | "Secondary"; - /** Format: int32 */ - readonly code?: number; - })[]; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number; - /** @description Número de Inscrição na Prefeitura (CCM) */ - readonly municipalTaxNumber?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Inactive" | "None" | "Active"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - }; + /** + * Excluir Todos os Webhooks existentes + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir todos os **Webhooks** cadastrados para a Conta Autenticada. + */ + readonly delete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão dos WebHooks */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - /** Listar as pessoas físicas ativas */ - NaturalPeople_Get: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": { - readonly naturalPeople?: readonly ({ - /** @description Identificação */ - readonly id?: string; - /** @description Nome completo */ - readonly name: string; - /** - * Format: int64 - * @description CPF - */ - readonly federalTaxNumber?: number; - /** @description Email */ - readonly email: string; - /** @description Endereço */ - readonly address: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - /** @description Estado */ - readonly state?: string; - }; - /** - * Format: date-time - * @description Data nascimento - */ - readonly birthDate?: string; - /** @description Número do Registro Geral (RG) */ - readonly idNumber?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Inactive" | "None" | "Active"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - })[]; - /** Format: int64 */ - readonly totalResults?: number; - /** Format: int32 */ - readonly totalPages?: number; - /** Format: int32 */ - readonly page?: number; - }; + readonly "/v2/webhooks/{webhook_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** Obter os detalhes de uma pessoa física */ - NaturalPeople_idGet: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - /** @description ID da pessoa física */ - id: string; - }; + /** + * Consultar um webhook existente + * @description ### Informações adicionais + * + * Utilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**. + */ + readonly get: operations["RegistrationLookupAction"]; + /** + * Alterar um Webhook existente + * @description ### Informações adicionais + * + * Utilize esta requisição para alterar os dados do **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. + */ + readonly put: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do webhook a ser consultado */ + readonly webhook_id: string; + }; + readonly cookie?: never; + }; + /** @description Dados para alterar o Webhook */ + readonly requestBody?: { + readonly content: { + readonly "application/json": { + /** @description WebHook (Notificação HTTP) */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: unknown; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + readonly responses: { + /** @description Sucesso na atualização da Webhook */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description WebHook (Notificação HTTP) */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: unknown; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly post?: never; + /** + * Excluir um Webhook existente + * @description ### Informações adicionais + * + * Utilize esta requisição para excluir o **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado. + * A exclusão do **Webhook** não exime o **Webhook** excluído de receber os notificações de eventos, já ocorridos na plataforma, que ainda estejam em processo de retentativa de envio dos gatilhos. + */ + readonly delete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do Webhook a ser excluído */ + readonly webhook_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na exclusão da Webhook */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; + }; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": { - /** @description Identificação */ - readonly id?: string; - /** @description Nome completo */ - readonly name: string; - /** - * Format: int64 - * @description CPF - */ - readonly federalTaxNumber?: number; - /** @description Email */ - readonly email: string; - /** @description Endereço */ - readonly address: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - /** @description Estado */ - readonly state?: string; - }; - /** - * Format: date-time - * @description Data nascimento - */ - readonly birthDate?: string; - /** @description Número do Registro Geral (RG) */ - readonly idNumber?: string; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Inactive" | "None" | "Active"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; + readonly "/v2/webhooks/{webhook_id}/pings": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + /** + * Criar notificação para Testar um webhook + * @description ### Informações adicionais + * + * Utilize esta requisição para criar uma notificação de teste (ping) em um **Webhook** já cadastrado. + * + * Esta ação irá criar um evento de notificação do tipo ping para o **Webhook** especificado, deste modo você poderá simular o recebimento de uma notificação de teste no **Webhook** cadastrado. + */ + readonly put: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do Webhook a ser testado */ + readonly webhook_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso ao criar notificação de teste */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + }; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - /** - * Listar as Notas Fiscais de Serviço (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - ServiceInvoices_Get: { - parameters: { - query?: { - /** @description Items por página */ - pageCount?: number; - /** @description Número da página */ - pageIndex?: number; - /** @description Data de competência início */ - issuedBegin?: string; - /** @description Data de competência fim */ - issuedEnd?: string; - /** @description Data de criação início */ - createdBegin?: string; - /** @description Data de criação fim */ - createdEnd?: string; - hasTotals?: boolean; - }; - path: { - /** @description ID da empresa */ - company_id: string; - }; +} +export type webhooks = Record; +export interface components { + schemas: never; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + readonly Companies_Get: { + readonly parameters: { + readonly query?: { + /** @description Items por página */ + readonly pageCount?: number; + /** @description Número da página */ + readonly pageIndex?: number; + }; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Consulta realizada com sucesso */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly companies?: readonly { + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name: string; + /** @description Nome fantasia */ + readonly tradeName?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber: number; + /** @description Email */ + readonly email: string; + /** @description Endereço */ + readonly address: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber: string; + /** @description RPS número serie */ + readonly rpsSerialNumber?: string; + /** + * Format: int64 + * @description RPS número + */ + readonly rpsNumber?: number; + /** + * Format: double + * @description Alíquota do ISS para Simples Nacional + */ + readonly issRate?: number; + /** + * @description Ambiente de processamento + * @enum {string} + */ + readonly environment?: "Development" | "Production" | "Staging"; + /** + * @description Status no sistema + * @enum {string} + */ + readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; + /** + * @description Determinação de imposto federal + * @enum {string} + */ + readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** + * @description Determinação de imposto municipal + * @enum {string} + */ + readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** @description Nome de login */ + readonly loginName?: string; + /** @description Senha de login */ + readonly loginPassword?: string; + /** @description Valor de emissão de autorização */ + readonly authIssueValue?: string; + /** @description Certificado */ + readonly certificate?: { + /** @description Thumbprint certificado */ + readonly thumbprint?: string; + /** + * Format: date-time + * @description Certificado alterado em + */ + readonly modifiedOn?: string; + /** + * Format: date-time + * @description Certificado expira em + */ + readonly expiresOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "Overdue" | "Pending" | "None" | "Active"; + }; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }[]; + /** Format: int64 */ + readonly totalResults?: number; + /** Format: int32 */ + readonly totalPages?: number; + /** Format: int32 */ + readonly page?: number; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": { - readonly serviceInvoices?: readonly ({ - /** @description Identificação */ - readonly id?: string; - /** - * @description Ambiente de Processamento - * @enum {string} - */ - readonly environment: "Development" | "Production" | "Staging"; - /** - * @description Status do processamento - * @enum {string} - */ - readonly flowStatus?: "CancelFailed" | "IssueFailed" | "Issued" | "Cancelled" | "PullFromCityHall" | "WaitingCalculateTaxes" | "WaitingDefineRpsNumber" | "WaitingSend" | "WaitingSendCancel" | "WaitingReturn" | "WaitingDownload"; - /** @description Mensagem de processamento */ - readonly flowMessage?: string; - /** @description Prestador dos serviços */ - readonly provider?: { - /** @description Nome Fantasia */ - readonly tradeName?: string; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate?: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; - /** - * @description Código da Natureza Jurídica - * @enum {string} - */ - readonly legalNature?: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @description Atividades da Empresa */ - readonly economicActivities?: readonly ({ - /** @enum {string} */ - readonly type?: "Main" | "Secondary"; - /** Format: int32 */ - readonly code?: number; - })[]; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number; - /** @description Número de Inscrição na Prefeitura (CCM) */ - readonly municipalTaxNumber?: string; - /** - * Format: double - * @description Taxa da Aliquota do ISS (Simples Nacional) - */ - readonly issRate?: number; - /** - * @description Determinação de imposto federal - * @enum {string} - */ - readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** - * @description Determinação de imposto municipal - * @enum {string} - */ - readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** @description Nome de login */ - readonly loginName?: string; - /** @description Senha de login */ - readonly loginPassword?: string; - /** @description Valor de emissão de autorização */ - readonly authIssueValue?: string; - readonly parentId?: string; - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number; - /** @description Email */ - readonly email?: string; - /** @description Endereço */ - readonly address?: { + readonly Companies_Post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** @description Dados da empresa */ + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name: string; + /** @description Nome fantasia */ + readonly tradeName?: string; /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG + * Format: int64 + * @description CNPJ ou CPF */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; + readonly federalTaxNumber: number; + /** @description Email */ + readonly email: string; + /** @description Endereço */ + readonly address: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; }; - /** @description Estado */ - readonly state?: string; - }; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Inactive" | "None" | "Active"; - /** - * @description Tipo da pessoa: Jurídica ou Física - * @enum {string} - */ - readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - /** @description Tomador dos serviços */ - readonly borrower?: { - readonly parentId?: string; - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number; - /** @description Telefone */ - readonly phoneNumber?: string; - /** @description Email */ - readonly email?: string; - /** @description Endereço */ - readonly address?: { /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG + * Format: date-time + * @description Data abertura da empresa */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; + readonly openningDate: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber: string; + /** @description RPS número serie */ + readonly rpsSerialNumber?: string; + /** + * Format: int64 + * @description RPS número + */ + readonly rpsNumber?: number; + /** + * Format: double + * @description Alíquota do ISS para Simples Nacional + */ + readonly issRate?: number; + /** + * @description Ambiente de processamento + * @enum {string} + */ + readonly environment?: "Development" | "Production" | "Staging"; + /** + * @description Status no sistema + * @enum {string} + */ + readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; + /** + * @description Determinação de imposto federal + * @enum {string} + */ + readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** + * @description Determinação de imposto municipal + * @enum {string} + */ + readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** @description Nome de login */ + readonly loginName?: string; + /** @description Senha de login */ + readonly loginPassword?: string; + /** @description Valor de emissão de autorização */ + readonly authIssueValue?: string; + /** @description Certificado */ + readonly certificate?: { + /** @description Thumbprint certificado */ + readonly thumbprint?: string; + /** + * Format: date-time + * @description Certificado alterado em + */ + readonly modifiedOn?: string; + /** + * Format: date-time + * @description Certificado expira em + */ + readonly expiresOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "Overdue" | "Pending" | "None" | "Active"; }; - /** @description Estado */ - readonly state?: string; - }; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Inactive" | "None" | "Active"; - /** - * @description Tipo da pessoa: Jurídica ou Física - * @enum {string} - */ - readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - /** @description Identificação única do cliente */ - readonly externalId?: string; - /** - * Format: int64 - * @description Número do lote da RPS - */ - readonly batchNumber?: number; - /** @description Número do protocolo do lote da RPS */ - readonly batchCheckNumber?: string; - /** - * Format: int64 - * @description Número do NFE - */ - readonly number?: number; - /** @description Código de Verificação da NFE */ - readonly checkCode?: string; - /** - * @description Status da NFE - * @enum {string} - */ - readonly status?: "Error" | "None" | "Created" | "Issued" | "Cancelled"; - /** - * @description Tipo da RPS - * @enum {string} - */ - readonly rpsType?: "Rps" | "RpsMista" | "Cupom"; - /** - * @description Status da RPS - * @enum {string} - */ - readonly rpsStatus?: "Normal" | "Canceled" | "Lost"; - /** - * @description Tipo da tributação - * @enum {string} - */ - readonly taxationType?: "None" | "WithinCity" | "OutsideCity" | "Export" | "Free" | "Immune" | "SuspendedCourtDecision" | "SuspendedAdministrativeProcedure" | "OutsideCityFree" | "OutsideCityImmune" | "OutsideCitySuspended" | "OutsideCitySuspendedAdministrativeProcedure" | "ObjectiveImune"; - /** - * Format: date-time - * @description Data de emissão - */ - readonly issuedOn?: string; - /** - * Format: date-time - * @description Data de cancelamento - */ - readonly cancelledOn?: string; - /** @description Número de serie da RPS */ - readonly rpsSerialNumber?: string; - /** - * Format: int64 - * @description Número da RPS - */ - readonly rpsNumber?: number; - /** @description Código do servico prestado no Municipio */ - readonly cityServiceCode?: string; - /** @description Código do servico prestado federal */ - readonly federalServiceCode?: string; - /** @description Descrição do serviço no municipio */ - readonly description?: string; - /** - * Format: double - * @description Valor do serviços - */ - readonly servicesAmount?: number; - /** - * Format: double - * @description Valor dos Serviços pago - */ - readonly paidAmount?: number; - /** - * @description Formas de pagamento - * @enum {string} - */ - readonly paymentMethod?: "None" | "Cash" | "Check" | "CreditCard" | "DebitCard" | "StoreCredit" | "FoodVoucher" | "MealVoucher" | "GiftCard" | "FuelVoucher" | "Others"; - /** - * Format: double - * @description Valor de deduções - */ - readonly deductionsAmount?: number; - /** - * Format: double - * @description Valor do desconto incondicionado - */ - readonly discountUnconditionedAmount?: number; - /** - * Format: double - * @description Valor do desconto condicionado - */ - readonly discountConditionedAmount?: number; - /** - * Format: double - * @description Valor da base de calculo de impostos - */ - readonly baseTaxAmount?: number; - /** - * Format: double - * @description Aliquota do ISS - */ - readonly issRate?: number; - /** - * Format: double - * @description Valor do ISS - */ - readonly issTaxAmount?: number; - /** - * Format: double - * @description Valor retido do Imposto de Renda (IR) - */ - readonly irAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do PIS - */ - readonly pisAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do COFINS - */ - readonly cofinsAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do CSLL - */ - readonly csllAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do INSS - */ - readonly inssAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do ISS - */ - readonly issAmountWithheld?: number; - /** - * Format: double - * @description Valor de outras retenções - */ - readonly othersAmountWithheld?: number; - /** - * Format: double - * @description Valor das retenções - */ - readonly amountWithheld?: number; - /** - * Format: double - * @description Valor líquido - */ - readonly amountNet?: number; - /** @description Local da Prestação do Serviço */ - readonly location?: { - /** @description Estado */ - readonly state?: string; - /** @description País */ - readonly country?: string; - /** @description Código Postal */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street?: string; - /** @description Número */ - readonly number?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Informações Adicionais (Complemento) */ - readonly AdditionalInformation?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - }; - /** @description Detalhes da atividade do evento */ - readonly activityEvent?: { - /** @description Nome do evento */ - readonly name?: string; - /** - * Format: date-time - * @description Data de início do evento - */ - readonly beginOn?: string; - /** - * Format: date-time - * @description Data do fim do evento - */ - readonly endOn?: string; - /** @description Código da atividade do evento */ - readonly Code?: string; - }; - /** @description Tributos aproximados */ - readonly approximateTax?: { - /** @description Nome da fonte da taxa */ - readonly source?: string; - /** @description Versão da taxa baseado na fonte */ - readonly version?: string; - /** - * Format: double - * @description Taxa dos tributos aproximados - */ - readonly totalRate?: number; - }; - /** @description Informações Adicionais */ - readonly additionalInformation?: string; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - })[]; - /** Format: int64 */ - readonly totalResults?: number; - /** Format: int32 */ - readonly totalPages?: number; - /** Format: int32 */ - readonly page?: number; - }; - }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** - * Emitir uma Nota Fiscal de Serviço (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - ServiceInvoices_Post: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - }; - }; - /** @description Dados da nota fiscal de serviço */ - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description Tomador dos serviços */ - readonly borrower?: { - /** - * @description Tipo do tomador dos serviços - * @enum {string} - */ - readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity"; - /** @description Nome / Razão Social */ - readonly name?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number; - /** @description Inscrição Municipal para Pessoas Jurídicas */ - readonly municipalTaxNumber?: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** @description Telefone */ - readonly phoneNumber?: string; - /** @description Email */ - readonly email?: string; - /** @description Endereço */ - readonly address?: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street?: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number?: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - /** @description Estado */ - readonly state?: string; - }; - }; - /** @description Identificação única do cliente */ - readonly externalId?: string; - /** @description Código do serviço no municipio */ - readonly cityServiceCode: string; - /** @description Código federal do servico (Item da lista de serviço LC 116) */ - readonly federalServiceCode?: string; - /** @description Código CNAE (somente quando necessario na cidade) */ - readonly cnaeCode?: string; - /** @description Código do NBS no municipio (somente quando necessario na cidade) */ - readonly nbsCode?: string; - /** @description Descrição dos serviços */ - readonly description: string; - /** - * Format: double - * @description Valor do serviços - */ - readonly servicesAmount: number; - /** @description Número de Serie da RPS */ - readonly rpsSerialNumber?: string; - /** - * Format: date-time - * @description Data da emissão no formato YYYY-MM-DDTHH:MM:SS.SSSSSS-03:00 - */ - readonly issuedOn?: string; - /** - * Format: int64 - * @description Número da RPS - */ - readonly rpsNumber?: number; - /** - * @description Tipo da tributação - * @enum {string} - */ - readonly taxationType?: "None" | "WithinCity" | "OutsideCity" | "Export" | "Free" | "Immune" | "SuspendedCourtDecision" | "SuspendedAdministrativeProcedure" | "OutsideCityFree" | "OutsideCityImmune" | "OutsideCitySuspended" | "OutsideCitySuspendedAdministrativeProcedure" | "ObjectiveImune"; - /** - * Format: double - * @description Aliquota do ISS - */ - readonly issRate?: number; - /** - * Format: double - * @description Valor do ISS - */ - readonly issTaxAmount?: number; - /** - * Format: double - * @description Valor de deduções - */ - readonly deductionsAmount?: number; - /** - * Format: double - * @description Valor do desconto incondicionado - */ - readonly discountUnconditionedAmount?: number; - /** - * Format: double - * @description Valor do desconto condicionado - */ - readonly discountConditionedAmount?: number; - /** - * Format: double - * @description Valor retido do Imposto de Renda (IR) - */ - readonly irAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do PIS - */ - readonly pisAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do COFINS - */ - readonly cofinsAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do CSLL - */ - readonly csllAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do INSS - */ - readonly inssAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do ISS - */ - readonly issAmountWithheld?: number; - /** - * Format: double - * @description Valor de outras retenções - */ - readonly othersAmountWithheld?: number; - /** @description Tributos aproximados */ - readonly approximateTax?: { - /** @description Nome da fonte da taxa */ - readonly source?: string; - /** @description Versão da taxa baseado na fonte */ - readonly version?: string; - /** - * Format: double - * @description Taxa dos tributos aproximados - */ - readonly totalRate?: number; - }; - /** @description Informações Adicionais */ - readonly additionalInformation?: string; - /** @description Local da Prestação do Serviço */ - readonly location?: { - /** @description Estado */ - readonly state?: string; - /** @description País */ - readonly country?: string; - /** @description Código Postal */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street?: string; - /** @description Número */ - readonly number?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Informações Adicionais (Complemento) */ - readonly AdditionalInformation?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - }; - /** @description Detalhes da atividade do evento */ - readonly activityEvent?: { - /** @description Nome do evento */ - readonly name?: string; - /** - * Format: date-time - * @description Data de início do evento - */ - readonly beginOn?: string; - /** - * Format: date-time - * @description Data do fim do evento - */ - readonly endOn?: string; - /** @description Código da atividade do evento */ - readonly Code?: string; - }; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; }; - }; - }; - responses: { - /** @description Nota Fiscal de Serviços foi enviada com sucesso para fila de emissão */ - 202: { - content: { - readonly "application/json": { - /** @description Identificação */ - readonly id?: string; - /** - * @description Ambiente de Processamento - * @enum {string} - */ - readonly environment: "Development" | "Production" | "Staging"; - /** - * @description Status do processamento - * @enum {string} - */ - readonly flowStatus?: "CancelFailed" | "IssueFailed" | "Issued" | "Cancelled" | "PullFromCityHall" | "WaitingCalculateTaxes" | "WaitingDefineRpsNumber" | "WaitingSend" | "WaitingSendCancel" | "WaitingReturn" | "WaitingDownload"; - /** @description Mensagem de processamento */ - readonly flowMessage?: string; - /** @description Prestador dos serviços */ - readonly provider?: { - /** @description Nome Fantasia */ - readonly tradeName?: string; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate?: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; - /** - * @description Código da Natureza Jurídica - * @enum {string} - */ - readonly legalNature?: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @description Atividades da Empresa */ - readonly economicActivities?: readonly ({ - /** @enum {string} */ - readonly type?: "Main" | "Secondary"; - /** Format: int32 */ - readonly code?: number; - })[]; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number; - /** @description Número de Inscrição na Prefeitura (CCM) */ - readonly municipalTaxNumber?: string; - /** - * Format: double - * @description Taxa da Aliquota do ISS (Simples Nacional) - */ - readonly issRate?: number; - /** - * @description Determinação de imposto federal - * @enum {string} - */ - readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** - * @description Determinação de imposto municipal - * @enum {string} - */ - readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** @description Nome de login */ - readonly loginName?: string; - /** @description Senha de login */ - readonly loginPassword?: string; - /** @description Valor de emissão de autorização */ - readonly authIssueValue?: string; - readonly parentId?: string; - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number; - /** @description Email */ - readonly email?: string; - /** @description Endere o */ - readonly address?: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street?: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number?: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - /** @description Estado */ - readonly state?: string; - }; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Inactive" | "None" | "Active"; - /** - * @description Tipo da pessoa: Jurídica ou Física - * @enum {string} - */ - readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - }; - /** @description Tomador dos serviços */ - readonly borrower?: { - readonly parentId?: string; - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number; - /** @description Telefone */ - readonly phoneNumber?: string; - /** @description Email */ - readonly email?: string; - /** @description Endereço */ - readonly address?: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street?: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number?: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - /** @description Estado */ - readonly state?: string; - }; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Inactive" | "None" | "Active"; - /** - * @description Tipo da pessoa: Jurídica ou Física - * @enum {string} - */ - readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - }; - /** @description Identificação única do cliente */ - readonly externalId?: string; - /** - * Format: int64 - * @description Número do lote da RPS - */ - readonly batchNumber?: number; - /** @description Número do protocolo do lote da RPS */ - readonly batchCheckNumber?: string; - /** - * Format: int64 - * @description Número do NFE - */ - readonly number?: number; - /** @description Código de Verificação da NFE */ - readonly checkCode?: string; - /** - * @description Status da NFE - * @enum {string} - */ - readonly status?: "Error" | "None" | "Created" | "Issued" | "Cancelled"; - /** - * @description Tipo da RPS - * @enum {string} - */ - readonly rpsType?: "Rps" | "RpsMista" | "Cupom"; - /** - * @description Status da RPS - * @enum {string} - */ - readonly rpsStatus?: "Normal" | "Canceled" | "Lost"; - /** - * @description Tipo da tributação - * @enum {string} - */ - readonly taxationType?: "None" | "WithinCity" | "OutsideCity" | "Export" | "Free" | "Immune" | "SuspendedCourtDecision" | "SuspendedAdministrativeProcedure" | "OutsideCityFree" | "OutsideCityImmune" | "OutsideCitySuspended" | "OutsideCitySuspendedAdministrativeProcedure" | "ObjectiveImune"; - /** - * Format: date-time - * @description Data de emissão - */ - readonly issuedOn?: string; - /** - * Format: date-time - * @description Data de cancelamento - */ - readonly cancelledOn?: string; - /** @description Número de serie da RPS */ - readonly rpsSerialNumber?: string; - /** - * Format: int64 - * @description Número da RPS - */ - readonly rpsNumber?: number; - /** @description Código do servico prestado no Municipio */ - readonly cityServiceCode?: string; - /** @description Código do servico prestado federal */ - readonly federalServiceCode?: string; - /** @description Descrição do serviço no municipio */ - readonly description?: string; - /** - * Format: double - * @description Valor do serviços - */ - readonly servicesAmount?: number; - /** - * Format: double - * @description Valor de deduções - */ - readonly deductionsAmount?: number; - /** - * Format: double - * @description Valor do desconto incondicionado - */ - readonly discountUnconditionedAmount?: number; - /** - * Format: double - * @description Valor do desconto condicionado - */ - readonly discountConditionedAmount?: number; - /** - * Format: double - * @description Valor da base de calculo de impostos - */ - readonly baseTaxAmount?: number; - /** - * Format: double - * @description Aliquota do ISS - */ - readonly issRate?: number; - /** - * Format: double - * @description Valor do ISS - */ - readonly issTaxAmount?: number; - /** - * Format: double - * @description Valor retido do Imposto de Renda (IR) - */ - readonly irAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do PIS - */ - readonly pisAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do COFINS - */ - readonly cofinsAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do CSLL - */ - readonly csllAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do INSS - */ - readonly inssAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do ISS - */ - readonly issAmountWithheld?: number; - /** - * Format: double - * @description Valor de outras retenções - */ - readonly othersAmountWithheld?: number; - /** - * Format: double - * @description Valor das retenções - */ - readonly amountWithheld?: number; - /** - * Format: double - * @description Valor líquido - */ - readonly amountNet?: number; - /** @description Local da Prestação do Serviço */ - readonly location?: { - /** @description Estado */ - readonly state?: string; - /** @description País */ - readonly country?: string; - /** @description Código Postal */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street?: string; - /** @description Número */ - readonly number?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Informações Adicionais (Complemento) */ - readonly AdditionalInformation?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - }; - /** @description Detalhes da atividade do evento */ - readonly activityEvent?: { - /** @description Nome do evento */ - readonly name?: string; - /** - * Format: date-time - * @description Data de início do evento - */ - readonly beginOn?: string; - /** - * Format: date-time - * @description Data do fim do evento - */ - readonly endOn?: string; - /** @description Código da atividade do evento */ - readonly Code?: string; - }; - /** @description Tributos aproximados */ - readonly approximateTax?: { - /** @description Nome da fonte da taxa */ - readonly source?: string; - /** @description Versão da taxa baseado na fonte */ - readonly version?: string; - /** - * Format: double - * @description Taxa dos tributos aproximados - */ - readonly totalRate?: number; - }; - /** @description Informações Adicionais */ - readonly additionalInformation?: string; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; + readonly responses: { + /** @description Sucesso na criação da empresa */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly companies?: { + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name: string; + /** @description Nome fantasia */ + readonly tradeName?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber: number; + /** @description Email */ + readonly email: string; + /** @description Endereço */ + readonly address: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber: string; + /** @description RPS número serie */ + readonly rpsSerialNumber?: string; + /** + * Format: int64 + * @description RPS número + */ + readonly rpsNumber?: number; + /** + * Format: double + * @description Alíquota do ISS para Simples Nacional + */ + readonly issRate?: number; + /** + * @description Ambiente de processamento + * @enum {string} + */ + readonly environment?: "Development" | "Production" | "Staging"; + /** + * @description Status no sistema + * @enum {string} + */ + readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; + /** + * @description Determinação de imposto federal + * @enum {string} + */ + readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** + * @description Determinação de imposto municipal + * @enum {string} + */ + readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** @description Nome de login */ + readonly loginName?: string; + /** @description Senha de login */ + readonly loginPassword?: string; + /** @description Valor de emissão de autorização */ + readonly authIssueValue?: string; + /** @description Certificado */ + readonly certificate?: { + /** @description Thumbprint certificado */ + readonly thumbprint?: string; + /** + * Format: date-time + * @description Certificado alterado em + */ + readonly modifiedOn?: string; + /** + * Format: date-time + * @description Certificado expira em + */ + readonly expiresOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "Overdue" | "Pending" | "None" | "Active"; + }; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Já existe uma empresa com o CNPJ informado */ + readonly 409: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Tempo de reposta do servidor excedeu o limite (60s) */ - 408: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; }; - }; - /** - * Obter os detalhes de uma Nota Fiscal de Serviço (NFSE) - * @description Você precisará do API Key da Empresa - */ - ServiceInvoices_idGet: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - /** @description ID da Nota Fiscal de Serviço (NFSE) */ - id: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": { - /** @description Identificação */ - readonly id?: string; - /** - * @description Ambiente de Processamento - * @enum {string} - */ - readonly environment: "Development" | "Production" | "Staging"; - /** - * @description Status do processamento - * @enum {string} - */ - readonly flowStatus?: "CancelFailed" | "IssueFailed" | "Issued" | "Cancelled" | "PullFromCityHall" | "WaitingCalculateTaxes" | "WaitingDefineRpsNumber" | "WaitingSend" | "WaitingSendCancel" | "WaitingReturn" | "WaitingDownload"; - /** @description Mensagem de processamento */ - readonly flowMessage?: string; - /** @description Prestador dos serviços */ - readonly provider?: { - /** @description Nome Fantasia */ - readonly tradeName?: string; - /** - * Format: date-time - * @description Data abertura da empresa - */ - readonly openningDate?: string; - /** - * @description Tipo do Regime Tributário - * @enum {string} - */ - readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; - /** - * @description Tipo do regime especial de tributação - * @enum {string} - */ - readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; - /** - * @description Código da Natureza Jurídica - * @enum {string} - */ - readonly legalNature?: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; - /** @description Atividades da Empresa */ - readonly economicActivities?: readonly ({ - /** @enum {string} */ - readonly type?: "Main" | "Secondary"; - /** Format: int32 */ - readonly code?: number; - })[]; - /** - * Format: int64 - * @description Número de Inscrição na Junta Comercial - */ - readonly companyRegistryNumber?: number; - /** - * Format: int64 - * @description Número de Inscrição na SEFAZ (IE) - */ - readonly regionalTaxNumber?: number; - /** @description Número de Inscrição na Prefeitura (CCM) */ - readonly municipalTaxNumber?: string; - /** - * Format: double - * @description Taxa da Aliquota do ISS (Simples Nacional) - */ - readonly issRate?: number; - /** - * @description Determinação de imposto federal - * @enum {string} - */ - readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** - * @description Determinação de imposto municipal - * @enum {string} - */ - readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; - /** @description Nome de login */ - readonly loginName?: string; - /** @description Senha de login */ - readonly loginPassword?: string; - /** @description Valor de emissão de autorização */ - readonly authIssueValue?: string; - readonly parentId?: string; - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number; - /** @description Email */ - readonly email?: string; - /** @description Endereço */ - readonly address?: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - /** @description Estado */ - readonly state?: string; - }; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Inactive" | "None" | "Active"; - /** - * @description Tipo da pessoa: Jurídica ou Física - * @enum {string} - */ - readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - }; - /** @description Tomador dos serviços */ - readonly borrower?: { - readonly parentId?: string; - /** @description Identificação */ - readonly id?: string; - /** @description Nome ou Razão Social */ - readonly name?: string; - /** - * Format: int64 - * @description CNPJ ou CPF - */ - readonly federalTaxNumber?: number; - /** @description Telefone */ - readonly phoneNumber?: string; - /** @description Email */ - readonly email?: string; - /** @description Endereço */ - readonly address?: { - /** - * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) - * Exemplo: BRA, USD, ARG - */ - readonly country: string; - /** @description CEP (Exemplo: 99999-999) */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street: string; - /** @description Número (Exemplo: 185 ou S/N) */ - readonly number: string; - /** @description Complemento (Exemplo: BLC A; APT 10 */ - readonly additionalInformation?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - /** @description Estado */ - readonly state?: string; - }; - /** - * @description Status no sistema - * @enum {string} - */ - readonly status?: "Inactive" | "None" | "Active"; - /** - * @description Tipo da pessoa: Jurídica ou Física - * @enum {string} - */ - readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; - }; - /** @description Identificação única do cliente */ - readonly externalId?: string; - /** - * Format: int64 - * @description Número do lote da RPS - */ - readonly batchNumber?: number; - /** @description Número do protocolo do lote da RPS */ - readonly batchCheckNumber?: string; - /** - * Format: int64 - * @description Número do NFE - */ - readonly number?: number; - /** @description Código de Verificação da NFE */ - readonly checkCode?: string; - /** - * @description Status da NFE - * @enum {string} - */ - readonly status?: "Error" | "None" | "Created" | "Issued" | "Cancelled"; - /** - * @description Tipo da RPS - * @enum {string} - */ - readonly rpsType?: "Rps" | "RpsMista" | "Cupom"; - /** - * @description Status da RPS - * @enum {string} - */ - readonly rpsStatus?: "Normal" | "Canceled" | "Lost"; - /** - * @description Tipo da tributação - * @enum {string} - */ - readonly taxationType?: "None" | "WithinCity" | "OutsideCity" | "Export" | "Free" | "Immune" | "SuspendedCourtDecision" | "SuspendedAdministrativeProcedure" | "OutsideCityFree" | "OutsideCityImmune" | "OutsideCitySuspended" | "OutsideCitySuspendedAdministrativeProcedure" | "ObjectiveImune"; - /** - * Format: date-time - * @description Data de emissão - */ - readonly issuedOn?: string; - /** - * Format: date-time - * @description Data de cancelamento - */ - readonly cancelledOn?: string; - /** @description Número de serie da RPS */ - readonly rpsSerialNumber?: string; - /** - * Format: int64 - * @description Número da RPS - */ - readonly rpsNumber?: number; - /** @description Código do servico prestado no Municipio */ - readonly cityServiceCode?: string; - /** @description Código do servico prestado federal */ - readonly federalServiceCode?: string; - /** @description Descrição do serviço no municipio */ - readonly description?: string; - /** - * Format: double - * @description Valor do serviços - */ - readonly servicesAmount?: number; - /** - * Format: double - * @description Valor de deduções - */ - readonly deductionsAmount?: number; - /** - * Format: double - * @description Valor do desconto incondicionado - */ - readonly discountUnconditionedAmount?: number; - /** - * Format: double - * @description Valor do desconto condicionado - */ - readonly discountConditionedAmount?: number; - /** - * Format: double - * @description Valor da base de calculo de impostos - */ - readonly baseTaxAmount?: number; - /** - * Format: double - * @description Aliquota do ISS - */ - readonly issRate?: number; - /** - * Format: double - * @description Valor do ISS - */ - readonly issTaxAmount?: number; - /** - * Format: double - * @description Valor retido do Imposto de Renda (IR) - */ - readonly irAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do PIS - */ - readonly pisAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do COFINS - */ - readonly cofinsAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do CSLL - */ - readonly csllAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do INSS - */ - readonly inssAmountWithheld?: number; - /** - * Format: double - * @description Valor retido do ISS - */ - readonly issAmountWithheld?: number; - /** - * Format: double - * @description Valor de outras retenções - */ - readonly othersAmountWithheld?: number; - /** - * Format: double - * @description Valor das retenções - */ - readonly amountWithheld?: number; - /** - * Format: double - * @description Valor líquido - */ - readonly amountNet?: number; - /** @description Local da Prestação do Serviço */ - readonly location?: { - /** @description Estado */ - readonly state?: string; - /** @description País */ - readonly country?: string; - /** @description Código Postal */ - readonly postalCode?: string; - /** @description Logradouro */ - readonly street?: string; - /** @description Número */ - readonly number?: string; - /** @description Bairro */ - readonly district?: string; - /** @description Informações Adicionais (Complemento) */ - readonly AdditionalInformation?: string; - /** @description Cidade */ - readonly city?: { - /** @description Código do IBGE */ - readonly code?: string; - /** @description Nome */ - readonly name?: string; - }; - }; - /** @description Detalhes da atividade do evento */ - readonly activityEvent?: { - /** @description Nome do evento */ - readonly name?: string; - /** - * Format: date-time - * @description Data de início do evento - */ - readonly beginOn?: string; - /** - * Format: date-time - * @description Data do fim do evento - */ - readonly endOn?: string; - /** @description Código da atividade do evento */ - readonly Code?: string; - }; - /** @description Tributos aproximados */ - readonly approximateTax?: { - /** @description Nome da fonte da taxa */ - readonly source?: string; - /** @description Versão da taxa baseado na fonte */ - readonly version?: string; - /** - * Format: double - * @description Taxa dos tributos aproximados - */ - readonly totalRate?: number; - }; - /** @description Informações Adicionais */ - readonly additionalInformation?: string; - /** - * Format: date-time - * @description Data de criação - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data da última modificação - */ - readonly modifiedOn?: string; - }; + readonly Companies_idGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa ou Inscrição Federal (CNPJ) */ + readonly company_id_or_tax_number: string; + }; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** - * Cancelar uma Nota Fiscal de Serviços (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - ServiceInvoices_Delete: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - /** @description ID da Nota Fiscal de Serviço (NFSE) */ - id: string; - }; - }; - responses: { - /** @description Nota fiscal cancelada com sucesso */ - 200: { - content: { - readonly "application/json": string; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly companies?: { + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name: string; + /** @description Nome fantasia */ + readonly tradeName?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber: number; + /** @description Email */ + readonly email: string; + /** @description Endereço */ + readonly address: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber: string; + /** @description RPS número serie */ + readonly rpsSerialNumber?: string; + /** + * Format: int64 + * @description RPS número + */ + readonly rpsNumber?: number; + /** + * Format: double + * @description Alíquota do ISS para Simples Nacional + */ + readonly issRate?: number; + /** + * @description Ambiente de processamento + * @enum {string} + */ + readonly environment?: "Development" | "Production" | "Staging"; + /** + * @description Status no sistema + * @enum {string} + */ + readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; + /** + * @description Determinação de imposto federal + * @enum {string} + */ + readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** + * @description Determinação de imposto municipal + * @enum {string} + */ + readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** @description Nome de login */ + readonly loginName?: string; + /** @description Senha de login */ + readonly loginPassword?: string; + /** @description Valor de emissão de autorização */ + readonly authIssueValue?: string; + /** @description Certificado */ + readonly certificate?: { + /** @description Thumbprint certificado */ + readonly thumbprint?: string; + /** + * Format: date-time + * @description Certificado alterado em + */ + readonly modifiedOn?: string; + /** + * Format: date-time + * @description Certificado expira em + */ + readonly expiresOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "Overdue" | "Pending" | "None" | "Active"; + }; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Tempo de reposta do servidor excedeu o limite (60s) */ - 408: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; }; - }; - /** - * Enviar email para o Tomador com a Nota Fiscal de Serviço (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - ServiceInvoices_SendEmail: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - /** @description ID da Nota Fiscal de Serviço (NFSE) */ - id: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": string; + readonly Companies_Put: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + }; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Tempo de reposta do servidor excedeu o limite (60s) */ - 408: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; - }; - }; - /** - * Download do PDF da Nota Fiscal de Serviço (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - ServiceInvoices_GetDocumentPdf: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - /** @description ID da Nota Fiscal de Serviço (NFSE) */ - id: string; - }; - }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": string; + /** @description Dados da empresa */ + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name: string; + /** @description Nome fantasia */ + readonly tradeName?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber: number; + /** @description Email */ + readonly email: string; + /** @description Endereço */ + readonly address: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber: string; + /** @description RPS número serie */ + readonly rpsSerialNumber?: string; + /** + * Format: int64 + * @description RPS número + */ + readonly rpsNumber?: number; + /** + * Format: double + * @description Alíquota do ISS para Simples Nacional + */ + readonly issRate?: number; + /** + * @description Ambiente de processamento + * @enum {string} + */ + readonly environment?: "Development" | "Production" | "Staging"; + /** + * @description Status no sistema + * @enum {string} + */ + readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; + /** + * @description Determinação de imposto federal + * @enum {string} + */ + readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** + * @description Determinação de imposto municipal + * @enum {string} + */ + readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** @description Nome de login */ + readonly loginName?: string; + /** @description Senha de login */ + readonly loginPassword?: string; + /** @description Valor de emissão de autorização */ + readonly authIssueValue?: string; + /** @description Certificado */ + readonly certificate?: { + /** @description Thumbprint certificado */ + readonly thumbprint?: string; + /** + * Format: date-time + * @description Certificado alterado em + */ + readonly modifiedOn?: string; + /** + * Format: date-time + * @description Certificado expira em + */ + readonly expiresOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "Overdue" | "Pending" | "None" | "Active"; + }; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + readonly responses: { + /** @description Sucesso na atualização da empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly companies?: { + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name: string; + /** @description Nome fantasia */ + readonly tradeName?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber: number; + /** @description Email */ + readonly email: string; + /** @description Endereço */ + readonly address: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber: string; + /** @description RPS número serie */ + readonly rpsSerialNumber?: string; + /** + * Format: int64 + * @description RPS número + */ + readonly rpsNumber?: number; + /** + * Format: double + * @description Alíquota do ISS para Simples Nacional + */ + readonly issRate?: number; + /** + * @description Ambiente de processamento + * @enum {string} + */ + readonly environment?: "Development" | "Production" | "Staging"; + /** + * @description Status no sistema + * @enum {string} + */ + readonly fiscalStatus?: "CityNotSupported" | "Pending" | "Inactive" | "None" | "Active"; + /** + * @description Determinação de imposto federal + * @enum {string} + */ + readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** + * @description Determinação de imposto municipal + * @enum {string} + */ + readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** @description Nome de login */ + readonly loginName?: string; + /** @description Senha de login */ + readonly loginPassword?: string; + /** @description Valor de emissão de autorização */ + readonly authIssueValue?: string; + /** @description Certificado */ + readonly certificate?: { + /** @description Thumbprint certificado */ + readonly thumbprint?: string; + /** + * Format: date-time + * @description Certificado alterado em + */ + readonly modifiedOn?: string; + /** + * Format: date-time + * @description Certificado expira em + */ + readonly expiresOn?: string; + /** + * @description Status do certificado + * @enum {string} + */ + readonly status?: "Overdue" | "Pending" | "None" | "Active"; + }; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly Companies_Delete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na remoção da empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": Record; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description empresa não foi encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly Companies_CertificateUpload: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + /** @description Arquivo do certificado digital com extensao PFX ou P12 */ + readonly requestBody: { + readonly content: { + readonly "multipart/form-data": { + /** Format: binary */ + readonly file?: string; + readonly password?: string; + }; + }; + }; + readonly responses: { + /** @description Sucesso na atualização da certificado digital */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Empresa não foi encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Nenhum arquivo foi encontrado na requisição */ + readonly 415: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly CompaniesNotifications_Get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Consulta realizada com sucesso */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly notifications?: readonly { + /** @description Identificação */ + readonly id?: string; + /** + * @description Canal de Notificação + * @enum {string} + */ + readonly channel?: "None" | "Email"; + /** @description Filtro de Evento */ + readonly filters?: readonly string[]; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Active" | "Inactive"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }[]; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly CompaniesNotifications_idGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + /** @description ID da notificação a ser consultado */ + readonly notification_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly notification?: { + /** @description Identificação */ + readonly id?: string; + /** + * @description Canal de Notificação + * @enum {string} + */ + readonly channel?: "None" | "Email"; + /** @description Filtro de Evento */ + readonly filters?: readonly string[]; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Active" | "Inactive"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly CompaniesNotifications_Delete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + /** @description ID da notificação */ + readonly notification_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na remoção da empresa */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": Record; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description empresa não foi encontrada */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly CompaniesNotifications_Post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + /** @description Dados da notificação */ + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description Lista de filtros de evento sem distinção entre maiúsculas e minúsculas associado a esta notificação. + * Os filtros de evento são usados para determinar em quais eventos essa notificação será acionada. + * Os valores de filtros suportados pode ser consultados através do requisição na API de **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** + * @description Determina se as notificações são enviadas quando o evento é gerado. + * Definir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active** + * para receber todas as notificações. + * @enum {string} + */ + readonly status?: "Active" | "Inactive"; + }; + }; + }; + readonly responses: { + /** @description Sucesso na criação da empresa */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly notification?: { + /** @description Identificação */ + readonly id?: string; + /** + * @description Canal de Notificação + * @enum {string} + */ + readonly channel?: "None" | "Email"; + /** @description Filtro de Evento */ + readonly filters?: readonly string[]; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Active" | "Inactive"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Já existe uma empresa com o CNPJ informado */ + readonly 409: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly EventTypes_GetAll: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do tipos de eventos */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Evento */ + readonly eventTypes?: readonly { + /** + * @description Identificador do evento, seguem o padrão **Resource.EventAction**. + * Onde **Resource**: nome da entidade que gerou o evento; + * **EventAction**: nome do evento e ação criados. + * Alguns exemplos **Invoice.Issued** ou **Blob.Updated** + */ + readonly id?: string; + /** @description Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. */ + readonly description?: string; + }[]; + }; + }; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly LegalPeople_Get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name: string; + /** @description Nome fantasia */ + readonly tradeName?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number; + /** @description Email */ + readonly email: string; + /** @description Endereço */ + readonly address: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate?: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature?: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly LegalPeople_idGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + /** @description ID da pessoa juridica */ + readonly id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly legalPeople?: { + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name: string; + /** @description Nome fantasia */ + readonly tradeName?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number; + /** @description Email */ + readonly email: string; + /** @description Endereço */ + readonly address: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate?: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature?: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly NaturalPeople_Get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly naturalPeople?: readonly { + /** @description Identificação */ + readonly id?: string; + /** @description Nome completo */ + readonly name: string; + /** + * Format: int64 + * @description CPF + */ + readonly federalTaxNumber?: number; + /** @description Email */ + readonly email: string; + /** @description Endereço */ + readonly address: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + /** + * Format: date-time + * @description Data nascimento + */ + readonly birthDate?: string; + /** @description Número do Registro Geral (RG) */ + readonly idNumber?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }[]; + /** Format: int64 */ + readonly totalResults?: number; + /** Format: int32 */ + readonly totalPages?: number; + /** Format: int32 */ + readonly page?: number; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly NaturalPeople_idGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + /** @description ID da pessoa física */ + readonly id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Identificação */ + readonly id?: string; + /** @description Nome completo */ + readonly name: string; + /** + * Format: int64 + * @description CPF + */ + readonly federalTaxNumber?: number; + /** @description Email */ + readonly email: string; + /** @description Endereço */ + readonly address: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + /** + * Format: date-time + * @description Data nascimento + */ + readonly birthDate?: string; + /** @description Número do Registro Geral (RG) */ + readonly idNumber?: string; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly ServiceInvoices_Get: { + readonly parameters: { + readonly query?: { + /** @description Items por página */ + readonly pageCount?: number; + /** @description Número da página */ + readonly pageIndex?: number; + /** @description Data de competência início */ + readonly issuedBegin?: string; + /** @description Data de competência fim */ + readonly issuedEnd?: string; + /** @description Data de criação início */ + readonly createdBegin?: string; + /** @description Data de criação fim */ + readonly createdEnd?: string; + readonly hasTotals?: boolean; + }; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly serviceInvoices?: readonly { + /** @description Identificação */ + readonly id?: string; + /** + * @description Ambiente de Processamento + * @enum {string} + */ + readonly environment: "Development" | "Production" | "Staging"; + /** + * @description Status do processamento + * @enum {string} + */ + readonly flowStatus?: "CancelFailed" | "IssueFailed" | "Issued" | "Cancelled" | "PullFromCityHall" | "WaitingCalculateTaxes" | "WaitingDefineRpsNumber" | "WaitingSend" | "WaitingSendCancel" | "WaitingReturn" | "WaitingDownload"; + /** @description Mensagem de processamento */ + readonly flowMessage?: string; + /** @description Prestador dos serviços */ + readonly provider?: { + /** @description Nome Fantasia */ + readonly tradeName?: string; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate?: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature?: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber?: string; + /** + * Format: double + * @description Taxa da Aliquota do ISS (Simples Nacional) + */ + readonly issRate?: number; + /** + * @description Determinação de imposto federal + * @enum {string} + */ + readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** + * @description Determinação de imposto municipal + * @enum {string} + */ + readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** @description Nome de login */ + readonly loginName?: string; + /** @description Senha de login */ + readonly loginPassword?: string; + /** @description Valor de emissão de autorização */ + readonly authIssueValue?: string; + readonly parentId?: string; + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number; + /** @description Email */ + readonly email?: string; + /** @description Endereço */ + readonly address?: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * @description Tipo da pessoa: Jurídica ou Física + * @enum {string} + */ + readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + /** @description Tomador dos serviços */ + readonly borrower?: { + readonly parentId?: string; + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number; + /** @description Telefone */ + readonly phoneNumber?: string; + /** @description Email */ + readonly email?: string; + /** @description Endereço */ + readonly address?: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * @description Tipo da pessoa: Jurídica ou Física + * @enum {string} + */ + readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + /** @description Identificação única do cliente */ + readonly externalId?: string; + /** + * Format: int64 + * @description Número do lote da RPS + */ + readonly batchNumber?: number; + /** @description Número do protocolo do lote da RPS */ + readonly batchCheckNumber?: string; + /** + * Format: int64 + * @description Número do NFE + */ + readonly number?: number; + /** @description Código de Verificação da NFE */ + readonly checkCode?: string; + /** + * @description Status da NFE + * @enum {string} + */ + readonly status?: "Error" | "None" | "Created" | "Issued" | "Cancelled"; + /** + * @description Tipo da RPS + * @enum {string} + */ + readonly rpsType?: "Rps" | "RpsMista" | "Cupom"; + /** + * @description Status da RPS + * @enum {string} + */ + readonly rpsStatus?: "Normal" | "Canceled" | "Lost"; + /** + * @description Tipo da tributação + * @enum {string} + */ + readonly taxationType?: "None" | "WithinCity" | "OutsideCity" | "Export" | "Free" | "Immune" | "SuspendedCourtDecision" | "SuspendedAdministrativeProcedure" | "OutsideCityFree" | "OutsideCityImmune" | "OutsideCitySuspended" | "OutsideCitySuspendedAdministrativeProcedure" | "ObjectiveImune"; + /** + * Format: date-time + * @description Data de emissão + */ + readonly issuedOn?: string; + /** + * Format: date-time + * @description Data de cancelamento + */ + readonly cancelledOn?: string; + /** @description Número de serie da RPS */ + readonly rpsSerialNumber?: string; + /** + * Format: int64 + * @description Número da RPS + */ + readonly rpsNumber?: number; + /** @description Código do servico prestado no Municipio */ + readonly cityServiceCode?: string; + /** @description Código do servico prestado federal */ + readonly federalServiceCode?: string; + /** @description Descrição do serviço no municipio */ + readonly description?: string; + /** + * Format: double + * @description Valor do serviços + */ + readonly servicesAmount?: number; + /** + * Format: double + * @description Valor dos Serviços pago + */ + readonly paidAmount?: number; + /** + * @description Formas de pagamento + * @enum {string} + */ + readonly paymentMethod?: "None" | "Cash" | "Check" | "CreditCard" | "DebitCard" | "StoreCredit" | "FoodVoucher" | "MealVoucher" | "GiftCard" | "FuelVoucher" | "Others"; + /** + * Format: double + * @description Valor de deduções + */ + readonly deductionsAmount?: number; + /** + * Format: double + * @description Valor do desconto incondicionado + */ + readonly discountUnconditionedAmount?: number; + /** + * Format: double + * @description Valor do desconto condicionado + */ + readonly discountConditionedAmount?: number; + /** + * Format: double + * @description Valor da base de calculo de impostos + */ + readonly baseTaxAmount?: number; + /** + * Format: double + * @description Aliquota do ISS + */ + readonly issRate?: number; + /** + * Format: double + * @description Valor do ISS + */ + readonly issTaxAmount?: number; + /** + * Format: double + * @description Valor retido do Imposto de Renda (IR) + */ + readonly irAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do PIS + */ + readonly pisAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do COFINS + */ + readonly cofinsAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do CSLL + */ + readonly csllAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do INSS + */ + readonly inssAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do ISS + */ + readonly issAmountWithheld?: number; + /** + * Format: double + * @description Valor de outras retenções + */ + readonly othersAmountWithheld?: number; + /** + * Format: double + * @description Valor das retenções + */ + readonly amountWithheld?: number; + /** + * Format: double + * @description Valor líquido + */ + readonly amountNet?: number; + /** @description Local da Prestação do Serviço */ + readonly location?: { + /** @description Estado */ + readonly state?: string; + /** @description País */ + readonly country?: string; + /** @description Código Postal */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street?: string; + /** @description Número */ + readonly number?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Informações Adicionais (Complemento) */ + readonly AdditionalInformation?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + }; + /** @description Detalhes da atividade do evento */ + readonly activityEvent?: { + /** @description Nome do evento */ + readonly name?: string; + /** + * Format: date-time + * @description Data de início do evento + */ + readonly beginOn?: string; + /** + * Format: date-time + * @description Data do fim do evento + */ + readonly endOn?: string; + /** @description Código da atividade do evento */ + readonly Code?: string; + }; + /** @description Tributos aproximados */ + readonly approximateTax?: { + /** @description Nome da fonte da taxa */ + readonly source?: string; + /** @description Versão da taxa baseado na fonte */ + readonly version?: string; + /** + * Format: double + * @description Taxa dos tributos aproximados + */ + readonly totalRate?: number; + }; + /** @description Informações Adicionais */ + readonly additionalInformation?: string; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }[]; + /** Format: int64 */ + readonly totalResults?: number; + /** Format: int32 */ + readonly totalPages?: number; + /** Format: int32 */ + readonly page?: number; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly ServiceInvoices_Post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + }; + readonly cookie?: never; + }; + /** @description Dados da nota fiscal de serviço */ + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Tomador dos serviços */ + readonly borrower?: { + /** + * @description Tipo do tomador dos serviços + * @enum {string} + */ + readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity"; + /** @description Nome / Razão Social */ + readonly name?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number; + /** @description Inscrição Municipal para Pessoas Jurídicas */ + readonly municipalTaxNumber?: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** @description Telefone */ + readonly phoneNumber?: string; + /** @description Email */ + readonly email?: string; + /** @description Endereço */ + readonly address?: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street?: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number?: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + /** @description Estado */ + readonly state?: string; + }; + }; + /** @description Identificação única do cliente */ + readonly externalId?: string; + /** @description Código do serviço no municipio */ + readonly cityServiceCode: string; + /** @description Código federal do servico (Item da lista de serviço LC 116) */ + readonly federalServiceCode?: string; + /** @description Código CNAE (somente quando necessario na cidade) */ + readonly cnaeCode?: string; + /** @description Código do NBS no municipio (somente quando necessario na cidade) */ + readonly nbsCode?: string; + /** @description Descrição dos serviços */ + readonly description: string; + /** + * Format: double + * @description Valor do serviços + */ + readonly servicesAmount: number; + /** @description Número de Serie da RPS */ + readonly rpsSerialNumber?: string; + /** + * Format: date-time + * @description Data da emissão no formato YYYY-MM-DDTHH:MM:SS.SSSSSS-03:00 + */ + readonly issuedOn?: string; + /** + * Format: int64 + * @description Número da RPS + */ + readonly rpsNumber?: number; + /** + * @description Tipo da tributação + * @enum {string} + */ + readonly taxationType?: "None" | "WithinCity" | "OutsideCity" | "Export" | "Free" | "Immune" | "SuspendedCourtDecision" | "SuspendedAdministrativeProcedure" | "OutsideCityFree" | "OutsideCityImmune" | "OutsideCitySuspended" | "OutsideCitySuspendedAdministrativeProcedure" | "ObjectiveImune"; + /** + * Format: double + * @description Aliquota do ISS + */ + readonly issRate?: number; + /** + * Format: double + * @description Valor do ISS + */ + readonly issTaxAmount?: number; + /** + * Format: double + * @description Valor de deduções + */ + readonly deductionsAmount?: number; + /** + * Format: double + * @description Valor do desconto incondicionado + */ + readonly discountUnconditionedAmount?: number; + /** + * Format: double + * @description Valor do desconto condicionado + */ + readonly discountConditionedAmount?: number; + /** + * Format: double + * @description Valor retido do Imposto de Renda (IR) + */ + readonly irAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do PIS + */ + readonly pisAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do COFINS + */ + readonly cofinsAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do CSLL + */ + readonly csllAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do INSS + */ + readonly inssAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do ISS + */ + readonly issAmountWithheld?: number; + /** + * Format: double + * @description Valor de outras retenções + */ + readonly othersAmountWithheld?: number; + /** @description Tributos aproximados */ + readonly approximateTax?: { + /** @description Nome da fonte da taxa */ + readonly source?: string; + /** @description Versão da taxa baseado na fonte */ + readonly version?: string; + /** + * Format: double + * @description Taxa dos tributos aproximados + */ + readonly totalRate?: number; + }; + /** @description Informações Adicionais */ + readonly additionalInformation?: string; + /** @description Local da Prestação do Serviço */ + readonly location?: { + /** @description Estado */ + readonly state?: string; + /** @description País */ + readonly country?: string; + /** @description Código Postal */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street?: string; + /** @description Número */ + readonly number?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Informações Adicionais (Complemento) */ + readonly AdditionalInformation?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + }; + /** @description Detalhes da atividade do evento */ + readonly activityEvent?: { + /** @description Nome do evento */ + readonly name?: string; + /** + * Format: date-time + * @description Data de início do evento + */ + readonly beginOn?: string; + /** + * Format: date-time + * @description Data do fim do evento + */ + readonly endOn?: string; + /** @description Código da atividade do evento */ + readonly Code?: string; + }; + }; + }; + }; + readonly responses: { + /** @description Nota Fiscal de Serviços foi enviada com sucesso para fila de emissão */ + readonly 202: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Identificação */ + readonly id?: string; + /** + * @description Ambiente de Processamento + * @enum {string} + */ + readonly environment: "Development" | "Production" | "Staging"; + /** + * @description Status do processamento + * @enum {string} + */ + readonly flowStatus?: "CancelFailed" | "IssueFailed" | "Issued" | "Cancelled" | "PullFromCityHall" | "WaitingCalculateTaxes" | "WaitingDefineRpsNumber" | "WaitingSend" | "WaitingSendCancel" | "WaitingReturn" | "WaitingDownload"; + /** @description Mensagem de processamento */ + readonly flowMessage?: string; + /** @description Prestador dos serviços */ + readonly provider?: { + /** @description Nome Fantasia */ + readonly tradeName?: string; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate?: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature?: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber?: string; + /** + * Format: double + * @description Taxa da Aliquota do ISS (Simples Nacional) + */ + readonly issRate?: number; + /** + * @description Determinação de imposto federal + * @enum {string} + */ + readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** + * @description Determinação de imposto municipal + * @enum {string} + */ + readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** @description Nome de login */ + readonly loginName?: string; + /** @description Senha de login */ + readonly loginPassword?: string; + /** @description Valor de emissão de autorização */ + readonly authIssueValue?: string; + readonly parentId?: string; + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number; + /** @description Email */ + readonly email?: string; + /** @description Endere o */ + readonly address?: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street?: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number?: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + /** @description Estado */ + readonly state?: string; + }; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * @description Tipo da pessoa: Jurídica ou Física + * @enum {string} + */ + readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + /** @description Tomador dos serviços */ + readonly borrower?: { + readonly parentId?: string; + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number; + /** @description Telefone */ + readonly phoneNumber?: string; + /** @description Email */ + readonly email?: string; + /** @description Endereço */ + readonly address?: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street?: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number?: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + /** @description Estado */ + readonly state?: string; + }; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * @description Tipo da pessoa: Jurídica ou Física + * @enum {string} + */ + readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + /** @description Identificação única do cliente */ + readonly externalId?: string; + /** + * Format: int64 + * @description Número do lote da RPS + */ + readonly batchNumber?: number; + /** @description Número do protocolo do lote da RPS */ + readonly batchCheckNumber?: string; + /** + * Format: int64 + * @description Número do NFE + */ + readonly number?: number; + /** @description Código de Verificação da NFE */ + readonly checkCode?: string; + /** + * @description Status da NFE + * @enum {string} + */ + readonly status?: "Error" | "None" | "Created" | "Issued" | "Cancelled"; + /** + * @description Tipo da RPS + * @enum {string} + */ + readonly rpsType?: "Rps" | "RpsMista" | "Cupom"; + /** + * @description Status da RPS + * @enum {string} + */ + readonly rpsStatus?: "Normal" | "Canceled" | "Lost"; + /** + * @description Tipo da tributação + * @enum {string} + */ + readonly taxationType?: "None" | "WithinCity" | "OutsideCity" | "Export" | "Free" | "Immune" | "SuspendedCourtDecision" | "SuspendedAdministrativeProcedure" | "OutsideCityFree" | "OutsideCityImmune" | "OutsideCitySuspended" | "OutsideCitySuspendedAdministrativeProcedure" | "ObjectiveImune"; + /** + * Format: date-time + * @description Data de emissão + */ + readonly issuedOn?: string; + /** + * Format: date-time + * @description Data de cancelamento + */ + readonly cancelledOn?: string; + /** @description Número de serie da RPS */ + readonly rpsSerialNumber?: string; + /** + * Format: int64 + * @description Número da RPS + */ + readonly rpsNumber?: number; + /** @description Código do servico prestado no Municipio */ + readonly cityServiceCode?: string; + /** @description Código do servico prestado federal */ + readonly federalServiceCode?: string; + /** @description Descrição do serviço no municipio */ + readonly description?: string; + /** + * Format: double + * @description Valor do serviços + */ + readonly servicesAmount?: number; + /** + * Format: double + * @description Valor de deduções + */ + readonly deductionsAmount?: number; + /** + * Format: double + * @description Valor do desconto incondicionado + */ + readonly discountUnconditionedAmount?: number; + /** + * Format: double + * @description Valor do desconto condicionado + */ + readonly discountConditionedAmount?: number; + /** + * Format: double + * @description Valor da base de calculo de impostos + */ + readonly baseTaxAmount?: number; + /** + * Format: double + * @description Aliquota do ISS + */ + readonly issRate?: number; + /** + * Format: double + * @description Valor do ISS + */ + readonly issTaxAmount?: number; + /** + * Format: double + * @description Valor retido do Imposto de Renda (IR) + */ + readonly irAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do PIS + */ + readonly pisAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do COFINS + */ + readonly cofinsAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do CSLL + */ + readonly csllAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do INSS + */ + readonly inssAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do ISS + */ + readonly issAmountWithheld?: number; + /** + * Format: double + * @description Valor de outras retenções + */ + readonly othersAmountWithheld?: number; + /** + * Format: double + * @description Valor das retenções + */ + readonly amountWithheld?: number; + /** + * Format: double + * @description Valor líquido + */ + readonly amountNet?: number; + /** @description Local da Prestação do Serviço */ + readonly location?: { + /** @description Estado */ + readonly state?: string; + /** @description País */ + readonly country?: string; + /** @description Código Postal */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street?: string; + /** @description Número */ + readonly number?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Informações Adicionais (Complemento) */ + readonly AdditionalInformation?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + }; + /** @description Detalhes da atividade do evento */ + readonly activityEvent?: { + /** @description Nome do evento */ + readonly name?: string; + /** + * Format: date-time + * @description Data de início do evento + */ + readonly beginOn?: string; + /** + * Format: date-time + * @description Data do fim do evento + */ + readonly endOn?: string; + /** @description Código da atividade do evento */ + readonly Code?: string; + }; + /** @description Tributos aproximados */ + readonly approximateTax?: { + /** @description Nome da fonte da taxa */ + readonly source?: string; + /** @description Versão da taxa baseado na fonte */ + readonly version?: string; + /** + * Format: double + * @description Taxa dos tributos aproximados + */ + readonly totalRate?: number; + }; + /** @description Informações Adicionais */ + readonly additionalInformation?: string; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Tempo de reposta do servidor excedeu o limite (60s) */ + readonly 408: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly ServiceInvoices_externalIdGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + /** @description ID externo da Nota Fiscal de Serviço (NFSE) */ + readonly externalId: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Identificação */ + readonly id?: string; + /** + * @description Ambiente de Processamento + * @enum {string} + */ + readonly environment: "Development" | "Production" | "Staging"; + /** + * @description Status do processamento + * @enum {string} + */ + readonly flowStatus?: "CancelFailed" | "IssueFailed" | "Issued" | "Cancelled" | "PullFromCityHall" | "WaitingCalculateTaxes" | "WaitingDefineRpsNumber" | "WaitingSend" | "WaitingSendCancel" | "WaitingReturn" | "WaitingDownload"; + /** @description Mensagem de processamento */ + readonly flowMessage?: string; + /** @description Prestador dos serviços */ + readonly provider?: { + /** @description Nome Fantasia */ + readonly tradeName?: string; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate?: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature?: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber?: string; + /** + * Format: double + * @description Taxa da Aliquota do ISS (Simples Nacional) + */ + readonly issRate?: number; + /** + * @description Determinação de imposto federal + * @enum {string} + */ + readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** + * @description Determinação de imposto municipal + * @enum {string} + */ + readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** @description Nome de login */ + readonly loginName?: string; + /** @description Senha de login */ + readonly loginPassword?: string; + /** @description Valor de emissão de autorização */ + readonly authIssueValue?: string; + readonly parentId?: string; + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number; + /** @description Email */ + readonly email?: string; + /** @description Endereço */ + readonly address?: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + /** @description Estado */ + readonly state?: string; + }; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * @description Tipo da pessoa: Jurídica ou Física + * @enum {string} + */ + readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + /** @description Tomador dos serviços */ + readonly borrower?: { + readonly parentId?: string; + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number; + /** @description Telefone */ + readonly phoneNumber?: string; + /** @description Email */ + readonly email?: string; + /** @description Endereço */ + readonly address?: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + /** @description Estado */ + readonly state?: string; + }; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * @description Tipo da pessoa: Jurídica ou Física + * @enum {string} + */ + readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + /** @description Identificação única do cliente */ + readonly externalId?: string; + /** + * Format: int64 + * @description Número do lote da RPS + */ + readonly batchNumber?: number; + /** @description Número do protocolo do lote da RPS */ + readonly batchCheckNumber?: string; + /** + * Format: int64 + * @description Número do NFE + */ + readonly number?: number; + /** @description Código de Verificação da NFE */ + readonly checkCode?: string; + /** + * @description Status da NFE + * @enum {string} + */ + readonly status?: "Error" | "None" | "Created" | "Issued" | "Cancelled"; + /** + * @description Tipo da RPS + * @enum {string} + */ + readonly rpsType?: "Rps" | "RpsMista" | "Cupom"; + /** + * @description Status da RPS + * @enum {string} + */ + readonly rpsStatus?: "Normal" | "Canceled" | "Lost"; + /** + * @description Tipo da tributação + * @enum {string} + */ + readonly taxationType?: "None" | "WithinCity" | "OutsideCity" | "Export" | "Free" | "Immune" | "SuspendedCourtDecision" | "SuspendedAdministrativeProcedure" | "OutsideCityFree" | "OutsideCityImmune" | "OutsideCitySuspended" | "OutsideCitySuspendedAdministrativeProcedure" | "ObjectiveImune"; + /** + * Format: date-time + * @description Data de emissão + */ + readonly issuedOn?: string; + /** + * Format: date-time + * @description Data de cancelamento + */ + readonly cancelledOn?: string; + /** @description Número de serie da RPS */ + readonly rpsSerialNumber?: string; + /** + * Format: int64 + * @description Número da RPS + */ + readonly rpsNumber?: number; + /** @description Código do servico prestado no Municipio */ + readonly cityServiceCode?: string; + /** @description Código do servico prestado federal */ + readonly federalServiceCode?: string; + /** @description Descrição do serviço no municipio */ + readonly description?: string; + /** + * Format: double + * @description Valor do serviços + */ + readonly servicesAmount?: number; + /** + * Format: double + * @description Valor de deduções + */ + readonly deductionsAmount?: number; + /** + * Format: double + * @description Valor do desconto incondicionado + */ + readonly discountUnconditionedAmount?: number; + /** + * Format: double + * @description Valor do desconto condicionado + */ + readonly discountConditionedAmount?: number; + /** + * Format: double + * @description Valor da base de calculo de impostos + */ + readonly baseTaxAmount?: number; + /** + * Format: double + * @description Aliquota do ISS + */ + readonly issRate?: number; + /** + * Format: double + * @description Valor do ISS + */ + readonly issTaxAmount?: number; + /** + * Format: double + * @description Valor retido do Imposto de Renda (IR) + */ + readonly irAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do PIS + */ + readonly pisAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do COFINS + */ + readonly cofinsAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do CSLL + */ + readonly csllAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do INSS + */ + readonly inssAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do ISS + */ + readonly issAmountWithheld?: number; + /** + * Format: double + * @description Valor de outras retenções + */ + readonly othersAmountWithheld?: number; + /** + * Format: double + * @description Valor das retenções + */ + readonly amountWithheld?: number; + /** + * Format: double + * @description Valor líquido + */ + readonly amountNet?: number; + /** @description Local da Prestação do Serviço */ + readonly location?: { + /** @description Estado */ + readonly state?: string; + /** @description País */ + readonly country?: string; + /** @description Código Postal */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street?: string; + /** @description Número */ + readonly number?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Informações Adicionais (Complemento) */ + readonly AdditionalInformation?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + }; + /** @description Detalhes da atividade do evento */ + readonly activityEvent?: { + /** @description Nome do evento */ + readonly name?: string; + /** + * Format: date-time + * @description Data de início do evento + */ + readonly beginOn?: string; + /** + * Format: date-time + * @description Data do fim do evento + */ + readonly endOn?: string; + /** @description Código da atividade do evento */ + readonly Code?: string; + }; + /** @description Tributos aproximados */ + readonly approximateTax?: { + /** @description Nome da fonte da taxa */ + readonly source?: string; + /** @description Versão da taxa baseado na fonte */ + readonly version?: string; + /** + * Format: double + * @description Taxa dos tributos aproximados + */ + readonly totalRate?: number; + }; + /** @description Informações Adicionais */ + readonly additionalInformation?: string; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Não foi possivel o download */ - 404: { - content: never; - }; - /** @description Tempo de reposta do servidor excedeu o limite (60s) */ - 408: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; }; - }; - /** - * Download do XML da Nota Fiscal de Serviço (NFSE) - * @description Você precisará do APIKEY da Empresa - */ - ServiceInvoices_GetDocumentXml: { - parameters: { - path: { - /** @description ID da empresa */ - company_id: string; - /** @description ID da Nota Fiscal de Serviço (NFSE) */ - id: string; - }; + readonly ServiceInvoices_idGet: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + /** @description ID da Nota Fiscal de Serviço (NFSE) */ + readonly id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Identificação */ + readonly id?: string; + /** + * @description Ambiente de Processamento + * @enum {string} + */ + readonly environment: "Development" | "Production" | "Staging"; + /** + * @description Status do processamento + * @enum {string} + */ + readonly flowStatus?: "CancelFailed" | "IssueFailed" | "Issued" | "Cancelled" | "PullFromCityHall" | "WaitingCalculateTaxes" | "WaitingDefineRpsNumber" | "WaitingSend" | "WaitingSendCancel" | "WaitingReturn" | "WaitingDownload"; + /** @description Mensagem de processamento */ + readonly flowMessage?: string; + /** @description Prestador dos serviços */ + readonly provider?: { + /** @description Nome Fantasia */ + readonly tradeName?: string; + /** + * Format: date-time + * @description Data abertura da empresa + */ + readonly openningDate?: string; + /** + * @description Tipo do Regime Tributário + * @enum {string} + */ + readonly taxRegime?: "Isento" | "MicroempreendedorIndividual" | "SimplesNacional" | "LucroPresumido" | "LucroReal"; + /** + * @description Tipo do regime especial de tributação + * @enum {string} + */ + readonly specialTaxRegime?: "Automatico" | "Nenhum" | "MicroempresaMunicipal" | "Estimativa" | "SociedadeDeProfissionais" | "Cooperativa" | "MicroempreendedorIndividual" | "MicroempresarioEmpresaPequenoPorte"; + /** + * @description Código da Natureza Jurídica + * @enum {string} + */ + readonly legalNature?: "EmpresaPublica" | "SociedadeEconomiaMista" | "SociedadeAnonimaAberta" | "SociedadeAnonimaFechada" | "SociedadeEmpresariaLimitada" | "SociedadeEmpresariaEmNomeColetivo" | "SociedadeEmpresariaEmComanditaSimples" | "SociedadeEmpresariaEmComanditaporAcoes" | "SociedadeemContaParticipacao" | "Empresario" | "Cooperativa" | "ConsorcioSociedades" | "GrupoSociedades" | "EmpresaDomiciliadaExterior" | "ClubeFundoInvestimento" | "SociedadeSimplesPura" | "SociedadeSimplesLimitada" | "SociedadeSimplesEmNomeColetivo" | "SociedadeSimplesEmComanditaSimples" | "EmpresaBinacional" | "ConsorcioEmpregadores" | "ConsorcioSimples" | "EireliNaturezaEmpresaria" | "EireliNaturezaSimples" | "ServicoNotarial" | "FundacaoPrivada" | "ServicoSocialAutonomo" | "CondominioEdilicio" | "ComissaoConciliacaoPrevia" | "EntidadeMediacaoArbitragem" | "PartidoPolitico" | "EntidadeSindical" | "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras" | "FundacaoAssociacaoDomiciliadaExterior" | "OrganizacaoReligiosa" | "ComunidadeIndigena" | "FundoPrivado" | "AssociacaoPrivada"; + /** @description Atividades da Empresa */ + readonly economicActivities?: readonly { + /** @enum {string} */ + readonly type?: "Main" | "Secondary"; + /** Format: int32 */ + readonly code?: number; + }[]; + /** + * Format: int64 + * @description Número de Inscrição na Junta Comercial + */ + readonly companyRegistryNumber?: number; + /** + * Format: int64 + * @description Número de Inscrição na SEFAZ (IE) + */ + readonly regionalTaxNumber?: number; + /** @description Número de Inscrição na Prefeitura (CCM) */ + readonly municipalTaxNumber?: string; + /** + * Format: double + * @description Taxa da Aliquota do ISS (Simples Nacional) + */ + readonly issRate?: number; + /** + * @description Determinação de imposto federal + * @enum {string} + */ + readonly federalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** + * @description Determinação de imposto municipal + * @enum {string} + */ + readonly municipalTaxDetermination?: "NotInformed" | "Default" | "SimplesNacional"; + /** @description Nome de login */ + readonly loginName?: string; + /** @description Senha de login */ + readonly loginPassword?: string; + /** @description Valor de emissão de autorização */ + readonly authIssueValue?: string; + readonly parentId?: string; + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number; + /** @description Email */ + readonly email?: string; + /** @description Endereço */ + readonly address?: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + /** @description Estado */ + readonly state?: string; + }; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * @description Tipo da pessoa: Jurídica ou Física + * @enum {string} + */ + readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + /** @description Tomador dos serviços */ + readonly borrower?: { + readonly parentId?: string; + /** @description Identificação */ + readonly id?: string; + /** @description Nome ou Razão Social */ + readonly name?: string; + /** + * Format: int64 + * @description CNPJ ou CPF + */ + readonly federalTaxNumber?: number; + /** @description Telefone */ + readonly phoneNumber?: string; + /** @description Email */ + readonly email?: string; + /** @description Endereço */ + readonly address?: { + /** + * @description Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd) + * Exemplo: BRA, USD, ARG + */ + readonly country: string; + /** @description CEP (Exemplo: 99999-999) */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street: string; + /** @description Número (Exemplo: 185 ou S/N) */ + readonly number: string; + /** @description Complemento (Exemplo: BLC A; APT 10 */ + readonly additionalInformation?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + /** @description Estado */ + readonly state?: string; + }; + /** + * @description Status no sistema + * @enum {string} + */ + readonly status?: "Inactive" | "None" | "Active"; + /** + * @description Tipo da pessoa: Jurídica ou Física + * @enum {string} + */ + readonly type?: "Undefined" | "NaturalPerson" | "LegalEntity" | "LegalPerson" | "Company" | "Customer"; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + /** @description Identificação única do cliente */ + readonly externalId?: string; + /** + * Format: int64 + * @description Número do lote da RPS + */ + readonly batchNumber?: number; + /** @description Número do protocolo do lote da RPS */ + readonly batchCheckNumber?: string; + /** + * Format: int64 + * @description Número do NFE + */ + readonly number?: number; + /** @description Código de Verificação da NFE */ + readonly checkCode?: string; + /** + * @description Status da NFE + * @enum {string} + */ + readonly status?: "Error" | "None" | "Created" | "Issued" | "Cancelled"; + /** + * @description Tipo da RPS + * @enum {string} + */ + readonly rpsType?: "Rps" | "RpsMista" | "Cupom"; + /** + * @description Status da RPS + * @enum {string} + */ + readonly rpsStatus?: "Normal" | "Canceled" | "Lost"; + /** + * @description Tipo da tributação + * @enum {string} + */ + readonly taxationType?: "None" | "WithinCity" | "OutsideCity" | "Export" | "Free" | "Immune" | "SuspendedCourtDecision" | "SuspendedAdministrativeProcedure" | "OutsideCityFree" | "OutsideCityImmune" | "OutsideCitySuspended" | "OutsideCitySuspendedAdministrativeProcedure" | "ObjectiveImune"; + /** + * Format: date-time + * @description Data de emissão + */ + readonly issuedOn?: string; + /** + * Format: date-time + * @description Data de cancelamento + */ + readonly cancelledOn?: string; + /** @description Número de serie da RPS */ + readonly rpsSerialNumber?: string; + /** + * Format: int64 + * @description Número da RPS + */ + readonly rpsNumber?: number; + /** @description Código do servico prestado no Municipio */ + readonly cityServiceCode?: string; + /** @description Código do servico prestado federal */ + readonly federalServiceCode?: string; + /** @description Descrição do serviço no municipio */ + readonly description?: string; + /** + * Format: double + * @description Valor do serviços + */ + readonly servicesAmount?: number; + /** + * Format: double + * @description Valor de deduções + */ + readonly deductionsAmount?: number; + /** + * Format: double + * @description Valor do desconto incondicionado + */ + readonly discountUnconditionedAmount?: number; + /** + * Format: double + * @description Valor do desconto condicionado + */ + readonly discountConditionedAmount?: number; + /** + * Format: double + * @description Valor da base de calculo de impostos + */ + readonly baseTaxAmount?: number; + /** + * Format: double + * @description Aliquota do ISS + */ + readonly issRate?: number; + /** + * Format: double + * @description Valor do ISS + */ + readonly issTaxAmount?: number; + /** + * Format: double + * @description Valor retido do Imposto de Renda (IR) + */ + readonly irAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do PIS + */ + readonly pisAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do COFINS + */ + readonly cofinsAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do CSLL + */ + readonly csllAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do INSS + */ + readonly inssAmountWithheld?: number; + /** + * Format: double + * @description Valor retido do ISS + */ + readonly issAmountWithheld?: number; + /** + * Format: double + * @description Valor de outras retenções + */ + readonly othersAmountWithheld?: number; + /** + * Format: double + * @description Valor das retenções + */ + readonly amountWithheld?: number; + /** + * Format: double + * @description Valor líquido + */ + readonly amountNet?: number; + /** @description Local da Prestação do Serviço */ + readonly location?: { + /** @description Estado */ + readonly state?: string; + /** @description País */ + readonly country?: string; + /** @description Código Postal */ + readonly postalCode?: string; + /** @description Logradouro */ + readonly street?: string; + /** @description Número */ + readonly number?: string; + /** @description Bairro */ + readonly district?: string; + /** @description Informações Adicionais (Complemento) */ + readonly AdditionalInformation?: string; + /** @description Cidade */ + readonly city?: { + /** @description Código do IBGE */ + readonly code?: string; + /** @description Nome */ + readonly name?: string; + }; + }; + /** @description Detalhes da atividade do evento */ + readonly activityEvent?: { + /** @description Nome do evento */ + readonly name?: string; + /** + * Format: date-time + * @description Data de início do evento + */ + readonly beginOn?: string; + /** + * Format: date-time + * @description Data do fim do evento + */ + readonly endOn?: string; + /** @description Código da atividade do evento */ + readonly Code?: string; + }; + /** @description Tributos aproximados */ + readonly approximateTax?: { + /** @description Nome da fonte da taxa */ + readonly source?: string; + /** @description Versão da taxa baseado na fonte */ + readonly version?: string; + /** + * Format: double + * @description Taxa dos tributos aproximados + */ + readonly totalRate?: number; + }; + /** @description Informações Adicionais */ + readonly additionalInformation?: string; + /** + * Format: date-time + * @description Data de criação + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data da última modificação + */ + readonly modifiedOn?: string; + }; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; }; - responses: { - /** @description Sucesso na requisição */ - 200: { - content: { - readonly "application/json": string; + readonly ServiceInvoices_Delete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + /** @description ID da Nota Fiscal de Serviço (NFSE) */ + readonly id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Nota fiscal cancelada com sucesso */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Tempo de reposta do servidor excedeu o limite (60s) */ + readonly 408: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; }; - }; - /** @description Algum parametro informado não é válido */ - 400: { - content: never; - }; - /** @description API Key da conta não é valida */ - 401: { - content: never; - }; - /** @description Não foi possivel o download */ - 404: { - content: never; - }; - /** @description Tempo de reposta do servidor excedeu o limite (60s) */ - 408: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: never; - }; }; - }; - /** - * Consultar um webhook existente - * @description ### Informações adicionais - * - * Utilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**. - */ - RegistrationLookupAction: { - parameters: { - path: { - /** @description ID do webhook a ser consultado */ - webhook_id: string; - }; + readonly ServiceInvoices_SendEmail: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + /** @description ID da Nota Fiscal de Serviço (NFSE) */ + readonly id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Tempo de reposta do servidor excedeu o limite (60s) */ + readonly 408: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; }; - responses: { - /** @description Sucesso na consulta do webhook */ - 200: { - content: { - readonly "application/json": { - /** @description WebHook (Notificação HTTP) */ - readonly webHook?: { - /** - * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de - * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. - */ - readonly id?: string; - /** @description A URL onde as notificações dos eventos deverão entregues. */ - readonly uri: string; - /** - * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor - * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. - * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. - */ - readonly secret?: string; - /** - * Format: int32 - * @description WebHook Media Type - * @enum {integer} - */ - readonly contentType?: 0 | 1; - /** - * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. - * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. - */ - readonly insecureSsl?: boolean; - /** - * Format: int32 - * @description WebHook Status - * @enum {integer} - */ - readonly status?: 0 | 1; - /** - * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. - * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. - * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. - */ - readonly filters?: readonly string[]; - /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ - readonly headers?: { - [key: string]: string; - }; - /** - * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas - * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. - */ - readonly properties?: { - [key: string]: unknown; - }; - /** - * Format: date-time - * @description Data de criação do webhook - */ - readonly createdOn?: string; - /** - * Format: date-time - * @description Data de modificação do webhook - */ - readonly modifiedOn?: string; - }; - }; + readonly ServiceInvoices_GetDocumentPdf: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + /** @description ID da Nota Fiscal de Serviço (NFSE) */ + readonly id: string; + }; + readonly cookie?: never; }; - }; - /** @description Algum parametro informado não é válido, verificar resposta */ - 400: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não foi possivel o download */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Tempo de reposta do servidor excedeu o limite (60s) */ + readonly 408: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly ServiceInvoices_GetDocumentXml: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID da empresa */ + readonly company_id: string; + /** @description ID da Nota Fiscal de Serviço (NFSE) */ + readonly id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na requisição */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": string; + }; + }; + /** @description Algum parametro informado não é válido */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description API Key da conta não é valida */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Não foi possivel o download */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Tempo de reposta do servidor excedeu o limite (60s) */ + readonly 408: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly RegistrationLookupAction: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description ID do webhook a ser consultado */ + readonly webhook_id: string; + }; + readonly cookie?: never; }; - }; - /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ - 401: { - content: never; - }; - /** @description Accesso proibido */ - 403: { - content: never; - }; - /** @description Webhook não encontrado */ - 404: { - content: never; - }; - /** @description Erro no processamento */ - 500: { - content: { - readonly "application/json": { - /** @description Lista de Erros */ - readonly errors?: readonly { - /** - * Format: int32 - * @description Código do erro - */ - readonly code?: number; - /** @description Mensagem contendo os detalhes do erro */ - readonly message?: string; - }[]; - }; + readonly requestBody?: never; + readonly responses: { + /** @description Sucesso na consulta do webhook */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description WebHook (Notificação HTTP) */ + readonly webHook?: { + /** + * @description ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de + * precisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID. + */ + readonly id?: string; + /** @description A URL onde as notificações dos eventos deverão entregues. */ + readonly uri: string; + /** + * @description Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor + * do **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*. + * O HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado. + */ + readonly secret?: string; + /** + * Format: int32 + * @description WebHook Media Type + * @enum {integer} + */ + readonly contentType?: 0 | 1; + /** + * @description Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos. + * Defina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**. + */ + readonly insecureSsl?: boolean; + /** + * Format: int32 + * @description WebHook Status + * @enum {integer} + */ + readonly status?: 0 | 1; + /** + * @description Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. + * Os filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. + * Os valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**. + */ + readonly filters?: readonly string[]; + /** @description Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. */ + readonly headers?: { + readonly [key: string]: string; + }; + /** + * @description Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas + * juntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP. + */ + readonly properties?: { + readonly [key: string]: unknown; + }; + /** + * Format: date-time + * @description Data de criação do webhook + */ + readonly createdOn?: string; + /** + * Format: date-time + * @description Data de modificação do webhook + */ + readonly modifiedOn?: string; + }; + }; + }; + }; + /** @description Algum parametro informado não é válido, verificar resposta */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; + /** @description Não autorizado, verificar o cabeçalho do HTTP Authorization */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Accesso proibido */ + readonly 403: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Webhook não encontrado */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Erro no processamento */ + readonly 500: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description Lista de Erros */ + readonly errors?: readonly { + /** + * Format: int32 + * @description Código do erro + */ + readonly code?: number; + /** @description Mensagem contendo os detalhes do erro */ + readonly message?: string; + }[]; + }; + }; + }; }; - }; }; - }; -}; +} diff --git a/src/generated/nfeio.ts b/src/generated/nfeio.ts index 93343d3..f84588c 100644 --- a/src/generated/nfeio.ts +++ b/src/generated/nfeio.ts @@ -4,399 +4,542 @@ * Do not edit this file directly. * * To regenerate: npm run generate - * Last generated: 2026-02-15T17:59:25.793Z + * Last generated: 2026-04-25T23:27:49.313Z * Generator: openapi-typescript */ -/** - * This file was auto-generated by openapi-typescript. - * Do not make direct changes to the file. - */ - - -export type paths = { - "/api/notifications/zip": { - post: { - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["ZipRequest"]; - readonly "text/json": components["schemas"]["ZipRequest"]; - readonly "application/*+json": components["schemas"]["ZipRequest"]; +export interface paths { + readonly "/api/notifications/zip": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - responses: { - /** @description OK */ - 200: { - content: never; + readonly get?: never; + readonly put?: never; + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": components["schemas"]["ZipRequest"]; + readonly "text/json": components["schemas"]["ZipRequest"]; + readonly "application/*+json": components["schemas"]["ZipRequest"]; + }; + }; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; }; - }; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/api/notifications/{id}": { - post: { - parameters: { - query?: { - path?: string; - outputType?: components["schemas"]["OutputType"]; - }; - path: { - id: string; + readonly "/api/notifications/{id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - responses: { - /** @description OK */ - 200: { - content: never; + readonly get?: never; + readonly put?: never; + readonly post: { + readonly parameters: { + readonly query?: { + readonly path?: string; + readonly outputType?: components["schemas"]["OutputType"]; + }; + readonly header?: never; + readonly path: { + readonly id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; }; - }; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/api/notifications/workflow/finished": { - post: { - readonly requestBody?: { - readonly content: { - readonly "application/json": string; - readonly "text/json": string; - readonly "application/*+json": string; + readonly "/api/notifications/workflow/finished": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - responses: { - /** @description OK */ - 200: { - content: never; + readonly get?: never; + readonly put?: never; + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": string; + readonly "text/json": string; + readonly "application/*+json": string; + }; + }; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; }; - }; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/api/processing-jobs/resources/outputs": { - get: { - responses: { - /** @description OK */ - 200: { - content: { - readonly "text/plain": readonly components["schemas"]["ResourceInfo"][]; - readonly "application/json": readonly components["schemas"]["ResourceInfo"][]; - readonly "text/json": readonly components["schemas"]["ResourceInfo"][]; - }; + readonly "/api/processing-jobs/resources/outputs": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - /** @description Unauthorized */ - 401: { - content: { - readonly "text/plain": components["schemas"]["ProblemDetails"]; - readonly "application/json": components["schemas"]["ProblemDetails"]; - readonly "text/json": components["schemas"]["ProblemDetails"]; - }; + readonly get: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "text/plain": readonly components["schemas"]["ResourceInfo"][]; + readonly "application/json": readonly components["schemas"]["ResourceInfo"][]; + readonly "text/json": readonly components["schemas"]["ResourceInfo"][]; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "text/plain": components["schemas"]["ProblemDetails"]; + readonly "application/json": components["schemas"]["ProblemDetails"]; + readonly "text/json": components["schemas"]["ProblemDetails"]; + }; + }; + }; }; - }; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/api/processing-jobs": { - get: { - parameters: { - query?: { - PageSize?: number; - Direction?: components["schemas"]["SortDirection"]; - Order?: components["schemas"]["SortOrder"]; - "Cursor.Value"?: string; - HasCursor?: boolean; + readonly "/api/processing-jobs": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - responses: { - /** @description OK */ - 200: { - content: { - readonly "text/plain": components["schemas"]["ProcessingBatchSummaryResponsePage"]; - readonly "application/json": components["schemas"]["ProcessingBatchSummaryResponsePage"]; - readonly "text/json": components["schemas"]["ProcessingBatchSummaryResponsePage"]; - }; + readonly get: { + readonly parameters: { + readonly query?: { + readonly PageSize?: number; + readonly Direction?: components["schemas"]["SortDirection"]; + readonly Order?: components["schemas"]["SortOrder"]; + readonly "Cursor.Value"?: string; + readonly HasCursor?: boolean; + }; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "text/plain": components["schemas"]["ProcessingBatchSummaryResponsePage"]; + readonly "application/json": components["schemas"]["ProcessingBatchSummaryResponsePage"]; + readonly "text/json": components["schemas"]["ProcessingBatchSummaryResponsePage"]; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "text/plain": components["schemas"]["ProblemDetails"]; + readonly "application/json": components["schemas"]["ProblemDetails"]; + readonly "text/json": components["schemas"]["ProblemDetails"]; + }; + }; + }; }; - /** @description Unauthorized */ - 401: { - content: { - readonly "text/plain": components["schemas"]["ProblemDetails"]; - readonly "application/json": components["schemas"]["ProblemDetails"]; - readonly "text/json": components["schemas"]["ProblemDetails"]; - }; + readonly put?: never; + readonly post: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": components["schemas"]["StartProcessingJobRequest"]; + readonly "text/json": components["schemas"]["StartProcessingJobRequest"]; + readonly "application/*+json": components["schemas"]["StartProcessingJobRequest"]; + }; + }; + readonly responses: { + /** @description Created */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "text/plain": components["schemas"]["ProcessingBatchesResponse"]; + readonly "application/json": components["schemas"]["ProcessingBatchesResponse"]; + readonly "text/json": components["schemas"]["ProcessingBatchesResponse"]; + }; + }; + /** @description Bad Request */ + readonly 400: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "text/plain": components["schemas"]["ProblemDetails"]; + readonly "application/json": components["schemas"]["ProblemDetails"]; + readonly "text/json": components["schemas"]["ProblemDetails"]; + }; + }; + }; }; - }; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - post: { - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["StartProcessingJobRequest"]; - readonly "text/json": components["schemas"]["StartProcessingJobRequest"]; - readonly "application/*+json": components["schemas"]["StartProcessingJobRequest"]; + readonly "/api/processing-jobs/{id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; }; - }; - responses: { - /** @description Created */ - 201: { - content: { - readonly "text/plain": components["schemas"]["ProcessingBatchesResponse"]; - readonly "application/json": components["schemas"]["ProcessingBatchesResponse"]; - readonly "text/json": components["schemas"]["ProcessingBatchesResponse"]; - }; + readonly get: { + readonly parameters: { + readonly query?: { + readonly status?: readonly components["schemas"]["StatusProcess"][]; + }; + readonly header?: never; + readonly path: { + readonly id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "text/plain": components["schemas"]["ProcessingBatchDetailResponse"]; + readonly "application/json": components["schemas"]["ProcessingBatchDetailResponse"]; + readonly "text/json": components["schemas"]["ProcessingBatchDetailResponse"]; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "text/plain": components["schemas"]["ProblemDetails"]; + readonly "application/json": components["schemas"]["ProblemDetails"]; + readonly "text/json": components["schemas"]["ProblemDetails"]; + }; + }; + }; }; - /** @description Bad Request */ - 400: { - content: { - readonly "text/plain": components["schemas"]["ProblemDetails"]; - readonly "application/json": components["schemas"]["ProblemDetails"]; - readonly "text/json": components["schemas"]["ProblemDetails"]; - }; + readonly put?: never; + readonly post?: never; + readonly delete: { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + readonly id: string; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "text/plain": components["schemas"]["ProcessingBatchDetailResponse"]; + readonly "application/json": components["schemas"]["ProcessingBatchDetailResponse"]; + readonly "text/json": components["schemas"]["ProcessingBatchDetailResponse"]; + }; + }; + /** @description Unauthorized */ + readonly 401: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "text/plain": components["schemas"]["ProblemDetails"]; + readonly "application/json": components["schemas"]["ProblemDetails"]; + readonly "text/json": components["schemas"]["ProblemDetails"]; + }; + }; + }; }; - }; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; }; - }; - "/api/processing-jobs/{id}": { - get: { - parameters: { - query?: { - status?: readonly components["schemas"]["StatusProcess"][]; +} +export type webhooks = Record; +export interface components { + schemas: { + readonly BatchProcessResponse: { + readonly input?: string | null; + readonly status?: string | null; + readonly statusReason?: string | null; + /** Format: date-time */ + readonly createdAt: string; + /** Format: date-time */ + readonly updatedAt?: string | null; + readonly outPuts?: readonly components["schemas"]["OutPutResponse"][] | null; }; - path: { - id: string; + /** @enum {string} */ + readonly Environment: "Test" | "Production"; + readonly FileParsingOptionsRequest: { + /** + * Format: int32 + * @description Coluna que está o input + * @example 1 + */ + readonly columnToParse?: number; + readonly parsingType?: components["schemas"]["ParsingType"]; }; - }; - responses: { - /** @description OK */ - 200: { - content: { - readonly "text/plain": components["schemas"]["ProcessingBatchDetailResponse"]; - readonly "application/json": components["schemas"]["ProcessingBatchDetailResponse"]; - readonly "text/json": components["schemas"]["ProcessingBatchDetailResponse"]; - }; + readonly GuidPaginationCursor: { + /** Format: uuid */ + readonly value?: string; }; - /** @description Unauthorized */ - 401: { - content: { - readonly "text/plain": components["schemas"]["ProblemDetails"]; - readonly "application/json": components["schemas"]["ProblemDetails"]; - readonly "text/json": components["schemas"]["ProblemDetails"]; - }; + readonly InputInfoRequest: { + /** + * @description Nome do processo + * @example s3://bucket/input.json + */ + readonly url?: string | null; + readonly parsingOptions?: components["schemas"]["FileParsingOptionsRequest"]; + /** + * @description Habilitar Cache + * @example true + */ + readonly useCache?: boolean; }; - }; - }; - delete: { - parameters: { - path: { - id: string; + readonly InputsResponse: { + /** Format: int32 */ + readonly totalInputs?: number; + readonly outputs?: readonly string[] | null; }; - }; - responses: { - /** @description OK */ - 200: { - content: { - readonly "text/plain": components["schemas"]["ProcessingBatchDetailResponse"]; - readonly "application/json": components["schemas"]["ProcessingBatchDetailResponse"]; - readonly "text/json": components["schemas"]["ProcessingBatchDetailResponse"]; - }; + readonly OutPutLinkResponse: { + readonly fileName?: string | null; + readonly url?: string | null; }; - /** @description Unauthorized */ - 401: { - content: { - readonly "text/plain": components["schemas"]["ProblemDetails"]; - readonly "application/json": components["schemas"]["ProblemDetails"]; - readonly "text/json": components["schemas"]["ProblemDetails"]; - }; + readonly OutPutResponse: { + readonly type?: string | null; + readonly status?: string | null; + readonly outPutLink?: components["schemas"]["OutPutLinkResponse"]; + }; + /** @enum {string} */ + readonly OutputType: "PDF" | "XML" | "Csv"; + /** @enum {string} */ + readonly ParsingType: "Csv" | "Xls"; + readonly ProblemDetails: { + readonly type?: string | null; + readonly title?: string | null; + /** Format: int32 */ + readonly status?: number | null; + readonly detail?: string | null; + readonly instance?: string | null; + } & { + readonly [key: string]: unknown; + }; + readonly ProcessingBatchDetailResponse: { + /** Format: uuid */ + readonly id?: string; + readonly name?: string | null; + readonly createdBy?: string | null; + readonly resourceName?: string | null; + /** Format: date-time */ + readonly createdAt?: string; + /** Format: date-time */ + readonly updatedAt?: string | null; + readonly inputs?: components["schemas"]["InputsResponse"]; + readonly metrics?: components["schemas"]["ProcessingMetricsResponse"]; + readonly status?: string | null; + readonly stage?: string | null; + readonly batchProcesses?: readonly components["schemas"]["BatchProcessResponse"][] | null; + }; + readonly ProcessingBatchSummaryResponse: { + /** Format: uuid */ + readonly id?: string; + /** Format: uuid */ + readonly parentId?: string | null; + readonly name?: string | null; + readonly createdBy?: string | null; + readonly resourceName?: string | null; + /** Format: date-time */ + readonly createdAt?: string; + /** Format: date-time */ + readonly updatedAt?: string | null; + readonly metrics?: components["schemas"]["ProcessingMetricsResponse"]; + readonly inputs?: components["schemas"]["InputsResponse"]; + readonly status?: string | null; + readonly stage?: string | null; + readonly autoGenerated?: boolean; + readonly outPuts?: readonly components["schemas"]["OutPutResponse"][] | null; + }; + readonly ProcessingBatchSummaryResponsePage: { + readonly items?: readonly components["schemas"]["ProcessingBatchSummaryResponse"][] | null; + readonly nextCursor?: components["schemas"]["GuidPaginationCursor"]; + readonly previousCursor?: components["schemas"]["GuidPaginationCursor"]; + readonly hasNext?: boolean; + readonly hasPrevious?: boolean; + }; + readonly ProcessingBatchesResponse: { + /** Format: uuid */ + readonly id?: string; + /** Format: date-time */ + readonly createdAt?: string; + /** Format: date-time */ + readonly updatedAt?: string | null; + readonly status?: string | null; + }; + readonly ProcessingMetricsResponse: { + /** Format: int32 */ + readonly total?: number; + /** Format: int32 */ + readonly totalSuccess?: number; + /** Format: int32 */ + readonly totalError?: number; + }; + readonly ResourceInfo: { + /** Format: int32 */ + readonly id?: number; + readonly name?: string | null; + readonly outputs?: readonly components["schemas"]["OutputType"][] | null; + }; + readonly ResourceInfoRequest: { + /** + * Format: int32 + * @description ID da fonte de dados + * @example 1 + */ + readonly id?: number; + /** + * @description Nome da fonte de dados + * @example NFeSefaz + */ + readonly name?: string | null; + /** + * @description Tipos de saidas + * @example [ + * "PDF", + * "XML" + * ] + */ + readonly outputs?: readonly components["schemas"]["OutputType"][] | null; + }; + /** @enum {string} */ + readonly SortDirection: "Forward" | "Backward"; + /** @enum {string} */ + readonly SortOrder: "Asc" | "Desc"; + readonly StartProcessingJobRequest: { + /** + * @description Quem criou a requisição + * @example joao.souza + */ + readonly createdBy?: string | null; + readonly input?: components["schemas"]["InputInfoRequest"]; + /** + * @description Nome do processo + * @example Processamento de Dados + */ + readonly name?: string | null; + readonly resource?: components["schemas"]["ResourceInfoRequest"]; + readonly environment?: components["schemas"]["Environment"]; + }; + /** @enum {string} */ + readonly StatusProcess: "Pending" | "Running" | "Completed" | "Duplicated" | "Error" | "PartialSuccess" | "Succeed"; + readonly ZipRequest: { + /** Format: uuid */ + readonly id?: string; + readonly type?: components["schemas"]["OutputType"]; + readonly blobName?: string | null; }; - }; - }; - }; -}; - -export type webhooks = Record; - -export type components = { - schemas: { - readonly BatchProcessResponse: { - readonly input?: string | null; - readonly status?: string | null; - readonly statusReason?: string | null; - /** Format: date-time */ - readonly createdAt: string; - /** Format: date-time */ - readonly updatedAt?: string | null; - readonly outPuts?: (readonly components["schemas"]["OutPutResponse"][]) | null; - }; - /** @enum {string} */ - readonly Environment: "Test" | "Production"; - readonly FileParsingOptionsRequest: { - /** - * Format: int32 - * @description Coluna que está o input - * @example 1 - */ - readonly columnToParse?: number; - readonly parsingType?: components["schemas"]["ParsingType"]; - }; - readonly GuidPaginationCursor: { - /** Format: uuid */ - readonly value?: string; - }; - readonly InputInfoRequest: { - /** - * @description Nome do processo - * @example s3://bucket/input.json - */ - readonly url?: string | null; - readonly parsingOptions?: components["schemas"]["FileParsingOptionsRequest"]; - /** - * @description Habilitar Cache - * @example true - */ - readonly useCache?: boolean; - }; - readonly InputsResponse: { - /** Format: int32 */ - readonly totalInputs?: number; - readonly outputs?: (readonly string[]) | null; - }; - readonly OutPutLinkResponse: { - readonly fileName?: string | null; - readonly url?: string | null; - }; - readonly OutPutResponse: { - readonly type?: string | null; - readonly status?: string | null; - readonly outPutLink?: components["schemas"]["OutPutLinkResponse"]; - }; - /** @enum {string} */ - readonly OutputType: "PDF" | "XML" | "Csv"; - /** @enum {string} */ - readonly ParsingType: "Csv" | "Xls"; - readonly ProblemDetails: { - readonly type?: string | null; - readonly title?: string | null; - /** Format: int32 */ - readonly status?: number | null; - readonly detail?: string | null; - readonly instance?: string | null; - [key: string]: unknown; - }; - readonly ProcessingBatchDetailResponse: { - /** Format: uuid */ - readonly id?: string; - readonly name?: string | null; - readonly createdBy?: string | null; - readonly resourceName?: string | null; - /** Format: date-time */ - readonly createdAt?: string; - /** Format: date-time */ - readonly updatedAt?: string | null; - readonly inputs?: components["schemas"]["InputsResponse"]; - readonly metrics?: components["schemas"]["ProcessingMetricsResponse"]; - readonly status?: string | null; - readonly stage?: string | null; - readonly batchProcesses?: (readonly components["schemas"]["BatchProcessResponse"][]) | null; - }; - readonly ProcessingBatchSummaryResponse: { - /** Format: uuid */ - readonly id?: string; - /** Format: uuid */ - readonly parentId?: string | null; - readonly name?: string | null; - readonly createdBy?: string | null; - readonly resourceName?: string | null; - /** Format: date-time */ - readonly createdAt?: string; - /** Format: date-time */ - readonly updatedAt?: string | null; - readonly metrics?: components["schemas"]["ProcessingMetricsResponse"]; - readonly inputs?: components["schemas"]["InputsResponse"]; - readonly status?: string | null; - readonly stage?: string | null; - readonly autoGenerated?: boolean; - readonly outPuts?: (readonly components["schemas"]["OutPutResponse"][]) | null; - }; - readonly ProcessingBatchSummaryResponsePage: { - readonly items?: (readonly components["schemas"]["ProcessingBatchSummaryResponse"][]) | null; - readonly nextCursor?: components["schemas"]["GuidPaginationCursor"]; - readonly previousCursor?: components["schemas"]["GuidPaginationCursor"]; - readonly hasNext?: boolean; - readonly hasPrevious?: boolean; - }; - readonly ProcessingBatchesResponse: { - /** Format: uuid */ - readonly id?: string; - /** Format: date-time */ - readonly createdAt?: string; - /** Format: date-time */ - readonly updatedAt?: string | null; - readonly status?: string | null; - }; - readonly ProcessingMetricsResponse: { - /** Format: int32 */ - readonly total?: number; - /** Format: int32 */ - readonly totalSuccess?: number; - /** Format: int32 */ - readonly totalError?: number; - }; - readonly ResourceInfo: { - /** Format: int32 */ - readonly id?: number; - readonly name?: string | null; - readonly outputs?: (readonly components["schemas"]["OutputType"][]) | null; - }; - readonly ResourceInfoRequest: { - /** - * Format: int32 - * @description ID da fonte de dados - * @example 1 - */ - readonly id?: number; - /** - * @description Nome da fonte de dados - * @example NFeSefaz - */ - readonly name?: string | null; - /** - * @description Tipos de saidas - * @example [ - * "PDF", - * "XML" - * ] - */ - readonly outputs?: (readonly components["schemas"]["OutputType"][]) | null; - }; - /** @enum {string} */ - readonly SortDirection: "Forward" | "Backward"; - /** @enum {string} */ - readonly SortOrder: "Asc" | "Desc"; - readonly StartProcessingJobRequest: { - /** - * @description Quem criou a requisição - * @example joao.souza - */ - readonly createdBy?: string | null; - readonly input?: components["schemas"]["InputInfoRequest"]; - /** - * @description Nome do processo - * @example Processamento de Dados - */ - readonly name?: string | null; - readonly resource?: components["schemas"]["ResourceInfoRequest"]; - readonly environment?: components["schemas"]["Environment"]; - }; - /** @enum {string} */ - readonly StatusProcess: "Pending" | "Running" | "Completed" | "Duplicated" | "Error" | "PartialSuccess" | "Succeed"; - readonly ZipRequest: { - /** Format: uuid */ - readonly id?: string; - readonly type?: components["schemas"]["OutputType"]; - readonly blobName?: string | null; }; - }; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; -}; - + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} export type $defs = Record; - -export type external = Record; - export type operations = Record; diff --git a/tests/integration/companies.integration.test.ts b/tests/integration/companies.integration.test.ts index 9a43e8c..14d0254 100644 --- a/tests/integration/companies.integration.test.ts +++ b/tests/integration/companies.integration.test.ts @@ -34,7 +34,7 @@ describe.skipIf(skipIfNoApiKey())('Companies Integration Tests', () => { createdCompanyIds.length = 0; }); - it('should create a company', async () => { + it('should create a company', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { const companyData = { ...TEST_COMPANY_DATA, name: `Test Company ${Date.now()}`, @@ -50,9 +50,9 @@ describe.skipIf(skipIfNoApiKey())('Companies Integration Tests', () => { createdCompanyIds.push(company.id); logTestInfo('Company created', { id: company.id }); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should retrieve a company by id', async () => { + it('should retrieve a company by id', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { // Create company first const companyData = { ...TEST_COMPANY_DATA, @@ -68,9 +68,9 @@ describe.skipIf(skipIfNoApiKey())('Companies Integration Tests', () => { expect(retrieved).toBeDefined(); expect(retrieved.id).toBe(created.id); expect(retrieved.name).toBe(companyData.name); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should list companies', async () => { + it('should list companies', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { // Create at least one company const companyData = { ...TEST_COMPANY_DATA, @@ -92,9 +92,9 @@ describe.skipIf(skipIfNoApiKey())('Companies Integration Tests', () => { // Just verify we got a valid response with companies const hasCompanies = response.data.length > 0; expect(hasCompanies).toBe(true); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should update a company', async () => { + it('should update a company', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { // Create company first const companyData = { ...TEST_COMPANY_DATA, @@ -113,9 +113,9 @@ describe.skipIf(skipIfNoApiKey())('Companies Integration Tests', () => { expect(updated).toBeDefined(); expect(updated.id).toBe(created.id); expect(updated.name).toBe(updatedName); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should delete a company', async () => { + it('should delete a company', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { // Create company first const companyData = { ...TEST_COMPANY_DATA, @@ -136,18 +136,18 @@ describe.skipIf(skipIfNoApiKey())('Companies Integration Tests', () => { if (index > -1) { createdCompanyIds.splice(index, 1); } - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should handle 404 for non-existent company', async () => { + it('should handle 404 for non-existent company', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { const fakeId = 'non-existent-id-' + Date.now(); logTestInfo('Testing 404 error', { id: fakeId }); await expect( client.companies.retrieve(fakeId) ).rejects.toThrow(); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should validate required fields on create', async () => { + it('should validate required fields on create', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { const invalidData = { // Missing required fields name: 'Invalid Company', @@ -157,9 +157,9 @@ describe.skipIf(skipIfNoApiKey())('Companies Integration Tests', () => { await expect( client.companies.create(invalidData) ).rejects.toThrow(); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should allow duplicate federalTaxNumber', async () => { + it('should allow duplicate federalTaxNumber', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { // Create first company const companyData = { ...TEST_COMPANY_DATA, @@ -181,7 +181,7 @@ describe.skipIf(skipIfNoApiKey())('Companies Integration Tests', () => { // Both should exist with different IDs expect(duplicate.id).not.toBe(created.id); expect(duplicate.federalTaxNumber).toBe(created.federalTaxNumber); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); // Note: Certificate upload test commented out as it requires valid PFX file // and test environment might not support it diff --git a/tests/integration/errors.integration.test.ts b/tests/integration/errors.integration.test.ts index e4f7b13..0fdfebe 100644 --- a/tests/integration/errors.integration.test.ts +++ b/tests/integration/errors.integration.test.ts @@ -29,7 +29,7 @@ describe.skipIf(skipIfNoApiKey())('Error Handling Integration Tests', () => { }); }); - it('should handle 401 authentication error', async () => { + it('should handle 401 authentication error', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { // Create client with invalid API key const invalidClient = new NfeClient({ apiKey: 'invalid-api-key-12345', @@ -50,9 +50,9 @@ describe.skipIf(skipIfNoApiKey())('Error Handling Integration Tests', () => { } logTestInfo('Authentication error caught as expected'); } - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should handle 404 not found error', async () => { + it('should handle 404 not found error', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { const fakeCompanyId = 'non-existent-company-' + Date.now(); logTestInfo('Testing 404 not found error', { id: fakeCompanyId }); @@ -67,9 +67,9 @@ describe.skipIf(skipIfNoApiKey())('Error Handling Integration Tests', () => { } logTestInfo('Not found error caught as expected'); } - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should handle 400 validation error', async () => { + it('should handle 400 validation error', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { const invalidData = { name: 'Invalid Company', // Missing required fields @@ -87,9 +87,9 @@ describe.skipIf(skipIfNoApiKey())('Error Handling Integration Tests', () => { } logTestInfo('Validation error caught as expected'); } - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should handle network timeout', async () => { + it('should handle network timeout', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { // Create client with very short timeout const timeoutClient = new NfeClient({ apiKey: INTEGRATION_TEST_CONFIG.apiKey, @@ -113,9 +113,9 @@ describe.skipIf(skipIfNoApiKey())('Error Handling Integration Tests', () => { ).toBe(true); logTestInfo('Timeout error caught as expected'); } - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should retry on transient errors', async () => { + it('should retry on transient errors', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { // This test verifies that retry logic works // We can't easily trigger transient errors from client side, // but we can verify the retry configuration is respected @@ -139,9 +139,9 @@ describe.skipIf(skipIfNoApiKey())('Error Handling Integration Tests', () => { expect(Array.isArray(companies)).toBe(true); logTestInfo('Retry configuration test passed'); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should respect rate limiting (if enforced)', async () => { + it('should respect rate limiting (if enforced)', { timeout: INTEGRATION_TEST_CONFIG.timeout * 2 }, async () => { // Make multiple rapid requests to potentially trigger rate limiting // Note: Test environment might not enforce rate limits strictly @@ -169,9 +169,9 @@ describe.skipIf(skipIfNoApiKey())('Error Handling Integration Tests', () => { // Test passes regardless - we're just checking behavior expect(results.length).toBe(10); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout * 2 }); + }); - it('should handle malformed response gracefully', async () => { + it('should handle malformed response gracefully', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { // Test with invalid endpoint that might return unexpected format const fakeEndpoint = '/v1/invalid-endpoint-test-' + Date.now(); @@ -190,9 +190,9 @@ describe.skipIf(skipIfNoApiKey())('Error Handling Integration Tests', () => { type: error instanceof NfeError ? 'NfeError' : 'Error', }); } - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should preserve error details from API', async () => { + it('should preserve error details from API', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { const invalidData = { name: 'Test', // Missing federalTaxNumber @@ -220,9 +220,9 @@ describe.skipIf(skipIfNoApiKey())('Error Handling Integration Tests', () => { }); } } - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should handle concurrent requests correctly', async () => { + it('should handle concurrent requests correctly', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { // Test that concurrent requests don't interfere with each other logTestInfo('Testing concurrent requests'); @@ -241,9 +241,9 @@ describe.skipIf(skipIfNoApiKey())('Error Handling Integration Tests', () => { }); logTestInfo('Concurrent requests handled correctly'); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it('should handle empty response lists', async () => { + it('should handle empty response lists', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { // Test listing resources that might be empty // This depends on account state, but should handle gracefully @@ -257,5 +257,5 @@ describe.skipIf(skipIfNoApiKey())('Error Handling Integration Tests', () => { expect(companies.length).toBeGreaterThanOrEqual(0); logTestInfo('Empty response handled correctly', { count: companies.length }); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); }); diff --git a/tests/integration/service-invoices.integration.test.ts b/tests/integration/service-invoices.integration.test.ts index bfae830..6c93d90 100644 --- a/tests/integration/service-invoices.integration.test.ts +++ b/tests/integration/service-invoices.integration.test.ts @@ -75,7 +75,7 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { servicesAmount: 100.00, }); - it.skipIf(skipIfNoApiKey())('should create a service invoice (sync)', async () => { + it.skipIf(skipIfNoApiKey())('should create a service invoice (sync)', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { const invoiceData = createTestInvoiceData(); logTestInfo('Creating service invoice', invoiceData); @@ -104,9 +104,9 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { } logTestInfo('Invoice created asynchronously', { status: result.flowStatus }); } - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it.skipIf(skipIfNoApiKey())('should poll invoice until complete (if async)', async () => { + it.skipIf(skipIfNoApiKey())('should poll invoice until complete (if async)', { timeout: 90000 }, async () => { const invoiceData = createTestInvoiceData(); logTestInfo('Creating service invoice with polling'); @@ -132,9 +132,9 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { createdInvoiceIds.push(result.id); logTestInfo('Invoice created synchronously, no polling needed', { id: result.id }); } - }, { timeout: 90000 }); // Longer timeout for polling + }); // Longer timeout for polling - it.skipIf(skipIfNoApiKey())('should use createAndWait helper', async () => { + it.skipIf(skipIfNoApiKey())('should use createAndWait helper', { timeout: 90000 }, async () => { const invoiceData = createTestInvoiceData(); logTestInfo('Using createAndWait helper'); @@ -149,9 +149,9 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { createdInvoiceIds.push(invoice.id); logTestInfo('Invoice created and waited', { id: invoice.id, number: invoice.number }); - }, { timeout: 90000 }); + }); - it.skipIf(skipIfNoApiKey())('should retrieve invoice by id', async () => { + it.skipIf(skipIfNoApiKey())('should retrieve invoice by id', { timeout: 90000 }, async () => { // Create invoice first const invoiceData = createTestInvoiceData(); const created = await client.serviceInvoices.createAndWait(testCompanyId, invoiceData, { @@ -166,9 +166,9 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { expect(retrieved).toBeDefined(); expect(retrieved.id).toBe(created.id); expect(retrieved.number).toBe(created.number); - }, { timeout: 90000 }); + }); - it.skipIf(skipIfNoApiKey())('should list service invoices', async () => { + it.skipIf(skipIfNoApiKey())('should list service invoices', { timeout: 90000 }, async () => { // Create invoice first const invoiceData = createTestInvoiceData(); const created = await client.serviceInvoices.createAndWait(testCompanyId, invoiceData, { @@ -187,9 +187,9 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { // Should include our created invoice const found = invoices.find(inv => inv.id === created.id); expect(found).toBeDefined(); - }, { timeout: 90000 }); + }); - it.skipIf(skipIfNoApiKey())('should cancel service invoice', async () => { + it.skipIf(skipIfNoApiKey())('should cancel service invoice', { timeout: 90000 }, async () => { // Create invoice first const invoiceData = createTestInvoiceData(); const created = await client.serviceInvoices.createAndWait(testCompanyId, invoiceData, { @@ -210,9 +210,9 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { if (index > -1) { createdInvoiceIds.splice(index, 1); } - }, { timeout: 90000 }); + }); - it.skipIf(skipIfNoApiKey())('should send invoice email', async () => { + it.skipIf(skipIfNoApiKey())('should send invoice email', { timeout: 90000 }, async () => { // Create invoice first const invoiceData = createTestInvoiceData(); const created = await client.serviceInvoices.createAndWait(testCompanyId, invoiceData, { @@ -228,9 +228,9 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { // Email sent successfully (no error thrown) logTestInfo('Invoice email sent'); - }, { timeout: 90000 }); + }); - it.skipIf(skipIfNoApiKey())('should download invoice PDF', async () => { + it.skipIf(skipIfNoApiKey())('should download invoice PDF', { timeout: 90000 }, async () => { // Create invoice first const invoiceData = createTestInvoiceData(); const created = await client.serviceInvoices.createAndWait(testCompanyId, invoiceData, { @@ -249,9 +249,9 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { // PDF should start with %PDF expect(pdfBuffer.toString('utf8', 0, 4)).toBe('%PDF'); logTestInfo('PDF downloaded', { size: pdfBuffer.length }); - }, { timeout: 90000 }); + }); - it.skipIf(skipIfNoApiKey())('should download invoice XML', async () => { + it.skipIf(skipIfNoApiKey())('should download invoice XML', { timeout: 90000 }, async () => { // Create invoice first const invoiceData = createTestInvoiceData(); const created = await client.serviceInvoices.createAndWait(testCompanyId, invoiceData, { @@ -270,9 +270,9 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { // XML should start with { + it.skipIf(skipIfNoApiKey())('should handle validation errors', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { const invalidData = { // Missing required fields description: 'Invalid invoice', @@ -282,18 +282,18 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { await expect( client.serviceInvoices.create(testCompanyId, invalidData) ).rejects.toThrow(); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it.skipIf(skipIfNoApiKey())('should handle 404 for non-existent invoice', async () => { + it.skipIf(skipIfNoApiKey())('should handle 404 for non-existent invoice', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { const fakeId = 'non-existent-invoice-' + Date.now(); logTestInfo('Testing 404 error', { id: fakeId }); await expect( client.serviceInvoices.retrieve(testCompanyId, fakeId) ).rejects.toThrow(); - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); - it.skipIf(skipIfNoApiKey())('should handle polling timeout', async () => { + it.skipIf(skipIfNoApiKey())('should handle polling timeout', { timeout: INTEGRATION_TEST_CONFIG.timeout }, async () => { const invoiceData = createTestInvoiceData(); const result = await client.serviceInvoices.create(testCompanyId, invoiceData); @@ -314,5 +314,5 @@ describe.skipIf(!hasApiKey)('ServiceInvoices Integration Tests', () => { createdInvoiceIds.push(match[1]); } } - }, { timeout: INTEGRATION_TEST_CONFIG.timeout }); + }); }); diff --git a/tests/unit/companies.test.ts b/tests/unit/companies.test.ts index a9e7306..0df2bab 100644 --- a/tests/unit/companies.test.ts +++ b/tests/unit/companies.test.ts @@ -159,7 +159,9 @@ describe('CompaniesResource', () => { }; // Mock global FormData constructor - global.FormData = vi.fn(() => mockFormData) as any; + global.FormData = vi.fn(function () { + return mockFormData; + }) as any; }); it('should upload certificate with buffer and password', async () => {