# Edit branch

## Before you start

An existing branch is a branch record already present in the company configuration. Use this
page to maintain its information and save the changed record.

The edit record opens from the branch list. It contains the branch form, contact information,
saved-record areas, and default-margin settings for the selected branch.

| If you need to… | Go to |
|---|---|
| Open an existing branch from the list | [Branches](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-view) |
| Review the branch form and its fields | [Branch information fields](#branch-information-fields) |
| Maintain contacts or the branch logo | [Maintain branch details and contacts](#maintain-branch-details-and-contacts) |
| Review saved areas and margins | [Review saved areas and default margins](#review-saved-areas-and-default-margins) |
| Correct a validation or save problem | [Fix validation and save problems](#fix-validation-and-save-problems) |
| Create a branch that does not exist yet | [New branch](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-new) |
| Maintain the existing branch logo on its registered page | [Edit branch logo](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-edit-record-2) |

## Find and open the branch

The **Branches** list is the entry point for selecting the branch record to edit.

Prerequisites

- Sign in to the application.
- Confirm that the branch already exists in **Branches**.
- Have edit permission for the branch, or new permission with the branch ID set to `0`.

Steps

1. Open **Configurations** > **Company** > **Branches**.
2. Select the data row for the branch you want to maintain.
3. Select the row's edit action.

**Result:** The selected branch edit screen is open.

## Understand the branch information

The branch edit screen is a form for maintaining one existing branch record. The main form
contains branch identity, registration, financial-year, currency, address, and contact
information.

| Area | What you use it for |
|---|---|
| Main branch form | Maintain branch information before saving the record. |
| **Contact Information** | Add a **Phone**, **Fax**, **Mobile**, **Email**, **Website**, or **Online Support** contact. |
| **Default** | Open the default-margin panel. |
| **Last Modifications** | Open the log-history panel. |
| **Save** | Save the branch record and remain on the record. |
| **Save and Close** | Save the branch record and return to the previous location. |

When a branch logo is present, upload and delete actions appear beside it.

### Branch information fields

A configurable field is required only when your company configuration enables that requirement.

| Field | Use or rule |
|---|---|
| **Display Name** | Branch name. It is configurable and has a required validator when empty. |
| **Full Name** | Full branch name. Pattern validation applies. |
| **Statement** | Branch statement. |
| **Managing Director** | Managing director information. |
| **Company Registration No.** | Company registration number. |
| **VAT ID Number** | Value-added tax identification number. |
| **VatRate** | VAT rate from `0` through `100`. |
| **Financial Year Start** | Select a day from `1` through `30` and a month from **January** through **December**. Day and month are required when empty under the form validators. |
| **Reference Currency** | Required currency selection. It is disabled when the branch has jobs. |
| **Local currency** | Select a currency from the available currency list. The choices are company-currency records returned at runtime, and each option displays the record's currency name. This selection is required. |
| **Street** | Address street, shown when the branch has an address. |
| **Zip Code** | Address postal code, shown when the branch has an address. |
| **Country** | Address country, shown when the branch has an address. |
| **State** | Address state, shown when the branch has an address. |
| **City** | Address city, shown when the branch has an address. |

The currency and country choices come from records available to the company at run time. Address
fields appear when the branch has an address.

> **Note:** Use the branch list to choose a different existing branch.

## Maintain branch details and contacts

Contact information identifies the ways colleagues can reach the branch. Use **Contact
Information** to add the contact types that apply, then enter each value in its corresponding
field.

Prerequisites

- The existing branch edit screen is open.
- You know the branch details and contact values to record.

Steps

1. Update the branch detail fields that need to change.
2. Select **Contact Information**.
3. Select the contact type.

   | If you need to add… | Select… |
   |---|---|
   | A telephone number | **Phone** |
   | A fax number | **Fax** |
   | A mobile number | **Mobile** |
   | An email address | **Email** |
   | A website | **Website** |
   | Online support details | **Online Support** |

4. Enter the contact value in its corresponding field.
5. For a **Phone**, **Fax**, or **Mobile** value, keep the value within the maximum length of `20`.
6. If you need to maintain the logo, select the upload icon and use **Attach** in the upload
   surface.
7. If you need to remove the logo, select the delete icon beside the branch logo.
8. Confirm the deletion when the application asks `Are you sure you want to delete this item?`.

**Result:** The changed details, applicable contact values, and completed logo operation are
prepared on the branch record.

## Review saved areas and default margins

Saved areas show the branch's default-margin settings or recorded modifications. A default margin
defines the margin choice used for the branch; the available child controls depend on that choice.

When the branch has a company-branch ID, select **Default** for the default-margin panel or
**Last Modifications** for the log-history panel. The **Registrations** tab, nominal commission,
and nominal margin controls are not available on this screen.

| Choice or area | What appears |
|---|---|
| **Default** | The default-margin panel. |
| **Last Modifications** | The log-history child area. |
| Fixed margin choice | A fixed-percentage choice and its fixed margin value field. |
| Descending absolute choice | The descending-absolute option. |
| Descending accumulative choice | The descending-accumulative option. |
| Accumulative or decreased-percentage choice | The degressive-margin child area. |

The fixed margin value accepts `0` through `100` and appears only for the fixed-percentage choice.
The degressive-margin child appears for accumulative or decreased-percentage choices. The
accumulative-margin area does not offer a currency choice on this screen.

![The saved-record tabs and default-margin choices](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/27801caf413f79f12c9395eac4020bad.png)

## Fix validation and save problems

Use the message on screen to locate the correction.

| Message | What to do |
|---|---|
| `Name is required` | Enter a value in **Display Name** before saving. |
| `Just '_' '-' And '.' Characters Accepted` | Correct the name so it satisfies the name pattern. |
| `required` | Complete the financial-year day or month that is empty. |
| `Branch does not exist` | Return to **Branches** and open an existing branch row. |
| `Please insert degressive margin list` | Add the required degressive margin list before saving the margin values. |
| `Error: Server Error` | Check the record and retry after the server error is resolved. |
| `Error while saving data ` | Check the values and save again. |
| `Are you sure you want to delete this item?` | Confirm only when you intend to remove the logo item. |
| `Logo Deleted Successfully` | The logo deletion completed. |

If no success message appears and the record does not change, verify the values and retry the
applicable save action rather than treating the save as complete.

### Save branch changes

Use the table to choose the save action that matches where you want to continue.

| If you need to… | Select… | Then confirm… |
|---|---|---|
| Save and remain on the branch record | **Save** | `Branch saved Successfully` |
| Save changed default-margin values | The margin area's **Save** action | `Data saved Successfully` |
| Save the branch and leave the record | **Save and Close** | `Branch saved Successfully` |

Prerequisites

- The branch details and contacts are complete.
- Any changed default-margin values are complete.
- The form has no validation message.

Steps

1. Select the save action from the table that matches where you want to continue.
2. Confirm the corresponding success message from the table.

The unsaved-change guard applies when leaving the edit screen. If a save does not show its success
message, correct the displayed problem and repeat the applicable save action.

**Result:** **Save** keeps you on the branch record with the changed values submitted. **Save and
Close** returns you to the previous location after submitting the changed record.

## Continue after editing

After the record is saved, continue from the saved branch outcome.

| If you need to… | Continue to… |
|---|---|
| Review or select another branch | [Branches](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-view) |
| Create a branch that does not exist | [New branch](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-new) |
| Maintain the existing branch logo | [Edit branch logo](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-company-branchs-edit-record-2) |
