{ "openapi": "3.0.1", "info": { "title": "Brazil Tax Reform Calculator - IBS and CBS", "description": "Simulate Brazilian IBS/CBS tax reform scenarios with step-by-step calculations, sourced assumptions, explicit estimate warnings and privacy-safe batch diagnostics.", "version": "0.1", "x-build-id": "1PyFM2lCfNS2FahwL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kman-br~brazil-tax-reform-calculator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kman-br-brazil-tax-reform-calculator", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/kman-br~brazil-tax-reform-calculator/runs": { "post": { "operationId": "runs-sync-kman-br-brazil-tax-reform-calculator", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/kman-br~brazil-tax-reform-calculator/run-sync": { "post": { "operationId": "run-sync-kman-br-brazil-tax-reform-calculator", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "categoria": { "title": "Category", "enum": [ "geral", "carga", "reduzido30", "reduzido60", "reduzido100", "urbano", "urbanoRodoviario", "intermunicipal", "aereoRegional", "fretamento", "combustivel" ], "type": "string", "description": "Choose a supported scenario category; this does not establish legal eligibility." }, "ano": { "title": "Year", "minimum": 2026, "maximum": 2033, "type": "integer", "description": "Year within the configured transition schedule." }, "base": { "title": "Net taxable base (BRL)", "minimum": 0, "maximum": 1000000000, "type": "number", "description": "Required net IBS/CBS base after statutory exclusions, not a gross invoice price." }, "creditos": { "title": "Eligible tax credits (BRL)", "required": [ "cbs", "ibs" ], "type": "object", "description": "Complete numeric object. Unknown fields and personal data are rejected.", "properties": { "cbs": { "type": "number", "title": "CBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1000000000 }, "ibs": { "type": "number", "title": "IBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1000000000 } }, "additionalProperties": false }, "permitirEstimativas": { "title": "Allow estimates", "type": "boolean", "description": "Omitted means false: only verified parameters may be used. True also enables old-tax comparison unless compararAntigos is explicitly false." }, "compararAntigos": { "title": "Compare old taxes", "type": "boolean", "description": "Opt-in: omitted follows the CLI (false unless permitirEstimativas is true). Explicit false disables old-tax comparison. Estimated parameters still require consent. No schema default is injected." }, "cumpreObrigacoes": { "title": "Ancillary obligations fulfilled", "type": "boolean", "description": "Omitted means false. A true declaration enables the configured 2026 payment waiver." }, "confirmarEnquadramento": { "title": "Confirm legal eligibility", "type": "boolean", "description": "Omitted means false. Explicit confirmation is required for supported reduced or exempt categories." }, "enquadramentoConfirmado": { "title": "Eligibility confirmation (engine field)", "type": "boolean", "description": "Equivalent engine/CLI JSON field. If both aliases are present they must agree." }, "aliquotasPlenas": { "title": "Hypothetical full reference rates", "required": [ "cbs", "ibs" ], "type": "object", "description": "Complete numeric object. Unknown fields and personal data are rejected.", "properties": { "cbs": { "type": "number", "title": "CBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "ibs": { "type": "number", "title": "IBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 } }, "additionalProperties": false }, "aliquotasAntigas": { "title": "Hypothetical old-tax rates", "required": [ "pis", "cofins", "icms", "iss", "ipi" ], "type": "object", "description": "Complete numeric object. Unknown fields and personal data are rejected.", "properties": { "pis": { "type": "number", "title": "PIS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "cofins": { "type": "number", "title": "COFINS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "icms": { "type": "number", "title": "ICMS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "iss": { "type": "number", "title": "ISS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "ipi": { "type": "number", "title": "IPI", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 } }, "additionalProperties": false }, "tac": { "title": "Direct independent freight contract", "required": [ "valor", "tipo", "pago", "contratacaoDireta" ], "type": "object", "description": "Anonymous cargo-only scenario. No contractor identifiers or free text. Payment and direct contracting must both be true. Presumed credits start in the configured year.", "properties": { "valor": { "type": "number", "title": "Gross contract payment (BRL)", "description": "Paid anonymous contract amount.", "minimum": 0, "maximum": 1000000000 }, "tipo": { "type": "string", "title": "Eligible contractor category", "description": "Category only; no identity is accepted.", "enum": [ "pf_nao_contribuinte", "mei" ], "editor": "select" }, "pago": { "type": "boolean", "title": "Payment declared", "description": "Must be true.", "editor": "checkbox" }, "contratacaoDireta": { "type": "boolean", "title": "Direct contract declared", "description": "Must be true.", "editor": "checkbox" }, "percentuais": { "type": "object", "title": "Hypothetical presumed-credit coefficients", "description": "Complete numeric object. Unknown fields and personal data are rejected.", "editor": "json", "additionalProperties": false, "required": [ "cbs", "ibs" ], "properties": { "cbs": { "type": "number", "title": "CBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "ibs": { "type": "number", "title": "IBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 } } } }, "additionalProperties": false }, "produto": { "title": "Fuel product", "enum": [ "diesel", "gasolina", "etanol", "glp" ], "type": "string", "description": "Required for combustivel only." }, "quantidade": { "title": "Fuel quantity", "minimum": 0, "maximum": 1000000000, "type": "number", "description": "Required for combustivel. Up to six decimal places." }, "unidade": { "title": "Fuel unit", "enum": [ "litro_20c", "kg" ], "type": "string", "description": "Must match the product. Liquid volumes must already be converted to 20 degrees Celsius." }, "adRem": { "title": "Hypothetical annual fuel rates (BRL/unit)", "required": [ "cbs", "ibs" ], "type": "object", "description": "Complete numeric object. Unknown fields and personal data are rejected.", "properties": { "cbs": { "type": "number", "title": "CBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1000000 }, "ibs": { "type": "number", "title": "IBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1000000 } }, "additionalProperties": false }, "destinacao": { "title": "Fuel destination", "enum": [ "insumo", "revenda", "consumo_final" ], "type": "string", "description": "Required for combustivel; affects potential buyer credits." }, "ibsRecolhido": { "title": "IBS payment declared", "type": "boolean", "description": "Fuel only; enables the configured CBS deduction in the applicable transition period. Omitted means false." }, "comando": { "title": "Operation", "enum": [ "calcular", "comparar" ], "type": "string", "description": "calcular evaluates the selected year; comparar evaluates all eight years in one dataset item and requires any estimate consent used.", "default": "calcular" }, "formato": { "title": "Rendered output format", "enum": [ "texto", "json", "markdown" ], "type": "string", "description": "Structured results are always included; this controls formatted only. Batch entries may override this setting.", "default": "texto" }, "calculations": { "title": "Batch calculations", "minItems": 1, "maxItems": 100, "type": "array", "description": "Optional alternative to the top-level scenario fields; clear Category, Year and Base first, or the run fails with MODO_MISTO. One dataset item per calculation. Invalid entries produce free diagnostics; an all-invalid run fails without any event.", "items": { "type": "object", "additionalProperties": false, "required": [ "categoria", "ano", "base" ], "properties": { "categoria": { "type": "string", "title": "Category", "description": "Choose a supported scenario category; this does not establish legal eligibility.", "enum": [ "geral", "carga", "reduzido30", "reduzido60", "reduzido100", "urbano", "urbanoRodoviario", "intermunicipal", "aereoRegional", "fretamento", "combustivel" ], "editor": "select", "enumTitles": [ "General regime: full rate, full credit (LC 214, art. 47)", "Cargo freight: general regime, optional TAC presumed credit (art. 169)", "30% rate reduction: regulated professional services (art. 127)", "60% rate reduction: listed goods and services (art. 128)", "Zero rate: listed goods and services, supplier keeps credits (art. 143)", "Urban rail or waterway public transport: 100% reduction, no credits (art. 285)", "Urban bus or metro public transport: exempt, no credits (art. 157)", "Intercity or interstate public passenger transport: 40% reduction with credits (art. 286)", "Regional air transport: 40% reduction (art. 287)", "Closed-group charter: general regime, ESTIMATE only", "Fuels: single-stage per-unit regime (arts. 172-180)" ] }, "ano": { "type": "integer", "title": "Year", "description": "Year within the configured transition schedule.", "minimum": 2026, "maximum": 2033 }, "base": { "type": "number", "title": "Net taxable base (BRL)", "description": "Required net IBS/CBS base after statutory exclusions, not a gross invoice price.", "minimum": 0, "maximum": 1000000000 }, "creditos": { "type": "object", "title": "Eligible tax credits (BRL)", "description": "Complete numeric object. Unknown fields and personal data are rejected.", "editor": "json", "additionalProperties": false, "required": [ "cbs", "ibs" ], "properties": { "cbs": { "type": "number", "title": "CBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1000000000 }, "ibs": { "type": "number", "title": "IBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1000000000 } } }, "permitirEstimativas": { "type": "boolean", "title": "Allow estimates", "description": "Omitted means false: only verified parameters may be used. True also enables old-tax comparison unless compararAntigos is explicitly false.", "editor": "checkbox" }, "compararAntigos": { "type": "boolean", "title": "Compare old taxes", "description": "Opt-in: omitted follows the CLI (false unless permitirEstimativas is true). Explicit false disables old-tax comparison. Estimated parameters still require consent. No schema default is injected.", "editor": "checkbox" }, "cumpreObrigacoes": { "type": "boolean", "title": "Ancillary obligations fulfilled", "description": "Omitted means false. A true declaration enables the configured 2026 payment waiver.", "editor": "checkbox" }, "confirmarEnquadramento": { "type": "boolean", "title": "Confirm legal eligibility", "description": "Omitted means false. Explicit confirmation is required for supported reduced or exempt categories.", "editor": "checkbox" }, "enquadramentoConfirmado": { "type": "boolean", "title": "Eligibility confirmation (engine field)", "description": "Equivalent engine/CLI JSON field. If both aliases are present they must agree.", "editor": "checkbox" }, "aliquotasPlenas": { "type": "object", "title": "Hypothetical full reference rates", "description": "Complete numeric object. Unknown fields and personal data are rejected.", "editor": "json", "additionalProperties": false, "required": [ "cbs", "ibs" ], "properties": { "cbs": { "type": "number", "title": "CBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "ibs": { "type": "number", "title": "IBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 } } }, "aliquotasAntigas": { "type": "object", "title": "Hypothetical old-tax rates", "description": "Complete numeric object. Unknown fields and personal data are rejected.", "editor": "json", "additionalProperties": false, "required": [ "pis", "cofins", "icms", "iss", "ipi" ], "properties": { "pis": { "type": "number", "title": "PIS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "cofins": { "type": "number", "title": "COFINS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "icms": { "type": "number", "title": "ICMS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "iss": { "type": "number", "title": "ISS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "ipi": { "type": "number", "title": "IPI", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 } } }, "tac": { "type": "object", "title": "Direct independent freight contract", "editor": "json", "additionalProperties": false, "description": "Anonymous cargo-only scenario. No contractor identifiers or free text. Payment and direct contracting must both be true. Presumed credits start in the configured year.", "required": [ "valor", "tipo", "pago", "contratacaoDireta" ], "properties": { "valor": { "type": "number", "title": "Gross contract payment (BRL)", "description": "Paid anonymous contract amount.", "minimum": 0, "maximum": 1000000000 }, "tipo": { "type": "string", "title": "Eligible contractor category", "description": "Category only; no identity is accepted.", "enum": [ "pf_nao_contribuinte", "mei" ], "editor": "select" }, "pago": { "type": "boolean", "title": "Payment declared", "description": "Must be true.", "editor": "checkbox" }, "contratacaoDireta": { "type": "boolean", "title": "Direct contract declared", "description": "Must be true.", "editor": "checkbox" }, "percentuais": { "type": "object", "title": "Hypothetical presumed-credit coefficients", "description": "Complete numeric object. Unknown fields and personal data are rejected.", "editor": "json", "additionalProperties": false, "required": [ "cbs", "ibs" ], "properties": { "cbs": { "type": "number", "title": "CBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 }, "ibs": { "type": "number", "title": "IBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1 } } } } }, "produto": { "type": "string", "title": "Fuel product", "description": "Required for combustivel only.", "enum": [ "diesel", "gasolina", "etanol", "glp" ], "editor": "select" }, "quantidade": { "type": "number", "title": "Fuel quantity", "description": "Required for combustivel. Up to six decimal places.", "minimum": 0, "maximum": 1000000000 }, "unidade": { "type": "string", "title": "Fuel unit", "description": "Must match the product. Liquid volumes must already be converted to 20 degrees Celsius.", "enum": [ "litro_20c", "kg" ], "editor": "select" }, "adRem": { "type": "object", "title": "Hypothetical annual fuel rates (BRL/unit)", "description": "Complete numeric object. Unknown fields and personal data are rejected.", "editor": "json", "additionalProperties": false, "required": [ "cbs", "ibs" ], "properties": { "cbs": { "type": "number", "title": "CBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1000000 }, "ibs": { "type": "number", "title": "IBS", "description": "Numeric amount or rate, as documented.", "minimum": 0, "maximum": 1000000 } } }, "destinacao": { "type": "string", "title": "Fuel destination", "description": "Required for combustivel; affects potential buyer credits.", "enum": [ "insumo", "revenda", "consumo_final" ], "editor": "select" }, "ibsRecolhido": { "type": "boolean", "title": "IBS payment declared", "description": "Fuel only; enables the configured CBS deduction in the applicable transition period. Omitted means false.", "editor": "checkbox" }, "comando": { "type": "string", "title": "Operation", "description": "calcular evaluates the selected year; comparar evaluates all eight years in one dataset item and requires any estimate consent used.", "enum": [ "calcular", "comparar" ], "editor": "select", "default": "calcular" }, "formato": { "type": "string", "title": "Rendered output format", "description": "Structured results are always included; this controls formatted only. Batch entries may override this setting.", "enum": [ "texto", "json", "markdown" ], "editor": "select", "default": "texto" } } } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }