# Tax Lodgment Status

The Tax Lodgment Status API reports where an entity's annual tax return has got to: whether it is still to be
submitted, has gone to the tax agent, has been sent to the ATO, has lodged successfully, or has failed or been
rejected. Alongside the status you get the tax agent, the lodgment date, the amount payable or refundable, and the
audit date where one applies.

The endpoints come in two levels, each available for a single financial year (`/status`) or a range of years
(`/history`):

- **Business level** (`/b/{businessCode}/...`) returns every entity of the requested type across a business, paginated.
  The `POST` variants take the same parameters and return the same response, but also let you narrow the results by
  brand, tag or white label in the request body.
- **Fund level** (`/f/{businessCode}/{fundCode}/...`) returns a single entity.

At either level you can filter to a particular lodgment status. Where multiple years are returned, they are ordered
latest year first.

**Supported entity types**

These endpoints support both **SMSF** and **Trust** entities.

At business level, use the `entityType` query parameter to choose which entity type to return. At fund level, the
entity type is determined by the entity that `fundCode` resolves to, and is returned in `legalType`.

**Entity type differences**

Some fields relate to obligations that apply to an SMSF but not to a Trust, and are not expected to be populated for
a Trust:

| Field | Why it differs |
|---|---|
| `auditDate` | An SMSF must be audited each year before its annual return is lodged, so an audit date is recorded against each lodged year. A Trust has no equivalent annual audit tied to lodgment. |
| `amountDue` | Trust income is generally assessed in the hands of the beneficiaries rather than the trust itself, so a Trust lodgment does not usually carry an amount payable or refundable. |


<div class="env-panel" data-component-name="EnvPanel"><div class="env-panel__header">Servers</div><div class="env-panel__body"><div class="env-row"><div class="env-name">Partner Integration Environment (Sandbox)</div><div class="env-url-row"><span class="env-url">https://api.class-pie.com.au/api/1.0</span><button type="button" class="copy-btn" data-copy="https://api.class-pie.com.au/api/1.0" aria-label="Copy"><svg viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path fill-rule="evenodd" clip-rule="evenodd" d="M5.16667 2.66667C5.16667 2.57462 5.24129 2.5 5.33333 2.5H12C12.092 2.5 12.1667 2.57462 12.1667 2.66667V10.6667C12.1667 10.7587 12.092 10.8333 12 10.8333H10H5.33333C5.24129 10.8333 5.16667 10.7587 5.16667 10.6667V4.66667V2.66667ZM4.16667 4.16667V2.66667C4.16667 2.02233 4.689 1.5 5.33333 1.5H12C12.6443 1.5 13.1667 2.02233 13.1667 2.66667V10.6667C13.1667 11.311 12.6443 11.8333 12 11.8333H10.5V13.3333C10.5 13.6428 10.3771 13.9395 10.1583 14.1583C9.9395 14.3771 9.64275 14.5 9.33333 14.5H2.66667C2.35725 14.5 2.0605 14.3771 1.84171 14.1583C1.62292 13.9395 1.5 13.6428 1.5 13.3333V5.33333C1.5 5.02391 1.62292 4.72717 1.84171 4.50838C2.0605 4.28958 2.35725 4.16667 2.66667 4.16667H4.16667ZM9.5 11.8333V13.3333C9.5 13.3775 9.48244 13.4199 9.45118 13.4512C9.41993 13.4824 9.37754 13.5 9.33333 13.5H2.66667C2.62246 13.5 2.58007 13.4824 2.54882 13.4512C2.51756 13.4199 2.5 13.3775 2.5 13.3333V5.33333C2.5 5.28913 2.51756 5.24674 2.54882 5.21548C2.58007 5.18423 2.62246 5.16667 2.66667 5.16667H4.16667V10.6667C4.16667 11.311 4.689 11.8333 5.33333 11.8333H9.5Z" fill="currentColor"/></svg></button></div></div><div class="env-row"><div class="env-name">Production Environment</div><div class="env-url-row"><span class="env-url">https://api.class.com.au/api/1.0</span><button type="button" class="copy-btn" data-copy="https://api.class.com.au/api/1.0" aria-label="Copy"><svg viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path fill-rule="evenodd" clip-rule="evenodd" d="M5.16667 2.66667C5.16667 2.57462 5.24129 2.5 5.33333 2.5H12C12.092 2.5 12.1667 2.57462 12.1667 2.66667V10.6667C12.1667 10.7587 12.092 10.8333 12 10.8333H10H5.33333C5.24129 10.8333 5.16667 10.7587 5.16667 10.6667V4.66667V2.66667ZM4.16667 4.16667V2.66667C4.16667 2.02233 4.689 1.5 5.33333 1.5H12C12.6443 1.5 13.1667 2.02233 13.1667 2.66667V10.6667C13.1667 11.311 12.6443 11.8333 12 11.8333H10.5V13.3333C10.5 13.6428 10.3771 13.9395 10.1583 14.1583C9.9395 14.3771 9.64275 14.5 9.33333 14.5H2.66667C2.35725 14.5 2.0605 14.3771 1.84171 14.1583C1.62292 13.9395 1.5 13.6428 1.5 13.3333V5.33333C1.5 5.02391 1.62292 4.72717 1.84171 4.50838C2.0605 4.28958 2.35725 4.16667 2.66667 4.16667H4.16667ZM9.5 11.8333V13.3333C9.5 13.3775 9.48244 13.4199 9.45118 13.4512C9.41993 13.4824 9.37754 13.5 9.33333 13.5H2.66667C2.62246 13.5 2.58007 13.4824 2.54882 13.4512C2.51756 13.4199 2.5 13.3775 2.5 13.3333V5.33333C2.5 5.28913 2.51756 5.24674 2.54882 5.21548C2.58007 5.18423 2.62246 5.16667 2.66667 5.16667H4.16667V10.6667C4.16667 11.311 4.689 11.8333 5.33333 11.8333H9.5Z" fill="currentColor"/></svg></button></div></div></div></div>

Version: v1.1

Metadata:
  - tags: ["Class Partner"]

## Servers

Partner Integration Environment (Sandbox)
```
https://api.class-pie.com.au/api/1.0
```

Production Environment
```
https://api.class.com.au/api/1.0
```

## Security

### Class_oAuth

Class uses oAuth2 and OpenID for authentication and authorisation

Type: oauth2
Token URL: https://app.class-pie.com.au/connect/token
Scopes:
- `fund.read`: View all fund information
- `fund.maintain`: View and maintain all fund information

## Download OpenAPI description

 - [Tax Lodgment Status](https://developer.myhub.com.au/_bundle/products/class/apis/partner/tax-lodgment.yaml)

## Business

 - [GET /b/{businessCode}/tax-lodgments/status](https://developer.myhub.com.au/products/class/apis/partner/tax-lodgment/business/getbusinesstaxlodgementstatus.md): Get all active records of fund tax lodgment status data at business level for the specified financialYear and status in the sequence of latest to earliest.
 - [POST /b/{businessCode}/tax-lodgments/status](https://developer.myhub.com.au/products/class/apis/partner/tax-lodgment/business/postbusinesstaxlodgementstatus.md): Get all active records of fund tax lodgment status data at business level for the specified financialYear and status in the sequence of latest to earliest.
 - [GET /b/{businessCode}/tax-lodgments/history](https://developer.myhub.com.au/products/class/apis/partner/tax-lodgment/business/getbusinesstaxlodgementstatushistory.md): Get all active records of tax lodgment status data at business level for from and to the specified financialYear and for the specified status in the sequence of latest to the earliest.
 - [POST /b/{businessCode}/tax-lodgments/history](https://developer.myhub.com.au/products/class/apis/partner/tax-lodgment/business/postbusinesstaxlodgementstatushistory.md): Get all active records of tax lodgment status data at business level for from and to the specified financialYear and for the specified status in the sequence of latest to the earliest.
## Fund

 - [GET /f/{businessCode}/{fundCode}/tax-lodgments/status](https://developer.myhub.com.au/products/class/apis/partner/tax-lodgment/fund/gettaxlodgmentstatus.md): Returns the tax lodgement status for a fund for a specific financial year. It also returns the latest period update and latest year lodged for the fund. Lodgement status include tax agent, lodgement d
 - [GET /f/{businessCode}/{fundCode}/tax-lodgments/history](https://developer.myhub.com.au/products/class/apis/partner/tax-lodgment/fund/gettaxlodgmentstatushistory.md): Returns the tax lodgment status for a fund for a range of financial years. It also returns the latest period update and latest year lodged for the fund. Lodgment status include tax agent, lodgment dat