Skip to main content
POST
/
api
/
sys
/
businesssettings
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A BusinessSetting represents a single name/value configuration entry for a location. Each setting is identified by a dotted key (Name) and holds its value as a string (Value). Together, the collection of BusinessSetting records for a location forms the full configuration surface — covering billing, portal features, check-in behaviour, mobile apps, communications, security and more. Boolean settings store "True" or "False" as the value string. Numeric settings store the number as a string. Date settings store the date in ISO 8601 format. All other settings store plain text, HTML or Markdown as appropriate. To read a setting, list BusinessSettings filtered by location and Name. To change a setting, update the matching record’s Value.

Complete setting reference

Billing — Invoice details

KeyTypeDescription
Billing.BillToNametextCompany / trading name shown on invoices
Billing.BillToAddresstextBilling address shown on invoices
Billing.BillToCitytextCity shown on invoices
Billing.BillToPostCodetextZip / post code shown on invoices
Billing.BillToStatetextState / Province shown on invoices
Billing.BillToCountrytextCountry (entity ID) shown on invoices
General.BusinessTaxIDNumbertextVAT / Tax ID number

Billing — Bank details

KeyTypeDescription
Billing.BankNametextBank name included at text of invoices
Billing.BankCodetextBank code
Billing.SortCodetextSort code / routing number
Billing.AccountNumbertextAccount number

Billing — Payment notifications

KeyTypeDescription
Payments.NotifyOnInvoiceDefaultboolEnable notifications about new invoices for customers registered from now on
Payments.NotifyOnNewPaymentDefaultboolEnable notifications about successful payments for customers registered from now on
Payments.NotifyOnFailedPaymentDefaultboolEnable notifications about failed payments for customers registered from now on
Payments.SuccessNotificationsEmailtextEmail address to send a copy of every successful payment notification to
Payments.FailureNotificationsEmailtextEmail address to send a copy of every failed payment notification to

Billing — Invoice contents

KeyTypeDescription
Billing.CreateZeroValueInvoicesboolCreate invoices even when total is zero
Billing.UsePeriodAsInvoiceDateboolUse the contract billing period start date as the invoice issue date
Billing.InvoicesIncludeProductNotesboolInclude product sale notes in invoice lines
Billing.InvoicesIncludeExtraServiceNotesboolInclude time-credit sale notes in invoice lines
Billing.InvoicesIncludeBookingNotesboolInclude booking notes in invoice lines
Billing.InvoicesIncludeTimePassNotesboolInclude pass sale notes in invoice lines
Billing.InvoicesIncludeFullyCreditedBookingsboolInclude lines for bookings fully paid by credit

Billing — Invoice split

KeyTypeDescription
Payments.CreateAnInvoicePerSpaceboolCreate an invoice per location based on transactions
Billing.SegregateContractsboolCreate an invoice per contract if a customer renews more than one
Payments.CreateAnInvoicePerPurchaseOrderboolCreate an invoice per purchase order reference
Billing.InvoiceSegregation.UsePreviousDayboolSet secondary invoice date to one day earlier than primary
Billing.SegregateBookingsboolMove bookings to secondary invoice
Billing.SegregateProductsboolMove products to secondary invoice
Billing.SegregateTimePassesboolMove passes to secondary invoice
Billing.SegregateTicketsboolMove event tickets to secondary invoice
Billing.SegregateChargesboolMove charges to secondary invoice

Billing — Invoice formatting

KeyTypeDescription
Billing.InvoiceFormat.SalestextInvoice reference format pattern. Use {1:0000} for sequential number, {0} for location reference, {year}/{month}/{day} for date parts
Billing.InvoiceFormat.DrafttextInvoice draft reference format pattern
Billing.InvoiceFormat.SeparateCreditNotesboolUse a different number sequence for credit notes
Billing.InvoiceFormat.CreditNotetextCredit note reference format pattern
Payments.PaymentReferenceGeneratortextPayment reference format (ePaymentReferenceGeneratorType enum value)

Billing — Amount rounding

KeyTypeDescription
Billing.Rounding.EnableboolEnable amount rounding
Billing.Rounding.Line.DecimalPointsnumberDecimal places for rounding each invoice line
Billing.Rounding.DecimalPointsnumberDecimal places for rounding invoice totals

Billing — Locked period

KeyTypeDescription
Billing.LockDatesdateLock invoices and payments made before this date

Billing — Tax

KeyTypeDescription
Billing.AddTaxToInvoicesboolAdd tax to invoices
Billing.RequireTaxRateboolRequire all sales to have a defined tax rate
Billing.PricesIncludeTaxboolPrices typed in the back-end include tax
Billing.DisplayTaxOnWebsiteboolDisplay prices including tax on website, app and emails
Billing.TaxValuetextDefault tax rate (entity ID of the tax rate record)

Billing — Financial accounts

KeyTypeDescription
Billing.RequireFinancialAccountboolRequire all sales to have a financial account

Billing — Proposals

KeyTypeDescription
Billing.DoNotIssueInvoiceboolLeave contracts issued by proposals as paused — do not issue invoices

Payments & Currency

KeyTypeDescription
Payments.CurrencytextSecondary currency (entity ID) — payments processed in this currency
Payments.ExchangeRatenumberExchange rate from primary to secondary currency
Payments.RemindToPayEverynumberNumber of days between payment reminders

Checkout — Plans

KeyTypeDescription
Forms.Enquiries.EnabledboolAllow customers to enquire about plans
Forms.Enquiries.Tour.EnabledboolInclude a tour as part of the enquiry
Forms.Enquiries.TariffIds.OnlyEnquireboolPrevent selected plans from being purchased directly

Checkout — Products

KeyTypeDescription
Store.AlwaysInvoiceboolAlways invoice products immediately when purchased

Checkout — Bookings

KeyTypeDescription
Bookings.CancelUnPaidBookingsForNonSubscribersboolRequire up-front payment for bookings made by contacts
Bookings.CancelUnPaidBookingsForSubscribersboolRequire up-front payment for bookings made by members
Bookings.AutoPayContactBookingsboolInvoice and collect payment for contact bookings as they end
Bookings.AutoPayMemberBookingsboolInvoice and collect payment for member bookings as they end
Bookings.ChargeBookingsImmediatelyboolCalculate price and use credit immediately when booking is requested
Bookings.RequestDraftsboolAllow customers to request a quote instead of confirming

Checkout — Event tickets

KeyTypeDescription
Events.CanCancelTicketsboolAllow customers to cancel event tickets
Events.CancelUnpaidTicketsboolAutomatically cancel unpaid tickets purchased by contacts
Events.InvoiceAttendeeboolInvoice the event buyer instead of their team paying customer

Bookings — General

KeyTypeDescription
Bookings.EnableGuestBookingsboolAllow new customers to register and book from calendar
Bookings.DoNotCreateGuestAccountboolDo not create account for guest bookers (reversed: False = create account)
Bookings.RegisterConactBookersAsVisitorsboolRegister all contacts as visitors when they book
Bookings.DoNotRegisterKnownCustomersAsVisitorsboolDo not register known customers as visitors when added as attendees (reversed)
Bookings.CancelIfNotChekedInboolRequire attendees to check in using NexBoard and cancel no-shows
Bookings.RequireConfirmation.MembersboolBookings made by members must be confirmed first
Bookings.RequireConfirmation.ContactsboolBookings made by contacts must be confirmed first

Bookings — Notifications

KeyTypeDescription
Bookings.SendConfirmationEmailboolSend booking confirmation email to customer
Bookings.SendConfirmationToVisitorsboolSend booking confirmation to every guest added to a booking
Bookings.SendReminderEmailboolSend booking reminder email before booking begins
Bookings.ReminderEmailMinutesnumberMinutes before each booking to send reminder
Bookings.SendAccessCodeboolInclude Internet Access Token in booking emails

Bookings — Charges & payments

KeyTypeDescription
Bookings.PaidBookingsCancellationPolicytextCancellation policy for invoiced bookings (ePaidBookingsCancellationPolicy enum value)
Bookings.UseCreditToPayBookingProductsboolUse available credit to pay for products added to bookings
Bookings.RejectIfNoCreditIsAvailableboolReject bookings if customers do not have enough credit
Bookings.DueDateIgnoreProductsboolIgnore recurrent products when calculating booking due dates

Bookings — Calendar

KeyTypeDescription
Calendars.ShowMemberDetailsInFeedboolShow customer names and company in calendar
Calendars.IncludeEventsInCalendarboolInclude events connected to a resource in calendar
Calendars.IncludeEventsInFeedboolInclude events in calendar iCal feed
PublicWebSite.ShowAllBookingsboolShow bookings from all users in calendar
Members.ViewTeamBookingsboolShow bookings made by team members on home page
Calendars.IncludeLinkedResourcesboolShow combined resources as booked in calendar
Bookings.ShowEndDateboolLet users book across different days
Bookings.AcceptPastBookingsboolAccept bookings in the past
Bookings.IncludeBookingCreditInPriceboolConsider money credit when showing booking prices
Calendars.DefaultViewtextDefault calendar view (eCalendarDefaultView enum value)
Bookings.DefaultBookingLengthtextDefault booking length
Bookings.IntervalLimittextTime picker interval

Bookings — Dynamic pricing

KeyTypeDescription
Nexudus.ML.ApplyFromdateApply dynamic pricing only to bookings made from this date

Bookings — Teams & attendance

KeyTypeDescription
Bookings.AttendanceBookingReminders.EnabledboolSend office attendance reminders
Bookings.AttendanceReport.EnabledboolSend weekly attendance report to team administrators
Members.AllowRemoveTeamMembersboolTeam administrators can remove members from teams
Forms.TeamAdminsCanUpdateCardsboolTeam administrators can update access card details

Check-in — General

KeyTypeDescription
Members.NotifyOnLowCreditboolNotify users when running low on access time
Members.NotifyOnLowCreditHoursnumberNotify when less than this many hours of credit remain
Members.NotifyOnAutoCheckoutboolNotify users when they are automatically checked out
Checkin.AlwaysRecordByMinuteboolRecord multiple check-ins on the same calendar day
Checkin.DailyCutOffTimetextDaily cut-off time for check-in
MobileApp.NexClicker.MaxCapacitynumberBuilding capacity (people)

Check-in — Pay as you go

KeyTypeDescription
Checkin.PayAsYouGoboolEnable pay-as-you-go access
Checkin.DiscountBookingsboolExclude time used in bookings from check-in duration
Checkin.PayAsYouGoMembersPayWithContractboolMembers pay pay-as-you-go charges via their contract
Checkin.PayAsYouGoMinPricenumberMinimum daily price
Checkin.PayAsYouGoMaxPricenumberMaximum daily price

Check-in — Network & devices

KeyTypeDescription
Security.DisableAutoCheckingboolDisable auto check-in via MAC address (reversed: False = auto check-in enabled)
PublicWebSite.Visitors.CreateAccessToknsboolGenerate an access token for every pre-registered visitor
PublicWebSite.Visitors.CreateAccessTokns.DefaultDurationnumberDefault duration in minutes for visitor access tokens
Checkin.DeviceCountLimitnumberMaximum number of devices per user
PublicWebSite.Visitors.CreateAccessTokns.MaximumDevicesVisitornumberMaximum number of devices per visitor

Sign-up & registration

KeyTypeDescription
Members.CanSignupboolAllow customers to sign up online
Members.SendWelcomeEmailboolSend welcome email with access details to new users
Members.UseInvitationLinkboolRestrict sign-ups to invite only
Signup.UseCaptchaboolProtect sign-up with Google Captcha
Signup.AskForPasswordboolLet customers create their own password at sign-up
Signup.ShowStoreOnSignUpboolOffer additional products during sign-up
Signup.KeepNewAccountsOnHoldboolKeep new customer accounts suspended by default
Signup.MemberMustChooseAPricePlanboolSuspend new accounts that do not complete payment
Signup.GooglePlusSignUpboolAllow sign-up with Google
Signup.GooglePlusSignInboolAllow sign-in with Google
Security.AutoRegisterboolAutomatically register existing customers at new locations
Security.AllowPasswordResetboolLet users change their password
Security.AutoGeneratePincodeboolAuto-generate 5-digit access pin-codes
Security.GenerateUniquePincodeboolRequire pin-codes to be unique across all customers

New customer access defaults

KeyTypeDescription
Access.Defaults.NetworkboolNew customers have access to IT network by default
Access.Defaults.BookingsboolNew customers can make bookings by default
Access.Defaults.ProductsboolNew customers can purchase products by default
Access.Defaults.EventsboolNew customers can purchase events by default
Access.Defaults.CommunityboolNew customers can use discussion boards by default

Forms — Sign-up personal details

KeyTypeDescription
SignupForm.LandLinetextPhone field requirement (eFormFieldStatus value)
SignupForm.MobilePhonetextMobile / Cell field requirement (eFormFieldStatus value)
SignupForm.GendertextGender field requirement (eFormFieldStatus value)
SignupForm.DateOfBirthtextDate of birth field requirement (eFormFieldStatus value)
SignupForm.ShowContactSectionboolShow contact details section in sign-up and profile forms
SignupForm.ShowBillingSectionboolShow billing details section in sign-up and profile forms
SignupForm.ShowProfileSectionboolShow profile details section in sign-up form
SignupForm.AvatartextPhoto profile field requirement (eFormFieldStatus value)

Forms — Contact details fields

KeyTypeDescription
Forms.AddresstextAddress form field requirement (eFormFieldStatus value)
Forms.CityNametextCity form field requirement (eFormFieldStatus value)
Forms.StatetextState form field requirement (eFormFieldStatus value)
Forms.PostCodetextPostcode / zip form field requirement (eFormFieldStatus value)
Forms.CountrytextCountry form field requirement (eFormFieldStatus value)

Forms — Billing details fields

KeyTypeDescription
Forms.BillingNametextCompany name billing field requirement (eFormFieldStatus value)
Forms.TaxIDNumbertextTax / Company ID billing field requirement (eFormFieldStatus value)
Forms.BillingAddresstextAddress billing field requirement (eFormFieldStatus value)
Forms.BillingCityNametextCity billing field requirement (eFormFieldStatus value)
Forms.BillingStatetextState billing field requirement (eFormFieldStatus value)
Forms.BillingPostCodetextPostcode / zip billing field requirement (eFormFieldStatus value)
Forms.BillingEmailtextBilling email field requirement (eFormFieldStatus value)
Forms.BillingCountrytextBilling country field requirement (eFormFieldStatus value)

Forms — Profile fields

KeyTypeDescription
Forms.CompanyNametextCompany name profile field requirement (eFormFieldStatus value)
Forms.BusinessAreatextIndustry profile field requirement (eFormFieldStatus value)
Forms.PositiontextPosition profile field requirement (eFormFieldStatus value)
Forms.ProfileSummarytextProfile bio field requirement (eFormFieldStatus value)
Forms.PorfileTagstextSkills profile field requirement (eFormFieldStatus value)
Forms.ProfileWebistetextWebsite profile field requirement (eFormFieldStatus value)
KeyTypeDescription
Legal.VisitorTermsAndConditionsmarkdownVisitor terms and conditions shown during NexIO registration
Legal.CheckoutTermsAndConditionsmarkdownCheckout terms shown before booking or payment
Legal.PrivacymarkdownPrivacy policy linked in portal footer
Legal.CookiesmarkdownCookies policy linked in portal footer and login page

Portal — Appearance & version

KeyTypeDescription
Nexudus.NextJS.VersiontextMembers Portal version
PublicWebSite.IncludeInLocationSelectorboolDisplay this location in website and app location selector
PublicWebSite.ShowOnlyRegisteredWithLocationsboolList only locations customers are registered with

Portal — Features

KeyTypeDescription
PublicWebSite.MyAccountboolEnable My Account section
PublicWebSite.HelpboolEnable help-desk section
PublicWebSite.DeliveriesboolEnable deliveries section
PublicWebSite.ContactboolEnable contact form
PublicWebSite.CommunityBoardboolEnable discussion boards section
PublicWebSite.EventsboolEnable events and tickets section
Members.PublicDirectoryboolEnable directory section
Blog.EnabledboolEnable articles section
PublicWebSite.AttendanceboolEnable team attendance section
PublicWebSite.VisitorsboolEnable visitor registration section
PublicWebSite.TourboolEnable tour request form
PublicWebSite.MetricsboolEnable metrics section
PublicWebSite.NotificationsboolEnable notifications section

Portal — Home page

KeyTypeDescription
PublicWebSite.Home.UseCommunityDashboardboolShow community feed when customers log in
HomePage.BannerboolShow rotating banner on home page
HomePage.ShowIconBarboolShow shortcuts to commonly used sections
HomePage.ShowClaimBarboolShow primary claim text
HomePage.ShowServicesBarboolShow offered services section
HomePage.ShowFooterClaimBarboolShow secondary claim text
HomePage.ShowCheckedInMembersboolShow list of checked-in customers
HomePage.NewsletterSignUpboolShow newsletter sign-up section

Portal — Banner

KeyTypeDescription
HomePage.BannerTexttextBanner main text
HomePage.BannerSmallTexttextBanner secondary text

Portal — Shortcuts

KeyTypeDescription
HomePage.AboutUsIconboolShow shortcut to about us
HomePage.EventsIconboolShow shortcut to events
HomePage.DirectoryIconboolShow shortcut to directory
HomePage.BookingsIconboolShow shortcut to bookings calendar
HomePage.MyAccountIconboolShow shortcut to my account or sign-up

Portal — Primary claim

KeyTypeDescription
HomePage.ClaimTexttextPrimary claim main text
HomePage.ClaimSmallTextLogouttextPrimary claim secondary text for logged-out users
HomePage.ClaimSmallTextLogintextPrimary claim secondary text for logged-in users

Portal — Service tiles

KeyTypeDescription
HomePage.ShowWorkspaceServiceboolShow workspace tile
HomePage.WorkSpaceShortTexttextWorkspace tile heading
HomePage.WorkSpaceLongTexttextWorkspace tile description
HomePage.ShowBookingsServiceboolShow bookings tile
HomePage.BookingsShortTexttextBookings tile heading
HomePage.BookingsLongTexttextBookings tile description
HomePage.ShowCommunityServiceboolShow community tile
HomePage.CommunityShortTexttextCommunity tile heading
HomePage.CommunityLongTexttextCommunity tile description
HomePage.ShowChildCareServiceboolShow child care tile
HomePage.ChildCareShortTexttextChild care tile heading
HomePage.ChildCareLongTexttextChild care tile description
HomePage.ShowBenefitsServiceboolShow benefits tile
HomePage.BenefitsShortTexttextBenefits tile heading
HomePage.BenefitsLongTexttextBenefits tile description
HomePage.ShowEventsServiceboolShow events tile
HomePage.EventsShortTexttextEvents tile heading
HomePage.EventsLongTexttextEvents tile description
KeyTypeDescription
HomePage.FooterClaimTexttextSecondary claim main text
Footer.SayingTexttextFooter saying text
Footer.SayingAuthortextFooter saying author

Portal — Social networks

KeyTypeDescription
Social.TwittertextX (Twitter) handle
Social.FlickrtextFlickr URL
Social.FacebooktextFacebook URL
Social.InstagramtextInstagram handle

Portal — Access to sections

These settings control who can see each section of the members portal. Values are integers from the ePublicWebsiteAccess enum: 1 = Everyone, 2 = Logged-in users, 3 = Only members, 4 = Only contacts.
KeyTypeDescription
Access.Globalint (1–4)Access level for entire portal
Access.HomePageint (1–4)Access level for home page
Access.AboutUsint (1–4)Access level for about us page
Access.Helpint (1–4)Access level for help-desk module
Access.Eventsint (1–4)Access level for events list and calendar
Access.Bookingsint (1–4)Access level for booking pages
Access.Directoryint (1–4)Access level for directory pages
Access.CommunityBoardint (1–4)Access level for discussion board pages
Access.Blogint (1–4)Access level for blog and article pages
Access.Contactint (1–4)Access level for contact pages
Access.Account.Paymentsint (1–4)Access level for payments page
Access.Account.PricePlansint (1–4)Access level for plan selection page
Access.Account.Allowancesint (1–4)Access level for benefits page
Access.Account.Storeint (1–4)Access level for products store page
Access.Discountsint (1–4)Access level for perks and benefits page
Access.FAQsint (1–4)Access level for FAQ pages

Portal — Data visibility

KeyTypeDescription
Access.Data.EventstextEvents visibility scope (eDataVisibilityCriteria enum value)
Access.Data.BlogtextArticles visibility scope
Access.Data.PerkstextPerks and discounts visibility scope
Access.Data.FAQstextFAQ articles visibility scope
Access.Data.ResourcestextBookable resources visibility scope
Access.Data.ProductstextProducts visibility scope

My Account features

KeyTypeDescription
Members.AllowTariffChangeboolUsers can change or cancel their plan
Members.AllowBookingsboolUsers can request new bookings
Members.AllowChangeBookingsboolUsers can change existing bookings
Members.AllowHelpMessagesboolUsers can submit help-desk requests
Members.ViewInvoicesboolUsers can view and pay invoices
Members.PrintInvoicesboolUsers can print invoices

Discussion boards

KeyTypeDescription
PublicWebSite.CommunityBoard.GroupsOnlyboolCustomers can only post to groups they have access to
Digest.AutoSignUpMembersboolSign up new users to daily digest
Digest.SendToMembersboolEnable digest notifications to members
Digest.SendToContactsboolEnable digest notifications to contacts
Digest.SubjectFormattextDigest email subject line format

Articles

KeyTypeDescription
Blog.AllowCommentsboolLet users post comments on articles
Blog.AutoPublishCommentsboolAutomatically publish comments on articles

Events

KeyTypeDescription
Events.SendAccessCodeboolInclude internet access code in event tickets
Events.SendRemindersboolSend 24-hour reminder before events

Newsletter

KeyTypeDescription
Newsletter.AutoSignUpMembersboolAdd every new customer as subscriber
Newsletter.DefaultOptInboolNewsletter subscribers active by default

Directory

KeyTypeDescription
Directory.OnlyInvoicingSpaceboolList only invoicing-location customers (reversed: False = list all locations)
Directory.DirectoryRecordstextDirectory record types (eDirectoryRecordType enum value)
Directory.DirectoryContentstextDirectory contents type (eDirectoryContents enum value)
Directory.ProfileTagstextProfile skills and industries

Tours

KeyTypeDescription
PublicWebSite.Tour.RequiresConfirmationboolTour requests must be confirmed by an administrator
PublicWebSite.Tour.TimeSlots.EnabledboolTours can only be booked at specific hours/days
PublicWebSite.Tour.TimeSlotstextTour time slots configuration
PublicWebSite.Tour.HosttextTour host user (entity ID)

About us

KeyTypeDescription
PublicWebSite.AboutUsboolEnable About Us module

Space dashboard

KeyTypeDescription
Dashboard.EnabledboolEnable space dashboard

Communications — Email

KeyTypeDescription
Email.DisableboolDisable notifications system (reversed: False = enabled)
Email.FromNametextFrom name on outgoing emails
Email.FromEmailtextReply-to email address
Email.CCEmailtextCC email address
Email.CCOEmailtextBCC email address
Email.CCOboolBCC the reply-to email on all outgoing emails
Email.UseDefaultSettingsboolUse Nexudus servers to deliver email
Email.ServerNametextCustom SMTP server host
Email.SMTPPortnumberCustom SMTP server port
Email.UseSSLboolConnect to SMTP using SSL
Email.ServerUsernametextSMTP username
Email.ServerPasswordtextSMTP password

Security & access

KeyTypeDescription
Access.TwoFactor.EnforceboolEnforce Two Factor Authentication for admin users
Access.TwoFactor.EnforceFromDatedateEnforce 2FA from this date
Security.Crm.EnforceOpportunityOwnershipboolOnly admins or owner can change CRM opportunities
Nexudus.Oauth.AccessTokenExpireTimeSpantextAdmin session timeout
PublicWebsite.AllowedDomainstextAuthorized redirect domains

Nexudus subscription

KeyTypeDescription
Nexudus.SupportUrltextDedicated Support Agent URL
Nexudus.TrialDaysnumberTrial period in days

Mobile app — Passport features

KeyTypeDescription
MobileApp.DisplayHomeVerticallyboolDisplay home sections vertically
MobileApp.FeedboolEnable Discussion boards section
MobileApp.DirectoryboolEnable directory section
MobileApp.BookingsboolEnable bookings and floor plans
MobileApp.EventsboolEnable events and tickets
MobileApp.BlogboolEnable articles section
MobileApp.MeboolEnable my account section
MobileApp.LocationServicesboolEnable location services
MobileApp.FeedPrivateboolEnable private messages
MobileApp.HelpboolEnable help-desk section
Google.Analytics.v4.MobileboolEnable Google Analytics 4

Mobile app — Passport home page

KeyTypeDescription
MobileApp.Home.CheckedInMembersboolShow checked-in customer count
MobileApp.Home.OngoingBookingsboolShow ongoing bookings
MobileApp.Home.UpcomingBookingsboolShow upcoming bookings
MobileApp.Home.BlogboolShow articles
MobileApp.Home.EventsboolShow events
MobileApp.Home.BenefitsboolShow customer credits and benefits
MobileApp.Home.InvoicesboolShow unpaid invoices
MobileApp.Home.DeliveriesboolShow uncollected deliveries
MobileApp.Home.ElatecboolShow print release (Elatec)
MobileApp.Home.CommunityBoardboolShow discussion boards
MobileApp.Home.VisitorsboolShow upcoming visitors
MobileApp.Home.AccessControlboolShow access control section
MobileApp.Home.QRCodeboolShow customer QR code

Mobile app — Passport white-label

KeyTypeDescription
MobileApp.PrimaryColortextPrimary colour
MobileApp.SecondaryColortextSecondary colour
MobileApp.TertiaryColortextTertiary colour
MobileApp.FontFamilytextFont family (eAppFontName enum value)

Mobile app — Passport access control

KeyTypeDescription
MobileApp.Access.EnabledboolEnable access control page in app
MobileApp.Access.UrltextAccess control page URL

Mobile app — Passport custom page

KeyTypeDescription
MobileApp.CustomPage.EnabledboolEnable custom page in app
MobileApp.CustomPage.TitletextCustom page title
MobileApp.CustomPage.UrltextCustom page URL
MobileApp.CustomPage.ShowOnHomePageboolShow custom page on app home page
MobileApp.CustomPage.SecrettextCustom page shared secret

Mobile app — Push notifications

KeyTypeDescription
OneSignal.AppKeytextOneSignal App Id
OneSignal.RestKeytextOneSignal REST Key

Mobile app — App download URLs

KeyTypeDescription
MobileApp.iOS.UrltextiOS app download URL
MobileApp.Android.UrltextAndroid app download URL
KeyTypeDescription
MobileApp.iOS.TeamIdtextiOS team id
MobileApp.iOS.BundleIdtextiOS bundle id
MobileApp.Android.PackageNametextAndroid package name
MobileApp.Android.CertFingerprinttextAndroid certificate fingerprint
AutomationTiles.SharedSecrettextAutomation tiles shared secret

NexIO — Visitor check-in

KeyTypeDescription
MobileApp.FrontDesk.VersiontextNexIO version
MobileApp.FrontDesk.Checkin.Fields.EmailboolAsk for visitor email
MobileApp.FrontDesk.Checkin.RequireEmailboolMake visitor email required
MobileApp.FrontDesk.Checkin.Fields.MemberboolAsk visitor to choose a customer as host
MobileApp.FrontDesk.Checkin.RequireMemberboolRequire visitor to choose a host
MobileApp.FrontDesk.Checkin.Fields.PhoneNumberboolAsk for visitor phone number
MobileApp.FrontDesk.Checkin.Fields.PhoneNumber.RequiredboolVisitor phone number is required
MobileApp.FrontDesk.Checkin.Fields.CompanyNameboolAsk for visitor company name
MobileApp.FrontDesk.Checkin.Fields.ReasonboolAsk for reason for visit
MobileApp.FrontDesk.Checkin.ShowNewsletterboolShow newsletter opt-in check-box
MobileApp.FrontDesk.Checkin.CustomerFiltertextCustomer selection menu filters

NexIO — Language / messages

KeyTypeDescription
MobileApp.FrontDesk.Checkin.WelcomeMessagetextWelcome message
MobileApp.FrontDesk.Checkin.HomeMessagetextHome message
MobileApp.FrontDesk.Checkin.TapToStartMessagetextTap to start message
MobileApp.FrontDesk.Checkin.IamVisitorMessagetextI am a visitor message
MobileApp.FrontDesk.Checkin.IamAMemberMessagetextI am a member message
MobileApp.FrontDesk.Checkin.DoYouHaveVisitorCodeMessagetextDo you have a code message
MobileApp.FrontDesk.Checkin.WelcomeTitletextWelcome title after check-in
MobileApp.FrontDesk.Checkin.WelcomeVisitortextWelcome text for visitors
MobileApp.FrontDesk.Checkin.WelcomeEventtextWelcome text for event attendees
MobileApp.FrontDesk.Checkin.WelcomeMembertextWelcome text for customers
MobileApp.FrontDesk.Checkin.ByeByeTitletextGoodbye title after check-out
MobileApp.FrontDesk.Checkin.ByeByeMessagetextGoodbye message after check-out

NexBoard

KeyTypeDescription
MobileApp.NexBoard.ShowLastCleanedboolShow when the resource was last cleaned

NexEvents

KeyTypeDescription
MobileApp.NexBoard.Checkin.QRCodesboolInclude QR code in attendee confirmation email

NexDelivery

KeyTypeDescription
MobileApp.FrontDesk.Delivery.HideSignatureScreenboolHide collection signature screens (reversed: False = shown)
MobileApp.FrontDesk.Delivery.HidePrintButtonboolHide delivery label print button (reversed: False = shown)

NexKIOSK

KeyTypeDescription
NexKiosk.EnabledboolEnable NexKIOSK
NexKiosk.QuickSale.EnabledboolEnable Quick Sale mode
NexKiosk.QuickSale.CoworkerIdtextCustomer for Quick Sale invoices (entity ID)
NexKiosk.ShowAllInvoicesboolShow all invoices, including those created outside NexKiosk
NexKiosk.POS.Payments.EnabledboolShow payment add/refund buttons
NexKiosk.POS.CoworkerTypetextCustomer type filter for POS (eCoworkerType enum value)
NexKiosk.KIOSK.Discounts.EnabledboolAllow discounts in Kiosk mode
NexKiosk.DisableAddToBillboolDisable add-to-bill for customers (reversed: False = allowed)
NexKiosk.StripeLocationIdtextStripe Location Id

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the BusinessSetting-Create role.

Request Body

Required Fields

BusinessId
integer
required
Business Id.
Name
string
required
Dotted setting key that identifies this configuration entry (e.g. Billing.AddTaxToInvoices, Bookings.SendConfirmationEmail).

Optional Fields

Value
string
Setting value stored as a string. Boolean settings use True/False, numeric settings use the number as text, dates use ISO 8601 format.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/businesssettings" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": ""
}'

Response

200

Status
integer
HTTP status code. 200 on success.
Message
string
A human-readable message confirming the creation.
Value
object
Contains the Id of the newly created record.
WasSuccessful
boolean
true if the businesssetting was created successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "BusinessSetting was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

Message
string
A summary of the validation error(s), in the format PropertyName: error message.
Value
any
null on validation failure.
Errors
object[]
Array of validation errors.
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}