ES | EN

📄 MIPYME Documents

Create a new company branch

POST
Endpoint URL https://api-billing.koywe.com/V1/company_branches
Requires authentication

Authentication

Send header Authorization: Bearer <token> (obtained from POST /auth) for protected endpoints.

Parameters

No parameters.

Request body — fields

FieldTypeRequiredDescription
account_idintegerAlways requiredID of the associated account
is_headquartersintegerOptionalIndicates whether the location is the company's headquarters. If the value is 1, it means this branch is the main office.
branch_typeintegerOptionalDefines 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.
namestringAlways requiredName of the company branch.
addressstringOptionalAddress of the company branch.
districtstringOptionalDistrict of the company branch.
citystringOptionalCity of the company branch.
phonestringOptionalPhone of the company branch.
company_branch_tax_codestringOptionalTax code assigned to the company branch for fiscal and accounting purposes.
company_branch_internal_codestringOptionalInternal code assigned to the company branch for identification within the system.
parent_company_branch_idintegerOptionalID of the parent company branch.

Request body — JSON example

{
    "account_id": 0,
    "is_headquarters": 0,
    "branch_type": 0,
    "name": "string",
    "address": "string",
    "district": "string",
    "city": "string",
    "phone": "string",
    "company_branch_tax_code": "string",
    "company_branch_internal_code": "string",
    "parent_company_branch_id": 0
}

Responses

Company branch successfully generated