> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mygigsters.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get super owed

> Retrieves the total superannuation owed to an employee, broken down by employer and individual payment transactions. This endpoint is useful for providing employees with a transparent view of their super entitlements and...

### Use Case

* Display total super owed to an employee in a dashboard
* Break down super owed by employer for multi-employer scenarios
* Review individual payment transactions and their statuses
* Reconcile super payments against payroll records

### Request Parameters

**employeeId** `string` *required*

Employee ID

### Responses

| Code | Description |
| - | - |
| `200` | Super owed retrieved successfully |
| `400` | Bad request - invalid employee id. |
| `401` | Unauthorized - Invalid authentication credentials |
| `404` | Employee not found |

### Response fields

**employeeId** `string`

The unique identifier of the employee

**total** `object`

The total superannuation amount owed to the employee across all employers

**properties**

**value** `number`

The monetary amount

**currency** `string`

ISO 4217 currency code

**byEmployer** `array`

Super owed broken down by each employer

**payments** `array`

Individual payment transactions contributing to super owed

> [accordion] Error response fields
>
> **success** `boolean`
>
> Always false for error responses, indicating the operation did not succeed.
>
> **statusCode** `integer`
>
> HTTP status code indicating the type of error. Common values: 400 (Bad Request), 401 (Unauthorized), 404 (Not Found), 500 (Server Error)
>
> **message** `string`
>
> Human-readable error message explaining what went wrong.

```bash cURL theme={null}
curl 'https://qa-super.mygigsters.com.au/v1/employees/69a2c642d87a988244021bbe/super-owed' \
    -u "apiUsername:apiPassword"
```

```javascript Node.js theme={null}
const response = await fetch("https://qa-super.mygigsters.com.au/v1/employees/69a2c642d87a988244021bbe/super-owed", {
  method: "GET",
  headers: {
    Authorization: "Basic " + Buffer.from("apiUsername:apiPassword").toString("base64"),
  },
});

const data = await response.json();
console.log(data);
```

```python Python theme={null}
import requests

response = requests.get(
    "https://qa-super.mygigsters.com.au/v1/employees/69a2c642d87a988244021bbe/super-owed",
    auth=("apiUsername", "apiPassword"),
)

print(response.json())
```

```ruby Ruby theme={null}
require "net/http"
require "json"
require "uri"

uri = URI("https://qa-super.mygigsters.com.au/v1/employees/69a2c642d87a988244021bbe/super-owed")
request = Net::HTTP::Get.new(uri)
request.basic_auth("apiUsername", "apiPassword")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts JSON.parse(response.body)
```

```php PHP theme={null}
<?php

$ch = curl_init("https://qa-super.mygigsters.com.au/v1/employees/69a2c642d87a988244021bbe/super-owed");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_USERPWD => "apiUsername:apiPassword",
]);

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));
```

```java Java theme={null}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;

public class Example {
    public static void main(String[] args) throws Exception {
        String credentials = Base64.getEncoder()
            .encodeToString("apiUsername:apiPassword".getBytes());

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://qa-super.mygigsters.com.au/v1/employees/69a2c642d87a988244021bbe/super-owed"))
            .header("Authorization", "Basic " + credentials)
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
```

```go Go theme={null}
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://qa-super.mygigsters.com.au/v1/employees/69a2c642d87a988244021bbe/super-owed", nil)
	if err != nil {
		panic(err)
	}
	req.SetBasicAuth("apiUsername", "apiPassword")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}
```

```csharp .NET theme={null}
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://qa-super.mygigsters.com.au/v1/employees/69a2c642d87a988244021bbe/super-owed");
request.Headers.Authorization = new AuthenticationHeaderValue(
    "Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("apiUsername:apiPassword")));

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```json 200 theme={null}
{
  "employeeId": "69a2c642d87a988244021bbe",
  "total": {
    "value": 3383.34,
    "currency": "AUD"
  },
  "byEmployer": [
    {
      "employerId": "6960d86e466f44ab3f163c66",
      "employerName": "MyGigsters Technologies Pty Ltd 2.0",
      "employerAbn": "34623710896",
      "total": {
        "value": 3383.34,
        "currency": "AUD"
      }
    }
  ],
  "payments": [
    {
      "transactionId": "txn-f764d975-482a-47bc-9558-167ac820eae5",
      "employerId": "6960d86e466f44ab3f163c66",
      "employerName": "MyGigsters Technologies Pty Ltd 2.0",
      "employerAbn": "34623710896",
      "amount": {
        "value": 200,
        "currency": "AUD"
      },
      "status": "SUBMITTED",
      "createdAt": "2026-03-18T07:23:05.843Z"
    }
  ]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.