---
title: "Lodgements"
method: POST
path: "/v1/workspaces/{workspace_id}/lodgements/search"
tags: ["statutory-deadlines"]
---

# Lodgements

`POST /v1/workspaces/{workspace_id}/lodgements/search`

## 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/workspaces/{workspace_id}/lodgements/search`
- Auth: HTTP bearer

## Path parameters

- `workspace_id` string, uuid, required

## Request body

- LodgementSearch: Lodgement list filters, sent in the body so search text stays out of URLs.
  - `search` string
  - `timing` 'overdue' | 'due_soon' | 'upcoming'
  - `return_type` '5602' | '5603' | 'bas' | 'afsa'
  - `cursor` string, nullable
  - `sort` 'urgency' | 'latest' | 'alphabetical' | 'reverse_alphabetical'
  - `completed` 'hide' | 'show'

## Response `200`

Successful Response

- LodgementPage
  - `items` LodgementRow[], required
    - `assignees` TaskPerson[], required
      - `email` string, nullable, required
      - `id` string, uuid, required
      - `name` string, required
    - `version` integer, required
    - `id` string, required
    - `matter_id` string, uuid, required
    - `matter_name` string, required
    - `workspace_slug` string, required
    - `matter_slug` string, required
    - `type` '5602' | '5603' | 'bas' | 'afsa', required
    - `period` string, required
    - `period_start` string, date, required
    - `period_end` string, date, required
    - `due_date` string, date, required
    - `timing` 'overdue' | 'due_soon' | 'upcoming', required
    - `days` integer, required
    - `calendar_version` string, required
    - `return_status` 'not_started' | 'draft' | 'review' | 'approved' | 'finalised' | 'lodged', required
    - `completed` boolean, required
  - `next_cursor` string, nullable, required
  - `total` integer, required
  - `timing_counts` object, required
  - `type_counts` object, required
  - `issues` object, required
  - `today` string, date, required
  - `rule_version` string, required
  - `calendar_version` string, required
  - `review_state` 'unapproved', required
  - `source_checked_on` string, date, required
  - `sources` object, 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)