API de importação de baixa manual
A API de importação de baixa manual deve ser utilizada para cadastrar uma ou mais baixas para clientes no Recuperador CRM.
Endpoint: https://www.recuperador.com.br/api/v1ImportacaoBaixaManual
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
{
email: string, baixasmanuais: array de baixamanual
}
Seguem informações complementares sobre cada coluna do objeto:
- 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.
- Baixas manuais: lista de baixas a serem importadas. O array deve ser do tipo baixamanual, que será descrito abaixo.
Classe baixamanual
{
id_credor: int id_acordo: int, id_contasareceber: int, cpf_cnpj: string, nome_cliente: string, datavencto: DateTime, datapagto: DateTime, valor_pago: decimal
}
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.
- *ID do acordo: aceita apenas valores inteiros e não é obrigatório. Ele deve ser preenchido com o código do acordo da parcela que aparece em Financeiro > Dívidas.
- *ID do contas a receber: aceita apenas valores inteiros e não é obrigatório. Ele deve ser preenchido com o código da parcela que aparece em Financeiro > Dívidas.
- *CPF/CNPJ: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
- *Nome do cliente: aceita no máximo 40 caracteres e é obrigatório.
- *Data vencto.: aceita no máximo 10 caracteres no formato AAAA-MM-DD e é obrigatório.
- *Data pagto.: aceita no máximo 10 caracteres no formato AAAA-MM-DD e é obrigatório.
- *Valor pago: aceita no máximo 8 dígitos e é obrigatório. Use ponto como separador de decimais.
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.