Rates File Processed

When the processing of a rates file is completed, we trigger an event to indicate the completion of this operation.

If the rates file contains any errors, we return the success field as false and provide details about the error in the detail field.

Path: /tax-file

Webhook payload object

Key	Type	Description
`taxFileId`	`string`	Identifier of the tax file.
`buyerId`	`integer`	Investor identifier.
`success`	`boolean`	Result of the processing. `True` in case of success, and `false` in case of failure.
`detail`	`string`	If there are failures in the file processing, this field will be filled with the error details.
`_links`	`object`	Resources available through HATEOAS. More information here. Available resources are: `buyer` - List investor information. `taxFile` - List information from processed rates spreadsheet.

Webhook payload example

{
   "taxFileId":"hBslrLUoL1",
   "buyerId":123,
   "success":false,
   "detail":"Detalhe do erro de processamento",
   "_links":{
      "buyer":{
         "href":"https://zuul.monkeyecx.com/v2/buyers/123",
         "type":"GET"
      },
      "taxFile":{
         "href":"https://zuul.monkeyecx.com/v2/buyers/123/buyer-tax-file/hBslrLUoL1",
         "type":"GET"
      }
   }
}