Webhook de parcelas aprovadas - Histórico de revisão

Suporte em 17h45min de 3 de novembro de 2021

2021-11-03T17:45:27Z

Suporte em 17h44min de 3 de novembro de 2021

2021-11-03T17:44:37Z

Suporte em 17h43min de 3 de novembro de 2021

2021-11-03T17:43:08Z

Suporte em 17h41min de 3 de novembro de 2021

2021-11-03T17:41:32Z

Suporte em 17h40min de 3 de novembro de 2021

2021-11-03T17:40:21Z

Suporte em 17h22min de 3 de novembro de 2021

2021-11-03T17:22:59Z

Suporte em 17h19min de 3 de novembro de 2021

2021-11-03T17:19:55Z

Suporte: Criou página com 'Neste capítulo, falaremos sobre como ativar e utilizar o módulo de webhook de parcelas aprovadas. Este módulo serve para integrar sistemas de terceiros com a baixa de parce...'

2021-11-03T17:19:43Z

Criou página com 'Neste capítulo, falaremos sobre como ativar e utilizar o módulo de webhook de parcelas aprovadas. Este módulo serve para integrar sistemas de terceiros com a baixa de parce...'

Página nova

Neste capítulo, falaremos sobre como ativar e utilizar o módulo de webhook de parcelas aprovadas. Este módulo serve para integrar sistemas de terceiros com a baixa de parcelas de acordo no Recuperador CRM.

Em resumo, o objetivo desse módulo é disparar automaticamente uma mensagem em formato POST para um sistema de terceiros com dados sobre a parcela de acordo aprovada. Isso permitirá com que o sistema de terceiros faça alguma ação, tais como cadastrar uma fatura, liberar um bloqueio, remover uma negativação etc.

== Configuração inicial ==

O primeiro passo é habilitar o webhook de parcelas aprovadas no cadastro do credor em questão. Isso pode ser feito logado como administrador (assessoria) por meio do menu '''Cadastros > Credores > aba Webhooks'''. Mude o campo '''HABILITA WEBHOOK DE PARCELAS APROVADAS''' para '''Sim''', defina o endereço do endpoint do sistema de terceiros e clique em '''Salvar'''.

== Locais de disparo do webhook de parcelas aprovadas ==

Os webhooks de parcelas aprovadas serão disparados automaticamente sempre que:

# Uma parcela de acordo for aprovada automaticamente na Zoop;
# Uma parcela de acordo for aprovada automaticamente na Pagar.me;
# Uma parcela de acordo for aprovada automaticamente no retorno de boletos próprios;
# Uma parcela de acordo for baixada manualmente;

Além disso, o sistema fará uma retentativa diária de disparo de webhooks não processados nos últimos 7 dias na parte da manhã. O sistema faz até 5 tentativas de envio de webhook de uma parcela aprovada para o sistema de terceiros.

== Relatório ==

Em '''Cadastros > Credores > aba Webhooks > botão Lista de payloads de parcelas aprovadas''', é possível consultar os disparos dos webhooks de parcelas aprovadas por período e o status do envio por meio da coluna Enviado.

Além disso, é possível usar o botão '''Reprocessar''' para forçar o envio dos webhooks de parcelas aprovadas um determinado período que eventualmente não foram enviadas. Isso pode ser especialmente útil em caso de queda temporária do sistema de terceiros.

[[Arquivo:ListaPayloadsParcelasAprovadas.png | none | 900px]]
''[[:imagem:ListaPayloadsParcelasAprovadas.png| Lista de payloads de parcelas aprovadas com destaque para a coluna Enviado e botão Reprocessar ]]''

== Classe do payload ==

← Edição anterior		Edição das 17h45min de 3 de novembro de 2021
Linha 2:		Linha 2:


−	Em resumo, o objetivo desse módulo é disparar automaticamente uma mensagem em formato POST para um sistema de terceiros com dados sobre a parcela de acordo aprovada. Isso permitirá com que o sistema de terceiros faça ~~alguma ação~~, tais como cadastrar uma fatura, liberar um bloqueio, remover uma negativação etc.	+	Em resumo, o objetivo desse módulo é disparar automaticamente uma mensagem em formato POST para um sistema de terceiros com dados sobre a parcela de acordo aprovada. Isso permitirá com que o sistema de terceiros faça algumam ações, tais como cadastrar uma fatura, liberar um bloqueio, remover uma negativação etc.

@@ Linha 55: / Linha 55: @@
 *'''string nome_credor''': nome do credor;
 *'''DatTime data_vencto''': data de vencimento da parcela de acordo;
-*DateTime data_pagto: data de pagamento da parcela de acordo;
+*'''DateTime data_pagto''': data de pagamento da parcela de acordo;
-*string meio_pagto: nome do meio de pagamento utilizado. Válido apenas se houver integração com Zoop ou Pagar.me;
+*'''string meio_pagto''': nome do meio de pagamento utilizado. Válido apenas se houver integração com Zoop ou Pagar.me;
-*string forma_pagto: nome da forma de pagamento utilizada. Válido apenas se houver integração com Zoop ou Pagar.me;
+*'''string forma_pagto''': nome da forma de pagamento utilizada. Válido apenas se houver integração com Zoop ou Pagar.me;
-*string parcela: código da parcela do acordo. Exemplo: 01/12 para parcela 1 de 12.
+*'''string parcela''': código da parcela do acordo. Exemplo: 01/12 para parcela 1 de 12.
-*decimal valor_principal_proporcional: valor do principal (original) dividido pela quantidade de parcelas acordadas;
+*'''decimal valor_principal_proporcional''': valor do principal (original) dividido pela quantidade de parcelas acordadas;
-*decimal valor_pago: valor pago pelo devedor;
+*'''decimal valor_pago''': valor pago pelo devedor;
-*decimal valor_honorarios_adv: valor negociado de honorários advocaticios, quando aplicáveis;
+*'''decimal valor_honorarios_adv''': valor negociado de honorários advocaticios, quando aplicáveis;
-*decimal valor_honorarios_ass: valor negociado de honorários da assessoria, quando aplicáveis;
+*'''decimal valor_honorarios_ass''': valor negociado de honorários da assessoria, quando aplicáveis;
-*decimal valor_liquido: valor líquido a ser repassado para o credor, desconsiderando comissões;
+*'''decimal valor_liquido''': valor líquido a ser repassado para o credor, desconsiderando comissões;
-*decimal valor_taxa_adm_agrupada: valor da taxa administrativa (comissões) da assessoria;
+*'''decimal valor_taxa_adm_agrupada''': valor da taxa administrativa (comissões) da assessoria;
-*string contratos: lista de códigos de contrato das dívidas negociadas no acordo desta parcela. Se houver mais de um código de contrato, eles serão separados por vírgula;
+*'''string contratos''': lista de códigos de contrato das dívidas negociadas no acordo desta parcela. Se houver mais de um código de contrato, eles serão separados por vírgula;
-*string unidades: lista de códigos de unidade das dívidas negociadas no acordo desta parcela. Se houver mais de um código de unidade, eles serão separados por vírgula;
+*'''string unidades''': lista de códigos de unidade das dívidas negociadas no acordo desta parcela. Se houver mais de um código de unidade, eles serão separados por vírgula;
-*string competencias: lista de datas de competência das dívidas negociadas no acordo desta parcela. Se houver mais de uma data de competência, elas serão separados por vírgula;
+*'''string competencias''': lista de datas de competência das dívidas negociadas no acordo desta parcela. Se houver mais de uma data de competência, elas serão separados por vírgula;
-*decimal valor_juros_proporcionais: valor dos juros cobrados no acordo dividido pela quantidade de parcelas acordadas;
+*'''decimal valor_juros_proporcionais''': valor dos juros cobrados no acordo dividido pela quantidade de parcelas acordadas;
-*decimal valor_multa_proporcional: valor da multa cobrados no acordo dividido pela quantidade de parcelas acordadas;
+*'''decimal valor_multa_proporcional''': valor da multa cobrados no acordo dividido pela quantidade de parcelas acordadas;
-*decimal valor_correcao_monetaria_proporcional: valor da correção monetária cobrada no acordo dividido pela quantidade de parcelas acordadas;
+*'''decimal valor_correcao_monetaria_proporcional''': valor da correção monetária cobrada no acordo dividido pela quantidade de parcelas acordadas;

@@ Linha 46: / Linha 46: @@
 O webhook disparará uma ação de POST para o endpoint informado no formato JSON com os seguintes campos:
-*int id: código do webhook;
+*'''int id''': código do webhook;
-*int id_credor: código do credor;
+*'''int id_credor''': código do credor;
-*int id_acordo: código do acordo referente à parcela aprovada;
+*'''int id_acordo''': código do acordo referente à parcela aprovada;
-*int id_cliente: código do cliente ;
+*'''int id_cliente''': código do cliente ;
-*int id_parcela: código da parcela de acordo aprovada;
+*'''int id_parcela''': código da parcela de acordo aprovada;
-*string nome_cliente: nome do devedor;
+*'''string nome_cliente''': nome do devedor;
-*string cpf_cnpj: CPF ou CNPJ formatado do devedor;
+*'''string cpf_cnpj''': CPF ou CNPJ formatado do devedor;
-*string nome_credor: nome do credor;
+*'''string nome_credor''': nome do credor;
-*DatTime data_vencto: data de vencimento da parcela de acordo;
+*'''DatTime data_vencto''': data de vencimento da parcela de acordo;
 *DateTime data_pagto: data de pagamento da parcela de acordo;
 *string meio_pagto: nome do meio de pagamento utilizado. Válido apenas se houver integração com Zoop ou Pagar.me;

@@ Linha 46: / Linha 46: @@
 O webhook disparará uma ação de POST para o endpoint informado no formato JSON com os seguintes campos:
-int id: código do webhook;
+*int id: código do webhook;
-int id_credor: código do credor;
+*int id_credor: código do credor;
-int id_acordo: código do acordo referente à parcela aprovada;
+*int id_acordo: código do acordo referente à parcela aprovada;
-int id_cliente: código do cliente ;
+*int id_cliente: código do cliente ;
-int id_parcela: código da parcela de acordo aprovada;
+*int id_parcela: código da parcela de acordo aprovada;
-string nome_cliente: nome do devedor;
+*string nome_cliente: nome do devedor;
-string cpf_cnpj: CPF ou CNPJ formatado do devedor;
+*string cpf_cnpj: CPF ou CNPJ formatado do devedor;
-string nome_credor: nome do credor;
+*string nome_credor: nome do credor;
-DatTime data_vencto: data de vencimento da parcela de acordo;
+*DatTime data_vencto: data de vencimento da parcela de acordo;
-DateTime data_pagto: data de pagamento da parcela de acordo;
+*DateTime data_pagto: data de pagamento da parcela de acordo;
-string meio_pagto: nome do meio de pagamento utilizado. Válido apenas se houver integração com Zoop ou Pagar.me;
+*string meio_pagto: nome do meio de pagamento utilizado. Válido apenas se houver integração com Zoop ou Pagar.me;
-string forma_pagto: nome da forma de pagamento utilizada. Válido apenas se houver integração com Zoop ou Pagar.me;
+*string forma_pagto: nome da forma de pagamento utilizada. Válido apenas se houver integração com Zoop ou Pagar.me;
-string parcela: código da parcela do acordo. Exemplo: 01/12 para parcela 1 de 12.
+*string parcela: código da parcela do acordo. Exemplo: 01/12 para parcela 1 de 12.
-decimal valor_principal_proporcional: valor do principal (original) dividido pela quantidade de parcelas acordadas;
+*decimal valor_principal_proporcional: valor do principal (original) dividido pela quantidade de parcelas acordadas;
-decimal valor_pago: valor pago pelo devedor;
+*decimal valor_pago: valor pago pelo devedor;
-decimal valor_honorarios_adv: valor negociado de honorários advocaticios, quando aplicáveis;
+*decimal valor_honorarios_adv: valor negociado de honorários advocaticios, quando aplicáveis;
-decimal valor_honorarios_ass: valor negociado de honorários da assessoria, quando aplicáveis;
+*decimal valor_honorarios_ass: valor negociado de honorários da assessoria, quando aplicáveis;
-decimal valor_liquido: valor líquido a ser repassado para o credor, desconsiderando comissões;
+*decimal valor_liquido: valor líquido a ser repassado para o credor, desconsiderando comissões;
-decimal valor_taxa_adm_agrupada: valor da taxa administrativa (comissões) da assessoria;
+*decimal valor_taxa_adm_agrupada: valor da taxa administrativa (comissões) da assessoria;
-string contratos: lista de códigos de contrato das dívidas negociadas no acordo desta parcela. Se houver mais de um código de contrato, eles serão separados por vírgula;
+*string contratos: lista de códigos de contrato das dívidas negociadas no acordo desta parcela. Se houver mais de um código de contrato, eles serão separados por vírgula;
-string unidades: lista de códigos de unidade das dívidas negociadas no acordo desta parcela. Se houver mais de um código de unidade, eles serão separados por vírgula;
+*string unidades: lista de códigos de unidade das dívidas negociadas no acordo desta parcela. Se houver mais de um código de unidade, eles serão separados por vírgula;
-string competencias: lista de datas de competência das dívidas negociadas no acordo desta parcela. Se houver mais de uma data de competência, elas serão separados por vírgula;
+*string competencias: lista de datas de competência das dívidas negociadas no acordo desta parcela. Se houver mais de uma data de competência, elas serão separados por vírgula;
-decimal valor_juros_proporcionais: valor dos juros cobrados no acordo dividido pela quantidade de parcelas acordadas;
+*decimal valor_juros_proporcionais: valor dos juros cobrados no acordo dividido pela quantidade de parcelas acordadas;
-decimal valor_multa_proporcional: valor da multa cobrados no acordo dividido pela quantidade de parcelas acordadas;
+*decimal valor_multa_proporcional: valor da multa cobrados no acordo dividido pela quantidade de parcelas acordadas;
-decimal valor_correcao_monetaria_proporcional: valor da correção monetária cobrada no acordo dividido pela quantidade de parcelas acordadas;
+*decimal valor_correcao_monetaria_proporcional: valor da correção monetária cobrada no acordo dividido pela quantidade de parcelas acordadas;

← Edição anterior		Edição das 17h40min de 3 de novembro de 2021
Linha 42:		Linha 42:


−	== Classe do payload ==	+	== Classe do evento do payload ==
		+
		+	O webhook disparará uma ação de POST para o endpoint informado no formato JSON com os seguintes campos:
		+
		+	int id: código do webhook;
		+	int id_credor: código do credor;
		+	int id_acordo: código do acordo referente à parcela aprovada;
		+	int id_cliente: código do cliente ;
		+	int id_parcela: código da parcela de acordo aprovada;
		+	string nome_cliente: nome do devedor;
		+	string cpf_cnpj: CPF ou CNPJ formatado do devedor;
		+	string nome_credor: nome do credor;
		+	DatTime data_vencto: data de vencimento da parcela de acordo;
		+	DateTime data_pagto: data de pagamento da parcela de acordo;
		+	string meio_pagto: nome do meio de pagamento utilizado. Válido apenas se houver integração com Zoop ou Pagar.me;
		+	string forma_pagto: nome da forma de pagamento utilizada. Válido apenas se houver integração com Zoop ou Pagar.me;
		+	string parcela: código da parcela do acordo. Exemplo: 01/12 para parcela 1 de 12.
		+	decimal valor_principal_proporcional: valor do principal (original) dividido pela quantidade de parcelas acordadas;
		+	decimal valor_pago: valor pago pelo devedor;
		+	decimal valor_honorarios_adv: valor negociado de honorários advocaticios, quando aplicáveis;
		+	decimal valor_honorarios_ass: valor negociado de honorários da assessoria, quando aplicáveis;
		+	decimal valor_liquido: valor líquido a ser repassado para o credor, desconsiderando comissões;
		+	decimal valor_taxa_adm_agrupada: valor da taxa administrativa (comissões) da assessoria;
		+	string contratos: lista de códigos de contrato das dívidas negociadas no acordo desta parcela. Se houver mais de um código de contrato, eles serão separados por vírgula;
		+	string unidades: lista de códigos de unidade das dívidas negociadas no acordo desta parcela. Se houver mais de um código de unidade, eles serão separados por vírgula;
		+	string competencias: lista de datas de competência das dívidas negociadas no acordo desta parcela. Se houver mais de uma data de competência, elas serão separados por vírgula;
		+	decimal valor_juros_proporcionais: valor dos juros cobrados no acordo dividido pela quantidade de parcelas acordadas;
		+	decimal valor_multa_proporcional: valor da multa cobrados no acordo dividido pela quantidade de parcelas acordadas;
		+	decimal valor_correcao_monetaria_proporcional: valor da correção monetária cobrada no acordo dividido pela quantidade de parcelas acordadas;

← Edição anterior		Edição das 17h22min de 3 de novembro de 2021
Linha 3:		Linha 3:

	Em resumo, o objetivo desse módulo é disparar automaticamente uma mensagem em formato POST para um sistema de terceiros com dados sobre a parcela de acordo aprovada. Isso permitirá com que o sistema de terceiros faça alguma ação, tais como cadastrar uma fatura, liberar um bloqueio, remover uma negativação etc.		Em resumo, o objetivo desse módulo é disparar automaticamente uma mensagem em formato POST para um sistema de terceiros com dados sobre a parcela de acordo aprovada. Isso permitirá com que o sistema de terceiros faça alguma ação, tais como cadastrar uma fatura, liberar um bloqueio, remover uma negativação etc.
		+
		+
		+	Dica: sistema de terceiros é um sistema feito por outra empresa, diferente da empresa responsável pelo Recuperador CRM, que receberá as informações da parcela aprovada. Esse sistema de terceiros pode ser um sistema de gestão, pode ser um sistema próprio etc.


Linha 8:		Linha 11:

	O primeiro passo é habilitar o webhook de parcelas aprovadas no cadastro do credor em questão. Isso pode ser feito logado como administrador (assessoria) por meio do menu '''Cadastros > Credores > aba Webhooks'''. Mude o campo '''HABILITA WEBHOOK DE PARCELAS APROVADAS''' para '''Sim''', defina o endereço do endpoint do sistema de terceiros e clique em '''Salvar'''.		O primeiro passo é habilitar o webhook de parcelas aprovadas no cadastro do credor em questão. Isso pode ser feito logado como administrador (assessoria) por meio do menu '''Cadastros > Credores > aba Webhooks'''. Mude o campo '''HABILITA WEBHOOK DE PARCELAS APROVADAS''' para '''Sim''', defina o endereço do endpoint do sistema de terceiros e clique em '''Salvar'''.
		+
		+
		+	Importante: o endpoint do webhook de parcelas aprovadas deve ser obtido com o suporte do seu sistema de terceiros. Ele deve começar com http ou https.

@@ Linha 13: / Linha 13: @@
 Os webhooks de parcelas aprovadas serão disparados automaticamente sempre que:
 # Uma parcela de acordo for aprovada automaticamente na Zoop;
@@ Linha 18: / Linha 19: @@
 # Uma parcela de acordo for aprovada automaticamente no retorno de boletos próprios;
 # Uma parcela de acordo for baixada manualmente;
 Além disso, o sistema fará uma retentativa diária de disparo de webhooks não processados nos últimos 7 dias na parte da manhã. O sistema faz até 5 tentativas de envio de webhook de uma parcela aprovada para o sistema de terceiros.