API Reference🏢company Branches

Get a specific company branch

Path parameters

company_branch_idstringRequired

Headers

AuthorizationstringRequired

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

Response

Successful response

account_idintegerOptional

ID of the associated account

company_branch_idstringOptional

ID 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.

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_permissionslist of objectsOptional

Errors