# Tax Lodgment Status

The Tax Lodgment Status API endpoints - temporary documentation as we transition these endpoints over to to our new API environment. The new developer portal will replace this documentation.
Ensure that you use the new BASE url apigateway.class.com.au


<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://apigateway.class-pie.com.au/api/1.0</span><button type="button" class="copy-btn" data-copy="https://apigateway.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://apigateway.class.com.au/api/1.0</span><button type="button" class="copy-btn" data-copy="https://apigateway.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: 1.0.0001
Metadata:
  - tags: ["Class Partner"]

## Servers

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

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

## Security

### Class_oAuth

Class uses oAuth2 and OpenID for authentication and authorisation

Type: oAuth2
Token URL: https://apigateway.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://developers.myhub.com.au/_bundle/products/class/apis/partner/tax-lodgment.yaml)

## Business

Ability to obtain the tax lodgment status at a business level, either for a particular year or for a range of years. Allows you to filter by a specific status.


### Tax lodgment status

 - [GET /b/{businessCode}/tax-lodgments/status](https://developers.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.

### Tax lodgment status

 - [POST /b/{businessCode}/tax-lodgments/status](https://developers.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.

### Tax lodgment status history

 - [GET /b/{businessCode}/tax-lodgments/history](https://developers.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.

### Tax lodgment status history

 - [POST /b/{businessCode}/tax-lodgments/history](https://developers.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

Ability to obtain the tax lodgment status at a fund level, either for a particular year or for a range of years. Allows you to filter by a specific status.


### Tax lodgment status

 - [GET /f/{businessCode}/{fundCode}/tax-lodgments/status](https://developers.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 date, amount due or refundable and audit date if available.

### Tax lodgment status history

 - [GET /f/{businessCode}/{fundCode}/tax-lodgments/history](https://developers.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 date, amount due or refundable and audit date if available. History is provided from latest year through to earlier years.