Skip to content
D
Documentation

Branches

reference
12 min readUpdated

Branches

The Branches configuration list contains your company’s branch records. Use it to find an existing branch, open its record, or start a new branch configuration.

A branch record is the company information maintained for one branch. After this definition, “branch” means that record unless the text names a list or form.

If you need to…Go to
Check whether the list and New action are availableBefore you start
Prepare the information needed for branch workPrerequisites
Find a branch or start a new recordFind and open a branch
Understand the list actionsList tools and branch actions
Identify a field or its ruleUnderstand the branch information
Review controls that appear for saved branchesHandle new and existing branch variations
Enter values and save a branchEnter and save branch information
Correct a message from the list or formWhen validation or saving goes wrong
Continue on a branch record or logo pageContinue from the branch record
Create a branchNew branch
Maintain an existing branchEdit branch
Maintain a branch logoEdit branch logo
Open the company configuration areaConfiguration home

The Branches page is the configuration list for branch records. The list can show configured captions such as Branch Name, Country, City, Managing Director, Financial Year Start, and Reference Currency, together with a main-branch indicator. The list shows five rows and a count of 5; its visible columns include Branch Name, Country, and Mail. Use the column headers visible in the list to identify the information available there.

The Branches list with its row count, visible columns, and New action

Before you start

Branches subscription and company access determine whether you can work with branch records. The branch count also determines whether New opens a form or takes you to the subscription-upgrade surface.

ConditionWhat you see or can do
Branches subscription is includedThe Branches list and branch form are available when the other access conditions are met.
Branches subscription is not includedThe list and form are replaced by the subscription-upgrade surface.
Your access allows a new branch and the branch limit is not exceededNew opens the new-branch form.
The branch limit is reachedNew opens the upgrade flow instead of the new-branch form.

Note: The branch count determines whether New opens the new-branch form or the upgrade flow. If the action opens the upgrade flow, use the subscription surface.

Prerequisites

Branch-list work starts with signed-in company configuration access and the branch information you need to review or record. Have the following ready before you open a form.

Have or confirmWhy it matters
Branches subscriptionWithout it, the list and form are replaced by the subscription-upgrade surface.
Access to company configurationAccess determines whether you can reach and work with the Branches page.
A new-branch allowance and an available branch slotThese conditions determine whether New opens the form or the upgrade flow.
Branch identity and company detailsThese values identify the branch and complete its company information.
Financial-year day and monthFinancial Year Start is required when its configurable values are empty.
Reference and local currenciesReference Currency and Local currency are required.
Address information, when an address existsStreet, Zip Code, Country, State, and City appear with the branch address.

Find and open a branch

Use the Branches list to identify a branch row, open its existing record, or begin a new branch. The list shows five rows and a count of 5.

Prerequisites

  • You have the Branches subscription and company configuration access.
  • For a new branch, your account can create a branch and the branch limit is not exceeded.
  • For an existing branch, the branch row is present in the list.

Steps

  1. Open Configuration home.
  2. Open the company configuration area.
  3. Select Branches.
  4. Review the visible branch rows and the count above the list.
  5. Select New when you need to begin a branch record.
  6. Confirm that the new-branch form opens.
  7. For an existing branch, select its row to open that branch record instead.
The new-branch form opened from the Branches list

Result: The new-branch form is open, or the selected existing branch record is open.

After opening a branch, continue to the field reference to review its information.

List tools and branch actions

The Branches list combines list-management tools with actions on branch records. Use the toolbar above the list for list work and the actions shown on each branch row for branch work.

Tool or actionUse
Save ChangesUse the named list save action when the list provides changes to save.
DeleteUse the named shared action where the active list surface provides it.
ExportOpen export choices for Excel or PDF.
NewOpen the new-branch form when the branch limit is not exceeded.
Main-branch statusIdentify which row is the main branch.

Export the branch list

To export the list:

Prerequisites

  • The Branches list is open.
  • The list contains data when you expect an export.

Steps

  1. Select Export.
  2. Choose the required Excel or PDF option.
  3. Confirm the export action in the dialog.

If the list has no data to export, the message is NO Data to Export.

Result: The selected export action is confirmed, or the list shows NO Data to Export.

Make a branch the main branch

To make a branch the main branch:

Prerequisites

  • The Branches list is open.
  • The branch row is not the current main branch.

Steps

  1. Open the row’s main-branch action.
  2. Select Yes in the confirmation when you intend to make the row the main branch.
  3. Select Cancel when you do not want to continue.

The confirmation path returns Data Saved Successfully.

Result: The main-branch action is confirmed or cancelled; a confirmed action returns Data Saved Successfully.

A branch row with its main-branch status and confirmation choices

After reviewing list actions, continue to the field reference to identify the values used on a branch record.

The branch row does not offer an active delete dropdown. Use the active list actions and the branch record pages linked from this page instead.

Understand the branch information

A branch record brings together the branch identity, company and registration details, financial year, currencies, address, contacts, margins, and modification history used in company configuration.

Field reference

AreaFieldType and rule
IdentityDisplay NameText. Required when empty where the company configuration makes the requirement applicable.
IdentityFull NameText. No required marker is shown.
IdentityStatementText. No required marker is shown.
CompanyManaging DirectorText. No required marker is shown.
RegistrationCompany Registration No.Text. No required marker is shown.
RegistrationVAT ID NumberText. No required marker is shown.
TaxVatRateNumber from 0 through 100.
Financial yearFinancial Year StartSelect a day and month. Required when empty where the configuration makes the requirement applicable.
CurrencyReference CurrencyRequired select. The options include United Arab Emirates Dirham, Kwait Dinar, Euro Member Countries, United Kingdom Pound, China Yuan Renminbi, United States Dollar, Egypt Pound, Qatari Riyal, and Saudi Arabian Rial.
CurrencyLocal currencyRequired select. Choose from the available currency list.
AddressStreetText. Appears when the branch has an address.
AddressZip CodeNumber. Appears when the branch has an address.
AddressCountrySelect. The options include Angola, Anguilla, Åland Islands, Albania, Andorra, Netherlands Antilles, United Arab Emirates, Argentina, Armenia, American Samoa, Antarctica, French Southern Territories, Antigua and Barbuda, and Australia.
AddressStateText. Appears when the branch has an address.
AddressCityText. Appears when the branch has an address.

The new-branch form shows required markers on Display Name, Financial Year Start, Reference Currency, and Local currency. The other labelled fields shown above have no required marker.

For Financial Year Start, the day values are 1 through 31, and the month values are January, February, March, April, May, June, July, August, September, October, November, and December.

The list has no fixed set of statically named data columns. Work from the headers visible in the list.

Additional contact values, margin controls, log-history filters, and file inputs appear in the branch forms.

After identifying the fields, use the next section to distinguish the areas available on a new branch from those available after saving.

Handle new and existing branch variations

The branch form changes when the record is new or saved, when you select a saved-record area, and when you choose a margin type. These variations determine which branch information is available at that moment.

Branch situation or choiceWhat appears
Branch subscription is not includedThe subscription-upgrade surface replaces the branch body.
CompanyBranchID is not presentDefault and Last Modifications are unavailable.
CompanyBranchID is presentDefault and Last Modifications appear for the saved branch.
Default is selectedThe default-margin area and its Save action appear.
Last Modifications is selectedThe log-history area appears with dated audit entries by users.
Fixed margin type is selectedFixed-percentage controls appear.
Accumulative margin type is selectedAccumulative/degressive margin controls appear.
Decreased margin type is selectedDecreased/degressive margin controls appear.
An existing branch is availableAttach can be used in the logo-upload surface.

Contact entries can be added with Phone, Fax, Mobile, Email, Website, and Online Support. The available saved-record areas are Default and Last Modifications. The Registrations tab, Reference Commission, Reference Margin, and the cumulative-margin currency control do not appear as available branch surfaces.

The saved branch Default area with margin choices and controls

The shared popup import surface belongs to the application’s shared import feature. Its generic actions are outside the Branches list procedure.

After checking which areas are available, enter the branch values and choose a save action.

Enter and save branch information

Use the new-branch form to enter the branch record, add the contact entries that apply, and choose the save action for the result you need. The same named save controls are used when maintaining an existing branch.

Prerequisites

  • The Branches list is open and New is available, or an existing branch record is open.
  • You have the branch identity, company, financial-year, currency, address, and contact values.
  • The required values are ready: Display Name when applicable, both parts of Financial Year Start, Reference Currency, and Local currency.
If you need to…Follow the related steps
Create a branchUse steps 1 through 11, beginning with New.
Maintain an existing branchStart at step 2, then use steps 3 through 11 for the values you are changing.
Save and remain on the recordUse step 10 and select Save.
Save and leave the recordUse step 11 and select Save and Close.

Steps

  1. Select New to open the new-branch form when you are creating a branch.
  2. Enter the branch identity and company values in the labelled fields.
  3. Enter a VatRate from 0 through 100 when a tax rate applies.
  4. Select a day and month in Financial Year Start.
  5. Select a value in Reference Currency.
  6. Select a value in Local currency.
  7. Enter the address values in Street, Zip Code, Country, State, and City when the branch has an address.
  8. Select one of Phone, Fax, Mobile, Email, Website, or Online Support to add a contact entry.
  9. Enter the contact value in the field added for that contact type.
  10. Select Save to save the branch and remain on the record.
  11. Select Save and Close when you want to save the branch and leave the record.
If you need to…Select
Save and remain on the branch recordSave
Save and leave the branch recordSave and Close
Upload a branch logoAttach in the logo-upload surface

After a branch save, the message is Branch saved Successfully. The default-margin area has its own Save action and returns Data saved Successfully when its margin data is saved. The passing surface test opened the form and confirmed its fields without submitting it.

The new-branch form with required fields, contact choices, and save actions

Result: The branch information is entered and submitted through the selected save action; a successful branch save uses Branch saved Successfully.

After saving, use the exact message to resolve any validation or save problem before continuing.

When validation or saving goes wrong

Use the exact message on screen to choose the supported correction or follow-up.

MessageWhere it appliesWhat to do
Forbidden characters detected. Please remove them and try again.Branch-list filteringRemove the forbidden characters and try the filter again.
NO Data to ExportExportReview the list contents before exporting.
Data Importing completedImportContinue from the completed import surface.
Data Saved SuccessfullyList save or main-branch confirmationContinue after the list action returns this message.
Data Deleted SuccessfullyNamed shared delete actionContinue only when the intended delete action returns this message.
Branch saved SuccessfullyBranch form saveContinue from the branch record after the save message appears.
Branch does not existBranch form lookupReturn to the Branches list and open an existing branch or start a new one.
Please insert degressive margin listDecreased/degressive margin saveAdd the required degressive margin list before saving the margin settings.
Data saved SuccessfullyDefault-margin saveContinue from the saved default-margin area.
Error while saving data Margin saveReview the margin information and select Save again.
Logo Deleted SuccessfullyLogo deletionContinue with the branch record or attach another logo.

Continue from the branch record

The Branches list hands work to the page that owns the selected branch record. A new action opens the new record; a saved record exposes Default and Last Modifications; the registered logo variant owns the branch-logo work.

If you need to…Continue to…
Create a branch from the new recordNew branch
Maintain an existing branchEdit branch
Maintain the branch logoEdit branch logo
Return to the branch listBranches

Prerequisites

  • For an existing record, select a saved branch row.
  • For a new record, have New available and the required branch information ready.

Steps

  1. Select New when you need the new-branch page.
  2. Select an existing branch row when you need its edit record.
  3. Select Default on a saved branch to review default-margin settings.
  4. Select Last Modifications on a saved branch to review recorded changes.
  5. Open Edit branch logo when the branch-logo record page is the next task.

Result: The page that owns the next branch task is open.

Use the linked page that matches the task you selected; return to this list when you need another branch.

Out of scope on this page

The following surfaces are not available for Branches list work on this page:

  • The list delete dropdown is not active on a branch row.
  • The Registrations tab does not appear.
  • Reference Commission and Reference Margin do not appear.
  • The cumulative-margin currency control does not appear.
  • Generic shared-popup actions are outside the Branches list’s owned work.

Use the visible list headers, controls, and messages when working in your own company configuration.

Was this page helpful?

Need help using the product?