Creates a new business.

Request

POST https://api.yourpayroll.co.uk/api/v2/business

Query parameters

Parameter name Value Description Additional
setupDefaultData boolean

Request body

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

{
    "addressLine1": "string",
    "addressLine2": "string",
    "autoEnrolmentStagingDate": "date-time",
    "budgetEntryMethod": "string",
    "budgetWarningPercent": "double",
    "chrn": "string",
    "city": "string",
    "contactEmailAddress": "string",
    "contactFaxNumber": "string",
    "contactName": "string",
    "contactPhoneNumber": "string",
    "county": "string",
    "dateCreated": "date-time",
    "endOfWeek": "string",
    "externalId": "string",
    "id": "int32",
    "initialFinancialYearStart": "int32",
    "journalService": "string",
    "leaveAccrualStartDateType": "string",
    "leaveYearStart": "date-time",
    "legalName": "string",
    "managersCanEditRosterBudgets": "boolean",
    "name": "string",
    "postCode": "string",
    "promoCode": "string",
    "region": "string",
    "source": "string",
    "standardHoursPerDay": "double",
    "whiteLabelName": "string"
}

Properties

Name Type Description
addressLine1 string String
addressLine2 string String
autoEnrolmentStagingDate date-time Nullable
budgetEntryMethod string BudgetEntryMethodEnum

Possible values are:

  • PercentageOfSales
  • Direct
budgetWarningPercent double Nullable
chrn string String
city string String
contactEmailAddress string String
contactFaxNumber string String
contactName string String
contactPhoneNumber string String
county string String
dateCreated date-time DateTime
endOfWeek string DayOfWeek

Possible values are:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
externalId string String
id int32 Int32
initialFinancialYearStart int32 Nullable
journalService string String
leaveAccrualStartDateType string LeaveAccrualStartDateType

Possible values are:

  • EmployeeStartDate
  • SpecifiedDate
leaveYearStart date-time Nullable
legalName string String
managersCanEditRosterBudgets boolean Nullable
name string String
postCode string String
promoCode string String
region string String
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
standardHoursPerDay double Decimal
whiteLabelName string String

Response

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

Status code Description Resource
200 OK

OK

UkBusinessExportModel