Update company branch

Path parameters

company_branch_idstringRequired

Request

This endpoint expects an object.

account_idintegerOptional

ID of the associated account

company_branch_idintegerOptional

ID of the company branch

namestringOptional

Name of the company branch.

addressstringOptional

Address of the company branch.

districtstringOptional

District of the company branch.

citystringOptional

City of the company branch.

phonestringOptional

Phone of the company branch.

company_branch_tax_codestringOptional

Tax code assigned to the company branch for fiscal and accounting purposes.

company_branch_internal_codestringOptional

Internal code assigned to the company branch for identification within the system.

parent_company_branch_idintegerOptional

ID of the parent company branch.

user_permissionsobjectOptional

Response

Product location updated successfully

account_idinteger or null

ID of the associated account

company_branch_idinteger or null

ID of the company branch

is_headquartersinteger or null

Indicates whether the location is the company's headquarters. If the value is 1, it means this branch is the main office.

branch_typeinteger or null

Defines the type of branch. If the value is 1, it is a physical (real) branch. If the value is 2, it is a virtual branch.

namestring or null

Name of the company branch.

addressstring or null

Address of the company branch.

districtstring or null

District of the company branch.

citystring or null

City of the company branch.

phonestring or null

Phone of the company branch.

company_branch_tax_codestring or null

Tax code assigned to the company branch for fiscal and accounting purposes.

company_branch_internal_codestring or null

Internal code assigned to the company branch for identification within the system.

parent_company_branch_idinteger or null

ID of the parent company branch.

user_permissionslist of objects or null

1	import requests
2
3	url = "https://api-billing.koywe.com/V1/company_branches/company_branch_id"
4
5	payload = {}
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.put(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"account_id": 1,
3	"company_branch_id": 1,
4	"is_headquarters": 1,
5	"branch_type": 1,
6	"name": "name",
7	"address": "address",
8	"district": "district",
9	"city": "city",
10	"phone": "phone",
11	"company_branch_tax_code": "company_branch_tax_code",
12	"company_branch_internal_code": "company_branch_internal_code",
13	"parent_company_branch_id": 1,
14	"user_permissions": [
15	{
16	"user_id": "user_id",
17	"has_branch_permission": 1.1,
18	"user_name": "user_name"
19	}
20	]
21	}

Update company branch

Path parameters

Headers

Request

Response

Errors