Manifestações da Duplicata (Recusa)

Entenda o webhook enviado quando uma manifestação de recusa é registrada para uma duplicata.

Você receberá este webhook quando uma manifestação de recusa for registrada para uma duplicata.

Rota do webhook

A Monkey envia o evento pela rota abaixo:

/trade-instruments

Evento TradeInstrumentRefusedEvent

O evento possui o tipo REFUSAL_DUE_TO_AMOUNT_DISCREPANCY ou REFUSAL_DUE_TO_DAMAGE ou REFUSAL_DUE_TO_QUALITY_OR_QUANTITY ou REFUSAL_DUE_TO_DUE_DATE_DISCREPANCY ou REFUSAL_DUE_TO_AMOUNT_DISCREPANCY ou REFUSAL_DUE_TO_UNKNOWN_TRANSACTION, que indica uma recusa por divergência de valor. Os campos paymentValue e invoicePaymentValue apresentam os valores informados no evento.

{
  "_links": {
    "trade-payable": {
      "href": "https://{url do ambiente}/v1/companies/{governmentId}/trade-payables/TRI-000001-2027",
      "type": "GET"
    }
  },
  "type": "REFUSAL_DUE_TO_AMOUNT_DISCREPANCY|REFUSAL_DUE_TO_DAMAGE|REFUSAL_DUE_TO_QUALITY_OR_QUANTITY|REFUSAL_DUE_TO_DUE_DATE_DISCREPANCY|REFUSAL_DUE_TO_AMOUNT_DISCREPANCY|REFUSAL_DUE_TO_UNKNOWN_TRANSACTION",
  "sponsorGovernmentId": "73068519000185",
  "paymentDate": null,
  "invoicePaymentDate": null,
  "paymentValue": 560,
  "invoicePaymentValue": 500,
  "tradeRepositoryId": "TRI-000001-2027",
  "annotation": "Divergência de valor",
  "acknowledgedAt": 1721444400000,
  "eventType": "TradeInstrumentRefusedEvent"
}

Campos do payload

CampoTipoDescrição
_links.trade-payable.hrefstringURL para consultar a duplicata relacionada à manifestação.
_links.trade-payable.typestringMétodo HTTP para consultar a duplicata: GET.
typestringTipo da manifestação. Neste webhook, os possívels valores podem ser: REFUSAL_DUE_TO_AMOUNT_DISCREPANCY|REFUSAL_DUE_TO_DAMAGE|REFUSAL_DUE_TO_QUALITY_OR_QUANTITY|REFUSAL_DUE_TO_DUE_DATE_DISCREPANCY|REFUSAL_DUE_TO_AMOUNT_DISCREPANCY|REFUSAL_DUE_TO_UNKNOWN_TRANSACTION.
sponsorGovernmentIdstringIdentificador governamental do sacado.
paymentDatenumber | nullData de pagamento em timestamp Unix, em milissegundos. No exemplo, o valor é null.
invoicePaymentDatenumber | nullData de pagamento da nota fiscal em timestamp Unix, em milissegundos. No exemplo, o valor é null.
paymentValuenumber | nullValor do pagamento informado na manifestação. No exemplo, o valor é 560.
invoicePaymentValuenumber | nullValor do pagamento da nota fiscal informado na manifestação. No exemplo, o valor é 500.
tradeRepositoryIdstringIdentificador da duplicata.
annotationstringAnotação associada à recusa. No exemplo, informa Divergência de valor.
acknowledgedAtnumberData e hora da recusa em timestamp Unix, em milissegundos.
eventTypestringNome do evento: TradeInstrumentRefusedEvent.

Consulte o instrumento comercial

Envie uma requisição GET para _links.trade-payable.href para consultar os detalhes do instrumento comercial relacionado ao evento.


Did this page help you?