Criar processo

HML Env

https://tjscscpphml.thema.inf.br

POST

/infra/apigw/tributacao/scpp/processos

Última modificação:2024-10-01 18:19:04

Este serviço será utilizado na criação do processo de cobrança, que incluirá as dívidas vinculadas ao devedor previamente cadastrado.

Poderão ser enviadas diversas dívidas de uma única vez, desde que sejam do mesmo devedor e tributo.

Para cada envio será retornada uma chave de processo. Esta chave deve ser devidamente armazenada, uma vez que será necessária posteriormente para a consulta de pagamentos, verificação da situação ou exclusão do processo.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/json

tributo

enum<string>

requerido

Código do tributo a ser cobrado

Valores permitidos:

001 - IPTU003 - ISS Variável007 - ISS Fixo

identificacao

string

requerido

Identificação do Imóvel ou Empresa na Prefeitura

<= 20 Caracteres

descricaoDivida

string

requerido

<= 1000 Caracteres

cpfCnpjDevedor

string

requerido

dataReferencia

string

requerido

Essa data deve ser uma data futura, e os valores de juros, multa e correção devem ser enviados já calculados até ela

Padrão de combinação:

yyyy-mm-dd

protesta

enum<string>

requerido

Define se ocorrerá o protesto após os procedimentos de cobrança

Valores permitidos:

S - SimN - Não

cda

string

requerido

Número da certidão de dívida ativa

<= 100 Caracteres

dividas

array [object {11}]

requerido

dataVencimento

string

requerido

Data original de vencimento

Padrão de combinação:

yyyy-mm-dd

chaveUnicaPrefeitura

integer

requerido

É o código que identifica o débito. Este campo é utilizado para evitar a importação e cobrança duplicada e utilizada na atualização monetária

exercicio

string

requerido

Ano de lançamento do tributo

numeroParcela

integer

requerido

valorOriginal

number <float>

requerido

valorCorrecao

number <float>

requerido

Valor da correção até a data de referência

valorMulta

number <float>

requerido

Valor de multa até a data de referência

valorJuro

number <float>

requerido

Valor de juro até a data de referência

valorEncargoLegal

number <float>

requerido

Encargo legal até a data de referência

dataDeclaracao

string

opcional

No caso de dívidas auto declaradas, deverá ser informada a data da declaração

Padrão de combinação:

yyyy-mm-dd

observacao

string

opcional

<= 100 Caracteres

Exemplo

{
  "tributo": "001",
  "identificacao": "939",
  "descricaoDivida": "IPTU",
  "cpfCnpjDevedor": "86822250000",
  "dataReferencia": "2026-02-25",
  "protesta": "S",
  "cda": "987654",
  "dividas": [
    {
      "dataVencimento": "2018-03-25",
      "chaveUnicaPrefeitura": 654,
      "exercicio": "2020",
      "numeroParcela": 1,
      "valorOriginal": 100.12,
      "valorCorrecao": 20.15,
      "valorMulta": 20.15,
      "valorJuro": 10.37,
      "valorEncargoLegal": 5.1,
      "dataDeclaracao": "2018-09-15",
      "observacao": "IPTU não pago de 2018"
    }
  ]
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://tjscscpphml.thema.inf.br/infra/apigw/tributacao/scpp/processos' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tributo": "001",
  "identificacao": "939",
  "descricaoDivida": "IPTU",
  "cpfCnpjDevedor": "86822250000",
  "dataReferencia": "2026-02-25",
  "protesta": "S",
  "cda": "987654",
  "dividas": [
    {
      "dataVencimento": "2018-03-25",
      "chaveUnicaPrefeitura": 654,
      "exercicio": "2020",
      "numeroParcela": 1,
      "valorOriginal": 100.12,
      "valorCorrecao": 20.15,
      "valorMulta": 20.15,
      "valorJuro": 10.37,
      "valorEncargoLegal": 5.1,
      "dataDeclaracao": "2018-09-15",
      "observacao": "IPTU não pago de 2018"
    }
  ]
}'

Respostas

🟢200Success

application/json

Body

chaveProcesso

string

requerido

Exemplo

{
    "chaveProcesso": "16590"
}

🟠400Requisição inválida

Modificado em 2024-10-01 18:19:04