Negociação da Duplicata

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

Rota do webhook

A Monkey envia o evento pela rota abaixo:

/trade-instruments

Evento `TradeInstrumentNegotiatedEvent`

O evento inclui os dados das partes envolvidas na negociação e os instrumentos comerciais negociados no array items.

{
  "_links": {
    "trade-payables": {
      "href": "https://{url do ambiente}/v1/companies/{governmentId}/trade-payables",
      "type": "GET"
    }
  },
  "purchaseId": null,
  "sponsorId": null,
  "sponsorName": null,
  "sponsorGovernmentId": "36751008000137",
  "sellerId": null,
  "sellerName": "Monkey Company - Seller",
  "sellerGovernmentId": "98765432000188",
  "buyerId": null,
  "buyerName": "Banco Monkey",
  "buyerGovernmentId": "11222333000177",
  "buyerReceivementBank": "001",
  "buyerReceivementAgency": "1234",
  "buyerReceivementAccount": "56789",
  "buyerReceivementAccountDigit": "0",
  "buyerReceivementAccountKey": "19999839209",
  "buyerReceivementAccountType": "CHECKING",
  "buyerReceivementAccountKeyType": "PHONE",
  "buyerReceivementSlipCode": "98760000015000",
  "buyerReceivementSlipType": "SIMPLE",
  "buyerReceivementSlipNumber": "1234567",
  "eventType": "TradeInstrumentNegotiatedEvent",
  "items": [
    {
      "_links": {
        "trade-payable": {
          "href": "https://gateway.hmg.caco.tech/v1/companies/36751008000137/trade-payables/TR-1234568",
          "type": "GET"
        }
      },
      "tradeRepositoryId": "TR-1234568",
      "payableUuid": null,
      "status": "SOLD",
      "detail": null,
      "externalId": "EXT-999000",
      "invoiceNumber": "NF-12345",
      "installment": 1,
      "totalInstallment": null,
      "paymentDate": 1703980800000,
      "tax": null,
      "sponsorTax": null,
      "paymentValue": 15000.5,
      "sellerPaymentValue": null,
      "sponsorPaymentValue": null,
      "discountValue": null,
      "subsidyValue": null
    }
  ]
}

Campos do payload

Campo	Tipo	Descrição
`_links.trade-payables.href`	string	URL para consultar a duplicata.
`_links.trade-payables.type`	string	Método HTTP para consultar a duplicata: `GET`.
`purchaseId`	string \| null	Identificador da compra. No exemplo, o valor é `null`.
`sponsorId`	string \| null	Identificador do sacado. No exemplo, o valor é `null`.
`sponsorName`	string \| null	Nome do sacado. No exemplo, o valor é `null`.
`sponsorGovernmentId`	string	Identificador governamental do sacado.
`sellerId`	string \| null	Identificador do vendedor (sacador). No exemplo, o valor é `null`.
`sellerName`	string	Nome do vendedor (sacador).
`sellerGovernmentId`	string	Identificador governamental do vendedor (sacador).
`buyerId`	string \| null	Identificador do comprador. No exemplo, o valor é `null`.
`buyerName`	string	Nome do comprador.
`buyerGovernmentId`	string	Identificador governamental do comprador.
`buyerReceivementBank`	string	Código do banco de recebimento do comprador.
`buyerReceivementAgency`	string	Agência da conta de recebimento do comprador.
`buyerReceivementAccount`	string	Número da conta de recebimento do comprador.
`buyerReceivementAccountDigit`	string	Dígito da conta de recebimento do comprador.
`buyerReceivementAccountKey`	string	Chave da conta de recebimento do comprador.
`buyerReceivementAccountType`	string	Tipo da conta de recebimento. No exemplo, `CHECKING`.
`buyerReceivementAccountKeyType`	string	Tipo da chave da conta de recebimento. No exemplo, `PHONE`.
`buyerReceivementSlipCode`	string	Código do boleto de recebimento do comprador.
`buyerReceivementSlipType`	string	Tipo do boleto de recebimento. No exemplo, `SIMPLE`.
`buyerReceivementSlipNumber`	string	Número do boleto de recebimento do comprador.
`eventType`	string	Nome do evento: `TradeInstrumentNegotiatedEvent`.
`items`	array	Notas fiscais incluídas na negociação.

Campos de `items`

Cada objeto em items representa um instrumento comercial negociado.

Campo	Tipo	Descrição
`_links.trade-payable.href`	string	URL para consultar a duplicata negociada.
`_links.trade-payable.type`	string	Método HTTP para consultar a duplicata: `GET`.
`tradeRepositoryId`	string	Identificador da duplicata.
`payableUuid`	string \| null	Identificador da nota fiscal associada. No exemplo, o valor é `null`.
`status`	string	Status do nota fiscal. No exemplo, `SOLD`.
`detail`	string \| null	Detalhe adicional da nota fiscal. No exemplo, o valor é `null`.
`externalId`	string	Identificador externo da nota fiscal.
`invoiceNumber`	string	Número da nota fiscal.
`installment`	number	Número da parcela.
`totalInstallment`	number \| null	Quantidade total de parcelas. No exemplo, o valor é `null`.
`paymentDate`	number	Data de pagamento em timestamp Unix, em milissegundos.
`tax`	number \| null	Valor da taxa. No exemplo, o valor é `null`.
`sponsorTax`	number \| null	Valor da taxa do sacado. No exemplo, o valor é `null`.
`paymentValue`	number	Valor de pagamento do item.
`sellerPaymentValue`	number \| null	Valor de pagamento do vendedor. No exemplo, o valor é `null`.
`sponsorPaymentValue`	number \| null	Valor de pagamento do sacado. No exemplo, o valor é `null`.
`discountValue`	number \| null	Valor do desconto. No exemplo, o valor é `null`.
`subsidyValue`	number \| null	Valor do subsídio. No exemplo, o valor é `null`.

Consulte os instrumentos comerciais

Use as URLs em _links para consultar os recursos relacionados ao evento:

Envie uma requisição GET para _links.trade-payables.href para consultar os instrumentos comerciais da empresa.
Envie uma requisição GET para items[]. _links.trade-payable.href para consultar os detalhes de cada instrumento comercial negociado.

Rota do webhook

Evento TradeInstrumentNegotiatedEvent

Campos do payload

Campos de items

Consulte os instrumentos comerciais

Evento `TradeInstrumentNegotiatedEvent`

Campos de `items`