UkAvailableBusinessModel resource

Methods

  • get - List Businesses

Resource

{
    "addressLine1": "string",
    "addressLine2": "string",
    "allowEmployeeTimesheetsWithoutStartStopTimes": "boolean",
    "autoEnrolmentStagingDate": "date-time",
    "billingStatus": "string",
    "branding": {
        "backgroundColour": "string",
        "backgroundImageUrl": "string",
        "darkModeBackgroundColour": "string",
        "darkModeLogoUrl": "string",
        "darkModeTextColour": "string",
        "darkModeTextSecondaryColour": "string",
        "logoUrl": "string",
        "textColour": "string",
        "textHoverColour": "string",
        "textSecondaryColour": "string"
    },
    "budgetEntryMethod": "string",
    "budgetWarningPercent": "double",
    "businessNumber": "string",
    "canApproveExpenses": "boolean",
    "canApproveLeaveRequests": "boolean",
    "canApproveTimesheets": "boolean",
    "canCreateAndApproveTimesheets": "boolean",
    "canCreateTimesheets": "boolean",
    "canManageRosterShifts": "boolean",
    "canViewExpenses": "boolean",
    "canViewLeaveRequests": "boolean",
    "canViewRosterShifts": "boolean",
    "canViewShiftCosts": "boolean",
    "city": "string",
    "contactEmailAddress": "string",
    "contactFaxNumber": "string",
    "contactName": "string",
    "contactPhoneNumber": "string",
    "county": "string",
    "dateCreated": "date-time",
    "employeeGroupPermissions": [
        {
            "canApproveExpenses": "boolean",
            "canApproveLeaveRequests": "boolean",
            "canApproveTimesheets": "boolean",
            "canCreateTimesheets": "boolean",
            "canManageRosters": "boolean",
            "canViewExpenses": "boolean",
            "canViewLeaveRequests": "boolean",
            "canViewRosters": "boolean",
            "canViewShiftCosts": "boolean",
            "id": "int32"
        }
    ],
    "endOfWeek": "string",
    "externalId": "string",
    "id": "int32",
    "initialFinancialYearStart": "int32",
    "isPayrollAdmin": "boolean",
    "journalService": "string",
    "kiosks": [
        {
            "allowEmployeeShiftSelection": "boolean",
            "availableToAllRestrictedUsersWithKioskAccess": "boolean",
            "branding": {
                "backgroundColour": "string",
                "backgroundImageUrl": "string",
                "darkModeBackgroundColour": "string",
                "darkModeLogoUrl": "string",
                "darkModeTextColour": "string",
                "darkModeTextSecondaryColour": "string",
                "logoUrl": "string",
                "textColour": "string",
                "textHoverColour": "string",
                "textSecondaryColour": "string"
            },
            "canAddEmployees": "boolean",
            "clockOffWindowMinutes": "int32",
            "clockOnWindowMinutes": "int32",
            "externalId": "string",
            "ianaTimeZone": "string",
            "id": "int32",
            "isLocationRequired": "boolean",
            "isPhotoRequired": "boolean",
            "isWorkTypeRequired": "boolean",
            "locationId": "int32",
            "name": "string",
            "restrictLocationsForEmployees": "boolean",
            "timeZone": "string"
        }
    ],
    "leaveAccrualStartDateType": "string",
    "leaveYearStart": "date-time",
    "legalName": "string",
    "locationPermissions": [
        {
            "canApproveExpenses": "boolean",
            "canApproveLeaveRequests": "boolean",
            "canApproveTimesheets": "boolean",
            "canCreateTimesheets": "boolean",
            "canManageRosters": "boolean",
            "canViewExpenses": "boolean",
            "canViewLeaveRequests": "boolean",
            "canViewRosters": "boolean",
            "canViewShiftCosts": "boolean",
            "id": [
                "int32"
            ]
        }
    ],
    "managersCanEditRosterBudgets": "boolean",
    "name": "string",
    "noTimesheetPermissions": "boolean",
    "paidBreaksEnabled": "boolean",
    "postCode": "string",
    "promoCode": "string",
    "region": "string",
    "registrationNumber": "string",
    "registrationNumberValidationBypassed": "boolean",
    "standardHoursPerDay": "double",
    "state": "string",
    "suburb": "string",
    "timesheetDimensionsEnabled": "boolean",
    "timesheetEntryPeriodEnd": "date-time",
    "timesheetsRequireLocation": "boolean",
    "timesheetsRequireWorkType": "boolean",
    "whiteLabelName": "string"
}

Properties

Name Type Description
addressLine1 string String
addressLine2 string String
allowEmployeeTimesheetsWithoutStartStopTimes boolean Boolean
autoEnrolmentStagingDate date-time Nullable
billingStatus string Nullable

Possible values are:

  • NotBillable
  • Trial
  • Billable
branding object WhiteLabelBrandingModel
branding.backgroundColour string String
branding.backgroundImageUrl string String
branding.darkModeBackgroundColour string String
branding.darkModeLogoUrl string String
branding.darkModeTextColour string String
branding.darkModeTextSecondaryColour string String
branding.logoUrl string String
branding.textColour string String
branding.textHoverColour string String
branding.textSecondaryColour string String
budgetEntryMethod string BudgetEntryMethodEnum

Possible values are:

  • PercentageOfSales
  • Direct
budgetWarningPercent double Nullable
businessNumber string String
canApproveExpenses boolean Boolean
canApproveLeaveRequests boolean Boolean
canApproveTimesheets boolean Boolean
canCreateAndApproveTimesheets boolean Boolean
canCreateTimesheets boolean Boolean
canManageRosterShifts boolean Boolean
canViewExpenses boolean Boolean
canViewLeaveRequests boolean Boolean
canViewRosterShifts boolean Boolean
canViewShiftCosts boolean Boolean
city string String
contactEmailAddress string String
contactFaxNumber string String
contactName string String
contactPhoneNumber string String
county string String
dateCreated date-time DateTime
employeeGroupPermissions[] array
employeeGroupPermissions[].canApproveExpenses boolean Boolean
employeeGroupPermissions[].canApproveLeaveRequests boolean Boolean
employeeGroupPermissions[].canApproveTimesheets boolean Boolean
employeeGroupPermissions[].canCreateTimesheets boolean Boolean
employeeGroupPermissions[].canManageRosters boolean Boolean
employeeGroupPermissions[].canViewExpenses boolean Boolean
employeeGroupPermissions[].canViewLeaveRequests boolean Boolean
employeeGroupPermissions[].canViewRosters boolean Boolean
employeeGroupPermissions[].canViewShiftCosts boolean Boolean
employeeGroupPermissions[].id int32 Int32
endOfWeek string DayOfWeek

Possible values are:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
externalId string String
id int32 Int32
initialFinancialYearStart int32 Nullable
isPayrollAdmin boolean Boolean
journalService string String
kiosks[] array
kiosks[].allowEmployeeShiftSelection boolean Nullable
kiosks[].availableToAllRestrictedUsersWithKioskAccess boolean Boolean
kiosks[].branding object WhiteLabelBrandingModel
kiosks[].branding.backgroundColour string String
kiosks[].branding.backgroundImageUrl string String
kiosks[].branding.darkModeBackgroundColour string String
kiosks[].branding.darkModeLogoUrl string String
kiosks[].branding.darkModeTextColour string String
kiosks[].branding.darkModeTextSecondaryColour string String
kiosks[].branding.logoUrl string String
kiosks[].branding.textColour string String
kiosks[].branding.textHoverColour string String
kiosks[].branding.textSecondaryColour string String
kiosks[].canAddEmployees boolean Boolean
kiosks[].clockOffWindowMinutes int32 Nullable
kiosks[].clockOnWindowMinutes int32 Nullable
kiosks[].externalId string String
kiosks[].ianaTimeZone string String
kiosks[].id int32 Int32
kiosks[].isLocationRequired boolean Boolean
kiosks[].isPhotoRequired boolean Nullable
kiosks[].isWorkTypeRequired boolean Boolean
kiosks[].locationId int32 Nullable
kiosks[].name string String
kiosks[].restrictLocationsForEmployees boolean Boolean
kiosks[].timeZone string String
leaveAccrualStartDateType string LeaveAccrualStartDateType

Possible values are:

  • EmployeeStartDate
  • SpecifiedDate
  • CalendarYear
  • CategorySpecificDate
leaveYearStart date-time Nullable
legalName string String
locationPermissions[] array
locationPermissions[].canApproveExpenses boolean Boolean
locationPermissions[].canApproveLeaveRequests boolean Boolean
locationPermissions[].canApproveTimesheets boolean Boolean
locationPermissions[].canCreateTimesheets boolean Boolean
locationPermissions[].canManageRosters boolean Boolean
locationPermissions[].canViewExpenses boolean Boolean
locationPermissions[].canViewLeaveRequests boolean Boolean
locationPermissions[].canViewRosters boolean Boolean
locationPermissions[].canViewShiftCosts boolean Boolean
locationPermissions[].id[] array of int32
managersCanEditRosterBudgets boolean Nullable
name string String
noTimesheetPermissions boolean Boolean
paidBreaksEnabled boolean Boolean
postCode string String
promoCode string String
region string String
registrationNumber string String
registrationNumberValidationBypassed boolean Boolean
standardHoursPerDay double Decimal
state string String
suburb string String
timesheetDimensionsEnabled boolean Boolean
timesheetEntryPeriodEnd date-time DateTime
timesheetsRequireLocation boolean Boolean
timesheetsRequireWorkType boolean Boolean
whiteLabelName string String