gestaoParcelas

Link raiz

{GRP}/tributacao/gestaoParcelas


Estes serviços serão acessíveis apenas com apresentação de um "token" obtido pela URL:

<protocolo>://<host>:<porta>/<contexto>/service/autenticacao/

apresentando no corpo do pacote o seguinte objeto JSON:

{"usuario":"usuario","senha":"senha","origem":"","uuid":""}

Os campos "origem" e "UUID" devem ser passados em branco, pois serão utilizados para outras finalidades.

O Token resultado desta chamada deve ser apresentado no cabeçalho de cada requisição, via campo entitulado "Authorization".

Serviços Disponíveis


  • Set Parcelas (/setParcela)

Permitir a gestão de parcelas dos contratos via WebServices. Nesse serviço o método de chamada é o POST. O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON. O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

Verificar documentação complementar em I:\public\Thema\Projeto\GRP\TRI\webService\Integração - FUNCAP - Gestão de Parcelas.odt

Header:

    key:Authorization  value:{   "token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c3VhcmlvIjoiZ3VzdGF2byIsInNlbmhhIjoidGhlbWEiLCJvcmlnZW0iOiJhcHBfY29ycyIsInV1aWQiOiI5NDQ3NDc0NzQ0MjEzMjEyMzEiLCJzZXJ2aWNvcyI6bnVsbCwiZGF0YURhQXV0ZW50aWNhY2FvIjoxNDc2MTE3NjQyNDA2fQ.EYcudb5jS0Rz8CAcaKyrz5Rg6QBeZXH1amEhHli6ozw" }

Json Body REQUEST:

 {
  "numeroParcela": 2,
  "acao": "1",
  "codigoTributo": "41",
  "dataVencimento": "2017-01-02",
  "dataValidade": "2017-03-02",
  "valorParcela": 500.00,
  "valorJuros": 0,
  "valorMulta": 0,
  "valorCorrecao": 0,
  "numeroContrato": 20161003,
  "inscricaoCadastroGeral": 206829
 }

Json Body RESPONSE:

 {
  "identificadorParcela": 3590772,
  "retorno": true
 }


NOTA: Para acessar esse serviço o usuário deverá ter acesso aos programas: 688489 - Autenticação e 688481 - Set Parcelas



  • Get Parcela Paga (/getParcelaPaga/{dataInicial}/{dataFinal})

Permitir a consulta de dados das parcelas pagas via WebServices. Nesse serviço o método de chamada é o GET. O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é TEXT_PLAIN. O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

Os atributos dataInicial e dataFinal devem ser passados na url da chamada.

Verificar documentação complementar em I:\public\Thema\Projeto\GRP\TRI\webService\Integração - FUNCAP - Atualiza Guia Pagamento.odt

Header:

    key:Authorization  value:{   "token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c3VhcmlvIjoiZ3VzdGF2byIsInNlbmhhIjoidGhlbWEiLCJvcmlnZW0iOiJhcHBfY29ycyIsInV1aWQiOiI5NDQ3NDc0NzQ0MjEzMjEyMzEiLCJzZXJ2aWNvcyI6bnVsbCwiZGF0YURhQXV0ZW50aWNhY2FvIjoxNDc2MTE3NjQyNDA2fQ.EYcudb5jS0Rz8CAcaKyrz5Rg6QBeZXH1amEhHli6ozw" }


Json Body RESPONSE:

  [
   {
    "identificadorParcela": 3151572,
    "dataPagamento": "2016-03-24",
    "valorPago": 246.3,
    "codigoLotePagamento": "CX2",
    "numeroMovimento": 1,
    "valorPagoMaior": 0,
    "descricaoErroBaixaArquivo": "Valor pago a menor"
  },
  {
    "identificadorParcela": 3151580,
    "dataPagamento": "2016-03-24",
    "valorPago": 66.1,
    "codigoLotePagamento": "CX2",
    "numeroMovimento": 1,
    "valorPagoMaior": 0,
    "descricaoErroBaixaArquivo": null
  }
 ]


NOTA: Para acessar esse serviço o usuário deverá ter acesso aos programas: 688489 - Autenticação e 688482 - Get Parcela Paga



  • Set Parcela Lote (/setParcelaLote)

Permitir a gestão de parcelas em lote via WebServices. Nesse serviço o método de chamada é o POST. O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON. O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

Verificar documentação complementar em I:\public\Thema\Projeto\GRP\TRI\webService\Integração - FUNCAP - Gestão de Parcelas.odt

Header:

    key:Authorization  value:{   "token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c3VhcmlvIjoiZ3VzdGF2byIsInNlbmhhIjoidGhlbWEiLCJvcmlnZW0iOiJhcHBfY29ycyIsInV1aWQiOiI5NDQ3NDc0NzQ0MjEzMjEyMzEiLCJzZXJ2aWNvcyI6bnVsbCwiZGF0YURhQXV0ZW50aWNhY2FvIjoxNDc2MTE3NjQyNDA2fQ.EYcudb5jS0Rz8CAcaKyrz5Rg6QBeZXH1amEhHli6ozw" }

Json Body REQUEST:

 [
     {
      "identificadorParcela": null,
      "numeroParcela": 2,
      "acao": "1",
      "codigoTributo": "41",
      "dataVencimento": "2016-11-17",
      "dataValidade": "2017-02-17",
      "valorParcela": 199,
      "valorJuros": 0,
      "valorMulta": 0,
      "valorCorrecao": 0,
      "numeroContrato": 20161117,
      "inscricaoCadastroGeral": 6039047
     }
 ]

Json Body RESPONSE:

 [
  {
   "identificadorParcela": 3590847,
   "numeroParcela": 2,
   "acao": 1,
   "dataVencimento": "2016-11-17",
   "valorParcela": 199,
   "valorJuros": 0,
   "valorMulta": 0,
   "valorCorrecao": 0,
   "numeroContrato": 20161117,
   "inscricaoCadastroGeral": 6039047,
   "observacao": null,
   "login": null,
   "codigoTributo": "41",
   "dataValidade": "2017-02-17"
  }
 ]


NOTA: Para acessar esse serviço o usuário deverá ter acesso aos programas: 688489 - Autenticação e 688483 - Set Parcela Lote