NAV

addCompany

POST /v2/company-partner/add

If you already have partner access to SimplePin's platform, this method will allow you to create a new company entity on the fly. When you call this method, you have to confirm the information of the company and the account's owner.

Please note, that the account owner should be unique in your system. SimplePin does not allow the creation of multiple company entities with the same email address. Since we are relying on you for account creation, we suggest that you validate the email address of the account owner before creating a company entry in SimplePin.

If the call is executed correctly, the company and its user entities will be created in SimplePin, which will respond with API tokens. This could be used for all of your calls with the exception of the company partner controller.

Parameters
Name
Description
addCompanyModelV2 (required)

This model allows you to specify all parameters required for company creation. 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
    },
    "billing_descriptor": "string",
    "business_phone_number": "string",
    "business_type": "SOLE",
    "collect_taxes": true,
    "company_code": "string",
    "customer_care_number": "string",
    "default_lang": {
        "available_langs": [
            "EN",
            "FR",
            "ES"
        ],
        "default_lang": "EN"
    },
    "email": "string",
    "established": "yyyy-MM-dd",
    "has_employees": true,
    "logo": "string",
    "name": "string",
    "owners": [
        {
            "account_title": "string",
            "address": {
                "id": 0,
                "zip": "string",
                "city": "string",
                "country": 0,
                "province": 0,
                "address": "string",
                "selected": true
            },
            "address_same_as_company": true,
            "date_of_birth": "yyyy-MM-dd",
            "email": "string",
            "first_name": "string",
            "last_name": "string",
            "logo": "string",
            "owner_ship": 1.01,
            "password": "string",
            "phone": "string",
            "role": "ACCOUNT_OWNER",
            "send_email": true,
            "ssn": "string",
            "state": "ACTIVE",
            "time_zone_id": "string",
            "user_code": "string"
        }
    ],
    "public_company": true,
    "tax_id_number": "string",
    "time_zone_id": "string",
    "web_hooks": [],
    "website": "string"
}
             
          
{ } CompanyAddV2Model
address (optional) AddressApiV2Model
billing_descriptor (optional) string
business_phone_number (optional) string
business_type (optional) string
collect_taxes (optional) boolean
company_code (optional) string
customer_care_number (optional) string
default_lang (optional) CompanyLanguageV2Model
email (optional) string
established (optional) string
has_employees (optional) boolean
logo (optional) string
name (optional) string
owners (optional) array|UserAddUpdateV2Model
public_company (optional) boolean
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
{ } CompanyLanguageV2Model
available_langs (optional) array
default_lang (optional) string
{ } UserAddUpdateV2Model
account_title (optional) string
address (optional) AddressApiV2Model
address_same_as_company (optional) boolean
date_of_birth (optional) string
email (optional) string
first_name (optional) string
last_name (optional) string
logo (optional) string
owner_ship (optional) number
password (optional) string
phone (optional) string
role (optional) string
send_email (optional) boolean
ssn (optional) string
state (optional) string
time_zone_id (optional) string
user_code (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/>
  <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>
  <customer_care_number>string</customer_care_number>
  <default_lang/>
  <email>string</email>
  <established>yyyy-MM-dd</established>
  <has_employees>1</has_employees>
  <logo>string</logo>
  <name>string</name>
  <owners>
    <owner>
      <account_title>string</account_title>
      <address/>
      <address_same_as_company>1</address_same_as_company>
      <date_of_birth>yyyy-MM-dd</date_of_birth>
      <email>string</email>
      <first_name>string</first_name>
      <last_name>string</last_name>
      <logo>string</logo>
      <owner_ship>1.01</owner_ship>
      <password>string</password>
      <phone>string</phone>
      <role>ACCOUNT_OWNER</role>
      <send_email>1</send_email>
      <ssn>string</ssn>
      <state>ACTIVE</state>
      <time_zone_id>string</time_zone_id>
      <user_code>string</user_code>
    </owner>
    <owner>
      <account_title>string</account_title>
      <address/>
      <address_same_as_company>1</address_same_as_company>
      <date_of_birth>yyyy-MM-dd</date_of_birth>
      <email>string</email>
      <first_name>string</first_name>
      <last_name>string</last_name>
      <logo>string</logo>
      <owner_ship>1.01</owner_ship>
      <password>string</password>
      <phone>string</phone>
      <role>ACCOUNT_OWNER</role>
      <send_email>1</send_email>
      <ssn>string</ssn>
      <state>ACTIVE</state>
      <time_zone_id>string</time_zone_id>
      <user_code>string</user_code>
    </owner>
  </owners>
  <public_company>1</public_company>
  <tax_id_number>string</tax_id_number>
  <time_zone_id>string</time_zone_id>
  <web_hooks/>
  <website>string</website>
</company_add_model>

             
          
{ } CompanyAddV2Model
address (optional) AddressApiV2Model
billing_descriptor (optional) string
business_phone_number (optional) string
business_type (optional) string
collect_taxes (optional) boolean
company_code (optional) string
customer_care_number (optional) string
default_lang (optional) CompanyLanguageV2Model
email (optional) string
established (optional) string
has_employees (optional) boolean
logo (optional) string
name (optional) string
owners (optional) array|UserAddUpdateV2Model
public_company (optional) boolean
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
{ } CompanyLanguageV2Model
available_langs (optional) array
default_lang (optional) string
{ } UserAddUpdateV2Model
account_title (optional) string
address (optional) AddressApiV2Model
address_same_as_company (optional) boolean
date_of_birth (optional) string
email (optional) string
first_name (optional) string
last_name (optional) string
logo (optional) string
owner_ship (optional) number
password (optional) string
phone (optional) string
role (optional) string
send_email (optional) boolean
ssn (optional) string
state (optional) string
time_zone_id (optional) string
user_code (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