NAV

getCompanyDetails

GET /v2/company/get-details

This API call provides information about all of the settings of the previously created company. Use this method if you would like to validate permissions or any additional configurations.

Response Messages
Code
Description
200
OK
401
Unauthorized
403
Forbidden
404
Not Found
             {
    "address": {
        "id": 0,
        "zip": "string",
        "city": "string",
        "country": 0,
        "province": 0,
        "address": "string",
        "selected": true
    },
    "api_key_models": [
        {
            "key": "string",
            "name": "string",
            "token": "string"
        }
    ],
    "billing_descriptor": "string",
    "business_phone_number": "string",
    "business_type": "SOLE",
    "collect_taxes": true,
    "company_code": "string",
    "company_payment_plan_settings": {
        "annual_interest": 1.01,
        "discount_on_early_payment": true,
        "early_payment_allowed": true,
        "maximum_number_of_installments": 0
    },
    "company_status": "REGISTRATION",
    "customer_care_number": "string",
    "default_currency": "AED",
    "default_lang": {
        "available_langs": [
            "EN",
            "FR",
            "ES"
        ],
        "default_lang": "EN"
    },
    "established": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "has_employees": true,
    "id": 0,
    "logo_url": "string",
    "name": "string",
    "primary_owner": {
        "account_title": "string",
        "address": {
            "id": 0,
            "zip": "string",
            "city": "string",
            "country": 0,
            "province": 0,
            "address": "string",
            "selected": true
        },
        "creation_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "date_of_birth": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "logo_url": "string",
        "owner_ship": 1.01,
        "phone": "string",
        "role": "ACCOUNT_OWNER",
        "ssn": "string",
        "state": "ACTIVE",
        "user_code": "string"
    },
    "public_company": true,
    "tax_id_number": "string",
    "taxation_type": "PRECALCULATED",
    "timezone_id": "string",
    "web_hooks": [],
    "website": "string"
}
             
          
{ } CompanyDetailsV2Model
address (optional) AddressApiV2Model
api_key_models (optional) array|ApiKeyV2Model
billing_descriptor (optional) string
business_phone_number (optional) string
business_type (optional) string
collect_taxes (optional) boolean
company_code (optional) string
company_payment_plan_settings (optional) CompanyPaymentPlanSettingsV2Model
company_status (optional) string
customer_care_number (optional) string
default_currency (optional) string
default_lang (optional) CompanyLanguageV2Model
established (optional) string
has_employees (optional) boolean
id (optional) integer
logo_url (optional) string
name (optional) string
primary_owner (optional) UserResponseV2Model
public_company (optional) boolean
tax_id_number (optional) string
taxation_type (optional) string
timezone_id (optional) string
web_hooks (optional) array
website (optional) string
{ } AddressApiV2Model
id (optional) integer
zip (optional) string
city (optional) string
country (optional) integer
province (optional) integer
address (optional) string
selected (optional) boolean
{ } ApiKeyV2Model
key (optional) string
name (optional) string
token (optional) string
{ } CompanyPaymentPlanSettingsV2Model
annual_interest (optional) number
discount_on_early_payment (optional) boolean
early_payment_allowed (optional) boolean
maximum_number_of_installments (optional) integer
{ } CompanyLanguageV2Model
available_langs (optional) array
default_lang (optional) string
{ } UserResponseV2Model
account_title (optional) string
address (optional) AddressApiV2Model
creation_date (optional) string
date_of_birth (optional) string
email (optional) string
first_name (optional) string
last_name (optional) string
logo_url (optional) string
owner_ship (optional) number
phone (optional) string
role (optional) string
ssn (optional) string
state (optional) string
user_code (optional) string
             <company_details_model>
  <address/>
  <api_key_models>
    <api_key_model>
      <key>string</key>
      <name>string</name>
      <token>string</token>
    </api_key_model>
    <api_key_model>
      <key>string</key>
      <name>string</name>
      <token>string</token>
    </api_key_model>
  </api_key_models>
  <billing_descriptor>string</billing_descriptor>
  <business_phone_number>string</business_phone_number>
  <business_type>SOLE</business_type>
  <collect_taxes>1</collect_taxes>
  <company_code>string</company_code>
  <company_payment_plan_settings/>
  <company_status>REGISTRATION</company_status>
  <customer_care_number>string</customer_care_number>
  <default_currency>AED</default_currency>
  <default_lang/>
  <established>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</established>
  <has_employees>1</has_employees>
  <id>0</id>
  <logo_url>string</logo_url>
  <name>string</name>
  <primary_owner/>
  <public_company>1</public_company>
  <tax_id_number>string</tax_id_number>
  <taxation_type>PRECALCULATED</taxation_type>
  <timezone_id>string</timezone_id>
  <web_hooks/>
  <website>string</website>
</company_details_model>

             
          
{ } CompanyDetailsV2Model
address (optional) AddressApiV2Model
api_key_models (optional) array|ApiKeyV2Model
billing_descriptor (optional) string
business_phone_number (optional) string
business_type (optional) string
collect_taxes (optional) boolean
company_code (optional) string
company_payment_plan_settings (optional) CompanyPaymentPlanSettingsV2Model
company_status (optional) string
customer_care_number (optional) string
default_currency (optional) string
default_lang (optional) CompanyLanguageV2Model
established (optional) string
has_employees (optional) boolean
id (optional) integer
logo_url (optional) string
name (optional) string
primary_owner (optional) UserResponseV2Model
public_company (optional) boolean
tax_id_number (optional) string
taxation_type (optional) string
timezone_id (optional) string
web_hooks (optional) array
website (optional) string
{ } AddressApiV2Model
id (optional) integer
zip (optional) string
city (optional) string
country (optional) integer
province (optional) integer
address (optional) string
selected (optional) boolean
{ } ApiKeyV2Model
key (optional) string
name (optional) string
token (optional) string
{ } CompanyPaymentPlanSettingsV2Model
annual_interest (optional) number
discount_on_early_payment (optional) boolean
early_payment_allowed (optional) boolean
maximum_number_of_installments (optional) integer
{ } CompanyLanguageV2Model
available_langs (optional) array
default_lang (optional) string
{ } UserResponseV2Model
account_title (optional) string
address (optional) AddressApiV2Model
creation_date (optional) string
date_of_birth (optional) string
email (optional) string
first_name (optional) string
last_name (optional) string
logo_url (optional) string
owner_ship (optional) number
phone (optional) string
role (optional) string
ssn (optional) string
state (optional) string
user_code (optional) string