Pular para conteúdo

Débito/divida

Para manusear os débitos do negativado, precisa ter em mãos os PK do negativado

Endpoints:

  • /negatives/:negative_pk/debts/: lista os débitos vinculados a determinado negativado.
  • /negatives/:negative_pk/debts/pk:uuid/ : detalha, apaga ou atualiza um registro específico, depende do verbo HTTP que esteja sendo utilizado.
  • /negatives/:negative_pk/debts/pk:uuid/down/ : efetua a baixa de uma dívida.

Os débitos, são as informações referente a(s) duplicata(s) que não foram pagas, engloba informações como valores e identificação da duplicada.

Regras básica de validação

  • Só pode existir uma dívida ativa com o mesmo número de contrato.
  • Só pode ser adicionado dívidas já vencidas e que tenha pelo menos 4 dias que a mesma está atrasada.
  • Dívidas vencidas acima de 1795 dias (aproximadamente 4 anos e 11 meses), não pode ser cadastrada.
  • A verificação de número de contrato irá ignorar a diferença entre letras maiúscula e minúscula.
  • Não se pode alterar as informações de uma dívida após a sincronização com a Serasa.
  • Após a sincronização com a Serasa, o único campo que pode ser alterado é o motivo da baixa.
  • Dívidas de cheque tem campos especificos para serem preenchidos e o campo seu número e número de contrato não devem ser informados, nos demais, esses campos se tornam obrigatórios.

Campos do Débito

Campo Tipo Obrigatório Somente leitura Tamanho máximo Observacao
pk String/UUID Não Sim Identifica de forma única o registro.
negative String/UUID Não Sim Identifica o pk do negativado no qual essa dívida está relacionada.
amount Decimal Sim Não 15/2 Valor da dívida. Aceita no máximo 15 dígitos com 2 casas decimais de precisão
operationType String Sim Não 2 Natureza/origem da dívida. As opções disponíves para este campo se encontra em dicionário de dados
ourNumber Inteiro Não Não 999999999 Campo seu número; usado para identificação da dívida no sistema consumidor, podendo ser um número inteiro entre 0 e 999999999, OBS: se for uma dívida de cheque (natureza DC) este campo não deve ser informado.
contractNumber String Sim Não 16 O número do contrato
dueDate Date Sim Não Data de vencimento
reasonLow Inteiro Não Não Motivo da baixa. Preenchido apenas através de uma operação de atualização quando se quer dar baixa na dívida, as opções disponiveis estão em dícionário de dados
isInclusionGenerate Boolean Não Sim Sincronização da inclusão foi efetuada/iniciada
isRemoveGenerate Boolean Não Sim Sincronização da baixa foi efetuada/iniciada. OBS: apenas quando foi dado baixa na dívida

Campos do cheque

Os campos abaixo são de uso exclusivo para cheque, para as demais naturezas, os mesmos não devem ser preenchidos

Campo Tipo Obrigatório Somente leitura Tamanho máximo Observacao
account Inteiro Sim Não 999999999 Número da conta bancária com o máximo de 9 digitos
bank Inteiro Sim Não 999 Código do banco. As opções de banco disponíveis estão em dicionário de dados
agency String Sim Não 4 Agência bancária
alinea Inteiro Sim Não Alínea do cheque. As disponíveis estão em dicionário de dados
checkNumber Inteiro Sim Não 999999 Número do cheque com o máximo de 6 dígitos

Cadastro de uma dívida

Endpoint: https://homolog-pefin.targetinformacoes.com/negatives/:negative_pk/debts/

Cadastro de uma dívida de cheque (DC)
curl -X POST --location "https://homolog-pefin.targetinformacoes.com/negatives/86ac7e08-5cc4-47c7-9266-fb746bbe3a33/debts/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token" \
    -d "{
        \"amount\": \"230.90\",
        \"operationType\": \"DC\",
        \"dueDate\": \"2022-01-30\",
        \"account\": 76497,
        \"bank\": 341,
        \"agency\": 7487,
        \"alinea\": 12,
        \"checkNumber\": 7489
    }"
Demais tipos de dívidas
curl -X POST --location "https://homolog-pefin.targetinformacoes.com/negatives/86ac7e08-5cc4-47c7-9266-fb746bbe3a33/debts/" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer chave_do_access_token" \
-d "{
      \"amount\": \"230.90\",
      \"operationType\": \"AL\",
      \"ourNumber\": 9947,
      \"contractNumber\": \"DEB-04/12\",
      \"dueDate\": \"2022-01-30\"
    }"

Retorno

Retorno cadastro de uma dívida de cheque (DC)
{
    "pk": "f01366f4-f95d-432c-91ff-01765caac209",
    "negative": "86ac7e08-5cc4-47c7-9266-fb746bbe3a33",
    "amount": "230.90",
    "operationType": "DC",
    "ourNumber": null,
    "contractNumber": null,
    "dueDate": "2022-01-30",
    "account": 76497,
    "bank": 341,
    "agency": "7487",
    "alinea": 12,
    "checkNumber": 7489,
    "reasonLow": null
}
Retorno do cadastro de demais tipos de dívidas
{
    "pk": "534da053-5a3d-4e57-aef8-7d57a928c561",
    "negative": "86ac7e08-5cc4-47c7-9266-fb746bbe3a33",
    "amount": "230.90",
    "operationType": "AL",
    "ourNumber": 9947,
    "contractNumber": "DEB-04/12",
    "dueDate": "2022-01-30",
    "account": null,
    "bank": null,
    "agency": null,
    "alinea": null,
    "checkNumber": null,
    "reasonLow": null
}

Listando as dívidas do negativado

Endpoint: https://homolog-pefin.targetinformacoes.com/negatives/:negative_pk/debts/

Listando as dívidas do negativado
curl -X GET --location "https://homolog-pefin.targetinformacoes.com/negatives/86ac7e08-5cc4-47c7-9266-fb746bbe3a33/debts/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token"

Retorno

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": "f01366f4-f95d-432c-91ff-01765caac209",
      "negative": "86ac7e08-5cc4-47c7-9266-fb746bbe3a33",
      "amount": "230.90",
      "operationType": "DC",
      "ourNumber": null,
      "contractNumber": null,
      "dueDate": "2022-01-30",
      "account": 76497,
      "bank": 341,
      "agency": "7487",
      "alinea": 12,
      "checkNumber": 7489,
      "reasonLow": null,
      "isInclusionGenerate": false,
      "isRemoveGenerate": false
    },
    {
      "pk": "f3e1f87e-b9df-4b9f-a6cc-55b5999bd912",
      "negative": "86ac7e08-5cc4-47c7-9266-fb746bbe3a33",
      "amount": "230.90",
      "operationType": "AL",
      "ourNumber": 9947,
      "contractNumber": "DEB-04/12",
      "dueDate": "2022-01-30",
      "account": null,
      "bank": null,
      "agency": null,
      "alinea": null,
      "checkNumber": null,
      "reasonLow": null,
      "isInclusionGenerate": false,
      "isRemoveGenerate": false
    }
  ]
}

Detalhando um registro

Endpoint: https://homolog-pefin.targetinformacoes.com/negatives/:negative_pk/debts/pk:uuid/

Detalhe de um registro cadastrado anteriormente
curl -X GET --location "https://homolog-pefin.targetinformacoes.com/negatives/8c510be2-8cf2-450f-b8c5-860ebc58f46c/debts/33b77ddf-0eb2-401f-ba17-76b6d7e256c3/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token"

Retorno

Retorno do cadastro de uma dívida
{
  "pk": "33b77ddf-0eb2-401f-ba17-76b6d7e256c3",
  "negative": "8c510be2-8cf2-450f-b8c5-860ebc58f46c",
  "amount": "230.90",
  "operationType": "DC",
  "ourNumber": null,
  "contractNumber": null,
  "dueDate": "2022-01-30",
  "account": 76497,
  "bank": 341,
  "agency": "7487",
  "alinea": 12,
  "checkNumber": 7489,
  "reasonLow": 1,
  "isInclusionGenerate": true,
  "isRemoveGenerate": false
}

Para apagar ou atualizar o registro, faça uma requisição igual a descrita em Detalhando um registro alterando apenas o verbo do HTTP para a respectiva necessidade (DELETE para apagar, PUT para atualizar o registro).

OBS: Após inserir o registro e ele ser sincronizado com a Serasa, o mesmo não pode mais ser alterado, apenas dado baixa. Caso precise que as informações que estão na Serasa seja atualizada é necessário efetuar uma baixa e uma nova inclusão do registro.

Efetuando a baixa da dívida

Endpoint: https://homolog-pefin.targetinformacoes.com/negatives/:negative_pk/debts/pk:uuid/down/

Para fazer a baixa da dívida, é necessário fazer uma requisição POST informando o motivo da baixa; caso a dívida seja dada baixa antes de ser efetuado a sincronização com a Serasa, a mesma não será enviada e não haverá comunicado ao mercado sobre a mesma.

Após efetuar a baixa da dívida, não se pode mais alterar a mesma.

Efetuando a baixa da dívida
curl -X POST --location "https://homolog-pefin.targetinformacoes.com/negatives/94adb487-1693-4c14-acee-79816ff26683/debts/f3e1f87e-b9df-4b9f-a6cc-55b5999bd912/down/" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer chave_do_access_token" \
    -d "{
          \"reasonLow\": 1
        }"

Retorno

Retorno da baixa da dívida
{
  "detail": "Dívida baixada com sucesso"
}