Overview

#CobCloud API / Credor

Endpoint:https://api-v3.cob.cloud

Devedor

API responsável por listar e cadastrar devedores e títulos

#Cadastrar Devedor e/ou Título

Adiciona um ou mais devedores e seus respectivos títulos/débitos

Importante: O cadastro do devedor é único por documento (CPF/CNPJ ou Código Externo), baseado do type_check.

Ou seja, o sistema faz uma validação se o devedor já existe na base, e não cadastra em duplicidade.

Quando a flag atualizar não é enviada ou enviada como false, a chave primária do título será devedor + nº do título + parcela + especie + vencimento + valor. Quando é enviada como true, a chave primária do título é devedor + nº do título + parcela + especie.

Caso seja enviado as mesmas informações, o sistema irá ignorar ou atualizar os dados, evitando assim a duplicidade de informações e possíveis cobranças indevidas.

#Request Body

dataobjectoptional

#Responses

string

#Consultar / Listar Devedores

Retorna os dados de um ou mais devedores

#query Parameters

codigo_externostring
Código do devedor no sistema do credor
nomestring
Razão social do devedor
documentostring
CPF/CNPJ do devedor
processostring
Número de controle da assessoria. Cada devedor possui um número único.
situacao_processostring
Define se quer localizar somente processos ativos ou encerrados.
limitint
Quantidade de registros por página
pageint
Página atual

#Responses

messagestringoptional
statusintoptional
valueoptional
Títulos/Débitos do devedor

Títulos

API responsável por listar os títulos / débitos dos devedores

#Baixar / Retirar Título

Baixa um ou mais títulos de devedores

Importante: O cadastro do devedor é único por documento (CPF/CNPJ ou Código Externo), baseado do type_check.

O cadastro do título/débito também é único, baseado no devedor + nº do título + parcela + especie + vencimento + valor. Caso utilize a informação valida_valor = false, a chave primária para localização ignorará o valor.

Se o título já estiver baixado ou não for localizado, o sistema identificará esses casos.

#Request Body

dataobjectoptional

#Responses

string

#Listar Títulos / Débitos

Retorna uma lista de títulos / débitos

#query Parameters

codigo_externostring
Código do devedor no sistema do credor
nomestring
Razão social do devedor
documentostring
CPF/CNPJ do devedor
processostring
Número de controle da assessoria. Cada devedor possui um número único.
statusstring
Status do título
date_typestring
Filtro de tipo de data
date_valuestring
Filtro de data
limitint
Quantidade de registros por página
pageint
Página atual

#Responses

messagestringoptional
statusintoptional
valueoptional
Títulos/Débitos do devedor

Ocorrências

API responsável por listar as ocorrências / contatos realizados com devedores

#Listar Ocorrências

Retorna uma lista de ocorrências / contatos realizados

#query Parameters

codigo_externostring
Código do devedor no sistema do credor
nomestring
Razão social do devedor
documentostring
CPF/CNPJ do devedor
processostring
Número de controle da assessoria. Cada devedor possui um número único.
data_ocorrenciastring
Filtro de data
limitint
Quantidade de registros por página
pageint
Página atual

#Responses

messagestringoptional
statusintoptional
valueoptional
Ocorrências / Contatos com Devedor

Prestações de Contas

API responsável por listar as prestações de contas / pagamentos / repasses

#Listar Prestações

Retorna os pagamentos realizados

#query Parameters

codigo_externostring
Código do devedor no sistema do credor
nomestring
Razão social do devedor
documentostring
CPF/CNPJ do devedor
processostring
Número de controle da assessoria. Cada devedor possui um número único.
numero_repasseint
Filtro de número do repasse. Número sequencial da prestação de contas.
data_repassestring
Filtro de data
local_pagamentostring
Local onde o devedor realizou o pagamento
limitint
Quantidade de registros por página
pageint
Página atual

#Responses

messagestringoptional
statusintoptional
valueoptional
Prestações de Contas / Pagamentos do devedor

Devoluções / Baixas

API responsável por listar os títulos que foram devolvidos sem pagamento

#Listar Devoluções

Retorna uma lista de devoluções e títulos devolvidos

#query Parameters

codigo_externostring
Código do devedor no sistema do credor
nomestring
Razão social do devedor
documentostring
CPF/CNPJ do devedor
processostring
Número de controle da assessoria. Cada devedor possui um número único.
data_devolucaostring
Filtro de data
limitint
Quantidade de registros por página
pageint
Página atual

#Responses

messagestringoptional
statusintoptional
valueoptional
Devoluções / Baixas de Títulos do devedor

POST /cli/devedores/cadastrar

curl --request POST \
  --url https://api-v3.cob.cloud/cli/devedores/cadastrar \
  --data '
{
  "data": {
    "devedores": [
      {
        "campos_adicionais": [
          [
            "PERFIL A",
            "NEGATIVADO"
          ]
        ],
        "codigo_externo": "",
        "documento": "000.000.000-01",
        "emails": [
          {
            "email": "joao@email.com.br",
            "principal": true
          }
        ],
        "enderecos": [
          {
            "bairro": "Centro",
            "cep": "00000-000",
            "cidade": "São Paulo",
            "complemento": "Apto 100",
            "logradouro": "Av. Brasil",
            "numero": "123",
            "principal": true,
            "uf": "SP"
          }
        ],
        "fantasia": "João",
        "razao_social": "João da Silva",
        "telefones": [
          {
            "nome_contato": "",
            "numero": "(48) 99999-0000",
            "tipo": "MÓVEL"
          }
        ],
        "titulos": [
          {
            "atualizar": false,
            "campos_adicionais": [
              [
                ""
              ]
            ],
            "data_doc": "2023-03-01",
            "especie": "Duplicata",
            "numero": "NF 15000",
            "obs": "",
            "parcela": "001",
            "valor": 150.25,
            "vencimento": "2023-03-10"
          }
        ]
      }
    ],
    "type_check": 1
  }
}
'

Show example in

Request Body Example

{
  "data": {
    "devedores": [
      {
        "campos_adicionais": [
          [
            "PERFIL A",
            "NEGATIVADO"
          ]
        ],
        "codigo_externo": "",
        "documento": "000.000.000-01",
        "emails": [
          {
            "email": "joao@email.com.br",
            "principal": true
          }
        ],
        "enderecos": [
          {
            "bairro": "Centro",
            "cep": "00000-000",
            "cidade": "São Paulo",
            "complemento": "Apto 100",
            "logradouro": "Av. Brasil",
            "numero": "123",
            "principal": true,
            "uf": "SP"
          }
        ],
        "fantasia": "João",
        "razao_social": "João da Silva",
        "telefones": [
          {
            "nome_contato": "",
            "numero": "(48) 99999-0000",
            "tipo": "MÓVEL"
          }
        ],
        "titulos": [
          {
            "atualizar": false,
            "campos_adicionais": [
              [
                ""
              ]
            ],
            "data_doc": "2023-03-01",
            "especie": "Duplicata",
            "numero": "NF 15000",
            "obs": "",
            "parcela": "001",
            "valor": 150.25,
            "vencimento": "2023-03-10"
          }
        ]
      }
    ],
    "type_check": 1
  }
}

Example Responses

Sucesso