Duplicata vinculada a uma nota (Matched)

Entenda o webhook enviado quando uma duplicata é vinculada a uma nota fiscal.

Você receberá este webhook quando uma duplicata for vinculada a uma nota fiscal.

Rota do webhook

A Monkey envia o evento pela rota abaixo:

/trade-instruments

Evento `TradeInstrumentMatchedEvent`

O evento possui o tipo MATCHED e identifica o vínculo da duplicata pelos campos invoiceUuid e tradeRepositoryId.

{
  "_links": {
    "payable": {
      "href": "https://{url do ambiente}/v1/companies/{governmentId}/payables/A2H1S2KS",
      "type": "GET"
    },
    "trade-payable": {
      "href": "https://{url do ambiente}/v1/companies/{governmentId}/trade-payables/TRI-000001-2027",
      "type": "GET"
    }
  },
  "type": "MATCHED",
  "tradeRepositoryId": "TRI-000001-2027",
  "sponsorGovernmentId": "73068519000185",
  "sellerName": "Monkey Company - Seller",
  "sellerGovernmentId": "12292693000112",
  "assetType": "DUPLICATA_MERCANTIL",
  "externalId": "EXT-001",
  "invoiceDate": 1782788400000,
  "invoiceNumber": "FAT-2026-001",
  "invoiceValue": 15000,
  "installment": "1",
  "paymentDate": 1785812400000,
  "paymentValue": 5100,
  "invoiceUuid": "A2H1S2KS",
  "eventType": "TradeInstrumentMatchedEvent"
}

Campos do payload

Campo	Tipo	Descrição
`_links.payable.href`	string	URL para consultar a conta a pagar vinculada.
`_links.payable.type`	string	Método HTTP da consulta da conta a pagar: `GET`.
`_links.trade-payable.href`	string	URL para consultar a duplicata vinculada.
`_links.trade-payable.type`	string	Método HTTP da consulta da duplicata `GET`.
`type`	string	Tipo do vínculo. Neste evento, o valor é `MATCHED`.
`tradeRepositoryId`	string	Identificador da duplicata.
`sponsorGovernmentId`	string	Identificador governamental do sacado.
`sellerName`	string	Nome do vendedor (sacador).
`sellerGovernmentId`	string	Identificador governamental do vendedor (sacador).
`assetType`	string	Tipo do ativo. No exemplo, `DUPLICATA_MERCANTIL`.
`externalId`	string	Identificador externo da nota fiscal.
`invoiceDate`	number	Data de emissão da nota fiscal em timestamp Unix, em milissegundos.
`invoiceNumber`	string	Número da nota fiscal.
`invoiceValue`	number	Valor total da nota fiscal.
`installment`	string	Número da parcela vinculada.
`paymentDate`	number	Data de vencimento ou pagamento em timestamp Unix, em milissegundos.
`paymentValue`	number	Valor da parcela.
`invoiceUuid`	string	Identificador da nota fiscal.
`eventType`	string	Nome do evento: `TradeInstrumentMatchedEvent`.

Consulte os recursos vinculados

Use as URLs em _links para obter os detalhes dos recursos relacionados ao evento:

Envie uma requisição GET para _links.payable.href para consultar a conta a pagar associada à duplicata.
Envie uma requisição GET para _links.trade-payable.href para consultar o instrumento comercial associado ao vínculo.

Updated 20 days ago

Did this page help you?