Skip to main content

Branch

Represents a branch.

addresses object[]

The list of branch addresses.

  • Array [
    • citystring

    The city for the address.

    countrystring

    The country.

    encodedKeystring

    The address encoded key, which is unique and generated.

    indexInListinteger<int32>

    The index of this address in the list of addresses.

    latitudenumber

    The GPS latitude of this address in signed degrees format (DDD.dddd) with 6 decimal positions, ranging from -90 to +90.

    line1string

    The first line of the address.

    line2string

    The second line of the address.

    longitudenumber

    The GPS longitude of this address in signed degrees format (DDD.dddd) with 6 decimal positions, ranging from -180 to +180.

    parentKeystring

    The address parent key indicating the object owning this address. For example: client, centre, or branch.

    postcodestring

    The post code.

    regionstring

    The region for the address.

  • ]
    • branchHolidays object[]

    The list of branch holidays.

  • Array [
    • creationDatestring<date-time>

    The date when the holiday was created.

    Example: 2016-09-06T13:37:50+03:00
    datestring<date>

    The date the holiday takes place.

    Example: 1987-04-26
    encodedKeystring

    The encoded key of the entity, generated, globally unique

    idinteger<int64>

    The ID of the holiday.

    isAnnuallyRecurringboolean

    TRUE if a holiday is annually recurring, FALSE otherwise.

    namestring

    The name of the holiday.

  • ]
    • creationDatestring<date-time>

    The creation date of the branch.

    Example: 2016-09-06T13:37:50+03:00
    emailAddressstring

    The branch email address.

    encodedKeystring

    The encoded key of the entity, generated, globally unique

    idstringrequired

    The branch ID, which must be unique.

    lastModifiedDatestring<date-time>

    The last date when the branch was modified.

    Example: 2016-09-06T13:37:50+03:00
    namestringrequired

    The branch name.

    notesstring

    The notes or description attached to this object.

    phoneNumberstring

    The branch phone number.

    statestring

    The branch state.

    Possible values: [ACTIVE, INACTIVE]

    Branch
    {
      "addresses": [
        {
          "city": "string",
          "country": "string",
          "encodedKey": "string",
          "indexInList": 0,
          "latitude": 0,
          "line1": "string",
          "line2": "string",
          "longitude": 0,
          "parentKey": "string",
          "postcode": "string",
          "region": "string"
        }
      ],
      "branchHolidays": [
        {
          "creationDate": "2016-09-06T13:37:50+03:00",
          "date": "1987-04-26",
          "encodedKey": "string",
          "id": 0,
          "isAnnuallyRecurring": true,
          "name": "string"
        }
      ],
      "creationDate": "2016-09-06T13:37:50+03:00",
      "emailAddress": "string",
      "encodedKey": "string",
      "id": "string",
      "lastModifiedDate": "2016-09-06T13:37:50+03:00",
      "name": "string",
      "notes": "string",
      "phoneNumber": "string",
      "state": "ACTIVE"
    }