Emissão de documentos
Recursos para emissão de documentos
POST https://tributos.suite.betha.cloud/integracoes/v1/documentos/alvaras\
POST https://tributos.suite.betha.cloud/integracoes/v1/documentos/certidoes-negativas\
GET https://tributos.suite.betha.cloud/integracoes/v1/documentos/{protocoloExecucao}\
GET https://tributos.suite.betha.cloud/integracoes/v1/documentos/{protocoloExecucao}/base64\
GET https://tributos.suite.betha.cloud/integracoes/v1/documentos/download/{protocoloExecucao}\
GET https://tributos.suite.betha.cloud/parceiros/v1/documentos/{protocoloExecucao}
Detalhamento dos recursos
A emissão de documentos é feita de forma assíncrona.
Utiliza-se os serviços de POST para solicitar a emissão, informando os dados do documento no body da requisição. Se a requisição for bem sucedida, é retornado o protocolo de execução do documento, o qual deve ser utilizado no serviço de consulta GET por meio de polling até que a emissão finalize.
Ao ser concluída, esse endpoint de consulta retorna os dados completos do documento, assim como um link direto para o arquivo. Caso seja necessário resgatar o conteúdo do arquivo\ em formato base64, pode-se utilizar o endpoint alternativo.
Quanto às APIs de consulta por protocolo, foram disponibilizadas duas similares:
- integracoes/v1/documentos/{protocoloExecucao}\
- parceiros/v1/documentos/{protocoloExecucao}
O que diferencia elas é o seu propósito: a consulta em integrações é destinada a acompanhar o resultado de uma emissão de documento solicitada, enquanto a consulta em parceiros tem por objetivo fornecer os dados completos de cada documento, incluindo propriedades específicas, como a classificacaoCertidao.
A seguir podem ser verificados os atributos disponíveis nas solicitações de emissão de documentos (POSTs):
/alvaras
| CAMPO | DESCRICAO | TIPO |
|---|---|---|
| modelo | Objeto com o id do modelo | Modelo |
| tipoAlvara | Tipo de alvará | LOCALIZACAO,PROVISORIO,SANITARIO |
| dataValidade | Data de validade do documento | LocalDate |
| dataEmissao | Data para emissão retroativa | LocalDate |
| informacoesComplementares | Informações complemantares | String |
| economico | Econômico do alvará | Economico |
Subtipos:
- modelo: Objeto contendo o identificador do modelo de relatório que será utilizado no processo de emissão do documento.
|
|---|
- economico: Objeto contendo um dos dados de identificação do econômico para o qual está sendo emitido o documento
|
|---|
|
|---|
/certidoes-negativas
| CAMPO | DESCRICAO | TIPO |
|---|---|---|
| modelo | Objeto com o id do modelo | Modelo |
| tipoCertidaoNegativa | Tipo de referente da certidão negativa | CONTRIBUINTE, IMOVEL,ECONOMICO |
| dataValidade | Data de validade do documento | LocalDate |
| dataEmissao | Data para emissão retroativa | LocalDate |
| informacoesComplementares | Informações complementares | String |
| comprovacao | Comprovação | String |
| finalidade | Finalidade | String |
| requerente | Requerente | String |
| ressalva | Ressalva | String |
| contribuinte | Contribuinte da certidão | Contribuinte |
| economico | Econômico da certidão | Economico| |
| imovel | Imóvel da certidão | Imovel |
Subtipos:
- modelo: Objeto contendo o identificador de relatório que será utilizado no processo de emissão de documento.
|
|---|
- contribuinte: objeto contendo um dos dados de identificação do contribuinte para certidão negativa do tipo Contribuinte.
|
|---|
- economico: objeto contendo um dos dados de identificação do econômico para certidão negativa do tipo Economico.
|
|---|
- imovel: objeto contendo um dos dados de identificação do imóvel para certidão negativa do tipo Imovel.
|
|---|
|
|---|
Recursos para cancelamento de documentos e reativação de documentos cancelados
POST https://tributos.suite.betha.cloud/parceiros/v1/documentos/cancelar/{protocoloExecucao}
POST https://tributos.suite.betha.cloud/parceiros/v1/documentos/reativar/{protocoloExecucao}
Detalhamento dos recursos
Para ambos os serviços, é necessário ser passado como parâmetro um dos protocolos (Emissao ou Execucao). Esses protocolos são validados, não sendo feito o cancelamento e/ou reativação de protocolos que não existam.
O processo de cancelar e reativar, por ser assíncrono, leva alguns segundos (em caso de alta demanda, poderá levar até alguns minutos), então, entre o cancelamento e a reativação, caso houver necessidade, pode ser utlizado o serviço de consulta/GET para verificar o atual estado do documento.
Além disso, para ambos os serviços poderá ser informado, no corpo da requisição, um json com a observação a ser registrada.