[необов’язково] Відділення

Відділення (Філії) використовуються, щоб розділити працівників, клієнтів і облікові записи

Для інформації: відділення мають важливе значення для розподілу доступу до ідентифікаторів Клієнтів між працівниками. Вони служать окремими підрозділами в організації, що дозволяє різним групам або окремим особам обробляти певні набори облікових записів і Клієнтів. Філії Контрагентів відокремлені.

Працівник однієї філії може бачити і працювати з клієнтами тільки зі своєї філії. Якщо працівник не призначений до жодної філії, він може бачити всіх Клієнтів Контрагента.

Працюючи з філіями, є наступні можливості:

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

#create-branch

#get-branch

#update-branch

Отримання списку відділень та їх загальну кількість

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

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

post

Create branch

Path parameters

counterparty_guidstringRequired

Counterparty GUID

Body

namestringOptional

branch name

Responses

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

Get branch

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

branch guid (uuid)

Responses

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

put

Update branch

Path parameters

counterparty_guidstringRequired

Counterparty GUID

branch_guidstringRequired

branch guid (uuid)

Body

is_deletedbooleanOptional

namestringOptional

Responses

Responseobject

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"
}

{}