---
title: "Detail"
method: GET
path: "/v1/matters/{matter_id}/editing/{kind}/{document_id}"
tags: ["editing"]
---

# Detail

`GET /v1/matters/{matter_id}/editing/{kind}/{document_id}`

## Request

- Base URL: `https://api.ender.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.ender.au/v1/matters/{matter_id}/editing/{kind}/{document_id}`
- Auth: HTTP bearer

## Path parameters

- `document_id` string, uuid, required
- `kind` string, required
- `matter_id` string, uuid, required

## Headers

- `X-Editing-Client` string, uuid, nullable

## Response `200`

Successful Response

- EditingDocumentDetail
  - `document` EditingDocumentSummary, required
    - `id` string, uuid, required
    - `kind` string, required
    - `title` string, required
    - `stage` 'preparing' | 'editing', required
    - `version` integer, required
    - `saved_version_number` integer, required
    - `document_date` string, date, required
    - `word_home` 'ender' | 'sharepoint', nullable, required
    - `word_url` string, nullable, required
    - `word_filename` string, nullable, required
    - `updated_at` string, date-time, required
    - `archived_at` string, date-time, nullable, required
  - `lease` DocumentLease, required: A live lease on the document. ``is_mine`` is true only for the client named by ``X-Editing-Client``; ``held_by_you`` is also true when the actor holds it from another client.
    - `holder_name` string, required
    - `is_mine` boolean, required
    - `held_by_you` boolean, required
    - `expires_at` string, date-time, required
  - `preparation` DocumentPreparationState, required: The Preparing document as the editor shows it, with live inputs.
    - `preparation` EditorPreparation, required: The preparation an editor shows, without outline node ids.
      - `report_id` string, uuid, required
      - `workflow_stage` 'prepare' | 'edit', required
      - `workflow_sha256` string, required
      - `exclusions` ContentExclusion[], required
        - `id` string, uuid, required
        - `mapping_revision_id` string, uuid, required
        - `section_id` string, required
        - `section_ids` string[], required
        - `quote` string, nullable, required
        - `action_ids` string[], required
        - `start_bookmark` string, required
        - `end_bookmark` string, required
      - `exclusion_version` integer, required
      - `template_version_id` string, uuid, required
      - `mapping_revision_id` string, uuid, required
      - `report_date` string, date, required
      - `document_url` string, required
      - `completed_required` integer, required
      - `total_required` integer, required
      - `ready` boolean, required
      - `inputs_ready` boolean, required
      - `generation_available` boolean, required
      - `blockers` string[], required
      - `sections` EditorPreparationSection[], required
        - `section_id` string, required
        - `parent_section_id` string, nullable, required
        - `active` boolean, required
        - `hidden` boolean, required
        - `heading` string, required
        - `bookmark_name` string, nullable, required
        - `anchor_text` string, nullable, required
        - `heading_occurrence` integer, required
        - `actions` DocumentPreparationAction[], required
          - `id` string, required
          - `treatment` 'merge_field' | 'alternative_wording' | 'ai_generate' | 'ender_list' | 'signature', required
          - `label` string, required
          - `field` string, nullable, required
          - `active` boolean, required
          - `ready` boolean, required
          - `issue` string, nullable, required
          - `draft_status` 'not_started' | 'drafted' | 'needs_review' | 'failed' | 'reviewed', nullable, required
          - `draft_key` string, nullable, required
          - `reviewed_at` string, date-time, nullable, required
          - `question` PractitionerQuestion, required
            - `prompt` string, required
            - `reason` string, required
            - `evidence_needed` string, required
          - `question_key` string, nullable, required
          - `clarification_available` boolean, required
          - `manually_written` boolean, required
          - `instruction` string, nullable, required
          - `table_mode` 'fixed_cells' | 'fixed_rows' | 'repeating_rows', nullable, required
          - `alternative_group_id` string, nullable, required
          - `alternative_option_key` string, nullable, required
          - `options` DocumentWordingOption[], required
            - `key` string, required
            - `label` string, required
            - `selected` boolean, required
            - `empty` boolean
            - `target_start_bookmark` string, required
            - `target_end_bookmark` string, required
            - `nested_action_ids` string[], required
          - `separator_bookmarks` array[], required
            - unknown[]
              - …
          - `target_start_bookmark` string, required
          - `target_end_bookmark` string, required
        - `ai_action_count` integer, required
        - `annexures` AnnexurePreflightItem[], required
          - `slot_key` string, required
          - `code` string, required
          - `item_key` string, required
          - `label` string, required
          - `required` boolean, required
          - `source_kind` 'firm_static' | 'feature_output' | 'matter_document' | 'matter_upload' | 'manual', required
          - `source_key` string, required
          - `insertion_mode` 'preserve' | 'populate_table' | 'replace_document' | 'append_document' | 'manual', required
          - `status` 'ready' | 'preserved' | 'missing' | 'manual', required
          - `source` ResolvedAnnexureSource, required
            - `source_key` string, required
            - `source_identity` string, required
            - `sha256` string, required
            - `filename` string, nullable, required
            - `content_type` string, nullable, required
            - `size_bytes` integer, nullable, required
          - `user_action` string, nullable, required
        - `completed_required` integer, required
        - `total_required` integer, required
        - `waiting_count` integer, required
        - `input_count` integer, required
        - `inputs_ready` boolean, required
        - `state` 'ready' | 'needs_input' | 'needs_ender_data' | 'needs_annexure' | 'needs_draft', required
        - `fields` EditorPreparationField[], required
          - `field` string, required
          - `active` boolean, required
          - `label` string, required
          - `value_source` 'ender' | 'matter_field' | 'report_value' | 'computed', required
          - `fill_kind` 'ender_value' | 'ender_pick' | 'ender_group' | 'input' | 'calculated', required
          - `ender_state` 'filled' | 'waiting' | 'overridden', nullable, required
          - `source_value` string, nullable
          - `pick` FieldPick: The record pick a field prints from, saved as the input `key`. `waiting` has no records to pick from; `record_gone` saved a record that is no longer in its feature. A pick of `several` reports its records in `selected_keys` and those no longer in their feature, with the label saved for each, in `gone`; a pick of one uses `selected_key`, which is Ender's default while the document has picked none.
            - `key` string, required
            - `noun` string, required
            - `several` boolean
            - `state` 'waiting' | 'unpicked' | 'picked' | 'record_gone', required
            - `options` PickOption[], required
              - …
            - `selected_key` string, nullable, required
            - `selected_keys` string[]
            - `gone` PickOption[]
              - …
          - `group` FieldGroup: Records a document lists from a feature, saved as the input `key`. `waiting` has no feature records to offer. `saved` is False while the document lists Ender's records unchanged.
            - `key` string, required
            - `title` string, required
            - `noun` string, required
            - `state` 'waiting' | 'ready', required
            - `saved` boolean, required
            - `lines` GroupLineDefinition[], required
              - …
            - `options` PickOption[], required
              - …
            - `records` GroupRecord[], required
              - …
          - `card` FieldCard: The card a field is one line of: what the card is about, and the field's label and place in it.
            - `key` string, required
            - `title` string, required
            - `line` string, required
            - `position` integer, required
          - `source_input_allowed` boolean, required
          - `source_key` string, nullable, required
          - `source_label` string, nullable, required
          - `source_feature` 'creditors' | 'employees' | 'cash_book' | 'date_of_insolvency' | 'remuneration' | 'voidables' | 'searches', nullable
          - `source_basis` string, nullable
          - `sources` ValueSources: Where an Ender value came from, beyond its feature: the calculation in words, the period, revision or version it reads, and its records. Each is present only when the source records it.
            - `calculation` string, nullable
            - `period` ValueSourcePeriod
              - …
            - `revision` integer, nullable
            - `version` integer, nullable
            - `finalised_on` string, date, nullable
            - `records` ValueSourceRecord[]
              - …
          - `settings_scope` 'profile' | 'matter_team', nullable, required
          - `selected_user_id` string, uuid, nullable, required
          - `issue` string, nullable, required
          - `input_type` 'text' | 'date' | 'amount' | 'url' | 'email' | 'phone' | 'choice', required
          - `value` string, nullable, required
          - `status` 'ender' | 'matter_field' | 'report_value' | 'missing' | 'missing_ender', required
          - `suggested_values` string[], required
          - `allowed_values` string[], required
          - `occurrences` EditorFieldOccurrence[], required
            - `action_id` string, required
            - `treatment` 'merge_field' | 'alternative_wording' | 'ai_generate' | 'ender_list', required
            - `section_id` string, required
            - `selection_id` string, nullable, required
            - `expected_text` string, nullable, required
            - `target_kind` string, required
            - `target_start_bookmark` string, required
            - `target_end_bookmark` string, required
    - `inputs` object, required
    - `blockers` ReadinessWarning[], required
      - `code` string, required
      - `message` string, required
  - `word` WordAuthority, required: Where Word is edited once the document leaves Preparing.
    - `home` 'ender' | 'sharepoint', nullable, required
    - `web_url` string, nullable, required
    - `etag` string, nullable, required
    - `filename` string, nullable, required
    - `publish_pending` boolean, required
  - `latest_finalisation` FinalisationSummary, required
    - `id` string, uuid, required
    - `version_number` integer, required
    - `pdf_size_bytes` integer, required
    - `published_document_ids` string[], required
    - `facts` object, required
    - `created_at` string, date-time, required
  - `finalised_current` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/ender/apis/ender-backend.md) - [All operations](https://skmtc.dev/ender/apis/ender-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/ender/apis/ender-backend/revisions/bf4373130521?raw)