NAV

updateCompany

POST /v2/company/update

The purpose of this API call is to provide a functionality that allows developers to update company information over a period of time.

Parameters
Name
Description
companyUpdateV2Model (required)

This model allows you to specify all parameters required for updating company information. For more details follow the body schema described in the details of this call.

Response Messages
Code
Description
200
OK
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
             {
    "address": {
        "id": 0,
        "zip": "string",
        "city": "string",
        "country": 0,
        "province": 0,
        "address": "string",
        "selected": true
    },
    "bank_account_type": "CHECKING",
    "billing_descriptor": "string",
    "business_phone_number": "string",
    "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
    },
    "customer_care_number": "string",
    "default_lang": {
        "available_langs": [
            "EN",
            "FR",
            "ES"
        ],
        "default_lang": "EN"
    },
    "email": "string",
    "established": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "logo": "string",
    "name": "string",
    "tax_id_number": "string",
    "time_zone_id": "string",
    "web_hooks": [],
    "website": "string"
}
             
          
{ } CompanyUpdateV2Model
address (optional) AddressApiV2Model
bank_account_type (optional) string
billing_descriptor (optional) string
business_phone_number (optional) string
collect_taxes (optional) boolean
company_code (optional) string
company_payment_plan_settings (optional) CompanyPaymentPlanSettingsV2Model
customer_care_number (optional) string
default_lang (optional) CompanyLanguageV2Model
email (optional) string
established (optional) string
logo (optional) string
name (optional) string
tax_id_number (optional) string
time_zone_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
{ } 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
             {
    "api_keys": [
        {
            "key": "string",
            "name": "string",
            "token": "string"
        }
    ],
    "company_code": "string",
    "id": 0,
    "name": "string"
}
             
          
{ } CompanyPreviewV2Model
api_keys (optional) array|ApiKeyV2Model
company_code (optional) string
id (optional) integer
name (optional) string
{ } ApiKeyV2Model
key (optional) string
name (optional) string
token (optional) string
             <company_add_model>
  <address/>
  <bank_account_type>CHECKING</bank_account_type>
  <billing_descriptor>string</billing_descriptor>
  <business_phone_number>string</business_phone_number>
  <collect_taxes>1</collect_taxes>
  <company_code>string</company_code>
  <company_payment_plan_settings/>
  <customer_care_number>string</customer_care_number>
  <default_lang/>
  <email>string</email>
  <established>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</established>
  <logo>string</logo>
  <name>string</name>
  <tax_id_number>string</tax_id_number>
  <time_zone_id>string</time_zone_id>
  <web_hooks/>
  <website>string</website>
</company_add_model>

             
          
{ } CompanyUpdateV2Model
address (optional) AddressApiV2Model
bank_account_type (optional) string
billing_descriptor (optional) string
business_phone_number (optional) string
collect_taxes (optional) boolean
company_code (optional) string
company_payment_plan_settings (optional) CompanyPaymentPlanSettingsV2Model
customer_care_number (optional) string
default_lang (optional) CompanyLanguageV2Model
email (optional) string
established (optional) string
logo (optional) string
name (optional) string
tax_id_number (optional) string
time_zone_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
{ } 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
             <company_preview_model>
  <api_keys>
    <api_key>
      <key>string</key>
      <name>string</name>
      <token>string</token>
    </api_key>
    <api_key>
      <key>string</key>
      <name>string</name>
      <token>string</token>
    </api_key>
  </api_keys>
  <company_code>string</company_code>
  <id>0</id>
  <name>string</name>
</company_preview_model>

             
          
{ } CompanyPreviewV2Model
api_keys (optional) array|ApiKeyV2Model
company_code (optional) string
id (optional) integer
name (optional) string
{ } ApiKeyV2Model
key (optional) string
name (optional) string
token (optional) string