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
Key
Type
Description
Billing.BillToName
text
Company / trading name shown on invoices
Billing.BillToAddress
text
Billing address shown on invoices
Billing.BillToCity
text
City shown on invoices
Billing.BillToPostCode
text
Zip / post code shown on invoices
Billing.BillToState
text
State / Province shown on invoices
Billing.BillToCountry
text
Country (entity ID) shown on invoices
General.BusinessTaxIDNumber
text
VAT / Tax ID number
Billing — Bank details
Key
Type
Description
Billing.BankName
text
Bank name included at text of invoices
Billing.BankCode
text
Bank code
Billing.SortCode
text
Sort code / routing number
Billing.AccountNumber
text
Account number
Billing — Payment notifications
Key
Type
Description
Payments.NotifyOnInvoiceDefault
bool
Enable notifications about new invoices for customers registered from now on
Payments.NotifyOnNewPaymentDefault
bool
Enable notifications about successful payments for customers registered from now on
Payments.NotifyOnFailedPaymentDefault
bool
Enable notifications about failed payments for customers registered from now on
Payments.SuccessNotificationsEmail
text
Email address to send a copy of every successful payment notification to
Payments.FailureNotificationsEmail
text
Email address to send a copy of every failed payment notification to
Billing — Invoice contents
Key
Type
Description
Billing.CreateZeroValueInvoices
bool
Create invoices even when total is zero
Billing.UsePeriodAsInvoiceDate
bool
Use the contract billing period start date as the invoice issue date
Billing.InvoicesIncludeProductNotes
bool
Include product sale notes in invoice lines
Billing.InvoicesIncludeExtraServiceNotes
bool
Include time-credit sale notes in invoice lines
Billing.InvoicesIncludeBookingNotes
bool
Include booking notes in invoice lines
Billing.InvoicesIncludeTimePassNotes
bool
Include pass sale notes in invoice lines
Billing.InvoicesIncludeFullyCreditedBookings
bool
Include lines for bookings fully paid by credit
Billing — Invoice split
Key
Type
Description
Payments.CreateAnInvoicePerSpace
bool
Create an invoice per location based on transactions
Billing.SegregateContracts
bool
Create an invoice per contract if a customer renews more than one
Payments.CreateAnInvoicePerPurchaseOrder
bool
Create an invoice per purchase order reference
Billing.InvoiceSegregation.UsePreviousDay
bool
Set secondary invoice date to one day earlier than primary
Billing.SegregateBookings
bool
Move bookings to secondary invoice
Billing.SegregateProducts
bool
Move products to secondary invoice
Billing.SegregateTimePasses
bool
Move passes to secondary invoice
Billing.SegregateTickets
bool
Move event tickets to secondary invoice
Billing.SegregateCharges
bool
Move charges to secondary invoice
Billing — Invoice formatting
Key
Type
Description
Billing.InvoiceFormat.Sales
text
Invoice reference format pattern. Use {1:0000} for sequential number, {0} for location reference, {year}/{month}/{day} for date parts
Billing.InvoiceFormat.Draft
text
Invoice draft reference format pattern
Billing.InvoiceFormat.SeparateCreditNotes
bool
Use a different number sequence for credit notes
Billing.InvoiceFormat.CreditNote
text
Credit note reference format pattern
Payments.PaymentReferenceGenerator
text
Payment reference format (ePaymentReferenceGeneratorType enum value)
Billing — Amount rounding
Key
Type
Description
Billing.Rounding.Enable
bool
Enable amount rounding
Billing.Rounding.Line.DecimalPoints
number
Decimal places for rounding each invoice line
Billing.Rounding.DecimalPoints
number
Decimal places for rounding invoice totals
Billing — Locked period
Key
Type
Description
Billing.LockDates
date
Lock invoices and payments made before this date
Billing — Tax
Key
Type
Description
Billing.AddTaxToInvoices
bool
Add tax to invoices
Billing.RequireTaxRate
bool
Require all sales to have a defined tax rate
Billing.PricesIncludeTax
bool
Prices typed in the back-end include tax
Billing.DisplayTaxOnWebsite
bool
Display prices including tax on website, app and emails
Billing.TaxValue
text
Default tax rate (entity ID of the tax rate record)
Billing — Financial accounts
Key
Type
Description
Billing.RequireFinancialAccount
bool
Require all sales to have a financial account
Billing — Proposals
Key
Type
Description
Billing.DoNotIssueInvoice
bool
Leave contracts issued by proposals as paused — do not issue invoices
Payments & Currency
Key
Type
Description
Payments.Currency
text
Secondary currency (entity ID) — payments processed in this currency
Payments.ExchangeRate
number
Exchange rate from primary to secondary currency
Payments.RemindToPayEvery
number
Number of days between payment reminders
Checkout — Plans
Key
Type
Description
Forms.Enquiries.Enabled
bool
Allow customers to enquire about plans
Forms.Enquiries.Tour.Enabled
bool
Include a tour as part of the enquiry
Forms.Enquiries.TariffIds.OnlyEnquire
bool
Prevent selected plans from being purchased directly
Checkout — Products
Key
Type
Description
Store.AlwaysInvoice
bool
Always invoice products immediately when purchased
Checkout — Bookings
Key
Type
Description
Bookings.CancelUnPaidBookingsForNonSubscribers
bool
Require up-front payment for bookings made by contacts
Bookings.CancelUnPaidBookingsForSubscribers
bool
Require up-front payment for bookings made by members
Bookings.AutoPayContactBookings
bool
Invoice and collect payment for contact bookings as they end
Bookings.AutoPayMemberBookings
bool
Invoice and collect payment for member bookings as they end
Bookings.ChargeBookingsImmediately
bool
Calculate price and use credit immediately when booking is requested
Bookings.RequestDrafts
bool
Allow customers to request a quote instead of confirming
Checkout — Event tickets
Key
Type
Description
Events.CanCancelTickets
bool
Allow customers to cancel event tickets
Events.CancelUnpaidTickets
bool
Automatically cancel unpaid tickets purchased by contacts
Events.InvoiceAttendee
bool
Invoice the event buyer instead of their team paying customer
Bookings — General
Key
Type
Description
Bookings.EnableGuestBookings
bool
Allow new customers to register and book from calendar
Bookings.DoNotCreateGuestAccount
bool
Do not create account for guest bookers (reversed: False = create account)
Bookings.RegisterConactBookersAsVisitors
bool
Register all contacts as visitors when they book
Bookings.DoNotRegisterKnownCustomersAsVisitors
bool
Do not register known customers as visitors when added as attendees (reversed)
Bookings.CancelIfNotChekedIn
bool
Require attendees to check in using NexBoard and cancel no-shows
Bookings.RequireConfirmation.Members
bool
Bookings made by members must be confirmed first
Bookings.RequireConfirmation.Contacts
bool
Bookings made by contacts must be confirmed first
Bookings — Notifications
Key
Type
Description
Bookings.SendConfirmationEmail
bool
Send booking confirmation email to customer
Bookings.SendConfirmationToVisitors
bool
Send booking confirmation to every guest added to a booking
Bookings.SendReminderEmail
bool
Send booking reminder email before booking begins
Bookings.ReminderEmailMinutes
number
Minutes before each booking to send reminder
Bookings.SendAccessCode
bool
Include Internet Access Token in booking emails
Bookings — Charges & payments
Key
Type
Description
Bookings.PaidBookingsCancellationPolicy
text
Cancellation policy for invoiced bookings (ePaidBookingsCancellationPolicy enum value)
Bookings.UseCreditToPayBookingProducts
bool
Use available credit to pay for products added to bookings
Bookings.RejectIfNoCreditIsAvailable
bool
Reject bookings if customers do not have enough credit
Bookings.DueDateIgnoreProducts
bool
Ignore recurrent products when calculating booking due dates
Bookings — Calendar
Key
Type
Description
Calendars.ShowMemberDetailsInFeed
bool
Show customer names and company in calendar
Calendars.IncludeEventsInCalendar
bool
Include events connected to a resource in calendar
Send welcome email with access details to new users
Members.UseInvitationLink
bool
Restrict sign-ups to invite only
Signup.UseCaptcha
bool
Protect sign-up with Google Captcha
Signup.AskForPassword
bool
Let customers create their own password at sign-up
Signup.ShowStoreOnSignUp
bool
Offer additional products during sign-up
Signup.KeepNewAccountsOnHold
bool
Keep new customer accounts suspended by default
Signup.MemberMustChooseAPricePlan
bool
Suspend new accounts that do not complete payment
Signup.GooglePlusSignUp
bool
Allow sign-up with Google
Signup.GooglePlusSignIn
bool
Allow sign-in with Google
Security.AutoRegister
bool
Automatically register existing customers at new locations
Security.AllowPasswordReset
bool
Let users change their password
Security.AutoGeneratePincode
bool
Auto-generate 5-digit access pin-codes
Security.GenerateUniquePincode
bool
Require pin-codes to be unique across all customers
New customer access defaults
Key
Type
Description
Access.Defaults.Network
bool
New customers have access to IT network by default
Access.Defaults.Bookings
bool
New customers can make bookings by default
Access.Defaults.Products
bool
New customers can purchase products by default
Access.Defaults.Events
bool
New customers can purchase events by default
Access.Defaults.Community
bool
New customers can use discussion boards by default
Forms — Sign-up personal details
Key
Type
Description
SignupForm.LandLine
text
Phone field requirement (eFormFieldStatus value)
SignupForm.MobilePhone
text
Mobile / Cell field requirement (eFormFieldStatus value)
SignupForm.Gender
text
Gender field requirement (eFormFieldStatus value)
SignupForm.DateOfBirth
text
Date of birth field requirement (eFormFieldStatus value)
SignupForm.ShowContactSection
bool
Show contact details section in sign-up and profile forms
SignupForm.ShowBillingSection
bool
Show billing details section in sign-up and profile forms
SignupForm.ShowProfileSection
bool
Show profile details section in sign-up form
SignupForm.Avatar
text
Photo profile field requirement (eFormFieldStatus value)
Forms — Contact details fields
Key
Type
Description
Forms.Address
text
Address form field requirement (eFormFieldStatus value)
Forms.CityName
text
City form field requirement (eFormFieldStatus value)
Forms.State
text
State form field requirement (eFormFieldStatus value)
Forms.PostCode
text
Postcode / zip form field requirement (eFormFieldStatus value)
Forms.Country
text
Country form field requirement (eFormFieldStatus value)
Forms — Billing details fields
Key
Type
Description
Forms.BillingName
text
Company name billing field requirement (eFormFieldStatus value)
Forms.TaxIDNumber
text
Tax / Company ID billing field requirement (eFormFieldStatus value)
Forms.BillingAddress
text
Address billing field requirement (eFormFieldStatus value)
Forms.BillingCityName
text
City billing field requirement (eFormFieldStatus value)
Forms.BillingState
text
State billing field requirement (eFormFieldStatus value)
Forms.BillingPostCode
text
Postcode / zip billing field requirement (eFormFieldStatus value)
Forms.BillingEmail
text
Billing email field requirement (eFormFieldStatus value)
Forms.BillingCountry
text
Billing country field requirement (eFormFieldStatus value)
Forms — Profile fields
Key
Type
Description
Forms.CompanyName
text
Company name profile field requirement (eFormFieldStatus value)
Forms.BusinessArea
text
Industry profile field requirement (eFormFieldStatus value)
Forms.Position
text
Position profile field requirement (eFormFieldStatus value)
Forms.ProfileSummary
text
Profile bio field requirement (eFormFieldStatus value)
Forms.PorfileTags
text
Skills profile field requirement (eFormFieldStatus value)
Forms.ProfileWebiste
text
Website profile field requirement (eFormFieldStatus value)
Legal terms & policies
Key
Type
Description
Legal.VisitorTermsAndConditions
markdown
Visitor terms and conditions shown during NexIO registration
Legal.CheckoutTermsAndConditions
markdown
Checkout terms shown before booking or payment
Legal.Privacy
markdown
Privacy policy linked in portal footer
Legal.Cookies
markdown
Cookies policy linked in portal footer and login page
Portal — Appearance & version
Key
Type
Description
Nexudus.NextJS.Version
text
Members Portal version
PublicWebSite.IncludeInLocationSelector
bool
Display this location in website and app location selector
PublicWebSite.ShowOnlyRegisteredWithLocations
bool
List only locations customers are registered with
Portal — Features
Key
Type
Description
PublicWebSite.MyAccount
bool
Enable My Account section
PublicWebSite.Help
bool
Enable help-desk section
PublicWebSite.Deliveries
bool
Enable deliveries section
PublicWebSite.Contact
bool
Enable contact form
PublicWebSite.CommunityBoard
bool
Enable discussion boards section
PublicWebSite.Events
bool
Enable events and tickets section
Members.PublicDirectory
bool
Enable directory section
Blog.Enabled
bool
Enable articles section
PublicWebSite.Attendance
bool
Enable team attendance section
PublicWebSite.Visitors
bool
Enable visitor registration section
PublicWebSite.Tour
bool
Enable tour request form
PublicWebSite.Metrics
bool
Enable metrics section
PublicWebSite.Notifications
bool
Enable notifications section
Portal — Home page
Key
Type
Description
PublicWebSite.Home.UseCommunityDashboard
bool
Show community feed when customers log in
HomePage.Banner
bool
Show rotating banner on home page
HomePage.ShowIconBar
bool
Show shortcuts to commonly used sections
HomePage.ShowClaimBar
bool
Show primary claim text
HomePage.ShowServicesBar
bool
Show offered services section
HomePage.ShowFooterClaimBar
bool
Show secondary claim text
HomePage.ShowCheckedInMembers
bool
Show list of checked-in customers
HomePage.NewsletterSignUp
bool
Show newsletter sign-up section
Portal — Banner
Key
Type
Description
HomePage.BannerText
text
Banner main text
HomePage.BannerSmallText
text
Banner secondary text
Portal — Shortcuts
Key
Type
Description
HomePage.AboutUsIcon
bool
Show shortcut to about us
HomePage.EventsIcon
bool
Show shortcut to events
HomePage.DirectoryIcon
bool
Show shortcut to directory
HomePage.BookingsIcon
bool
Show shortcut to bookings calendar
HomePage.MyAccountIcon
bool
Show shortcut to my account or sign-up
Portal — Primary claim
Key
Type
Description
HomePage.ClaimText
text
Primary claim main text
HomePage.ClaimSmallTextLogout
text
Primary claim secondary text for logged-out users
HomePage.ClaimSmallTextLogin
text
Primary claim secondary text for logged-in users
Portal — Service tiles
Key
Type
Description
HomePage.ShowWorkspaceService
bool
Show workspace tile
HomePage.WorkSpaceShortText
text
Workspace tile heading
HomePage.WorkSpaceLongText
text
Workspace tile description
HomePage.ShowBookingsService
bool
Show bookings tile
HomePage.BookingsShortText
text
Bookings tile heading
HomePage.BookingsLongText
text
Bookings tile description
HomePage.ShowCommunityService
bool
Show community tile
HomePage.CommunityShortText
text
Community tile heading
HomePage.CommunityLongText
text
Community tile description
HomePage.ShowChildCareService
bool
Show child care tile
HomePage.ChildCareShortText
text
Child care tile heading
HomePage.ChildCareLongText
text
Child care tile description
HomePage.ShowBenefitsService
bool
Show benefits tile
HomePage.BenefitsShortText
text
Benefits tile heading
HomePage.BenefitsLongText
text
Benefits tile description
HomePage.ShowEventsService
bool
Show events tile
HomePage.EventsShortText
text
Events tile heading
HomePage.EventsLongText
text
Events tile description
Portal — Secondary claim & footer
Key
Type
Description
HomePage.FooterClaimText
text
Secondary claim main text
Footer.SayingText
text
Footer saying text
Footer.SayingAuthor
text
Footer saying author
Portal — Social networks
Key
Type
Description
Social.Twitter
text
X (Twitter) handle
Social.Flickr
text
Flickr URL
Social.Facebook
text
Facebook URL
Social.Instagram
text
Instagram 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.
Show all invoices, including those created outside NexKiosk
NexKiosk.POS.Payments.Enabled
bool
Show payment add/refund buttons
NexKiosk.POS.CoworkerType
text
Customer type filter for POS (eCoworkerType enum value)
NexKiosk.KIOSK.Discounts.Enabled
bool
Allow discounts in Kiosk mode
NexKiosk.DisableAddToBill
bool
Disable add-to-bill for customers (reversed: False = allowed)
NexKiosk.StripeLocationId
text
Stripe 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-Read role.
Path Parameters
integer
required
The Id of the BusinessSetting record to retrieve.
Code Examples
curl -X GET \ "https://spaces.nexudus.com/api/sys/businesssettings/87654321" \ -H "Authorization: Bearer YOUR_TOKEN"