# Branch Business Days

The branch business day endpoint gives you information about each business day, such as opening and closing times.

# The Branch Business Day Object

# Sample

{
  "branch": {
    "id": "8d82ff0c"
  },
  "opener": {
    "id": "8f12f639"
  },
  "closer": {
    "id": "8f12f639"
  },
  "id": "8f557d74",
  "business_date": "2019-12-09",
  "opened_at": "2019-12-09 07:48:05",
  "closed_at": "2019-12-10 10:23:17",
  "created_at": "2019-12-10 10:23:17",
  "updated_at": "2019-12-10 10:23:17"
}

# Attributes

Field	Type	Rules	Description
`id`	`string`		Unique identifier for the business day.
`business_date*`	`string`		The business date `YYYY-MM-DD`.
`opener*`	`object`	`includable`	The User object who started the business day.
`closer`	`object`	`includable`	The User object who closed the business day.
`branch*`	`object`	`includable`	The Branch object attached to the business day.
`opened_at*`	`string`		Time `YYYY-MM-DD HH-MM-SS` in UTC at which the business day was opened.
`closed_at`	`string`		Time `YYYY-MM-DD HH-MM-SS` in UTC at which the business day was closed.
`created_at`	`string`	`sortable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was created.
`updated_at`	`string`	`sortable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was updated.

# List Branch Business Days

GET /branch_business_days

# Scope

operations.read

# Filters

opener_id
closer_id
branch_id
business_date

# Response

{
    "data": [
        {
            "id": "8d8b5e84",
            "business_date": "2019-02-13",
            "opened_at": "2018-09-18 15:43:22",
            "closed_at": "2017-07-22 02:51:14",
            "created_at": "2019-04-26 16:47:37",
            "updated_at": "2019-04-26 16:47:37"
        }
    ]
}

# Get Branch Business Day

GET /branch_business_days/{branchBusinessDayId}

# Scope

operations.read

# Response

{
  "data": {
    "branch": {
      "id": "8d82ff0c"
    },
    "opener": {
      "id": "8f12f639"
    },
    "closer": {
      "id": "8f12f639"
    },
    "id": "8f557d74",
    "business_date": "2019-12-09",
    "opened_at": "2019-12-09 07:48:05",
    "closed_at": "2019-12-10 10:23:17",
    "created_at": "2019-12-10 10:23:17",
    "updated_at": "2019-12-10 10:23:17"
  }
}

# Create Branch Business Day

POST /branch_business_days

# Scope

operations.write

# Request

{
    "business_date": "2019-02-13",
    "opener_id": "8d103804",
    "closer_id": "8d103804",
    "branch_id": "8d103804",
    "opened_at": "2018-09-18 15:43:22",
    "closed_at": "2017-07-22 02:51:14"
}

# Response

{
  "data": {
    "branch": {
      "id": "8d82ff0c"
    },
    "opener": {
      "id": "8f12f639"
    },
    "closer": {
      "id": "8f12f639"
    },
    "id": "8f557d74",
    "business_date": "2019-12-09",
    "opened_at": "2019-12-09 07:48:05",
    "closed_at": "2019-12-10 10:23:17",
    "created_at": "2019-12-10 10:23:17",
    "updated_at": "2019-12-10 10:23:17"
  }
}

← Addresses Branches →