[optional] Branch

Please use branches to segregate employees, customers and digital entity

Good to know: branches are essential for segregating access to entities and clients among employees. They serve as distinct divisions within an organization, allowing different teams or individuals to handle specific sets of entities and customers.

Branches of the counterparties are separate. An employee from one branch can see and work with customers only from his branch. If the employee is not assigned to any branch he/she can see all the customers of the Counterparty.

Working with branches you have the following features:

#get-branches-list-and-total-branches-count

Create branch

Get Branch

Update Branch

Get the branches list and total branch entities

Get branches list and total branches count

get

Get branches list and total branches count

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Query parameters

namesstring[]Optional

branches names filter (string)

guidsstring[]Optional

branches guids filter (uuid)

limitintegerOptional

limit (int)

offsetintegerOptional

offset (int)

orderstring · enumOptional

list order (string)

Possible values:

Responses

200

OK

application/json

400

json with error msg

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/branches HTTP/1.1
Host: your_host
Accept: */*

{
  "list": [
    {
      "counterparty_guid": "text",
      "created_at": "text",
      "guid": "text",
      "is_deleted": true,
      "name": "text",
      "updated_at": "text"
    }
  ],
  "total": 1
}

Create branch

Create branch

post

Create branch

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

namestringOptional

branch name

Responses

200

OK

application/json

400

json with error msg

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/counterparty/{counterparty_guid}/branches HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "guid": "text"
}

Get Branch

Get branch

get

Get branch

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

branch guid (uuid)

Responses

200

OK

application/json

400

json with error msg

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/counterparty/{counterparty_guid}/branches/{branch_guid} HTTP/1.1
Host: your_host
Accept: */*

{
  "counterparty_guid": "text",
  "created_at": "text",
  "guid": "text",
  "is_deleted": true,
  "name": "text",
  "updated_at": "text"
}

Update Branch

Update branch

put

Update branch

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

branch guid (uuid)

Body

is_deletedbooleanOptional

namestringOptional

Responses

200

OK

application/json

Responseobject

400

json with error msg

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/counterparty/{counterparty_guid}/branches/{branch_guid} HTTP/1.1
Host: your_host
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "is_deleted": true,
  "name": "text"
}

{}