MyGigsters API Documentation

Get Submitted Contribution History

GET/v1/contributions/submitted/history

Overview

Retrieves all submitted contributions with filtering and pagination support. This endpoint provides access to the complete history of contributions that have been automatically stored when submitted via POST /v1/contributions/contribution/simplified.

Filtering

You can filter contributions by:

Employee ID: Filter contributions for a specific employee/member
Date Range: Filter contributions within a specific date range using startDate and endDate

Pagination

This endpoint supports pagination to efficiently retrieve large contribution histories:

page: Page number (default: 1)
limit: Number of items per page (default: 10, maximum: 100)

Use Cases

Audit Trail: Review all submitted contributions for compliance
Reporting: Generate reports on contribution history
Reconciliation: Match contributions with payment records
Employee History: View contribution history for specific employees
Date Range Analysis: Analyze contributions within specific time periods

Authentication

This endpoint requires Basic Authentication using your API Key credentials. For detailed authentication instructions, please refer to the Authentication guide.

Request Parameters

Parameter	Type	Description
employeeId	string	Filter contributions by employee/member ID (UUID)
startDate	string	Start date for filtering contributions (ISO 8601 format). Only contributions submitted on or after this date will be returned.
endDate	string	End date for filtering contributions (ISO 8601 format). Only contributions submitted on or before this date will be returned.
page	integer	Page number for pagination (default: 1)
limit	integer	Number of items per page (default: 10, max: 100)

Responses

Content-Type: application/json

Response Code

Description

Schema

200

Successfully retrieved contribution history

Parameter

Type

Description

contributions

array

Array of submitted contributions. Each contribution includes the transaction ID, employee/employer IDs, contribution amount, full contribution details, and timestamps.

meta

object

Pagination metadata

Parameter	Type	Description
page	integer	Current page number
limit	integer	Number of items per page
total	number	Total count of contributions matching the filters across all pages
totalPages	number	Total number of pages available
hasNext	boolean	Whether there is a next page available
hasPrevious	boolean	Whether there is a previous page available

400

Bad request - Invalid query parameters or date format. Check that date parameters are in ISO 8601 format and pagination parameters are valid.

Parameter	Type	Description
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. May include specific details about which field or value caused the error.
errorCode	integer	SuperChoice-specific error code for programmatic error handling. Refer to the error code reference documentation for a complete list of codes.

401

Unauthorized - Invalid authentication credentials

Parameter	Type	Description
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. May include specific details about which field or value caused the error.
errorCode	integer	SuperChoice-specific error code for programmatic error handling. Refer to the error code reference documentation for a complete list of codes.

500

Internal server error - An unexpected error occurred. If this persists, contact support with your transaction ID.

Parameter	Type	Description
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. May include specific details about which field or value caused the error.
errorCode	integer	SuperChoice-specific error code for programmatic error handling. Refer to the error code reference documentation for a complete list of codes.

Sample Request - cURL

curl 'https://super.mygigsters.com.au/v1/contributions/submitted/history' \
    -u "apiUsername:apiPassword-from-api-keys"

Sample Response - 200

{
  "contributions": [
    {
      "id": "695aaad7cada3b024c053699",
      "transactionId": "txn-550e8400-e29b-41d4-a716-446655440000",
      "employerId": "6944f5bc514fc0a1479bffdb",
      "employeeId": "695905b976478151e2a56fed",
      "amount": {
        "value": 110,
        "currency": "AUD"
      },
      "contributionDetails": {
        "fund": {
          "usi": "94358124791001"
        },
        "member": {
          "name": {
            "firstName": "Lisa",
            "lastName": "Brown"
          },
          "email": {
            "value": "lisa.brown2025@email.com"
          },
          "totalMemberContributionAmount": {
            "value": 110,
            "currency": "AUD"
          },
          "superGuaranteeAmount": {
            "value": 110,
            "currency": "AUD"
          },
          "employmentStatus": "FULL_TIME",
          "payPeriodStartDate": 1638277200,
          "payPeriodEndDate": 1640955600
        }
      },
      "createdAt": "2026-01-04T18:00:55.737Z",
      "updatedAt": "2026-01-04T18:00:55.737Z"
    },
    {
      "id": "695aaad7cada3b024c053698",
      "transactionId": "txn-550e8400-e29b-41d4-a716-446655440000",
      "employerId": "6944f5bc514fc0a1479bffdb",
      "employeeId": "695905b976478151e2a56fed",
      "amount": {
        "value": 1390,
        "currency": "AUD"
      },
      "contributionDetails": {
        "fund": {
          "usi": "94358124791001"
        },
        "member": {
          "name": {
            "firstName": "Lisa",
            "lastName": "Brown"
          },
          "email": {
            "value": "lisa.brown2025@email.com"
          },
          "totalMemberContributionAmount": {
            "value": 1390,
            "currency": "AUD"
          },
          "superGuaranteeAmount": {
            "value": 1390,
            "currency": "AUD"
          },
          "employmentStatus": "CASUAL",
          "payPeriodStartDate": 1638277200,
          "payPeriodEndDate": 1640955600
        }
      },
      "createdAt": "2026-01-04T18:00:55.293Z",
      "updatedAt": "2026-01-04T18:00:55.293Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "total": 2,
    "totalPages": 1,
    "hasNext": false,
    "hasPrevious": false
  }
}