{ "openapi": "3.0.4", "info": { "title": "Empresas", "description": "# Introdução\r\n\r\nSeja bem-vindo a documentação da API de Empresas!\r\nNossa API foi criada utilizando o padrão REST que possibilita a integração de seu sistema ao nosso, sendo assim você também pode extender ou recriar as funcionalidades existentes na nossa plataforma, tudo isso consumindo a API que está documentada abaixo.\r\n\r\n# Como usar a API?\r\nLogo a seguir você encontrará todos os recursos e métodos suportados pela API, sendo que essa página possibilita que você teste os recursos e métodos diretamente através dela.\r\n\r\n# Autenticação\r\nVocê precisa de uma chave de API (API Key) para identificar a conta que está realizando solicitações para a API.\r\nPara isso você deve colocar sua chave de API no campo que se encontra no topo desta página para que os métodos funcionem corretamente.\r\nNo seu código de integração temos suporte para autenticação de diversas formas sendo eles:\r\nHTTP Header (Authorization ou X-NFEIO-APIKEY) ou HTTP Query String (api_key) nos dois modos passando o valor da sua chave de api (API Key).", "version": "v2" }, "paths": { "/v2/companies": { "post": { "tags": [ "Companies" ], "summary": "Criar uma Empresa", "description": "### Informações adicionais\r\nUtilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.", "requestBody": { "description": "Dados da Empresa a ser criada", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResource" } } } }, "responses": { "200": { "description": "Sucesso na criação da Empresa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "get": { "tags": [ "Companies" ], "summary": "Consultar todas as Empresas da Conta", "description": "### Informações adicionais\r\nUtilize esta requisição para consultar os dados das empresas vinculadas a conta.", "parameters": [ { "name": "startingAfter", "in": "query", "description": "Id de início do contador (Default: Empty)", "schema": { "type": "string" } }, { "name": "endingBefore", "in": "query", "description": "Id final do contador (Default: Empty)", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limite de resultados na página (Default: 10)", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Sucesso na consulta da Empresa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompaniesResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Empresa não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v2/companies/{company_id}": { "get": { "tags": [ "Companies" ], "summary": "Consultar uma Empresa pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma empresas pelo ID.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na consulta da Empresa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Empresa não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "head": { "tags": [ "Companies" ], "summary": "Consultar se Empresa Existe pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma empresas pelo ID.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na consulta da Empresa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Empresa não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "put": { "tags": [ "Companies" ], "summary": "Alterar uma Empresa pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para alterar os dados de uma empresas pelo ID.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Dados da Empresa a ser alterada", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResource" } } } }, "responses": { "200": { "description": "Sucesso na alteração da Empresa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Empresa não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "delete": { "tags": [ "Companies" ], "summary": "Excluir uma Empresa por ID", "description": "### Informações adicionais\r\nUtilize esta requisição para excluir uma empresas pelo ID, cuidado pois esse processo é irreversível.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Sucesso na exclusão da Empresa" }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Empresa não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v2/companies/{company_id}/certificates": { "post": { "tags": [ "Companies Certificates" ], "summary": "Upload de um Certificado", "description": "### Informações adicionais\r\nUtilize 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.\r\nO **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.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da empresa", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File", "Password" ], "type": "object", "properties": { "File": { "type": "string", "description": "Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12", "format": "binary" }, "Password": { "type": "string", "description": "Senha do certificado ICP-Brasil" } } }, "encoding": { "File": { "style": "form" }, "Password": { "style": "form" } } }, "application/form-data": { "schema": { "required": [ "File", "Password" ], "type": "object", "properties": { "File": { "type": "string", "description": "Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12", "format": "binary" }, "Password": { "type": "string", "description": "Senha do certificado ICP-Brasil" } } }, "encoding": { "File": { "style": "form" }, "Password": { "style": "form" } } } } }, "responses": { "200": { "description": "Sucesso no upload e vinculo com a Empresa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CertificateMetadataResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "get": { "tags": [ "Companies Certificates" ], "summary": "Consultar Certificado habilitado para empresa", "description": "### Informações adicionais\r\nUtilize esta requisição para consultar os dados do **Certificado da ICP-Brasil** habilitado para a empresa.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa relacionada ao certificado", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na consulta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CertificatesMetadataResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v1/companies/{company_id}/certificate": { "post": { "tags": [ "Companies Certificates" ], "summary": "Upload de um Certificado", "description": "### Informações adicionais\r\nUtilize 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.\r\nO **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.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da empresa", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File", "Password" ], "type": "object", "properties": { "File": { "type": "string", "description": "Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12", "format": "binary" }, "Password": { "type": "string", "description": "Senha do certificado ICP-Brasil" } } }, "encoding": { "File": { "style": "form" }, "Password": { "style": "form" } } }, "application/form-data": { "schema": { "required": [ "File", "Password" ], "type": "object", "properties": { "File": { "type": "string", "description": "Arquivo com certificado ICP-Brasil com extensão .pfx ou .p12", "format": "binary" }, "Password": { "type": "string", "description": "Senha do certificado ICP-Brasil" } } }, "encoding": { "File": { "style": "form" }, "Password": { "style": "form" } } } } }, "responses": { "200": { "description": "Sucesso no upload e vinculo com a Empresa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CertificateMetadataResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "get": { "tags": [ "Companies Certificates" ], "summary": "Consultar Certificado habilitado para empresa", "description": "### Informações adicionais\r\nUtilize esta requisição para consultar os dados do **Certificado da ICP-Brasil** habilitado para a empresa.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa relacionada ao certificado", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na consulta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CertificatesMetadataResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v2/companies/{company_id}/certificates/{certificate_thumbprint}": { "get": { "tags": [ "Companies Certificates" ], "summary": "Consultar um Certificado por sua impressão digital", "description": "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__).", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa relacionada ao certificado", "required": true, "schema": { "type": "string" } }, { "name": "certificate_thumbprint", "in": "path", "description": "Impressão digital do certificado", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na consulta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CertificateMetadataResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Certificado não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "delete": { "tags": [ "Companies Certificates" ], "summary": "Excluir um Certificado por sua impressão digital", "description": "### Informações adicionais\r\nUtilize esta requisição para excluir o **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__) e desvincula-lo da **Empresa**.\r\n**ATENÇÃO pois esta requisição é irreversível**", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa relacionada ao certificado", "required": true, "schema": { "type": "string" } }, { "name": "certificate_thumbprint", "in": "path", "description": "Impressão digital do certificado", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Sucesso na exclusão e desvinculo com a Empresa" }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Certificado não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v1/companies/{company_id}/certificate/{certificate_thumbprint}": { "get": { "tags": [ "Companies Certificates" ], "summary": "Consultar um Certificado por sua impressão digital", "description": "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de um **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__).", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa relacionada ao certificado", "required": true, "schema": { "type": "string" } }, { "name": "certificate_thumbprint", "in": "path", "description": "Impressão digital do certificado", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na consulta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CertificateMetadataResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Certificado não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "delete": { "tags": [ "Companies Certificates" ], "summary": "Excluir um Certificado por sua impressão digital", "description": "### Informações adicionais\r\nUtilize esta requisição para excluir o **Certificado da ICP-Brasil** através da **impressão digital do certificado** (__thumbprint__) e desvincula-lo da **Empresa**.\r\n**ATENÇÃO pois esta requisição é irreversível**", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa relacionada ao certificado", "required": true, "schema": { "type": "string" } }, { "name": "certificate_thumbprint", "in": "path", "description": "Impressão digital do certificado", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Sucesso na exclusão e desvinculo com a Empresa" }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Certificado não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v2/companies/{company_id}/municipaltaxes": { "get": { "tags": [ "Companies Municipal Taxes" ], "summary": "Listar as Inscrições Municipais", "description": "### Informações adicionais\r\nUtilize esta requisição para listar as inscrições municipais na empresa para processar __Documentos Fiscais__.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Municipal** representa os dados necessários sobre o cadastro municipal da empresa junto à prefeitura, exigidos para a emissão de notas fiscais de serviços (NFS-e) e para o cumprimento das obrigações tributárias no âmbito municipal.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } }, { "name": "startingAfter", "in": "query", "description": "Id de início do contador (Default: Empty)", "schema": { "type": "string" } }, { "name": "endingBefore", "in": "query", "description": "Id final do contador (Default: Empty)", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limite de resultados na página (Default: 10)", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Sucesso na criação da Inscrição Municipal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.MunicipalTaxResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "post": { "tags": [ "Companies Municipal Taxes" ], "summary": "Criar uma Inscrição Municipal", "description": "### Informações adicionais\r\nUtilize esta requisição para criar novas inscrição municipais na empresa para processar __Documentos Fiscais__.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Municipal** representa os dados necessários sobre o cadastro municipal da empresa junto à prefeitura, exigidos para a emissão de notas fiscais de serviços (NFS-e) e para o cumprimento das obrigações tributárias no âmbito municipal.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Dados da Inscrição Municipal a ser criada", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource" } } } }, "responses": { "200": { "description": "Sucesso na criação da Inscrição Municipal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.MunicipalTaxResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}": { "get": { "tags": [ "Companies Municipal Taxes" ], "summary": "Consultar uma Inscrição Municipal pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma empresas pelo ID.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Municipal** representa os dados necessários sobre o cadastro municipal da empresa junto à prefeitura, exigidos para a emissão de notas fiscais de serviços (NFS-e) e para o cumprimento das obrigações tributárias no âmbito municipal.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } }, { "name": "municipal_tax_id", "in": "path", "description": "ID da Inscrição Mnicipal que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na consulta da Inscrição Municipal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.MunicipalTaxResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Inscrição Municipal não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "put": { "tags": [ "Companies Municipal Taxes" ], "summary": "Alterar uma Inscrição Municipal pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para alterar os dados de uma Inscrição Municipal pelo ID.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Municipal** representa os dados necessários sobre o cadastro municipal da empresa junto à prefeitura, exigidos para a emissão de notas fiscais de serviços (NFS-e) e para o cumprimento das obrigações tributárias no âmbito municipal.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } }, { "name": "municipal_tax_id", "in": "path", "description": "ID da Inscrição Municipal que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Dados da Inscrição Municipal a ser alterada", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource" } } } }, "responses": { "200": { "description": "Sucesso na alteração da Inscrição Municipal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.MunicipalTaxResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Inscrição Municipal não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "delete": { "tags": [ "Companies Municipal Taxes" ], "summary": "Excluir uma Inscrição Municipal pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para excluir uma Inscrição Municipal pelo ID, cuidado pois esse processo é irreversível.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Municipal** representa os dados necessários sobre o cadastro municipal da empresa junto à prefeitura, exigidos para a emissão de notas fiscais de serviços (NFS-e) e para o cumprimento das obrigações tributárias no âmbito municipal.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } }, { "name": "municipal_tax_id", "in": "path", "description": "ID da Inscrição Municipal que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Sucesso na exclusão da Inscrição Municipal" }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Inscrição Municipal não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}/updateprefecture": { "patch": { "tags": [ "Companies Municipal Taxes" ], "summary": "Atualizar status da prefeitura para uma Inscrição Municipal pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para atualizar o status de uma prefeitura relacionada a uma Inscrição Municipal pelo ID.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Municipal** representa os dados necessários sobre o cadastro municipal da empresa junto à prefeitura, exigidos para a emissão de notas fiscais de serviços (NFS-e) e para o cumprimento das obrigações tributárias no âmbito municipal.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } }, { "name": "municipal_tax_id", "in": "path", "description": "ID da Inscrição Municipal que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Sucesso na atualização do status da prefeitura da Inscrição Municipal" }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Inscrição Municipal não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v2/companies/{company_id}/municipaltaxes/{municipal_tax_id}/series/{serie}": { "get": { "tags": [ "Companies Municipal Taxes" ], "summary": "Consultar uma Serie pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma Serie de RPS.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Municipal** representa os dados necessários sobre o cadastro municipal da empresa junto à prefeitura, exigidos para a emissão de notas fiscais de serviços (NFS-e) e para o cumprimento das obrigações tributárias no âmbito municipal.\r\n**Serie** representa a série do RPS (Recibo Provisório de Serviços) utilizada para a emissão de notas fiscais de serviços eletrônicas (NFS-e).", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } }, { "name": "municipal_tax_id", "in": "path", "description": "ID da Inscrição Mnicipal que deverá ser retornado", "required": true, "schema": { "type": "string" } }, { "name": "serie", "in": "path", "description": "Série do RPS que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na consulta da Série", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.SerieResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Inscrição Municipal não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v2/companies/{company_id}/statetaxes": { "get": { "tags": [ "Companies State Taxes" ], "summary": "Listar as Inscrições Estaduais", "description": "### Informações adicionais\r\nUtilize esta requisição para listar as inscrições estaduais na empresa para processar __Documentos Fiscais__.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } }, { "name": "startingAfter", "in": "query", "description": "Id de início do contador (Default: Empty)", "schema": { "type": "string" } }, { "name": "endingBefore", "in": "query", "description": "Id final do contador (Default: Empty)", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limite de resultados na página (Default: 10)", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Sucesso na criação da Inscrição Estadual", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxesResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "post": { "tags": [ "Companies State Taxes" ], "summary": "Criar uma Inscrição Estadual", "description": "### Informações adicionais\r\nUtilize esta requisição para criar novas inscrição estadual na empresa para processar __Documentos Fiscais__.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Dados da Inscrição Estadual a ser criada", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResource" } } } }, "responses": { "200": { "description": "Sucesso na criação da Inscrição Estadual", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v2/companies/{company_id}/statetaxes/{state_tax_id}": { "get": { "tags": [ "Companies State Taxes" ], "summary": "Consultar uma Inscrição Estadual pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para consultar os dados de uma empresas pelo ID.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } }, { "name": "state_tax_id", "in": "path", "description": "ID da Inscrição Estadual que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na consulta da Inscrição Estadual", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Inscrição Estadual não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "put": { "tags": [ "Companies State Taxes" ], "summary": "Alterar uma Inscrição Estadual pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para alterar os dados de uma Inscrição Estadual pelo ID.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } }, { "name": "state_tax_id", "in": "path", "description": "ID da Inscrição Estadual que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Dados da Inscrição Estadual a ser alterada", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResource" } } } }, "responses": { "200": { "description": "Sucesso na alteração da Inscrição Estadual", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxResource" } } } }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Inscrição Estadual não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } }, "delete": { "tags": [ "Companies State Taxes" ], "summary": "Excluir uma Inscrição Estadual pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para excluir uma Inscrição Estadual pelo ID, cuidado pois esse processo é irreversível.\r\n**Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais.\r\n**Inscrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } }, { "name": "state_tax_id", "in": "path", "description": "ID da Inscrição Estadual que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Sucesso na exclusão da Inscrição Estadual" }, "400": { "description": "Algum parametro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Inscrição Estadual não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } } } } }, "/v2/companies/{company_id}/statetaxes/{state_tax_id}/switch-authorizer": { "post": { "tags": [ "Companies State Taxes" ], "summary": "Alterar o ambiente de uma Inscrição Estadual pelo ID", "description": "### Informações adicionais\r\nUtilize esta requisição para definir o ambiente de autorização das Notas Fiscais de uma Inscrição Estadual pelo ID.", "parameters": [ { "name": "company_id", "in": "path", "description": "ID da Empresa", "required": true, "schema": { "type": "string" } }, { "name": "state_tax_id", "in": "path", "description": "ID da Inscrição Estadual que deverá ser retornado", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json;odata.metadata=minimal;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=minimal;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=minimal": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=full;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=full;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=full": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=none;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=none": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.streaming=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=minimal;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=full;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=full;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=none;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.metadata=none;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.streaming=true;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.streaming=true;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.streaming=false;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;odata.streaming=false;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;IEEE754Compatible=false": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/json;IEEE754Compatible=true": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerResponse" } } } }, "400": { "description": "Algum parâmetro informado não é válido, verificar resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "404": { "description": "Inscrição Estadual não encontrada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorsResource" } } } }, "204": { "description": "Sucesso na exclusão da Inscrição Estadual" } } } }, "/v1/companies/{companyIdOrTaxNumber}": { "get": { "tags": [ "Companies V1" ], "summary": "Obter os detalhes de uma empresa", "parameters": [ { "name": "companyIdOrTaxNumber", "in": "path", "description": "ID da empresa ou Inscrição Federal (CNPJ)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na requisição", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanySingleResourceV1" } } } }, "400": { "description": "Algum parametro informado não é válido" }, "401": { "description": "API Key da conta não é valida" }, "500": { "description": "Erro no processamento" } } } }, "/v1/companies": { "get": { "tags": [ "Companies V1" ], "summary": "Obter os detalhes de todas as empresas da conta", "parameters": [ { "name": "pageCount", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "pageIndex", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na requisição", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyCollectionResourceV1" } } } }, "400": { "description": "Algum parametro informado não é válido" }, "401": { "description": "API Key da conta não é valida" }, "500": { "description": "Erro no processamento" } } }, "post": { "tags": [ "Companies V1" ], "summary": "Criar uma empresa", "requestBody": { "description": "Dados da empresa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyResourceV1" } } } }, "responses": { "201": { "description": "Sucesso na criação da empresa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanySingleResourceV1" } } } }, "400": { "description": "Algum parametro informado não é válido" }, "401": { "description": "API Key da conta não é valida" }, "409": { "description": "Já existe uma empresa com o CNPJ informado" }, "500": { "description": "Erro no processamento" } } } }, "/v1/companies/{companyId}": { "put": { "tags": [ "Companies V1" ], "summary": "Atualizar uma empresa", "parameters": [ { "name": "companyId", "in": "path", "description": "ID da empresa", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Dados da empresa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyResourceV1" } } } }, "responses": { "200": { "description": "Sucesso na atualização da empresa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanySingleResourceV1" } } } }, "400": { "description": "Algum parametro informado não é válido" }, "401": { "description": "API Key da conta não é valida" }, "500": { "description": "Erro no processamento" } } }, "delete": { "tags": [ "Companies V1" ], "summary": "Deletar uma empresa", "parameters": [ { "name": "companyId", "in": "path", "description": "ID da empresa", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Sucesso na deleção da empresa" }, "400": { "description": "Algum parametro informado não é válido" }, "401": { "description": "API Key da conta não é valida" }, "500": { "description": "Erro no processamento" } } } } }, "components": { "schemas": { "DFeTech.TaxPayers.Domain.Entities.Address": { "type": "object", "properties": { "state": { "type": "string", "nullable": true }, "city": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.CityBase" }, "district": { "type": "string", "nullable": true }, "additionalInformation": { "type": "string", "nullable": true }, "streetPrefix": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DFeTech.TaxPayers.Domain.Entities.ApiEnvironment": { "enum": [ "Development", "Production", "Staging" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.CertificateStatus": { "enum": [ "None", "Active", "Inactive", "Overdue", "Pending" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.CityBase": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DFeTech.TaxPayers.Domain.Entities.CityExtended": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DFeTech.TaxPayers.Domain.Entities.CompanyFiscalStatus": { "enum": [ "None", "Active", "CityNotSupported", "Pending", "Inactive" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.EnvironmentType": { "enum": [ "None", "Production", "Test" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.FederalTaxDeterminationBy": { "enum": [ "NotInformed", "Default", "SimplesNacional" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.LegalNature": { "enum": [ "None", "EmpresaPublica", "SociedadeEconomiaMista", "SociedadeAnonimaAberta", "SociedadeAnonimaFechada", "SociedadeEmpresariaLimitada", "SociedadeEmpresariaEmNomeColetivo", "SociedadeEmpresariaEmComanditaSimples", "SociedadeEmpresariaEmComanditaporAcoes", "SociedadeemContaParticipacao", "Empresario", "Cooperativa", "ConsorcioSociedades", "GrupoSociedades", "SociedadeEstrangeiraNoBrasil", "EmpresaBinacionalArgentinoBrasileira", "EmpresaDomiciliadaExterior", "ClubeFundoInvestimento", "SociedadeSimplesPura", "SociedadeSimplesLimitada", "SociedadeSimplesEmNomeColetivo", "SociedadeSimplesEmComanditaSimples", "EmpresaBinacional", "ConsorcioEmpregadores", "ConsorcioSimples", "EireliNaturezaEmpresaria", "EireliNaturezaSimples", "SociedadeUnipessoaldeAdvogados", "CooperativaDeConsumo", "EmpresaSimplesDeInovacao", "InvestidorNaoResidente", "ServicoNotarial", "FundacaoPrivada", "ServicoSocialAutonomo", "CondominioEdilicio", "ComissaoConciliacaoPrevia", "EntidadeMediacaoArbitragem", "PartidoPolitico", "EntidadeSindical", "EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras", "FundacaoAssociacaoDomiciliadaExterior", "OrganizacaoReligiosa", "ComunidadeIndigena", "FundoPrivado", "OrgaoDirecaoNacionalPartidoPolitico", "OrgaoDirecaoRegionalPartidoPolitico", "OrgaoDirecaoLocalPartidoPolitico", "ComiteFinanceiroDePartidoPolitico", "FrentePlebiscitariaOuReferendaria", "OrganizacaoSocial", "DemaisCondominios", "PlanoBeneficiosPrevidenciaComplementarFechada", "AssociacaoPrivada", "EmpresaIndividualImobiliaria", "SeguradoEspecial", "ContribuinteIndividual", "CandidatoCargoPoliticoEletivo", "Leiloeiro", "ProdutorRural", "OrganizacaoInternacional", "RepresentacaoDiplomaticaEstrangeira", "OutrasInstituicoesExtraterritoriais" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.MunicipalTaxDeterminationBy": { "enum": [ "NotInformed", "Default", "SimplesNacional" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.MunicipalTaxFiscalStatus": { "enum": [ "None", "Active", "CityNotSupported", "Pending", "Inactive" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.SecurityCredential": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DFeTech.TaxPayers.Domain.Entities.SpecialTaxRegime": { "enum": [ "Nenhum", "MicroempresaMunicipal", "Estimativa", "SociedadeDeProfissionais", "Cooperativa", "MicroempreendedorIndividual", "MicroempresarioEmpresaPequenoPorte", "Automatico" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.StateCode": { "enum": [ "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" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.StateTaxProcessingAuthorizer": { "enum": [ "Normal", "EPEC" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.StateTaxType": { "enum": [ "Default", "NFe", "NFCe" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.Status": { "enum": [ "None", "Active", "Inactive" ], "type": "string" }, "DFeTech.TaxPayers.Domain.Entities.TaxRegime": { "enum": [ "None", "LucroReal", "LucroPresumido", "SimplesNacional", "SimplesNacionalExcessoSublimite", "MicroempreendedorIndividual", "Isento" ], "type": "string" }, "DFeTech.TaxPayers.Resources.AddressResource": { "required": [ "city", "country", "district", "number", "postalCode", "state", "street" ], "type": "object", "properties": { "state": { "minLength": 1, "type": "string", "description": "Estado, ex.: SP, RJ, AC, padrão ISO 3166-2 ALFA 2." }, "city": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CityBaseResource" }, "district": { "minLength": 1, "type": "string", "description": "Bairro do Endereço" }, "additionalInformation": { "type": "string", "description": "Complemento do Endereço, ex.: AP 2, BL A.", "nullable": true }, "street": { "minLength": 1, "type": "string", "description": "Logradouro do Endereço" }, "number": { "minLength": 1, "type": "string", "description": "Número do Endereço. Usar S/N para \"sem número\"." }, "postalCode": { "minLength": 1, "type": "string", "description": "Cód. Endereço Postal (CEP)" }, "country": { "minLength": 1, "type": "string", "description": "País, ex.: BRA, ARG, USA, padrão ISO 3166-1 ALFA-3." } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.CertificateMetadataResource": { "type": "object", "properties": { "certificate": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CertificateMetadataResourceItem" } }, "additionalProperties": false, "description": "Certificado" }, "DFeTech.TaxPayers.Resources.CertificateMetadataResourceItem": { "type": "object", "properties": { "taxPayerId": { "type": "string", "description": "Identificador do contribuinte", "nullable": true }, "thumbprint": { "type": "string", "description": "A impressão digital do certificado", "nullable": true }, "taxId": { "type": "string", "description": "Documento do contribuinte", "nullable": true }, "subject": { "type": "string", "description": "Nome do certificado (subject distinguished name)", "nullable": true }, "validUntil": { "type": "string", "description": "Data no horário local após o qual um certificado não é mais válido", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Data de modificação", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.CertificateStatus" } }, "additionalProperties": false, "description": "Certificado" }, "DFeTech.TaxPayers.Resources.CertificatesMetadataResource": { "type": "object", "properties": { "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CertificateMetadataResourceItem" }, "description": "Certificado", "nullable": true } }, "additionalProperties": false, "description": "Certificado" }, "DFeTech.TaxPayers.Resources.CityBaseResource": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Cód. do Município, segundo o Tabela de Municípios do IBGE" }, "name": { "minLength": 1, "type": "string", "description": "Nome do Município" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.CompaniesResource": { "type": "object", "properties": { "companies": { "type": "array", "items": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyResourceItem" }, "description": "Lista de Empresa", "nullable": true } }, "additionalProperties": false, "description": "Empresas" }, "DFeTech.TaxPayers.Resources.CompanyCertificateV1": { "type": "object", "properties": { "thumbprint": { "type": "string", "description": "Thumbprint certificado", "nullable": true }, "modifiedOn": { "type": "string", "description": "Certificado alterado em", "format": "date-time", "nullable": true }, "expiresOn": { "type": "string", "description": "Certificado expira em", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.CertificateStatus" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.CompanyCollectionResourceV1": { "type": "object", "properties": { "totalResults": { "type": "integer", "format": "int64", "nullable": true }, "totalPages": { "type": "integer", "format": "int32", "nullable": true }, "page": { "type": "integer", "format": "int32", "nullable": true }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyResourceV1" }, "nullable": true } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.CompanyResource": { "type": "object", "properties": { "company": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyResourceItem" } }, "additionalProperties": false, "description": "Empresa" }, "DFeTech.TaxPayers.Resources.CompanyResourceItem": { "required": [ "address", "federalTaxNumber", "name", "taxRegime" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Razão Social" }, "accountId": { "type": "string", "description": "Identificador da conta", "nullable": true }, "tradeName": { "type": "string", "description": "Nome Fantasia", "nullable": true }, "federalTaxNumber": { "type": "integer", "description": "Número de Inscrição Federal (CNPJ)", "format": "int64" }, "municipalTaxNumber": { "type": "string", "description": "Número da Inscrição Municipal", "nullable": true }, "taxRegime": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.TaxRegime" }, "address": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.AddressResource" }, "id": { "type": "string", "description": "Identificador (gerado automaticamente)", "nullable": true }, "stateTaxes": { "type": "array", "items": { "type": "string" }, "description": "Lista de Inscrição Estadual", "nullable": true }, "municipalTaxes": { "type": "array", "items": { "type": "string" }, "description": "Lista de Inscrição Municipal", "nullable": true }, "status": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.Status" }, "createdOn": { "type": "string", "description": "Data de criação", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Data de modificação", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Dados da Empresa" }, "DFeTech.TaxPayers.Resources.CompanyResourceV1": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificação", "nullable": true }, "name": { "type": "string", "description": "Nome ou Razão Social", "nullable": true }, "tradeName": { "type": "string", "description": "Nome fantasia", "nullable": true }, "federalTaxNumber": { "type": "integer", "description": "CNPJ ou CPF", "format": "int64", "nullable": true }, "email": { "type": "string", "description": "Email", "nullable": true }, "address": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.Address" }, "openningDate": { "type": "string", "description": "Data abertura da empresa", "format": "date-time", "nullable": true }, "taxRegime": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.TaxRegime" }, "specialTaxRegime": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.SpecialTaxRegime" }, "legalNature": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.LegalNature" }, "companyRegistryNumber": { "type": "integer", "description": "Número de Inscricação na Junta Comercial", "format": "int64", "nullable": true }, "regionalTaxNumber": { "type": "integer", "description": "Número de Inscricação na SEFAZ (IE)", "format": "int64", "nullable": true }, "municipalTaxNumber": { "type": "string", "description": "Número de Inscricação na Prefeitura (CCM)", "nullable": true }, "rpsSerialNumber": { "type": "string", "description": "RPS número serie", "nullable": true }, "rpsNumber": { "type": "integer", "description": "RPS número", "format": "int64", "nullable": true }, "lastRpsSent": { "type": "integer", "description": "RPS número", "format": "int64", "nullable": true }, "issRate": { "type": "number", "description": "Alíquota do ISS para Simples Nacional", "format": "double", "nullable": true }, "environment": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.ApiEnvironment" }, "fiscalStatus": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.MunicipalTaxFiscalStatus" }, "federalTaxDetermination": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.FederalTaxDeterminationBy" }, "municipalTaxDetermination": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.MunicipalTaxDeterminationBy" }, "loginName": { "type": "string", "description": "Login para acesso ao sistema", "nullable": true }, "loginPassword": { "type": "string", "description": "Senha para acesso ao sistema", "nullable": true }, "authIssueValue": { "type": "string", "description": "Código de autenticação gerado pela prefeitura", "nullable": true }, "certificate": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyCertificateV1" }, "createdOn": { "type": "string", "description": "Data de criação", "format": "date-time", "nullable": true }, "modifiedOn": { "type": "string", "description": "Data da última modificação", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.Status" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.CompanySingleResourceV1": { "type": "object", "properties": { "companies": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CompanyResourceV1" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.CreateCompanyResource": { "type": "object", "properties": { "company": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateCompanyResourceItem" } }, "additionalProperties": false, "description": "Dados para Criar Empresa" }, "DFeTech.TaxPayers.Resources.CreateCompanyResourceItem": { "required": [ "address", "federalTaxNumber", "name", "taxRegime" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Razão Social" }, "accountId": { "type": "string", "description": "Identificador da conta", "nullable": true }, "tradeName": { "type": "string", "description": "Nome Fantasia", "nullable": true }, "federalTaxNumber": { "type": "integer", "description": "Número de Inscrição Federal (CNPJ)", "format": "int64" }, "municipalTaxNumber": { "type": "string", "description": "Número da Inscrição Municipal", "nullable": true }, "taxRegime": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.TaxRegime" }, "address": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.AddressResource" } }, "additionalProperties": false, "description": "Criar Empresa" }, "DFeTech.TaxPayers.Resources.CreateMunicipalTaxResource": { "type": "object", "properties": { "municipalTax": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateMunicipalTaxResourceItem" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.CreateMunicipalTaxResourceItem": { "type": "object", "properties": { "city": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.CityExtended" }, "taxNumber": { "type": "string", "description": "Inscrição Municipal", "nullable": true }, "environment": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.ApiEnvironment" }, "specialTaxRegime": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.SpecialTaxRegime" }, "email": { "type": "string", "description": "Email", "nullable": true }, "legalNature": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.LegalNature" }, "companyRegistryNumber": { "type": "integer", "description": "Registro da Empresa na Junta Comercial", "format": "int64", "nullable": true }, "regionalTaxNumber": { "type": "integer", "description": "Número Região", "format": "int64", "nullable": true }, "issRate": { "type": "number", "description": "ALíquota do ISS (%)", "format": "double", "nullable": true }, "federalTaxDetermination": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.FederalTaxDeterminationBy" }, "municipalTaxDetermination": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.MunicipalTaxDeterminationBy" }, "loginName": { "type": "string", "description": "Login para acesso ao sistema", "nullable": true }, "loginPassword": { "type": "string", "description": "Senha para acesso ao sistema", "nullable": true }, "authIssueValue": { "type": "string", "description": "Código de autenticação gerado pela prefeitura", "nullable": true }, "rpsNumber": { "type": "integer", "description": "Número do RPS", "format": "int64" }, "lastRpsSent": { "type": "integer", "description": "Último RPS enviado", "format": "int64" }, "rpsSerialNumber": { "type": "string", "description": "Série do RPS", "nullable": true } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.CreateStateTaxProcessingDetailsResource": { "type": "object", "properties": { "switchAuthorizerStrategy": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxProcessingSwitchAuthorizerStrategyResource" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.CreateStateTaxResource": { "type": "object", "properties": { "stateTax": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxResourceItem" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.CreateStateTaxResourceItem": { "required": [ "code", "taxNumber", "type" ], "type": "object", "properties": { "code": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.StateCode" }, "environmentType": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.EnvironmentType" }, "taxNumber": { "minLength": 1, "type": "string", "description": "Inscrição Estadual" }, "specialTaxRegime": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.SpecialTaxRegime" }, "serie": { "type": "integer", "description": "Serie para a emissão NFe", "format": "int32", "nullable": true }, "number": { "type": "integer", "description": "Número para a emissão NFe", "format": "int64", "nullable": true }, "securityCredential": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.SecurityCredential" }, "type": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.StateTaxType" }, "processingDetails": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxProcessingDetailsResource" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.ErrorResource": { "type": "object", "properties": { "code": { "type": "integer", "description": "Código do erro", "format": "int32", "nullable": true, "readOnly": true }, "message": { "type": "string", "description": "Mensagem contendo os detalhes do erro", "nullable": true } }, "additionalProperties": false, "description": "Erro" }, "DFeTech.TaxPayers.Resources.ErrorsResource": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.ErrorResource" }, "description": "Lista de Erros", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Lista de Erros" }, "DFeTech.TaxPayers.Resources.MunicipalTaxResource": { "type": "object", "properties": { "municipalTax": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.MunicipalTaxResourceItem" } }, "additionalProperties": false, "description": "Inscrição Municipal" }, "DFeTech.TaxPayers.Resources.MunicipalTaxResourceItem": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador (gerado automaticamente)", "nullable": true }, "companyId": { "type": "string", "description": "Código da Empresa", "nullable": true }, "accountId": { "type": "string", "description": "Código da Conta", "nullable": true }, "status": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.Status" }, "city": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.CityExtended" }, "taxNumber": { "type": "string", "description": "Inscrição Municipal", "nullable": true }, "specialTaxRegime": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.SpecialTaxRegime" }, "email": { "type": "string", "description": "Email", "nullable": true }, "legalNature": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.LegalNature" }, "companyRegistryNumber": { "type": "integer", "description": "Registro da Empresa na Junta Comercial", "format": "int64", "nullable": true }, "regionalTaxNumber": { "type": "integer", "description": "Número Região", "format": "int64", "nullable": true }, "rpsSerialNumber": { "type": "string", "description": "Série do RPS", "nullable": true }, "rpsNumber": { "type": "integer", "description": "Número do RPS", "format": "int64" }, "lastRpsSent": { "type": "integer", "description": "Número do último RPS", "format": "int64" }, "issRate": { "type": "number", "description": "ALíquota do ISS (%)", "format": "double", "nullable": true }, "environment": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.ApiEnvironment" }, "fiscalStatus": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.CompanyFiscalStatus" }, "federalTaxDetermination": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.FederalTaxDeterminationBy" }, "municipalTaxDetermination": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.MunicipalTaxDeterminationBy" }, "loginName": { "type": "string", "description": "Login para acesso ao sistema", "nullable": true }, "loginPassword": { "type": "string", "description": "Senha para acesso ao sistema", "nullable": true }, "authIssueValue": { "type": "string", "description": "Código de autenticação gerado pela prefeitura", "nullable": true }, "rpsSerialNumbers": { "type": "array", "items": { "type": "string" }, "description": "Todas as séries para esta Inscrição Municipal", "nullable": true } }, "additionalProperties": false, "description": "Dados da Inscrição Municipal" }, "DFeTech.TaxPayers.Resources.SerieResource": { "type": "object", "properties": { "serie": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.SerieResourceItem" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.SerieResourceItem": { "type": "object", "properties": { "rpsNumber": { "type": "integer", "description": "Próximo número de RPS", "format": "int64" }, "lastRpsSent": { "type": "integer", "description": "Último RPS enviado", "format": "int64" } }, "additionalProperties": false, "description": "Dados da Serie" }, "DFeTech.TaxPayers.Resources.StateTaxProcessingAuthorizerResource": { "enum": [ "Normal", "EPEC" ], "type": "string" }, "DFeTech.TaxPayers.Resources.StateTaxProcessingSwitchAuthorizerStrategyResource": { "enum": [ "Manual", "StateTaxAuthorityStatusUnavailable" ], "type": "string" }, "DFeTech.TaxPayers.Resources.StateTaxResource": { "type": "object", "properties": { "stateTax": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxResourceItem" } }, "additionalProperties": false, "description": "Inscrição Estadual" }, "DFeTech.TaxPayers.Resources.StateTaxResourceItem": { "required": [ "code", "taxNumber", "type" ], "type": "object", "properties": { "code": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.StateCode" }, "environmentType": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.EnvironmentType" }, "taxNumber": { "minLength": 1, "type": "string", "description": "Inscrição Estadual" }, "specialTaxRegime": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.SpecialTaxRegime" }, "serie": { "type": "integer", "description": "Serie para a emissão NFe", "format": "int32", "nullable": true }, "number": { "type": "integer", "description": "Número para a emissão NFe", "format": "int64", "nullable": true }, "securityCredential": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.SecurityCredential" }, "type": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.StateTaxType" }, "processingDetails": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxProcessingDetailsResource" }, "id": { "type": "string", "description": "Identificador (gerado automaticamente)", "nullable": true }, "companyId": { "type": "string", "description": "Código da Empresa", "nullable": true }, "accountId": { "type": "string", "description": "Código da Conta", "nullable": true }, "status": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.Status" }, "series": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Todas as séries para esta Inscrição Estadual", "nullable": true }, "createdOn": { "type": "string", "description": "Data de criação", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Data de modificação", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Dados da Inscrição Estadual" }, "DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerRequest": { "type": "object", "properties": { "authorizer": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxProcessingAuthorizerResource" }, "reason": { "type": "string", "description": "Motivo da contingência", "nullable": true } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.StateTaxSwitchAuthorizerResponse": { "type": "object", "properties": { "fromAuthorizer": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.StateTaxProcessingAuthorizer" }, "toAuthorizer": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.StateTaxProcessingAuthorizer" }, "reason": { "type": "string", "description": "Motivo da contingência", "nullable": true }, "modifiedOn": { "type": "string", "description": "Data e hora da modificação", "format": "date-time" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.StateTaxesResource": { "type": "object", "properties": { "stateTaxes": { "type": "array", "items": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.StateTaxResourceItem" }, "description": "Lista de Inscrições Estaduais", "nullable": true } }, "additionalProperties": false, "description": "Inscrições Estaduais" }, "DFeTech.TaxPayers.Resources.UpdateCompanyResource": { "type": "object", "properties": { "company": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateCompanyResourceItem" } }, "additionalProperties": false, "description": "Dados para Alterar Empresa" }, "DFeTech.TaxPayers.Resources.UpdateCompanyResourceItem": { "required": [ "address", "federalTaxNumber", "name", "taxRegime" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Razão Social" }, "accountId": { "type": "string", "description": "Identificador da conta", "nullable": true }, "tradeName": { "type": "string", "description": "Nome Fantasia", "nullable": true }, "federalTaxNumber": { "type": "integer", "description": "Número de Inscrição Federal (CNPJ)", "format": "int64" }, "municipalTaxNumber": { "type": "string", "description": "Número da Inscrição Municipal", "nullable": true }, "taxRegime": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.TaxRegime" }, "address": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.AddressResource" }, "id": { "type": "string", "description": "Identificador (gerado automaticamente)", "nullable": true } }, "additionalProperties": false, "description": "Alterar Empresa" }, "DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResource": { "type": "object", "properties": { "municipalTax": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResourceItem" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.UpdateMunicipalTaxResourceItem": { "type": "object", "properties": { "city": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.CityExtended" }, "taxNumber": { "type": "string", "description": "Inscrição Municipal", "nullable": true }, "specialTaxRegime": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.SpecialTaxRegime" }, "email": { "type": "string", "description": "Email", "nullable": true }, "legalNature": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.LegalNature" }, "companyRegistryNumber": { "type": "integer", "description": "Registro da Empresa na Junta Comercial", "format": "int64", "nullable": true }, "regionalTaxNumber": { "type": "integer", "description": "Número Região", "format": "int64", "nullable": true }, "rpsNumber": { "type": "integer", "description": "Número do RPS", "format": "int64" }, "lastRpsSent": { "type": "integer", "description": "Número do último RPS", "format": "int64" }, "issRate": { "type": "number", "description": "ALíquota do ISS (%)", "format": "double", "nullable": true }, "federalTaxDetermination": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.FederalTaxDeterminationBy" }, "municipalTaxDetermination": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.MunicipalTaxDeterminationBy" }, "loginName": { "type": "string", "description": "Login para acesso ao sistema", "nullable": true }, "loginPassword": { "type": "string", "description": "Senha para acesso ao sistema", "nullable": true }, "authIssueValue": { "type": "string", "description": "Código de autenticação gerado pela prefeitura", "nullable": true }, "environment": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.ApiEnvironment" }, "rpsSerialNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.UpdateStateTaxResource": { "type": "object", "properties": { "stateTax": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.UpdateStateTaxResourceItem" } }, "additionalProperties": false }, "DFeTech.TaxPayers.Resources.UpdateStateTaxResourceItem": { "required": [ "code", "taxNumber", "type" ], "type": "object", "properties": { "code": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.StateCode" }, "environmentType": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.EnvironmentType" }, "taxNumber": { "minLength": 1, "type": "string", "description": "Inscrição Estadual" }, "specialTaxRegime": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.SpecialTaxRegime" }, "serie": { "type": "integer", "description": "Serie para a emissão NFe", "format": "int32", "nullable": true }, "number": { "type": "integer", "description": "Número para a emissão NFe", "format": "int64", "nullable": true }, "securityCredential": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.SecurityCredential" }, "type": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Domain.Entities.StateTaxType" }, "processingDetails": { "$ref": "#/components/schemas/DFeTech.TaxPayers.Resources.CreateStateTaxProcessingDetailsResource" } }, "additionalProperties": false }, "Microsoft.OData.Edm.EdmContainerElementKind": { "enum": [ "None", "EntitySet", "ActionImport", "FunctionImport", "Singleton" ], "type": "string" }, "Microsoft.OData.Edm.EdmExpressionKind": { "enum": [ "None", "BinaryConstant", "BooleanConstant", "DateTimeOffsetConstant", "DecimalConstant", "FloatingConstant", "GuidConstant", "IntegerConstant", "StringConstant", "DurationConstant", "Null", "Record", "Collection", "Path", "If", "Cast", "IsOf", "FunctionApplication", "LabeledExpressionReference", "Labeled", "PropertyPath", "NavigationPropertyPath", "DateConstant", "TimeOfDayConstant", "EnumMember", "AnnotationPath" ], "type": "string" }, "Microsoft.OData.Edm.EdmSchemaElementKind": { "enum": [ "None", "TypeDefinition", "Term", "Action", "EntityContainer", "Function" ], "type": "string" }, "Microsoft.OData.Edm.EdmTypeKind": { "enum": [ "None", "Primitive", "Entity", "Complex", "Collection", "EntityReference", "Enum", "TypeDefinition", "Untyped", "Path" ], "type": "string" }, "Microsoft.OData.Edm.IEdmEntityContainer": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "schemaElementKind": { "$ref": "#/components/schemas/Microsoft.OData.Edm.EdmSchemaElementKind" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "elements": { "type": "array", "items": { "$ref": "#/components/schemas/Microsoft.OData.Edm.IEdmEntityContainerElement" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Microsoft.OData.Edm.IEdmEntityContainerElement": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "containerElementKind": { "$ref": "#/components/schemas/Microsoft.OData.Edm.EdmContainerElementKind" }, "container": { "$ref": "#/components/schemas/Microsoft.OData.Edm.IEdmEntityContainer" } }, "additionalProperties": false }, "Microsoft.OData.Edm.IEdmExpression": { "type": "object", "properties": { "expressionKind": { "$ref": "#/components/schemas/Microsoft.OData.Edm.EdmExpressionKind" } }, "additionalProperties": false }, "Microsoft.OData.Edm.IEdmModel": { "type": "object", "properties": { "schemaElements": { "type": "array", "items": { "$ref": "#/components/schemas/Microsoft.OData.Edm.IEdmSchemaElement" }, "nullable": true, "readOnly": true }, "vocabularyAnnotations": { "type": "array", "items": { "$ref": "#/components/schemas/Microsoft.OData.Edm.Vocabularies.IEdmVocabularyAnnotation" }, "nullable": true, "readOnly": true }, "referencedModels": { "type": "array", "items": { "$ref": "#/components/schemas/Microsoft.OData.Edm.IEdmModel" }, "nullable": true, "readOnly": true }, "declaredNamespaces": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "directValueAnnotationsManager": { "$ref": "#/components/schemas/Microsoft.OData.Edm.Vocabularies.IEdmDirectValueAnnotationsManager" }, "entityContainer": { "$ref": "#/components/schemas/Microsoft.OData.Edm.IEdmEntityContainer" } }, "additionalProperties": false }, "Microsoft.OData.Edm.IEdmSchemaElement": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "schemaElementKind": { "$ref": "#/components/schemas/Microsoft.OData.Edm.EdmSchemaElementKind" }, "namespace": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Microsoft.OData.Edm.IEdmType": { "type": "object", "properties": { "typeKind": { "$ref": "#/components/schemas/Microsoft.OData.Edm.EdmTypeKind" } }, "additionalProperties": false }, "Microsoft.OData.Edm.IEdmTypeReference": { "type": "object", "properties": { "isNullable": { "type": "boolean", "readOnly": true }, "definition": { "$ref": "#/components/schemas/Microsoft.OData.Edm.IEdmType" } }, "additionalProperties": false }, "Microsoft.OData.Edm.Vocabularies.IEdmDirectValueAnnotationsManager": { "type": "object", "additionalProperties": false }, "Microsoft.OData.Edm.Vocabularies.IEdmTerm": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "schemaElementKind": { "$ref": "#/components/schemas/Microsoft.OData.Edm.EdmSchemaElementKind" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "type": { "$ref": "#/components/schemas/Microsoft.OData.Edm.IEdmTypeReference" }, "appliesTo": { "type": "string", "nullable": true, "readOnly": true }, "defaultValue": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Microsoft.OData.Edm.Vocabularies.IEdmVocabularyAnnotatable": { "type": "object", "additionalProperties": false }, "Microsoft.OData.Edm.Vocabularies.IEdmVocabularyAnnotation": { "type": "object", "properties": { "qualifier": { "type": "string", "nullable": true, "readOnly": true }, "term": { "$ref": "#/components/schemas/Microsoft.OData.Edm.Vocabularies.IEdmTerm" }, "target": { "$ref": "#/components/schemas/Microsoft.OData.Edm.Vocabularies.IEdmVocabularyAnnotatable" }, "value": { "$ref": "#/components/schemas/Microsoft.OData.Edm.IEdmExpression" }, "usesDefault": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Microsoft.OData.ODataEntitySetInfo": { "type": "object", "properties": { "typeAnnotation": { "$ref": "#/components/schemas/Microsoft.OData.ODataTypeAnnotation" }, "url": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Microsoft.OData.ODataFunctionImportInfo": { "type": "object", "properties": { "typeAnnotation": { "$ref": "#/components/schemas/Microsoft.OData.ODataTypeAnnotation" }, "url": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Microsoft.OData.ODataServiceDocument": { "type": "object", "properties": { "typeAnnotation": { "$ref": "#/components/schemas/Microsoft.OData.ODataTypeAnnotation" }, "entitySets": { "type": "array", "items": { "$ref": "#/components/schemas/Microsoft.OData.ODataEntitySetInfo" }, "nullable": true }, "singletons": { "type": "array", "items": { "$ref": "#/components/schemas/Microsoft.OData.ODataSingletonInfo" }, "nullable": true }, "functionImports": { "type": "array", "items": { "$ref": "#/components/schemas/Microsoft.OData.ODataFunctionImportInfo" }, "nullable": true } }, "additionalProperties": false }, "Microsoft.OData.ODataSingletonInfo": { "type": "object", "properties": { "typeAnnotation": { "$ref": "#/components/schemas/Microsoft.OData.ODataTypeAnnotation" }, "url": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Microsoft.OData.ODataTypeAnnotation": { "type": "object", "properties": { "typeName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false } }, "securitySchemes": { "Authorization_Header": { "type": "apiKey", "description": "Autenticar usando o cabeçalho HTTP", "name": "Authorization", "in": "header" }, "Authorization_QueryParam": { "type": "apiKey", "description": "Autenticar usando o parâmetro na URL", "name": "apikey", "in": "query" }, "Authorization_JwtBearer": { "type": "http", "description": "Autenticar usando o cabeçalho HTTP", "scheme": "bearer", "bearerFormat": "Json Web Token" } } }, "security": [ { "Authorization_Header": [], "Authorization_QueryParam": [] }, { "Authorization_JwtBearer": [] } ], "tags": [ { "name": "Companies", "description": "Utilize esta requisição para criar novas empresas plataforma para processar Documentos Fiscais. **Empresa** representa uma pessoa jurídica que precisa processar Documentos Fiscais." }, { "name": "Companies Certificates", "description": "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.\r\n\r\nO **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." }, { "name": "Companies State Taxes", "description": "Está sessão é destinada às **Incrições Estaduais(IE)**. Uma **Incrição Estadual** representa os dados necessários sobre o cadastro Estadual (ICMS) que é preciso para processar Documentos Fiscais na SEFAZ.\r\n\r\nUtilizando as informações abaixo você pode criar novas IEs na empresa para processar **Documentos Fiscais**. Além disso, também é possível listar as IEs por empresa e consultar, alterar e exluir uma IE pelo ID da mesma." } ] }