Create a company

POST/client_api/v2/companies

For resellers. Sets up a client company under your reseller account, and a login for it when you send an email.

Parameters

namestringRequired
The company's name. It has to be unique across our accounts.
emailstring
The email for the company's own API and portal login. Left out, no login is made.
passwordstring
The password for that login. Left out, we make one up.
contact_namestring
The person we talk to at the company.
contact_emailstring
That person's email address.
contact_numberstring
That person's phone number.
currency_idstringRequired
The currency the company is billed in, as a three-letter code from List currencies.
industryenum
What the company does.
Possible enum values
aerospace_defenseairlines_aviationapparel_fashionarts_craftsautomotiveaviation_aerospacebroadcast_mediachemicalscivil_engineeringcomputer_hardwarecomputer_softwareconstructionconsumer_electronicsconsumer_goodsdefense_spaceelectrical_electronic_manufacturingentertainmentevents_servicesfine_artfood_beveragesfurniturehealth_wellness_fitnesshealthcare_serviceshospital_health_careindustrial_automationinformation_technology_and_servicesinvestment_managementleisure_travel_tourismlogistics_supply_chainluxury_goods_jewelrymachinerymanufacturingmechanical_or_industrial_engineeringmedical_devicesoil_energypackage_freight_deliverypaper_forest_productspharmaceuticalsphotographyprintingprofessional_training_coachingpublishingretailsporting_goodstelecommunicationstextilestransportation_trucking_railroadutilitieswirelessother
markup_multipliernumber
What the company pays as a multiple of our price to you. 1.5 adds 50%.
address_attributesobjectRequired
The company's address. Its country decides which bank details the company's invoices show.

Returns

Returns the company.

Errors

400Bad Request
The request body isn't valid JSON, or something failed on our side.
401Unauthorized
The token is missing, expired or invalid. Sign in again.

View as Markdown

POST /client_api/v2/companies

1curl -X POST "https://sandbox-api.vatit-stream.com/client_api/v2/companies" \
2  -H "Authorization: Bearer $API_TOKEN" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "name": "Karoo Leather Works",
6    "email": "admin@karooleather.example",
7    "password": "choose-a-password",
8    "contact_name": "Pieter van Wyk",
9    "contact_email": "pieter@karooleather.example",
10    "contact_number": "+27 23 555 0198",
11    "currency_id": "ZAR",
12    "industry": "consumer_goods",
13    "markup_multiplier": 1.5,
14    "address_attributes": {
15      "name": "Pieter van Wyk",
16      "company": "Karoo Leather Works",
17      "address_1": "8 Church Street",
18      "city": "Prince Albert",
19      "province": "Western Cape",
20      "postal_code": "6930",
21      "country_id": 20,
22      "email": "pieter@karooleather.example",
23      "phone": "+27 23 555 0198"
24    }
25  }'

Response

{
  "company": {
    "id": 11,
    "account_number": "MYSKAR001",
    "account_status": "active",
    "address": {
      "id": 147,
      "address_1": "8 Church Street",
      "address_2": null,
      "address_3": null,
      "city": "Prince Albert",
      "classification": "business",
      "company": "Karoo Leather Works",
      "country_id": 20,
      "email": "pieter@karooleather.example",
      "import_code": null,
      "latitude": null,
      "longitude": null,
      "name": "Pieter van Wyk",
      "phone": "+27235550198",
      "postal_code": "6930",
      "province": "Western Cape",
      "summary": "South Africa",
      "tax_number": null,
      "time_zone_id": null
    },
    "api_users": [
      {
        "id": 15,
        "email": "admin@karooleather.example",
        "identity": "admin@karooleather.example"
      }
    ],
    "code": "MYSKAR001",
    "company_billing": true,
    "currency_id": "ZAR",
    "name": "Karoo Leather Works"
  }
}