Creates a new business.

Request

POST https://api.yourpayroll.com.au/api/v2/business

Query parameters

Parameter name Value Description Additional
setupDefaultData boolean

Request body

The request body takes a complete BusinessModel resource, containing the following writable properties:

{
    "abn": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "budgetEntryMethod": "string",
    "budgetWarningPercent": "double",
    "city": "string",
    "contactEmailAddress": "string",
    "contactFaxNumber": "string",
    "contactName": "string",
    "contactPhoneNumber": "string",
    "county": "string",
    "dateCreated": "date-time",
    "endOfWeek": "string",
    "externalId": "string",
    "id": "int32",
    "initialFinancialYearStart": "int32",
    "integratedTimesheetsEnabled": "boolean",
    "journalService": "string",
    "legalName": "string",
    "managersCanEditRosterBudgets": "boolean",
    "name": "string",
    "postCode": "string",
    "standardHoursPerDay": "double",
    "state": "string",
    "suburb": "string",
    "whiteLabelName": "string"
}

Properties

Name Type
abn string
addressLine1 string
addressLine2 string
budgetEntryMethod string
budgetWarningPercent double
city string
contactEmailAddress string
contactFaxNumber string
contactName string
contactPhoneNumber string
county string
dateCreated date-time
endOfWeek string
externalId string
id int32
initialFinancialYearStart int32
integratedTimesheetsEnabled boolean
journalService string
legalName string
managersCanEditRosterBudgets boolean
name string
postCode string
standardHoursPerDay double
state string
suburb string
whiteLabelName string

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK