Skip to content
D
Documentation

New branch

reference
8 min readUpdated

A branch record stores the company information used to identify and administer one branch. New branch is the company-administration screen where you enter that record before reviewing or editing it.

If you need to…Go to
Work with the branch listBranches
Continue editing an existing branchExisting branch
Review the branch-logo edit-record variantBranch logo
The healthy New branch form with its main fields and save actions

Before you start

The branch form is the company-administration entry point for creating a branch record. Your subscription and access determine whether the form is available; the branch data and required values determine whether it can be saved.

Prerequisites

Have or confirmWhy it matters
Signed-in company-administration accessUse the signed-in application to open the branch area.
Branch configuration included in your subscriptionThe branch form is available when your subscription includes branch configuration.
The branch record is available on the pageThe main form appears only when the branch exists.
A value for Display Name when the branch name is emptyDisplay Name is required under that company configuration.
A day and month for Financial Year Start when either value is emptyEach part of Financial Year Start is required under that company configuration.
Values for Reference Currency and Local currencyBoth controls are required.
The branch identity, registration, financial-year, currency, address, and contact informationThese values complete the information areas on the form.

On the available live form, Display Name, Financial Year Start, Reference Currency, and Local currency carry required markers. The remaining fields are optional. Save and Save and Close are available for a new branch when editing is allowed or when a new branch is allowed and the branch ID is zero.

Find and open the branch screen

The branch area is where you start a new branch or return to an existing branch for comparison and continued editing. Use Branches to locate those records.

Prerequisites

  • You have the company-administration access described in Before you start.
  • You know whether you are starting a new branch or continuing an existing one.

Steps

  1. Open Branches.

  2. Choose the path that matches your task.

    If you need to…Do this
    Start a new branchStart a new branch from the branch area.
    Continue an existing branchOpen its branch record from the branch list.
  3. Confirm that the branch form is open.

    The open New branch form with its main fields

Result: The branch form is open with Save and Save and Close available, or the existing branch record is open for review or continuation.

Understand the branch information

A branch record brings together the identity, legal registration, financial-year, currency, address, and contact information that people use to administer that branch.

Use the field labels below to identify the information areas on the form.

Information areaControlWhat to enter or select
IdentityDisplay NameThe branch name. It is conditionally required when the branch name is empty, and pattern validation applies.
IdentityFull NameThe branch's full name. Pattern validation applies.
IdentityStatementThe branch statement text.
IdentityManaging DirectorThe managing director's name or details.
RegistrationCompany Registration No.The company registration number.
RegistrationVAT ID NumberThe VAT identification number.
TaxVatRateA number from 0 through 100.
Financial yearFinancial Year StartA day and a month for the start of the financial year. Both are conditionally required when empty.
CurrencyReference CurrencySelect from the available currency values. The control is disabled when the branch has jobs.
CurrencyLocal currencyChoices come from the company-currency list.
AddressStreetThe street address. The address area requires an address record.
AddressZip CodeThe postal or ZIP code.
AddressCountryThe country from the country list.
AddressStateThe state or region.
AddressCityThe city.

For Financial Year Start, choose from these values:

PartChoices
Day1 through 30
MonthJanuary, February, March, April, May, June, July, August, September, October, November, or December

The contact area starts with Contact Information. Select it to open the contact choices, then choose the contact field you need.

Contact choiceField added
PhoneA phone contact field
FaxA fax contact field
MobileA mobile contact field
EmailAn email contact field
WebsiteA website contact field
Online SupportAn online-support contact field

Contact entries repeat from the branch's contact information list. Phone, fax, and mobile values accept up to 20 characters and use the field's validation key handler.

The Contact Information choices open above the branch form

Complete and save branch information

Enter the branch information and select a save action to create the branch record.

Prerequisites

Steps

  1. In Display Name, enter the branch name when the branch name is empty.

  2. Enter the branch's full name in Full Name.

  3. In VatRate, enter a value from 0 through 100 when a tax rate applies.

  4. In Financial Year Start, select the day and month.

    PartChoices
    Day1 through 30
    MonthJanuary through December
  5. Select values in Reference Currency and Local currency.

  6. Select a value in Country.

  7. Select Contact Information.

  8. Select a contact choice.

    If you need to add…Select
    A phone contactPhone
    A fax contactFax
    A mobile contactMobile
    An email contactEmail
    A website contactWebsite
    An online-support contactOnline Support
  9. Enter the contact value in the field that the selected contact choice adds.

  10. Choose one save action.

If you need to…Select
Save the branch and remain on the pageSave
Save the branch and request the close actionSave and Close

After a successful branch save, the application uses the message Branch saved Successfully. Leaving the page with unsaved changes prompts you with Do you want to save your changes?.

Result: The branch information is submitted through the selected save action; the success message is Branch saved Successfully when the save succeeds.

Handle new and existing branch variations

The branch screen changes after a branch has an ID and when you select different configuration panels. A new branch begins with the main information form; a saved branch exposes review and history controls.

SituationWhat appears
The branch is newDefault and Last Modifications are not available.
The branch is savedDefault and Last Modifications become available.
The default-margin selection is activeThe default-margin panel appears.
The log-history selection is activeThe log-history panel appears.
The fixed-percentage selection is activeA fixed margin field appears.
Descending Accumulative or Descending Absolute is activeThe corresponding margin fields appear in the default margin panel.
The branch has a logoThe logo-delete icon is shown.
The branch existsThe logo-upload icon is shown.
The logo upload is readySelect Attach in the upload component to complete the upload.

Select Default to open the default margin panel. Select Last Modifications to open the change-history panel. The default margin panel has its own Save action. The margin area includes neither Registrations nor a currency choice.

When validation or saving goes wrong

The following table matches the messages associated with this page to the action that can resolve or contain the problem.

MessageWhen to actReader action
Name is requiredThe branch name is empty where Display Name is required.Enter a value in Display Name.
Just '_' '-' And '.' Characters AcceptedThe name pattern rejects the entered value.Correct Display Name or Full Name to a value accepted by the field pattern.
requiredA required Financial Year Start value is empty.Select both the day and month for Financial Year Start.
Branch does not existThe branch lookup does not find the branch record.Return to the branch area and open or start the branch again.
Please insert degressive margin listA degressive margin selection has no margin list.Add the degressive margin list before saving that margin configuration.
Error: Server ErrorThe logo operation reports a server error.Review the logo information before continuing.
Error while saving data Saving margin data reports an error.Review the margin information before saving again.
Do you want to save your changes?Leaving with unsaved changes invokes the unsaved-change prompt.Choose the dialog action that matches whether you want to keep or discard the changes.
Are you sure you want to delete this item?A delete action requests confirmation.Confirm only when you intend to delete that item.
Logo Deleted SuccessfullyThe logo deletion succeeds.Continue with the branch record or upload another logo.
Data saved SuccessfullyDefault margin data saves successfully.Continue reviewing the saved margin configuration.

Out of scope

The shared popup import flow belongs to the application's shared import feature, not to this branch creation and branch-edit page. Its generic upload and import controls are therefore outside this page.

The following surfaces are also outside the branch information covered here:

  • The nominal percentage controls are disabled by the page condition and do not appear.
  • The Registrations tab does not appear.
  • Bank-account controls are commented out rather than available branch controls.
  • Some icon-only actions have no visible label.

Continue from the branch record

A saved branch is the record you return to when you need to review its information or continue editing its configuration. The saved record exposes Default and Last Modifications for those follow-up views.

Prerequisites

  • The branch information has been submitted through a save action.
  • You know whether you want the branch list or an existing branch record.

Steps

  1. Return to Branches to review the branch list.
  2. Open the saved branch record when you need to compare or edit its information.
  3. Select Default to review the default margin panel.
  4. Select Last Modifications to review the change-history panel.

Result: You are back at the branch list or an existing branch record with the available review panels.

Was this page helpful?

Need help using the product?