REremote-com
Invoices

contractor_invoice.pay_out_failed

This event is triggered when the payout of a contractor invoice fails — the funds could not be sent to the contractor, for example because of an issue with the contractor's bank details. It is sent once per invoice: if a retry fails again, the event is not sent again.

The payload is stateless. Use the contractor invoice ID and employment ID to retrieve current details.

postWebhookcontractor_invoice.pay_out_failed

Payload

company_idstring required

The unique identifier of the related company.

contractor_invoice_idstring required

The unique identifier of the contractor invoice.

employment_idstring required

The unique identifier of the related employment.

event_typestring required

The webhook event type identifier.

Example payload

{
  "company_id": "123-example",
  "contractor_invoice_id": "123-example",
  "employment_id": "123-example",
  "event_type": "contractor_invoice.pay_out_failed"
}

Response

Any 200 response confirms that the webhook was delivered.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.