Skip to main content
PUT

Important Notes

  • Full Replace: Validation is identical to Onboard Employer - the same required fields, the same ABN checks, and the same Direct Debit agreement requirement apply.
  • ABN Validation: The ABN is validated in two stages - a format check (exactly 11 digits) and the ATO checksum algorithm. A syntactically-correct but non-existent ABN (e.g. 34623710897) is rejected.
  • Contact Area Code: contactPerson.areaCode must be one of the valid Australian landline area codes: 02, 03, 04, 07, 08.
  • Contact Email Uniqueness: If you change contactPerson.emailAddress, the new email must not already be used by another of your employers (case-insensitive), or the request is rejected with 400 (error code 4003). Keeping the employer’s current email is always allowed.
  • Ownership Check: The employer must belong to the authenticated client. Attempting to update an employer belonging to another client returns 404.

Use Case

  • Update an employer’s company, contact, address, or payment account details
  • Correct or replace direct debit and refund account information

Request Parameters

string
required
The employer ID

Request Body

object
required
Company and employer details
object
required
Contact person details for the employer
object
required
Company postal address
object
required
Bank account details for direct debit payments
object
required
Bank account details for refunds
object
required
Direct debit agreement acceptance
Optional. Legal agreement acceptances. All fields are required if this object is provided.
string
Optional. Base64-encoded PNG of the employer’s digital signature collected during onboarding.

Responses

Response fields

string
Unique identifier for the updated employer
number
Client ID associated with this employer
string
Success message
string
Timestamp when the employer was onboarded
boolean
Always false for error responses, indicating the operation did not succeed.
integer
HTTP status code indicating the type of error. Common values: 400 (Bad Request), 401 (Unauthorized), 404 (Not Found), 500 (Server Error)
string
Human-readable error message explaining what went wrong. May include specific details about which field or value caused the error. Examples include “Invalid ABN format”, “ABN failed the ATO checksum validation”, and “Area code must be one of ‘02’, ‘03’, ‘04’, ‘07’, ‘08’”.
integer
Superannuation clearing house-specific error code for programmatic error handling. Refer to the error code reference documentation for a complete list of codes.
Last modified on November 10, 2026