Registers the business for STP using the ATO settings supplied
POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/stpregister
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required |
The request body takes a complete AuStpRegistrationModel resource, containing the following writable properties:
{
"abn": "string",
"addressLine1": "string",
"addressLine2": "string",
"atoIntegrationOption": "string",
"branch": "string",
"contactEmailAddress": "string",
"contactName": "string",
"contactPhoneNumber": "string",
"intermediaryAbn": "string",
"intermediaryContactEmail": "string",
"intermediaryContactName": "string",
"intermediaryContactPhone": "string",
"lodgementRole": "string",
"name": "string",
"postCode": "string",
"sbrEnabled": "boolean",
"sbrSoftwareId": "string",
"singleTouchPayrollEnabled": "boolean",
"state": "string",
"suburb": "string",
"suburbId": "int32",
"taxAgentNumber": "string"
}
Name | Type | Description |
---|---|---|
abn | string | String |
addressLine1 | string | String |
addressLine2 | string | String |
atoIntegrationOption | string |
AtoIntegrationOption
Possible values are:
|
branch | string | String |
contactEmailAddress | string | String |
contactName | string | String |
contactPhoneNumber | string | String |
intermediaryAbn | string | String |
intermediaryContactEmail | string | String |
intermediaryContactName | string | String |
intermediaryContactPhone | string | String |
lodgementRole | string |
AtoSupplierRole
Possible values are:
|
name | string | String |
postCode | string | String |
sbrEnabled | boolean | Boolean |
sbrSoftwareId | string | String |
singleTouchPayrollEnabled | boolean | Boolean |
state | string | String |
suburb | string | String |
suburbId | int32 |
Nullable |
taxAgentNumber | string | String |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
AuStpRegistrationModel |
Powered by DapperDox