openapi: 3.0.0 servers: - url: https://api.nfe.io description: Nota Fiscal de Serviço - url: https://api.nfse.io description: Webhooks info: title: Nota Fiscal de Serviço version: v1 description: "# Introdução\nSeja bem-vindo a documentação da API de Nota Fiscal de Serviço!\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.\n# Como usar a API?\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.\n# Autenticação\nVocê precisa de uma chave de API (API Key) para identificar a conta que está realizando solicitações para a API. \nPara isso você deve colocar sua chave de API no campo que se encontra topo desta página para que os métodos funcionem corretamente.\nNo seu código e integração temos suporte para autenticação de diversas formas sendo eles: \nHTTP Header (Authorization) ou HTTP Query String (api_key) nos dois modos passando o valor da sua chave de api (API Key).\n\n" paths: /v1/companies: get: tags: - Companies summary: Listar as empresas ativas de uma conta operationId: Companies_Get parameters: - name: pageCount in: query description: Items por página required: false schema: type: integer format: int32 - name: pageIndex in: query description: Número da página required: false schema: type: integer format: int32 responses: "200": description: Consulta realizada com sucesso content: application/json: schema: type: object properties: companies: type: array items: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: Tipo do regime especial de tributação enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: Ambiente de processamento enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string totalResults: format: int64 type: integer totalPages: format: int32 type: integer page: format: int32 type: integer "400": description: Algum parametro informado não é válido, verificar resposta "401": description: API Key da conta não é valida "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] post: tags: - Companies summary: Criar uma empresa operationId: Companies_Post requestBody: description: Dados da empresa required: true content: application/json: schema: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: Tipo do regime especial de tributação enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: Ambiente de processamento enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string responses: "201": description: Sucesso na criação da empresa content: application/json: schema: type: object properties: companies: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: Tipo do regime especial de tributação enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: Ambiente de processamento enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "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 security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id_or_tax_number}: get: tags: - Companies summary: Obter os detalhes de uma empresa operationId: Companies_idGet parameters: - name: company_id_or_tax_number 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: type: object properties: companies: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: Tipo do regime especial de tributação enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: Ambiente de processamento enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}: put: tags: - Companies summary: Atualizar uma empresa operationId: Companies_Put requestBody: description: Dados da empresa required: true content: application/json: schema: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: Tipo do regime especial de tributação enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: Ambiente de processamento enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string responses: "200": description: Sucesso na atualização da empresa content: application/json: schema: type: object properties: companies: required: - name - federalTaxNumber - email - address - openningDate - taxRegime - legalNature - municipalTaxNumber type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: Tipo do regime especial de tributação enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string rpsSerialNumber: description: RPS número serie type: string rpsNumber: format: int64 description: RPS número type: integer issRate: format: double description: Alíquota do ISS para Simples Nacional type: number environment: description: Ambiente de processamento enum: - Development - Production - Staging type: string fiscalStatus: description: Status no sistema enum: - CityNotSupported - Pending - Inactive - None - Active type: string federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string certificate: description: Certificado type: object properties: thumbprint: description: Thumbprint certificado type: string modifiedOn: format: date-time description: Certificado alterado em type: string expiresOn: format: date-time description: Certificado expira em type: string status: description: Status do certificado enum: - Overdue - Pending - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "500": description: Erro no processamento parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string security: - Authorization_Header: [] Authorization_QueryParam: [] delete: tags: - Companies summary: Excluir uma empresa operationId: Companies_Delete parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string responses: "200": description: Sucesso na remoção da empresa content: application/json: schema: type: object "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "404": description: empresa não foi encontrada "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/certificate: post: tags: - Companies summary: Upload do certificado digital da empresa usando o codificação multipart/form-data. operationId: Companies_CertificateUpload requestBody: description: Arquivo do certificado digital com extensao PFX ou P12 required: true content: multipart/form-data: schema: type: object properties: file: type: string format: binary password: type: string responses: "200": description: Sucesso na atualização da certificado digital content: application/json: schema: type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "404": description: Empresa não foi encontrada "415": description: Nenhum arquivo foi encontrado na requisição "500": description: Erro no processamento parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/notifications: get: tags: - CompaniesNotifications summary: Listar as notificações de uma empresa description: Utilize esta requisição para consultar uma lista das **Notificações** cadastradas na **Empresa**. operationId: CompaniesNotifications_Get parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string responses: "200": description: Consulta realizada com sucesso content: application/json: schema: type: object properties: notifications: type: array items: type: object properties: id: description: Identificação type: string channel: description: Canal de Notificação enum: - None - Email type: string filters: description: Filtro de Evento type: array items: type: string status: description: Status no sistema enum: - Active - Inactive type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido, verificar resposta "401": description: API Key da conta não é valida "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/notifications/{notification_id}: get: tags: - CompaniesNotifications summary: Consultar uma notificação existente description: Utilize esta requisição para consultar uma **Notificação** que esteja cadastrada e tenha o ID igual ao parametro **{notification_id}**. operationId: CompaniesNotifications_idGet parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: notification_id in: path description: ID da notificação a ser consultado required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: object properties: notification: type: object properties: id: description: Identificação type: string channel: description: Canal de Notificação enum: - None - Email type: string filters: description: Filtro de Evento type: array items: type: string status: description: Status no sistema enum: - Active - Inactive type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] delete: tags: - CompaniesNotifications summary: Excluir uma notificação operationId: CompaniesNotifications_Delete parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: notification_id in: path description: ID da notificação required: true schema: type: string responses: "200": description: Sucesso na remoção da empresa content: application/json: schema: type: object "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "404": description: empresa não foi encontrada "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/notifications/email: post: tags: - CompaniesNotifications summary: Criar notificação via Email da Nota Fiscal de Serviço (NFSE) description: "Utilize esta requisição para definir se os Tomadores (Clientes) das Notas Fiscais de Serviço (NFSE)\r\ndevem ser notificados via email que a NFSE foi **emitida** ou **cancelada** com sucesso." operationId: CompaniesNotifications_Post parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string requestBody: description: Dados da notificação required: true content: application/json: schema: description: Cria Notificação para Email type: object properties: filters: description: "Lista de filtros de evento sem distinção entre maiúsculas e minúsculas associado a esta notificação.\r\nOs filtros de evento são usados para determinar em quais eventos essa notificação será acionada.\r\nOs valores de filtros suportados pode ser consultados através do requisição na API de **Tipos de Eventos**." type: array items: type: string status: description: "Determina se as notificações são enviadas quando o evento é gerado.\r\nDefinir como **Inactive** para não receber nenhuma nova notificação, sendo o padrão: **Active**\r\npara receber todas as notificações." enum: - Active - Inactive type: string responses: "201": description: Sucesso na criação da empresa content: application/json: schema: type: object properties: notification: type: object properties: id: description: Identificação type: string channel: description: Canal de Notificação enum: - None - Email type: string filters: description: Filtro de Evento type: array items: type: string status: description: Status no sistema enum: - Active - Inactive type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "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 security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/eventTypes: get: tags: - EventTypes summary: Listar os Tipos de Eventos gerados pela plataforma description: "Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados\r\ncriando notificações para os webhooks ativos e configurados para receber os eventos.\r\n \r\nSão identificados seguindo o padrão do nome do evento.\r\n\r\nEsse tipos podem ser utilizados como filtro ao criar ou alterar um webhook,\r\nsendo que o filtro determina quais notificações de eventos e ação serão enviadas\r\npara um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook\r\nele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros." operationId: EventTypes_GetAll responses: "200": description: Sucesso na consulta do tipos de eventos content: application/json: schema: description: Tipos de Eventos type: object properties: eventTypes: description: Lista de Evento type: array items: description: "Eventos ocorrem a todo instante na plataforma durante os processamentos e são registrados\r\ncriando notificações para os webhooks ativos e configurados para receber os eventos." type: object properties: id: description: "Identificador do evento, seguem o padrão **Resource.EventAction**.\r\nOnde **Resource**: nome da entidade que gerou o evento;\r\n**EventAction**: nome do evento e ação criados.\r\nAlguns exemplos **Invoice.Issued** ou **Blob.Updated**" type: string description: description: Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. type: string "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/legalpeople: get: tags: - LegalPeople summary: Listar as pessoas jurídicas ativas operationId: LegalPeople_Get parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: required: - name - email - address type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string status: description: Status no sistema enum: - Inactive - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/legalpeople/{id}: get: tags: - LegalPeople summary: Obter os detalhes de uma pessoa jurídica operationId: LegalPeople_idGet parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da pessoa juridica required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: object properties: legalPeople: required: - name - email - address type: object properties: id: description: Identificação type: string name: description: Nome ou Razão Social type: string tradeName: description: Nome fantasia type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string status: description: Status no sistema enum: - Inactive - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/naturalpeople: get: tags: - NaturalPeople summary: Listar as pessoas físicas ativas operationId: NaturalPeople_Get parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: object properties: naturalPeople: type: array items: required: - name - email - address type: object properties: id: description: Identificação type: string name: description: Nome completo type: string federalTaxNumber: format: int64 description: CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string birthDate: format: date-time description: Data nascimento type: string idNumber: description: Número do Registro Geral (RG) type: string status: description: Status no sistema enum: - Inactive - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string totalResults: format: int64 type: integer totalPages: format: int32 type: integer page: format: int32 type: integer "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/naturalpeople/{id}: get: tags: - NaturalPeople summary: Obter os detalhes de uma pessoa física operationId: NaturalPeople_idGet parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da pessoa física required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: required: - name - email - address type: object properties: id: description: Identificação type: string name: description: Nome completo type: string federalTaxNumber: format: int64 description: CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string birthDate: format: date-time description: Data nascimento type: string idNumber: description: Número do Registro Geral (RG) type: string status: description: Status no sistema enum: - Inactive - None - Active type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices: get: tags: - ServiceInvoices summary: Listar as Notas Fiscais de Serviço (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_Get parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: pageCount in: query description: Items por página required: false schema: type: integer format: int32 - name: pageIndex in: query description: Número da página required: false schema: type: integer format: int32 - name: issuedBegin in: query description: Data de competência início required: false schema: type: string format: yyyy-MM-dd - name: issuedEnd in: query description: Data de competência fim required: false schema: type: string format: yyyy-MM-dd - name: createdBegin in: query description: Data de criação início required: false schema: type: string format: yyyy-MM-dd - name: createdEnd in: query description: Data de criação fim required: false schema: type: string format: yyyy-MM-dd - name: hasTotals in: query required: false schema: type: boolean responses: "200": description: Sucesso na requisição content: application/json: schema: type: object properties: serviceInvoices: type: array items: required: - environment type: object properties: id: description: Identificação type: string environment: description: Ambiente de Processamento enum: - Development - Production - Staging type: string flowStatus: description: Status do processamento enum: - CancelFailed - IssueFailed - Issued - Cancelled - PullFromCityHall - WaitingCalculateTaxes - WaitingDefineRpsNumber - WaitingSend - WaitingSendCancel - WaitingReturn - WaitingDownload type: string flowMessage: description: Mensagem de processamento type: string provider: description: Prestador dos serviços type: object properties: tradeName: description: Nome Fantasia type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: Tipo do regime especial de tributação enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string issRate: format: double description: Taxa da Aliquota do ISS (Simples Nacional) type: number federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string borrower: description: Tomador dos serviços type: object properties: parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer phoneNumber: description: Telefone type: string email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string externalId: description: Identificação única do cliente type: string batchNumber: format: int64 description: Número do lote da RPS type: integer batchCheckNumber: description: Número do protocolo do lote da RPS type: string number: format: int64 description: Número do NFE type: integer checkCode: description: Código de Verificação da NFE type: string status: description: Status da NFE enum: - Error - None - Created - Issued - Cancelled type: string rpsType: description: Tipo da RPS enum: - Rps - RpsMista - Cupom type: string rpsStatus: description: Status da RPS enum: - Normal - Canceled - Lost type: string taxationType: description: Tipo da tributação enum: - None - WithinCity - OutsideCity - Export - Free - Immune - SuspendedCourtDecision - SuspendedAdministrativeProcedure - OutsideCityFree - OutsideCityImmune - OutsideCitySuspended - OutsideCitySuspendedAdministrativeProcedure - ObjectiveImune type: string issuedOn: format: date-time description: Data de emissão type: string cancelledOn: format: date-time description: Data de cancelamento type: string rpsSerialNumber: description: Número de serie da RPS type: string rpsNumber: format: int64 description: Número da RPS type: integer cityServiceCode: description: Código do servico prestado no Municipio type: string federalServiceCode: description: Código do servico prestado federal type: string description: description: Descrição do serviço no municipio type: string servicesAmount: format: double description: Valor do serviços type: number paidAmount: format: double description: Valor dos Serviços pago type: number paymentMethod: description: Formas de pagamento enum: - None - Cash - Check - CreditCard - DebitCard - StoreCredit - FoodVoucher - MealVoucher - GiftCard - FuelVoucher - Others type: string deductionsAmount: format: double description: Valor de deduções type: number discountUnconditionedAmount: format: double description: Valor do desconto incondicionado type: number discountConditionedAmount: format: double description: Valor do desconto condicionado type: number baseTaxAmount: format: double description: Valor da base de calculo de impostos type: number issRate: format: double description: Aliquota do ISS type: number issTaxAmount: format: double description: Valor do ISS type: number irAmountWithheld: format: double description: Valor retido do Imposto de Renda (IR) type: number pisAmountWithheld: format: double description: Valor retido do PIS type: number cofinsAmountWithheld: format: double description: Valor retido do COFINS type: number csllAmountWithheld: format: double description: Valor retido do CSLL type: number inssAmountWithheld: format: double description: Valor retido do INSS type: number issAmountWithheld: format: double description: Valor retido do ISS type: number othersAmountWithheld: format: double description: Valor de outras retenções type: number amountWithheld: format: double description: Valor das retenções type: number amountNet: format: double description: Valor líquido type: number location: description: Local da Prestação do Serviço type: object properties: state: description: Estado type: string country: description: País type: string postalCode: description: Código Postal type: string street: description: Logradouro type: string number: description: Número type: string district: description: Bairro type: string AdditionalInformation: description: Informações Adicionais (Complemento) type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string activityEvent: description: Detalhes da atividade do evento type: object properties: name: description: Nome do evento type: string beginOn: format: date-time description: Data de início do evento type: string endOn: format: date-time description: Data do fim do evento type: string Code: description: Código da atividade do evento type: string approximateTax: description: Tributos aproximados type: object properties: source: description: Nome da fonte da taxa type: string version: description: Versão da taxa baseado na fonte type: string totalRate: format: double description: Taxa dos tributos aproximados type: number additionalInformation: description: Informações Adicionais type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string totalResults: format: int64 type: integer totalPages: format: int32 type: integer page: format: int32 type: integer "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] post: tags: - ServiceInvoices summary: Emitir uma Nota Fiscal de Serviço (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_Post parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string requestBody: description: Dados da nota fiscal de serviço required: true content: application/json: schema: description: Emissão de nota fiscal de serviço required: - cityServiceCode - description - servicesAmount type: object properties: borrower: description: Tomador dos serviços required: [] type: object properties: type: description: Tipo do tomador dos serviços enum: - Undefined - NaturalPerson - LegalEntity type: string name: description: Nome / Razão Social type: string maxLenght: 115 federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer maxLength: 14 municipalTaxNumber: description: Inscrição Municipal para Pessoas Jurídicas type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string phoneNumber: description: Telefone type: string minLength: 7 maxLenght: 20 email: description: Email type: string address: description: Endereço required: - country type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string length: 3 postalCode: description: 'CEP (Exemplo: 99999-999)' type: string length: 9 street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string length: 7 name: description: Nome type: string state: description: Estado type: string length: 2 externalId: description: Identificação única do cliente type: string cityServiceCode: description: Código do serviço no municipio type: string federalServiceCode: description: Código federal do servico (Item da lista de serviço LC 116) type: string cnaeCode: description: Código CNAE (somente quando necessario na cidade) type: string nbsCode: description: Código do NBS no municipio (somente quando necessario na cidade) type: string description: description: Descrição dos serviços type: string servicesAmount: format: double description: Valor do serviços type: number rpsSerialNumber: description: Número de Serie da RPS type: string issuedOn: format: date-time description: Data da emissão no formato YYYY-MM-DDTHH:MM:SS.SSSSSS-03:00 type: string rpsNumber: format: int64 description: Número da RPS type: integer taxationType: description: Tipo da tributação enum: - None - WithinCity - OutsideCity - Export - Free - Immune - SuspendedCourtDecision - SuspendedAdministrativeProcedure - OutsideCityFree - OutsideCityImmune - OutsideCitySuspended - OutsideCitySuspendedAdministrativeProcedure - ObjectiveImune type: string issRate: format: double description: Aliquota do ISS type: number issTaxAmount: format: double description: Valor do ISS type: number deductionsAmount: format: double description: Valor de deduções type: number discountUnconditionedAmount: format: double description: Valor do desconto incondicionado type: number discountConditionedAmount: format: double description: Valor do desconto condicionado type: number irAmountWithheld: format: double description: Valor retido do Imposto de Renda (IR) type: number pisAmountWithheld: format: double description: Valor retido do PIS type: number cofinsAmountWithheld: format: double description: Valor retido do COFINS type: number csllAmountWithheld: format: double description: Valor retido do CSLL type: number inssAmountWithheld: format: double description: Valor retido do INSS type: number issAmountWithheld: format: double description: Valor retido do ISS type: number othersAmountWithheld: format: double description: Valor de outras retenções type: number approximateTax: description: Tributos aproximados type: object properties: source: description: Nome da fonte da taxa type: string version: description: Versão da taxa baseado na fonte type: string totalRate: format: double description: Taxa dos tributos aproximados type: number additionalInformation: description: Informações Adicionais type: string location: description: Local da Prestação do Serviço type: object properties: state: description: Estado type: string country: description: País type: string postalCode: description: Código Postal type: string street: description: Logradouro type: string number: description: Número type: string district: description: Bairro type: string AdditionalInformation: description: Informações Adicionais (Complemento) type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string activityEvent: description: Detalhes da atividade do evento type: object properties: name: description: Nome do evento type: string beginOn: format: date-time description: Data de início do evento type: string endOn: format: date-time description: Data do fim do evento type: string Code: description: Código da atividade do evento type: string responses: "202": description: Nota Fiscal de Serviços foi enviada com sucesso para fila de emissão content: application/json: schema: required: - environment type: object properties: id: description: Identificação type: string environment: description: Ambiente de Processamento enum: - Development - Production - Staging type: string flowStatus: description: Status do processamento enum: - CancelFailed - IssueFailed - Issued - Cancelled - PullFromCityHall - WaitingCalculateTaxes - WaitingDefineRpsNumber - WaitingSend - WaitingSendCancel - WaitingReturn - WaitingDownload type: string flowMessage: description: Mensagem de processamento type: string provider: description: Prestador dos serviços type: object properties: tradeName: description: Nome Fantasia type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: Tipo do regime especial de tributação enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string issRate: format: double description: Taxa da Aliquota do ISS (Simples Nacional) type: number federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endere o required: - country type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string borrower: description: Tomador dos serviços type: object properties: parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer phoneNumber: description: Telefone type: string email: description: Email type: string address: description: Endereço required: - country type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string externalId: description: Identificação única do cliente type: string batchNumber: format: int64 description: Número do lote da RPS type: integer batchCheckNumber: description: Número do protocolo do lote da RPS type: string number: format: int64 description: Número do NFE type: integer checkCode: description: Código de Verificação da NFE type: string status: description: Status da NFE enum: - Error - None - Created - Issued - Cancelled type: string rpsType: description: Tipo da RPS enum: - Rps - RpsMista - Cupom type: string rpsStatus: description: Status da RPS enum: - Normal - Canceled - Lost type: string taxationType: description: Tipo da tributação enum: - None - WithinCity - OutsideCity - Export - Free - Immune - SuspendedCourtDecision - SuspendedAdministrativeProcedure - OutsideCityFree - OutsideCityImmune - OutsideCitySuspended - OutsideCitySuspendedAdministrativeProcedure - ObjectiveImune type: string issuedOn: format: date-time description: Data de emissão type: string cancelledOn: format: date-time description: Data de cancelamento type: string rpsSerialNumber: description: Número de serie da RPS type: string rpsNumber: format: int64 description: Número da RPS type: integer cityServiceCode: description: Código do servico prestado no Municipio type: string federalServiceCode: description: Código do servico prestado federal type: string description: description: Descrição do serviço no municipio type: string servicesAmount: format: double description: Valor do serviços type: number deductionsAmount: format: double description: Valor de deduções type: number discountUnconditionedAmount: format: double description: Valor do desconto incondicionado type: number discountConditionedAmount: format: double description: Valor do desconto condicionado type: number baseTaxAmount: format: double description: Valor da base de calculo de impostos type: number issRate: format: double description: Aliquota do ISS type: number issTaxAmount: format: double description: Valor do ISS type: number irAmountWithheld: format: double description: Valor retido do Imposto de Renda (IR) type: number pisAmountWithheld: format: double description: Valor retido do PIS type: number cofinsAmountWithheld: format: double description: Valor retido do COFINS type: number csllAmountWithheld: format: double description: Valor retido do CSLL type: number inssAmountWithheld: format: double description: Valor retido do INSS type: number issAmountWithheld: format: double description: Valor retido do ISS type: number othersAmountWithheld: format: double description: Valor de outras retenções type: number amountWithheld: format: double description: Valor das retenções type: number amountNet: format: double description: Valor líquido type: number location: description: Local da Prestação do Serviço type: object properties: state: description: Estado type: string country: description: País type: string postalCode: description: Código Postal type: string street: description: Logradouro type: string number: description: Número type: string district: description: Bairro type: string AdditionalInformation: description: Informações Adicionais (Complemento) type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string activityEvent: description: Detalhes da atividade do evento type: object properties: name: description: Nome do evento type: string beginOn: format: date-time description: Data de início do evento type: string endOn: format: date-time description: Data do fim do evento type: string Code: description: Código da atividade do evento type: string approximateTax: description: Tributos aproximados type: object properties: source: description: Nome da fonte da taxa type: string version: description: Versão da taxa baseado na fonte type: string totalRate: format: double description: Taxa dos tributos aproximados type: number additionalInformation: description: Informações Adicionais type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "408": description: Tempo de reposta do servidor excedeu o limite (60s) "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices/external/{id}: get: tags: - ServiceInvoices summary: Obter os detalhes de uma Nota Fiscal de Serviço (NFSE) através do ID externo (externalId) description: Você precisará do API Key da Empresa operationId: ServiceInvoices_idGet parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: externalId in: path description: ID externo da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: required: - environment type: object properties: id: description: Identificação type: string environment: description: Ambiente de Processamento enum: - Development - Production - Staging type: string flowStatus: description: Status do processamento enum: - CancelFailed - IssueFailed - Issued - Cancelled - PullFromCityHall - WaitingCalculateTaxes - WaitingDefineRpsNumber - WaitingSend - WaitingSendCancel - WaitingReturn - WaitingDownload type: string flowMessage: description: Mensagem de processamento type: string provider: description: Prestador dos serviços type: object properties: tradeName: description: Nome Fantasia type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: Tipo do regime especial de tributação enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string issRate: format: double description: Taxa da Aliquota do ISS (Simples Nacional) type: number federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string borrower: description: Tomador dos serviços type: object properties: parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer phoneNumber: description: Telefone type: string email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string externalId: description: Identificação única do cliente type: string batchNumber: format: int64 description: Número do lote da RPS type: integer batchCheckNumber: description: Número do protocolo do lote da RPS type: string number: format: int64 description: Número do NFE type: integer checkCode: description: Código de Verificação da NFE type: string status: description: Status da NFE enum: - Error - None - Created - Issued - Cancelled type: string rpsType: description: Tipo da RPS enum: - Rps - RpsMista - Cupom type: string rpsStatus: description: Status da RPS enum: - Normal - Canceled - Lost type: string taxationType: description: Tipo da tributação enum: - None - WithinCity - OutsideCity - Export - Free - Immune - SuspendedCourtDecision - SuspendedAdministrativeProcedure - OutsideCityFree - OutsideCityImmune - OutsideCitySuspended - OutsideCitySuspendedAdministrativeProcedure - ObjectiveImune type: string issuedOn: format: date-time description: Data de emissão type: string cancelledOn: format: date-time description: Data de cancelamento type: string rpsSerialNumber: description: Número de serie da RPS type: string rpsNumber: format: int64 description: Número da RPS type: integer cityServiceCode: description: Código do servico prestado no Municipio type: string federalServiceCode: description: Código do servico prestado federal type: string description: description: Descrição do serviço no municipio type: string servicesAmount: format: double description: Valor do serviços type: number deductionsAmount: format: double description: Valor de deduções type: number discountUnconditionedAmount: format: double description: Valor do desconto incondicionado type: number discountConditionedAmount: format: double description: Valor do desconto condicionado type: number baseTaxAmount: format: double description: Valor da base de calculo de impostos type: number issRate: format: double description: Aliquota do ISS type: number issTaxAmount: format: double description: Valor do ISS type: number irAmountWithheld: format: double description: Valor retido do Imposto de Renda (IR) type: number pisAmountWithheld: format: double description: Valor retido do PIS type: number cofinsAmountWithheld: format: double description: Valor retido do COFINS type: number csllAmountWithheld: format: double description: Valor retido do CSLL type: number inssAmountWithheld: format: double description: Valor retido do INSS type: number issAmountWithheld: format: double description: Valor retido do ISS type: number othersAmountWithheld: format: double description: Valor de outras retenções type: number amountWithheld: format: double description: Valor das retenções type: number amountNet: format: double description: Valor líquido type: number location: description: Local da Prestação do Serviço type: object properties: state: description: Estado type: string country: description: País type: string postalCode: description: Código Postal type: string street: description: Logradouro type: string number: description: Número type: string district: description: Bairro type: string AdditionalInformation: description: Informações Adicionais (Complemento) type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string activityEvent: description: Detalhes da atividade do evento type: object properties: name: description: Nome do evento type: string beginOn: format: date-time description: Data de início do evento type: string endOn: format: date-time description: Data do fim do evento type: string Code: description: Código da atividade do evento type: string approximateTax: description: Tributos aproximados type: object properties: source: description: Nome da fonte da taxa type: string version: description: Versão da taxa baseado na fonte type: string totalRate: format: double description: Taxa dos tributos aproximados type: number additionalInformation: description: Informações Adicionais type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices/{id}: get: tags: - ServiceInvoices summary: Obter os detalhes de uma Nota Fiscal de Serviço (NFSE) description: Você precisará do API Key da Empresa operationId: ServiceInvoices_idGet parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: required: - environment type: object properties: id: description: Identificação type: string environment: description: Ambiente de Processamento enum: - Development - Production - Staging type: string flowStatus: description: Status do processamento enum: - CancelFailed - IssueFailed - Issued - Cancelled - PullFromCityHall - WaitingCalculateTaxes - WaitingDefineRpsNumber - WaitingSend - WaitingSendCancel - WaitingReturn - WaitingDownload type: string flowMessage: description: Mensagem de processamento type: string provider: description: Prestador dos serviços type: object properties: tradeName: description: Nome Fantasia type: string openningDate: format: date-time description: Data abertura da empresa type: string taxRegime: description: Tipo do Regime Tributário enum: - Isento - MicroempreendedorIndividual - SimplesNacional - LucroPresumido - LucroReal type: string specialTaxRegime: description: Tipo do regime especial de tributação enum: - Automatico - Nenhum - MicroempresaMunicipal - Estimativa - SociedadeDeProfissionais - Cooperativa - MicroempreendedorIndividual - MicroempresarioEmpresaPequenoPorte type: string legalNature: description: Código da Natureza Jurídica enum: - EmpresaPublica - SociedadeEconomiaMista - SociedadeAnonimaAberta - SociedadeAnonimaFechada - SociedadeEmpresariaLimitada - SociedadeEmpresariaEmNomeColetivo - SociedadeEmpresariaEmComanditaSimples - SociedadeEmpresariaEmComanditaporAcoes - SociedadeemContaParticipacao - Empresario - Cooperativa - ConsorcioSociedades - GrupoSociedades - EmpresaDomiciliadaExterior - ClubeFundoInvestimento - SociedadeSimplesPura - SociedadeSimplesLimitada - SociedadeSimplesEmNomeColetivo - SociedadeSimplesEmComanditaSimples - EmpresaBinacional - ConsorcioEmpregadores - ConsorcioSimples - EireliNaturezaEmpresaria - EireliNaturezaSimples - ServicoNotarial - FundacaoPrivada - ServicoSocialAutonomo - CondominioEdilicio - ComissaoConciliacaoPrevia - EntidadeMediacaoArbitragem - PartidoPolitico - EntidadeSindical - EstabelecimentoBrasilFundacaoAssociacaoEstrangeiras - FundacaoAssociacaoDomiciliadaExterior - OrganizacaoReligiosa - ComunidadeIndigena - FundoPrivado - AssociacaoPrivada type: string economicActivities: description: Atividades da Empresa type: array items: type: object properties: type: enum: - Main - Secondary type: string code: format: int32 type: integer companyRegistryNumber: format: int64 description: Número de Inscrição na Junta Comercial type: integer regionalTaxNumber: format: int64 description: Número de Inscrição na SEFAZ (IE) type: integer municipalTaxNumber: description: Número de Inscrição na Prefeitura (CCM) type: string issRate: format: double description: Taxa da Aliquota do ISS (Simples Nacional) type: number federalTaxDetermination: description: Determinação de imposto federal enum: - NotInformed - Default - SimplesNacional type: string municipalTaxDetermination: description: Determinação de imposto municipal enum: - NotInformed - Default - SimplesNacional type: string loginName: description: Nome de login type: string loginPassword: description: Senha de login type: string authIssueValue: description: Valor de emissão de autorização type: string parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string borrower: description: Tomador dos serviços type: object properties: parentId: type: string id: description: Identificação type: string name: description: Nome ou Razão Social type: string federalTaxNumber: format: int64 description: CNPJ ou CPF type: integer phoneNumber: description: Telefone type: string email: description: Email type: string address: description: Endereço required: - country - street - number type: object properties: country: description: "Sigla do País (padrão ISO 3166-1 mais em http://bit.ly/1OgCkxd)\r\nExemplo: BRA, USD, ARG" type: string postalCode: description: 'CEP (Exemplo: 99999-999)' type: string street: description: Logradouro type: string number: description: 'Número (Exemplo: 185 ou S/N)' type: string additionalInformation: description: 'Complemento (Exemplo: BLC A; APT 10' type: string district: description: Bairro type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string state: description: Estado type: string status: description: Status no sistema enum: - Inactive - None - Active type: string type: description: 'Tipo da pessoa: Jurídica ou Física' enum: - Undefined - NaturalPerson - LegalEntity - LegalPerson - Company - Customer type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string externalId: description: Identificação única do cliente type: string batchNumber: format: int64 description: Número do lote da RPS type: integer batchCheckNumber: description: Número do protocolo do lote da RPS type: string number: format: int64 description: Número do NFE type: integer checkCode: description: Código de Verificação da NFE type: string status: description: Status da NFE enum: - Error - None - Created - Issued - Cancelled type: string rpsType: description: Tipo da RPS enum: - Rps - RpsMista - Cupom type: string rpsStatus: description: Status da RPS enum: - Normal - Canceled - Lost type: string taxationType: description: Tipo da tributação enum: - None - WithinCity - OutsideCity - Export - Free - Immune - SuspendedCourtDecision - SuspendedAdministrativeProcedure - OutsideCityFree - OutsideCityImmune - OutsideCitySuspended - OutsideCitySuspendedAdministrativeProcedure - ObjectiveImune type: string issuedOn: format: date-time description: Data de emissão type: string cancelledOn: format: date-time description: Data de cancelamento type: string rpsSerialNumber: description: Número de serie da RPS type: string rpsNumber: format: int64 description: Número da RPS type: integer cityServiceCode: description: Código do servico prestado no Municipio type: string federalServiceCode: description: Código do servico prestado federal type: string description: description: Descrição do serviço no municipio type: string servicesAmount: format: double description: Valor do serviços type: number deductionsAmount: format: double description: Valor de deduções type: number discountUnconditionedAmount: format: double description: Valor do desconto incondicionado type: number discountConditionedAmount: format: double description: Valor do desconto condicionado type: number baseTaxAmount: format: double description: Valor da base de calculo de impostos type: number issRate: format: double description: Aliquota do ISS type: number issTaxAmount: format: double description: Valor do ISS type: number irAmountWithheld: format: double description: Valor retido do Imposto de Renda (IR) type: number pisAmountWithheld: format: double description: Valor retido do PIS type: number cofinsAmountWithheld: format: double description: Valor retido do COFINS type: number csllAmountWithheld: format: double description: Valor retido do CSLL type: number inssAmountWithheld: format: double description: Valor retido do INSS type: number issAmountWithheld: format: double description: Valor retido do ISS type: number othersAmountWithheld: format: double description: Valor de outras retenções type: number amountWithheld: format: double description: Valor das retenções type: number amountNet: format: double description: Valor líquido type: number location: description: Local da Prestação do Serviço type: object properties: state: description: Estado type: string country: description: País type: string postalCode: description: Código Postal type: string street: description: Logradouro type: string number: description: Número type: string district: description: Bairro type: string AdditionalInformation: description: Informações Adicionais (Complemento) type: string city: description: Cidade type: object properties: code: description: Código do IBGE type: string name: description: Nome type: string activityEvent: description: Detalhes da atividade do evento type: object properties: name: description: Nome do evento type: string beginOn: format: date-time description: Data de início do evento type: string endOn: format: date-time description: Data do fim do evento type: string Code: description: Código da atividade do evento type: string approximateTax: description: Tributos aproximados type: object properties: source: description: Nome da fonte da taxa type: string version: description: Versão da taxa baseado na fonte type: string totalRate: format: double description: Taxa dos tributos aproximados type: number additionalInformation: description: Informações Adicionais type: string createdOn: format: date-time description: Data de criação type: string modifiedOn: format: date-time description: Data da última modificação type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] delete: tags: - ServiceInvoices summary: Cancelar uma Nota Fiscal de Serviços (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_Delete parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Nota fiscal cancelada com sucesso content: application/json: schema: type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "408": description: Tempo de reposta do servidor excedeu o limite (60s) "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices/{id}/sendemail: put: tags: - ServiceInvoices summary: Enviar email para o Tomador com a Nota Fiscal de Serviço (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_SendEmail parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "408": description: Tempo de reposta do servidor excedeu o limite (60s) "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices/{id}/pdf: get: tags: - ServiceInvoices summary: Download do PDF da Nota Fiscal de Serviço (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_GetDocumentPdf parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "404": description: Não foi possivel o download "408": description: Tempo de reposta do servidor excedeu o limite (60s) "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v1/companies/{company_id}/serviceinvoices/{id}/xml: get: tags: - ServiceInvoices summary: Download do XML da Nota Fiscal de Serviço (NFSE) description: Você precisará do APIKEY da Empresa operationId: ServiceInvoices_GetDocumentXml parameters: - name: company_id in: path description: ID da empresa required: true schema: type: string - name: id in: path description: ID da Nota Fiscal de Serviço (NFSE) required: true schema: type: string responses: "200": description: Sucesso na requisição content: application/json: schema: type: string "400": description: Algum parametro informado não é válido "401": description: API Key da conta não é valida "404": description: Não foi possivel o download "408": description: Tempo de reposta do servidor excedeu o limite (60s) "500": description: Erro no processamento security: - Authorization_Header: [] Authorization_QueryParam: [] /v2/webhooks/eventtypes: get: tags: - WebHooks summary: Listar os Tipos de Eventos gerados pela plataforma description: "### Informações adicionais\r\n\r\nEventos ocorrem a todo instante na plataforma durante os processamentos e são registrados\r\ncriando notificações para os webhooks ativos e configurados para receber os eventos.\r\n \r\nSão identificados seguindo o padrão **Resource.EventAction**,\r\nonde **Resource**: nome da entidade que gerou o evento;\r\n**EventAction**: nome do evento e ação criados.\r\n\r\nEsse tipos podem ser utilizados como filtro ao criar ou alterar um webhook,\r\nsendo que o filtro determina quais notificações de eventos e ação serão enviadas\r\npara um determinado webhook, ou seja, dependendo de quais filtros são vinculados ao webhook\r\nele só receberá as notificações de evento e ação que correspondem a um ou mais desses filtros." responses: "200": description: Sucesso na consulta do tipos de eventos content: application/json: schema: description: Tipos de Eventos type: object properties: eventTypes: description: Lista de Evento type: array items: description: Tipo de Evento type: object properties: id: description: "Identificador do evento, seguem o padrão **Resource.EventAction**.\r\nOnde **Resource**: nome da entidade que gerou o evento;\r\n**EventAction**: nome do evento e ação criados.\r\nAlguns exemplos **Invoice.Issued** ou **Blob.Updated**" type: string description: description: Descrição para o recurso, evento e ação exemplicando quando e onde eles ocorrem dentro na plataforma. type: string status: format: int32 description: WebHook Filter Status enum: - 0 - 1 type: integer "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] /v2/webhooks: get: tags: - WebHooks summary: Listar os Webhooks description: "### Informações adicionais\r\n \r\nUtilize esta requisição para consultar uma lista de **Webhooks** cadastrados na Conta Autenticada." responses: "200": description: Sucesso na consulta da lista content: application/json: schema: description: Web Hooks type: object properties: webHooks: description: Lista de Web Hook type: array items: description: WebHook (Notificação HTTP) required: - uri type: object properties: id: description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." type: string uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization "403": description: Accesso proibido "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] post: tags: - WebHooks summary: Criar um Webhook description: "### Informações adicionais\r\n \r\nUtilize esta requisição para criar novos **Webhooks** para receber as notificações de eventos ocorridos na plataforma.\r\n \r\nNa criação do **Webhook** a URL informada no cadastro deve ser responsiva, ou seja, deverá responder *(HTTP Status 200 OK)* a uma requisição *(HTTP POST)* que será feita para testar se a URL está operando como normalmente, caso contrario uma mensagem de erro será retornada.\r\n \r\nUm **Webhook** é semelhante a uma assinatura em um *sistema de publicação e assinatura*\r\nque permite ao assinante indicar *quando*, *como* e *onde* as notificações de eventos deve ser despachadas.\r\nUm **Webhook** é registrado e gerenciado por Conta o que significa que cada Conta tem um conjunto separado de ganchos\r\nque podem ser acionados por eventos gerados através de ações executadas por esse Conta.\r\nOu seja, a **Conta da _Empresa A_** não verá os WebHooks disparados por uma ação executada pelo usuário **Conta da _Empresa B_**." requestBody: description: Dados para criar um Web Hook content: application/json: schema: description: Dados para criar um Web Hook type: object properties: webHook: description: Dados para criar um Web Hook required: - uri type: object properties: uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string responses: "201": description: Sucesso na criação da webhook content: application/json: schema: description: Web Hook type: object properties: webHook: description: WebHook (Notificação HTTP) required: - uri type: object properties: id: description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." type: string uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization "403": description: Accesso proibido "404": description: Webhook não encontrado "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] delete: tags: - WebHooks summary: Excluir Todos os Webhooks existentes description: "### Informações adicionais\r\n \r\nUtilize esta requisição para excluir todos os **Webhooks** cadastrados para a Conta Autenticada." responses: "204": description: Sucesso na exclusão dos WebHooks "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization "403": description: Accesso proibido "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] /v2/webhooks/{webhook_id}: get: tags: - WebHooks summary: Consultar um webhook existente description: "### Informações adicionais\r\n \r\nUtilize esta requisição para consultar um **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id**." operationId: RegistrationLookupAction parameters: - name: webhook_id in: path description: ID do webhook a ser consultado required: true schema: type: string responses: "200": description: Sucesso na consulta do webhook content: application/json: schema: description: Web Hook type: object properties: webHook: description: WebHook (Notificação HTTP) required: - uri type: object properties: id: description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." type: string uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization "403": description: Accesso proibido "404": description: Webhook não encontrado "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] put: tags: - WebHooks summary: Alterar um Webhook existente description: "### Informações adicionais\r\n \r\nUtilize esta requisição para alterar os dados do **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado." parameters: - name: webhook_id in: path description: ID do webhook a ser consultado required: true schema: type: string requestBody: description: Dados para alterar o Webhook content: application/json: schema: description: Dados para alterar um Web Hook type: object properties: webHook: description: WebHook (Notificação HTTP) required: - uri type: object properties: id: description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." type: string uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string responses: "200": description: Sucesso na atualização da Webhook content: application/json: schema: description: Web Hook type: object properties: webHook: description: WebHook (Notificação HTTP) required: - uri type: object properties: id: description: "ID exclusivo do WebHook. Este ID pode ser usado para se referir mais tarde ao WebHook no caso de\r\nprecisa ser atualizado ou excluído. O ID é, por padrão, na forma de um GUID." type: string uri: description: A URL onde as notificações dos eventos deverão entregues. type: string secret: description: "Segredo, contendo de 32 até 64 caracteres que será usado gerar o valor\r\ndo **HMAC-SHA1** em hexadecimal que será enviado no cabeçalho HTTP *X-Hub-Signature*.\r\nO HMAC-SHA1 será gerado baseado no bytes do corpo do evento de notificação que será enviado." type: string contentType: format: int32 description: WebHook Media Type enum: - 0 - 1 type: integer insecureSsl: description: "Determina se o certificado SSL do host da URL será verificado ao entregar as notificações dos eventos.\r\nDefina como **true** para pular a verificação do certificado SSL, sendo o padrão: **false**." type: boolean status: format: int32 description: WebHook Status enum: - 0 - 1 type: integer filters: description: "Lista de filtros sem distinção entre maiúsculas e minúsculas associado a este webhook. \r\nOs filtros são usados para determinar em quais notificações dos eventos esse WebHook será notificado. \r\nOs valores de filtros suportados pode ser consultados através do requisição do **Tipos de Eventos**." uniqueItems: true type: array items: type: string headers: description: Lista de cabeçalhos HTTP adicionais que serão enviados juntamente com as notificações dos eventos para o webhook. type: object additionalProperties: type: string properties: description: "Lista de propriedades adicionais que não diferenciam maiúsculas de minúsculas que serão enviadas \r\njuntamente com as notificações dos eventos para o webhook como parte do corpo da entidade de solicitação HTTP." type: object additionalProperties: {} createdOn: format: date-time description: Data de criação do webhook type: string modifiedOn: format: date-time description: Data de modificação do webhook type: string "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization "403": description: Accesso proibido "404": description: Webhook não encontrado "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] delete: tags: - WebHooks summary: Excluir um Webhook existente description: "### Informações adicionais\r\n \r\nUtilize esta requisição para excluir o **Webhook** que esteja cadastrado e tenha o ID igual ao parametro **webhook_id** especificado.\r\nA exclusão do **Webhook** não exime o **Webhook** excluído de receber os notificações de eventos, já ocorridos na plataforma, que ainda estejam em processo de retentativa de envio dos gatilhos." parameters: - name: webhook_id in: path description: ID do Webhook a ser excluído required: true schema: type: string responses: "204": description: Sucesso na exclusão da Webhook "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization "403": description: Accesso proibido "404": description: Webhook não encontrado "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] /v2/webhooks/{webhook_id}/pings: put: tags: - WebHooks summary: Criar notificação para Testar um webhook description: "### Informações adicionais\r\n \r\nUtilize esta requisição para criar uma notificação de teste (ping) em um **Webhook** já cadastrado.\r\n\r\nEsta ação irá criar um evento de notificação do tipo ping para o **Webhook** especificado, deste modo você poderá simular o recebimento de uma notificação de teste no **Webhook** cadastrado." parameters: - name: webhook_id in: path description: ID do Webhook a ser testado required: true schema: type: string responses: "204": description: Sucesso ao criar notificação de teste "400": description: Algum parametro informado não é válido, verificar resposta content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string "401": description: Não autorizado, verificar o cabeçalho do HTTP Authorization "403": description: Accesso proibido "404": description: Webhook não encontrado "500": description: Erro no processamento content: application/json: schema: description: Lista de Erros type: object properties: errors: description: Lista de Erros type: array items: description: Erro type: object properties: code: format: int32 description: Código do erro type: integer message: description: Mensagem contendo os detalhes do erro type: string security: - Authorization_Header: [] Authorization_QueryParam: [] components: securitySchemes: Authorization_Header: name: Authorization in: header type: apiKey description: 'Autenticar usando o Cabeçalho HTTP Authorization com sua API Key' Authorization_QueryParam: name: apikey in: query type: apiKey description: 'Autenticar usando o Parametro na URL, exemplo: "/?apikey={APIKEY_TOKEN}"'