Suporte: Criou página com 'A API de importação de créditos deve ser utilizada para cadastrar um ou mais créditos ou débitos para devedores no Recuperador CRM. Os créditos e débitos são valores q...'

2026-02-03T20:18:10Z

Criou página com 'A API de importação de créditos deve ser utilizada para cadastrar um ou mais créditos ou débitos para devedores no Recuperador CRM. Os créditos e débitos são valores q...'

Página nova

A API de importação de créditos deve ser utilizada para cadastrar um ou mais créditos ou débitos para devedores no Recuperador CRM. Os créditos e débitos são valores que podem ser utilizados como desconto em novos acordos.

Endpoint: https://app.recuperador.com.br/api/v1ImportacaoCredDeb

Ação: '''POST'''

Formato: '''JSON'''

Autenticação: enviar o '''token''' da API no campo '''username''' da autenticação '''Basic Auth'''. Deixe o campo password em branco.

== Objeto de entrada ==

{
'''atualizar''': string,
'''email''': string,
'''creddebs''': array de créditos e débitos
}

Seguem informações complementares sobre cada coluna do objeto:

* Atualizar: deve ser preenchido com S para Sim e N para Não. Quando marcado como S, este campo faz o importador atualizar códigos de créditos ou débitos existentes na base de dados com os novos dados.
* E-mail: e-mail que receberá o resultado da importação. Este método é assíncrono, por isso deve-se informar um endereço de e-mail para recebimento do resultado do processamento.
* CredDebs: lista de créditos ou débitos a serem importados. O array deve ser do tipo creddeb, que será descrito abaixo.

== Classe creddeb ==

{
'''id_credor''': int
'''cpf_cnpj''': string,
'''nome_cliente''': string,
'''data''': Date,
'''descricao''': string,
'''valor''': decimal,
'''tipo''': string,
'''obs''': string,
'''contrato''': string,
'''unidade''': string,
'''competencia''': string,
'''codigo''': string
}

Seguem informações complementares sobre cada coluna do objeto:

* *ID do credor: aceita apenas valores inteiros e é obrigatório. Ele deve ser preenchido com o código do credor que aparece em Cadastros > Credores.
* *CPF/CNPJ do devedor: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
* *Nome do devedor: aceita no máximo de 40 caracteres e é obrigatório.
* *Código: aceita no máximo 100 caracteres e é obrigatório. Serve para identificar unicamente o crédito no sistema do credor.
* *Data: aceita no máximo 10 caracteres no formato DD/MM/AAAA e é obrigatório.
* Descrição: aceita no máximo 100 caracteres e não é obrigatório.
* *Valor: aceita no máximo 8 dígitos e é obrigatório.
* *Tipo: aceita no máximo 1 dígito e é obrigatório. Use C maiúsculo para crédito. Débitos não podem ser importados.
* Observações: aceita no máximo 4.000 caracteres e não é obrigatório.
* Contrato: aceita no máximo 40 dígitos. Pode ou não ser obrigatório dependendo da parametrização do cadastro do credor.
* Unidade: aceita no máximo 40 dígitos. Pode ou não ser obrigatório dependendo da parametrização do cadastro do credor.
* Competência: aceita no máximo 10 dígitos. Pode ou não ser obrigatório dependendo da parametrização do cadastro do credor.

== Classe de retorno ==

{
'''sucesso''': bool,
'''mensagem''': string
}

Seguem informações complementares sobre cada coluna do objeto:

* Sucesso: retornará true em caso de chamada realizada com sucesso e false em caso de erro na chamada.
* Mensagem: exibirá a mensagem de sucesso ou de erro.

API de importação de créditos - Histórico de revisão

Suporte: Criou página com 'A API de importação de créditos deve ser utilizada para cadastrar um ou mais créditos ou débitos para devedores no Recuperador CRM. Os créditos e débitos são valores q...'