# New branch

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 list | [Branches](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-view) |
| Continue editing an existing branch | [Existing branch](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-edit-record) |
| Review the branch-logo edit-record variant | [Branch logo](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-edit-record-2) |

![The healthy New branch form with its main fields and save actions](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/73d408b879290325385052eb7e5fcc88.png)

## 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 confirm | Why it matters |
|---|---|
| Signed-in company-administration access | Use the signed-in application to open the branch area. |
| Branch configuration included in your subscription | The branch form is available when your subscription includes branch configuration. |
| The branch record is available on the page | The main form appears only when the branch exists. |
| A value for **Display Name** when the branch name is empty | **Display Name** is required under that company configuration. |
| A day and month for **Financial Year Start** when either value is empty | Each part of **Financial Year Start** is required under that company configuration. |
| Values for **Reference Currency** and **Local currency** | Both controls are required. |
| The branch identity, registration, financial-year, currency, address, and contact information | These 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](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-view)
to locate those records.

Prerequisites

- You have the company-administration access described in [Before you start](#before-you-start).
- You know whether you are starting a new branch or continuing an existing one.

Steps

1. Open [Branches](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-view).
2. Choose the path that matches your task.

   | If you need to… | Do this |
   |---|---|
   | Start a new branch | Start a new branch from the branch area. |
   | Continue an existing branch | Open its branch record from the branch list. |

3. Confirm that the branch form is open.

   ![The open New branch form with its main fields](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/57801bb382d8a27fb92c56d2ed6bb405.png)

**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 area | Control | What to enter or select |
|---|---|---|
| Identity | **Display Name** | The branch name. It is conditionally required when the branch name is empty, and pattern validation applies. |
| Identity | **Full Name** | The branch's full name. Pattern validation applies. |
| Identity | **Statement** | The branch statement text. |
| Identity | **Managing Director** | The managing director's name or details. |
| Registration | **Company Registration No.** | The company registration number. |
| Registration | **VAT ID Number** | The VAT identification number. |
| Tax | **VatRate** | A number from `0` through `100`. |
| Financial year | **Financial Year Start** | A day and a month for the start of the financial year. Both are conditionally required when empty. |
| Currency | **Reference Currency** | Select from the available currency values. The control is disabled when the branch has jobs. |
| Currency | **Local currency** | Choices come from the company-currency list. |
| Address | **Street** | The street address. The address area requires an address record. |
| Address | **Zip Code** | The postal or ZIP code. |
| Address | **Country** | The country from the country list. |
| Address | **State** | The state or region. |
| Address | **City** | The city. |

For **Financial Year Start**, choose from these values:

| Part | Choices |
|---|---|
| Day | `1` through `30` |
| Month | `January`, `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 choice | Field added |
|---|---|
| **Phone** | A phone contact field |
| **Fax** | A fax contact field |
| **Mobile** | A mobile contact field |
| **Email** | An email contact field |
| **Website** | A website contact field |
| **Online Support** | An 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](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/c06704bd038853a76aa842a608630015.png)

## Complete and save branch information

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

Prerequisites

- The New branch form is open.
- You have the values described in [Understand the branch information](#understand-the-branch-information).

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.

   | Part | Choices |
   |---|---|
   | Day | `1` through `30` |
   | Month | `January` 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 contact | **Phone** |
   | A fax contact | **Fax** |
   | A mobile contact | **Mobile** |
   | An email contact | **Email** |
   | A website contact | **Website** |
   | An online-support contact | **Online 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 page | **Save** |
| Save the branch and request the close action | **Save 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.

| Situation | What appears |
|---|---|
| The branch is new | **Default** and **Last Modifications** are not available. |
| The branch is saved | **Default** and **Last Modifications** become available. |
| The default-margin selection is active | The default-margin panel appears. |
| The log-history selection is active | The log-history panel appears. |
| The fixed-percentage selection is active | A fixed margin field appears. |
| `Descending Accumulative` or `Descending Absolute` is active | The corresponding margin fields appear in the default margin panel. |
| The branch has a logo | The logo-delete icon is shown. |
| The branch exists | The logo-upload icon is shown. |
| The logo upload is ready | Select **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.

| Message | When to act | Reader action |
|---|---|---|
| `Name is required` | The branch name is empty where **Display Name** is required. | Enter a value in **Display Name**. |
| `Just '_' '-' And '.' Characters Accepted` | The name pattern rejects the entered value. | Correct **Display Name** or **Full Name** to a value accepted by the field pattern. |
| `required` | A required **Financial Year Start** value is empty. | Select both the day and month for **Financial Year Start**. |
| `Branch does not exist` | The branch lookup does not find the branch record. | Return to the branch area and open or start the branch again. |
| `Please insert degressive margin list` | A degressive margin selection has no margin list. | Add the degressive margin list before saving that margin configuration. |
| `Error: Server Error` | The 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 Successfully` | The logo deletion succeeds. | Continue with the branch record or upload another logo. |
| `Data saved Successfully` | Default 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](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-view) 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.
