BillingPaymentsCrypto
BillingPaymentsCrypto
  • Introduction
    • 👋 Welcome
    • ▶️ What you need to operate
    • 🔑 Sandbox environment credentials
    • 🔧 Postman Collection
  • About us
    • 🌐 About us
    • ✨ Use cases
    • 🛡️ Security and data ownership
    • 💲 Pricing
  • Examples by country
  • API Reference
  • Webhooks
LogoLogo
API Reference🏢company Branches

POST
https://api-billing.koywe.com/V1/company_branches
POST
/V1/company_branches
1import requests
2
3url = "https://api-billing.koywe.com/V1/company_branches"
4
5payload = {
6 "account_id": 1,
7 "name": "string"
8}
9headers = {
10 "Authorization": "Bearer <token>",
11 "Content-Type": "application/json"
12}
13
14response = requests.post(url, json=payload, headers=headers)
15
16print(response.json())
Try it
201Created
1{
2 "account_id": 1,
3 "company_branch_id": "string",
4 "is_headquarters": 1,
5 "branch_type": 1,
6 "name": "string",
7 "address": "string",
8 "district": "string",
9 "city": "string",
10 "phone": "string",
11 "company_branch_tax_code": "string",
12 "company_branch_internal_code": "string",
13 "parent_company_branch_id": 1,
14 "user_permissions": [
15 {
16 "user_id": "string",
17 "has_branch_permission": 1.1,
18 "user_name": "string"
19 }
20 ]
21}
Was this page helpful?
Previous

Get a specific company branch

Next
Built with
Create a new company branch

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Request

This endpoint expects an object.
account_idintegerRequired
ID of the associated account
namestringRequired
Name of the company branch.
is_headquartersintegerOptional
Indicates whether the location is the company's headquarters. If the value is 1, it means this branch is the main office.
branch_typeintegerOptional
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.
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.

Response

Company branch successfully generated
account_idinteger or null
ID of the associated account
company_branch_idstring 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

Errors

Bearer authentication of the form Bearer <token>, where token is your auth token.

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.

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.