---
title: "tax_return_deleted"
method: POST
path: "tax_return_deleted"
tags: ["Webhooks"]
---

# tax_return_deleted

`POST tax_return_deleted` (webhook)

A tax return was deleted.

## Payload

- object: Fields common to every tax return event.
  - `id` integer
  - `tax_return_name` string, nullable
  - `tax_year` integer, nullable
  - `client_email` string, nullable
  - `client_name` string, nullable
  - `entity_id` integer
  - `entity_name` string, nullable
  - `external_entity_id` string, nullable
  - `entity_type` string, nullable
  - `entity_tags` EntityTag[]: Tags as objects.
    - `id` integer
    - `name` string
  - `firm_role_summary` string: A formatted, human-readable summary of who holds which role on the entity, not structured data. Empty when no roles are assigned. Use `GET /entities/{entity_id}/firm_role_assignments` if you need the underlying ids.
  - `assigned_to` string, nullable
  - `assigned_to_email` string, nullable
  - `link` string, nullable: Path within the Soraban app, relative to the firm's subdomain.
  - `questionnaire_id` integer, nullable
  - `updated_at` string, date-time
  - `meta_data` object: Signature and payment state. These fields are nested here, not at the top level of the payload.
    - `draft_status` string, nullable
    - `all_signed` boolean, nullable
    - `has_payment` boolean
    - `payment_status` string, nullable
    - `payment_amount` number, nullable: In dollars.
    - `status` string, nullable

## Acknowledgement `200`

Return any 2xx to acknowledge. Returning `410 Gone` deletes the subscription.

---

[API](https://skmtc.dev/soraban/apis/soraban-private-api.md) - [All operations](https://skmtc.dev/soraban/apis/soraban-private-api/llms.txt) - [OpenAPI document](https://skmtc.dev/soraban/apis/soraban-private-api/revisions/1c230fa547ad?raw)