Create New Business

Creates a new business.

Request

POST http:///api/v2/business

Query parameters

Parameter name Value Description Additional
setupDefaultData boolean

Request body

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

{
    "addressLine1": "string",
    "addressLine2": "string",
    "blockNumber": "string",
    "budgetEntryMethod": "string",
    "budgetWarningPercent": "double",
    "contactEmailAddress": "string",
    "contactFaxNumber": "string",
    "contactName": "string",
    "contactPhoneNumber": "string",
    "countryId": "string",
    "crn": "string",
    "dateCreated": "date-time",
    "endOfWeek": "string",
    "externalId": "string",
    "formulaForCalculatingOrdinaryRateOfPay": "string",
    "id": "int32",
    "industryName": "string",
    "initialFinancialYearStart": "int32",
    "journalService": "string",
    "leaveAccrualStartDateType": "string",
    "leaveAnniversarySetting": "string",
    "leaveAnniversarySettingDate": "date-time",
    "leaveYearStart": "date-time",
    "legalName": "string",
    "levelNumber": "string",
    "managersCanEditRosterBudgets": "boolean",
    "name": "string",
    "numberOfEmployees": "string",
    "payCycleFrequency": "string",
    "postCode": "string",
    "promoCode": "string",
    "region": "string",
    "registrationNumberValidationBypassed": "boolean",
    "source": "string",
    "standardDaysPerWeek": "int32",
    "standardHoursPerDay": "double",
    "state": "string",
    "suburb": "string",
    "unitNumber": "string",
    "whiteLabelId": "int32",
    "whiteLabelName": "string"
}

Properties

Name Type Description
addressLine1 string String
addressLine2 string String
blockNumber string String
budgetEntryMethod string BudgetEntryMethodEnum

Possible values are:

  • PercentageOfSales
  • Direct
budgetWarningPercent double Nullable
contactEmailAddress string String
contactFaxNumber string String
contactName string String
contactPhoneNumber string String
countryId string String
crn string String
dateCreated date-time DateTime
endOfWeek string DayOfWeek

Possible values are:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
externalId string String
formulaForCalculatingOrdinaryRateOfPay string FormulaForCalculatingOrdinaryRateOfPayEnum

Possible values are:

  • DividedBy26
  • ActualWorkingDays
  • AverageWorkingDays
id int32 Int32
industryName string String
initialFinancialYearStart int32 Nullable
journalService string String
leaveAccrualStartDateType string LeaveAccrualStartDateType

Possible values are:

  • EmployeeStartDate
  • SpecifiedDate
  • CalendarYear
  • CategorySpecificDate
leaveAnniversarySetting string Nullable

Possible values are:

  • EmployeeStartDate
  • CalendarYear
  • SpecifiedDate
leaveAnniversarySettingDate date-time Nullable
leaveYearStart date-time Nullable
legalName string String
levelNumber string String
managersCanEditRosterBudgets boolean Nullable
name string String
numberOfEmployees string Nullable

Possible values are:

  • OneToTen
  • ElevenToFifty
  • FiftyOneToTwoFifty
  • TwoFiftyOneAndUp
payCycleFrequency string Nullable

Possible values are:

  • Weekly
  • Fortnightly
  • Monthly
  • FourWeekly
  • Quarterly
  • Annually
  • HalfMonthly
  • BiWeekly
  • SemiMonthly
  • Weekly52Or53
  • OffCycle
postCode string String
promoCode string String
region string String
registrationNumberValidationBypassed boolean Boolean
source string Nullable

Possible values are:

  • None
  • Saasu
  • Xero
  • MYOB
  • Deputy
  • EmployeeTimePunch
  • ClickSuper
  • IntegratedTimesheets
  • FileImport
  • FileExport
  • QuickBooks
  • Harmony
  • AwardStore
  • Attache
  • IntegratedRostering
  • ReckonAccounts
  • API
  • MicroPower
  • RosterLive
  • NetSuite
  • Kounta
  • TimeAndAttendanceKiosk
  • DetailedFileExport
  • JonasPremier
  • WageEasy
  • Maestrano
  • WorkZone
  • EmployeePortal
  • RosterTemplate
  • Onboarding
  • Admin
  • WorkZoneClockOnOff
  • NetSuiteOneWorld
  • Sage50
  • PensionSync
  • FinancialsOffice
  • ProntoXI
  • PayRunDefault
  • StandardWorkDay
  • Beam
  • PayRunAutomation
  • BureauDashboard
  • Wiise
  • QBOMigrationTool
  • AbridgedFileImport
  • QBOForcedMigration
  • HmrcDpsUpdate
  • HmrcDpsStudentLoan
  • HmrcDpsPostGradLoan
  • Sage50FileImporter
  • FPSFileImporter
  • OAuth
  • FreshBooks
  • StarFileImporter
  • ActiveCampaign
  • SummaryAndDetailsExport
  • Telleroo
  • EmployeeAdvancedHoursUpload
  • BusinessCentral
  • Paytron
  • AccessFinancials
  • Comma
  • Zoho
  • FlatFileEmployeeImporter
  • Twinfield
  • SageAccounting
  • Square
  • Quickfile
  • Tide
  • TideSso
  • FreeAgent
  • Akahu
  • InstaPay
  • Zepto
  • Slack
  • Caxton
  • QuickbooksStandalonePayroll
  • ImportEmployeeSelfSetup
  • XeroIdentityPayrollSignUp
  • XeroIdentityHrSignUp
  • SageIntacct
  • InstaPayDaily
  • Salesforce
  • AutomatedPublicHolidayNotWorked
  • EmployeePayRatesUpload
  • Zapier
  • StapledSuperFund
  • Swag
  • Crezco
  • KafkaConsumer
  • EmployeeLeaveRateCalculationMethodUpload
standardDaysPerWeek int32 Int32
standardHoursPerDay double Decimal
state string String
suburb string String
unitNumber string String
whiteLabelId int32 Nullable
whiteLabelName string String

Response

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

Status code Description Resource
200 OK

OK

 MyBusinessExportModel