Manifestações da Duplicata (Anotação comercial)

Entenda o webhook enviado quando uma anotação comercial é registrada para uma duplicata.

Você receberá este webhook quando uma anotação comercial for registrada para uma duplicata.

Rota do webhook

A Monkey envia o evento pela rota abaixo:

/trade-instruments

Evento `TradeInstrumentAnnotationIncludedEvent`

O evento possui o tipo COMMERCIAL_NOTE e inclui a anotação comercial no campo annotation.

{
  "_links": {
    "trade-payable": {
      "href": "https://{url do ambiente}/v1/companies/{governmentId}/trade-payables/TRI-000001-2027",
      "type": "GET"
    }
  },
  "type": "COMMERCIAL_NOTE",
  "sponsorGovernmentId": "73068519000185",
  "paymentDate": null,
  "invoicePaymentDate": null,
  "paymentValue": null,
  "invoicePaymentValue": null,
  "tradeRepositoryId": "TRI-000001-2027",
  "annotation": "Anotação teste",
  "acknowledgedAt": 1721444400000,
  "eventType": "TradeInstrumentAnnotationIncludedEvent"
}

Campos do payload

Campo	Tipo	Descrição
`_links.trade-payable.href`	string	URL para consultar a duplicata relacionada à manifestação.
`_links.trade-payable.type`	string	Método HTTP para consultar a duplicata: `GET`.
`type`	string	Tipo da manifestação. Neste webhook, o valor é `COMMERCIAL_NOTE`.
`sponsorGovernmentId`	string	Identificador governamental do sacado.
`paymentDate`	number \| null	Data de pagamento em timestamp Unix, em milissegundos. No exemplo, o valor é `null`.
`invoicePaymentDate`	number \| null	Data de pagamento da nota fiscal em timestamp Unix, em milissegundos. No exemplo, o valor é `null`.
`paymentValue`	number \| null	Valor do pagamento. No exemplo, o valor é `null`.
`invoicePaymentValue`	number \| null	Valor do pagamento da nota fiscal. No exemplo, o valor é `null`.
`tradeRepositoryId`	string	Identificador do instrumento comercial.
`annotation`	string	Texto da anotação comercial. No exemplo, o valor é `Anotação teste`.
`acknowledgedAt`	number	Data e hora do registro da anotação em timestamp Unix, em milissegundos.
`eventType`	string	Nome do evento: `TradeInstrumentAnnotationIncludedEvent`.

Consulte o instrumento comercial

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

Updated 20 days ago

Did this page help you?