Branchconfiguration

Model representation of the configuration for a branch.

address object

Represents an address.

citystring

The city for this address.

countrystring

The country that is part of the address.

line1string

The first line of the address.

line2string

The second line of the address.

postcodestring

The post code that is part of the address.

regionstring

The region that is part of the address.

customFieldValueSets object[]

Custom fields value sets of the branch. Ordered by the set id.

Array [

groupedCustomFieldValues object[]

Custom field values for group type sets. Ordered by the group index that must start from 0.

Array [

customFieldValues object[]required

Custom field values of the group.

Array [

customFieldIdstringrequired

User-defined ID, globally unique.

valuestringrequired

Custom field value

]

indexinteger<int32>required

Index representing the id of custom field values in a set.

]

idstringrequired

User-defined set ID, globally unique.

standardCustomFieldValues object[]

Custom field values for standard type sets. Ordered by custom field id.

Array [

customFieldIdstringrequired

User-defined ID, globally unique.

valuestringrequired

Custom field value

]

]

emailAddressstring

Branch email address.

holidays object[]

Holidays of the branch. The yaml file dictates the ordering.

Array [

dayOfMonthinteger<int32>required

Day of the month of the holiday

idinteger<int64>required

The id of the Holiday

isAnnuallyRecurringbooleanrequired

If holiday occurs every year

monthOfYearinteger<int32>required

Month of the year of the holiday

namestringrequired

The description of the Holiday

yearinteger<int32>required

Year of holiday

]

idstringrequired

User-defined ID, globally unique. Branches are ordered by id in the yaml file.

namestringrequired

Name of the branch.

notesstring

Notes for the branch.

phoneNumberstring

Branch phone number, as a string.

statestringrequired

Model representation of the state of a branch.

Possible values: [ACTIVE, INACTIVE]

Branchconfiguration

{
  "address": {
    "city": "string",
    "country": "string",
    "line1": "string",
    "line2": "string",
    "postcode": "string",
    "region": "string"
  },
  "customFieldValueSets": [
    {
      "groupedCustomFieldValues": [
        {
          "customFieldValues": [
            {
              "customFieldId": "string",
              "value": "string"
            }
          ],
          "index": 0
        }
      ],
      "id": "string",
      "standardCustomFieldValues": [
        {
          "customFieldId": "string",
          "value": "string"
        }
      ]
    }
  ],
  "emailAddress": "string",
  "holidays": [
    {
      "dayOfMonth": 0,
      "id": 0,
      "isAnnuallyRecurring": true,
      "monthOfYear": 0,
      "name": "string",
      "year": 0
    }
  ],
  "id": "string",
  "name": "string",
  "notes": "string",
  "phoneNumber": "string",
  "state": "ACTIVE"
}