# Create a new company

Create a new company record in the PMS by providing the company details in the request body. The input JSON payload should include information such as the company's name, contact details, industry, and other relevant attributes. The authenticated user is associated with the creation for audit purposes. Upon successful creation, the response returns the full details of the newly created company, including its unique identifier. This endpoint is essential for adding new organisations to the system for management and operational purposes.

Endpoint: POST /api/v3/companies
Version: 3.0.4
Security: OAuth2

## Query parameters:

  - `currentUser` (object, required)

## Request fields (application/json):

  - `companyName` (string, required)
    The name of the company

  - `consolidatedBilling` (boolean)
    Indicates if the company uses consolidated billing

  - `companyNumber` (string)
    The registration number of the company

  - `vatRegistered` (boolean)
    Indicates if the company is VAT registered

  - `vatNumber` (string)
    The VAT number of the company

  - `websiteUrl` (string)
    The website URL of the company

  - `creditLimit` (number)
    The credit limit of the company

  - `creditAccount` (boolean)
    Indicates if the company has a credit account

  - `companyFinanceAccount` (object)
    The finance account details of the company

  - `companyFinanceAccount.id` (integer)
    Unique identifier of the finance account

  - `companyFinanceAccount.accountCode` (string)
    Account code of the finance account

  - `companyFinanceAccount.contact` (object)
    The primary correspondence contact of the company

  - `companyFinanceAccount.contact.id` (integer)
    Unique identifier of the contact

  - `companyFinanceAccount.contact.firstName` (string)
    First name of the contact

  - `companyFinanceAccount.contact.lastName` (string)
    Last name of the contact

  - `companyFinanceAccount.company` (object)
    Company summary associated with the finance account

  - `companyFinanceAccount.company.id` (integer)
    Unique identifier of the company

  - `companyFinanceAccount.company.companyName` (string)
    Name of the company

  - `companyFinanceAccount.externalId` (string)
    External identifier of the finance account

  - `companyFinanceAccount.exportedDate` (string)
    Date when the finance account was exported

  - `companyFinanceAccount.exportStatus` (string)
    Export status of the finance account
    Enum: "SKIPPED", "CREATED", "PENDING", "SENT", "EXPORTED", "FAILED", "IMPORTED"

  - `billingAddress` (object, required)
    The primary address of the company

  - `billingAddress.id` (integer)
    Unique identifier of the address

  - `billingAddress.addressLine1` (string)
    First line of the address

  - `billingAddress.addressLine2` (string)
    Second line of the address

  - `billingAddress.addressLine3` (string)
    Third line of the address

  - `billingAddress.city` (string)
    City of the address

  - `billingAddress.postCode` (string)
    Postal code of the address

  - `billingAddress.country` (object)
    Data Transfer Object representing a Country entity in the Property Management System (PMS).

  - `billingAddress.country.id` (integer)
    Unique identifier of the country

  - `billingAddress.country.name` (string, required)
    Name of the country

  - `billingAddress.country.sortOrder` (integer, required)
    Sort order of the country

  - `billingAddress.country.countryCodeAlpha2` (string, required)
    Alpha-2 country code

  - `billingAddress.country.countryCodeAlpha3` (string, required)
    Alpha-3 country code

  - `billingAddress.country.countryCodeNumeric` (string, required)
    Numeric country code

  - `billingAddress.nickname` (string)

  - `primaryCompanyAddress` (object, required)
    The primary address of the company

  - `primaryCompanyEmailAddress` (object)
    The primary email address of the company

  - `primaryCompanyEmailAddress.id` (integer)
    Unique identifier of the email address
    Example: 1

  - `primaryCompanyEmailAddress.email` (string, required)

  - `primaryCompanyEmailAddress.nickname` (string)
    Nickname of the email address
    Example: "Work"

  - `primaryCompanyEmailAddress.primary` (boolean)
    Primary email address
    Example: true

  - `primaryCompanyTelephoneNumber` (object, required)
    The primary telephone number of the company

  - `primaryCompanyTelephoneNumber.id` (integer)
    Unique identifier of the company telephone number

  - `primaryCompanyTelephoneNumber.number` (string)
    Telephone number

  - `primaryCompanyTelephoneNumber.nickname` (string)
    Nickname for the telephone number

  - `primaryCompanyTelephoneNumber.primary` (boolean)
    Indicates if this is the primary telephone number

  - `type` (string)
    The type of the company
    Enum: "CUSTOMER", "BOOKING_AGENT", "SUPPLIER", "NETWORK_PROVIDER", "LANDLORD", "LETTING_AGENT", "MANAGING_AGENT", "BILLING", "PARENT"

  - `parentCompany` (object)
    Company data to update

  - `status` (string)
    The status of the company
    Enum: "ACTIVE", "INACTIVE", "ARCHIVED"

  - `hasPublicLiability` (boolean)
    Indicates if the company has public liability

  - `liabilityAmount` (number)
    The liability amount of the company

  - `riskAssessment` (boolean)
    Indicates if the company has a risk assessment

  - `paymentTerm` (number)
    The payment term of the company

  - `wrapInvoicesManually` (boolean)
    Indicates if the company wraps invoices manually

  - `referrer` (object)
    The referrer details of the company

  - `referrer.id` (integer)
    Unique identifier of the referrer

  - `referrer.code` (string)
    Code of the referrer

  - `referrer.name` (string)
    Name of the referrer

  - `industry` (object)
    The industry of the company

  - `industry.id` (integer)
    Unique identifier of the industry

  - `industry.name` (string)
    Name of the industry

  - `marketSegment` (object)
    The market segment of the company

  - `marketSegment.id` (integer)
    Unique identifier of the market segment

  - `marketSegment.name` (string, required)
    Name of the market segment

  - `primaryCorrespondenceContact` (object)
    The primary correspondence contact of the company

  - `emailTo` (string)
    The email to details for the company
    Enum: "BOOKING_CONTACT", "BOOKING_GUESTS", "BOOKING_CONTACT_AND_GUESTS"

  - `bankName` (string)
    The bank name of the company

  - `bankAccountName` (string)
    The bank account name of the company

  - `bankAccountNo` (string)
    The bank account number of the company

  - `bankSortCode` (string)
    The bank sort code of the company

  - `bankBicCode` (string)
    The bank BIC code of the company

  - `bankIbanCode` (string)
    The bank IBAN code of the company

  - `linkCode` (string)
    The link code of the company

  - `lifecycleStage` (string)
    The lifecycle stage of the company
    Enum: "LEAD", "QUALIFIED", "DISQUALIFIED", "OPPORTUNITY", "CUSTOMER"

  - `source` (string)
    The source of the company
    Enum: "OFFLINE_SOURCE", "ONLINE_ENQUIRY_FORM", "ONLINE_BOOKING", "SALES_CHANNEL", "DIRECT_SALE"

  - `creditCheckOk` (boolean)
    Indicates if the company's credit check is okay

  - `creditCheckDate` (string)
    The date of the company's credit check

## Response 200 fields (application/json):

  - `id` (integer)
    The unique identifier of the company

  - `companyName` (string, required)
    The name of the company

  - `consolidatedBilling` (boolean)
    Indicates if the company uses consolidated billing

  - `companyNumber` (string)
    The registration number of the company

  - `vatRegistered` (boolean)
    Indicates if the company is VAT registered

  - `vatNumber` (string)
    The VAT number of the company

  - `websiteUrl` (string)
    The website URL of the company

  - `creditLimit` (number)
    The credit limit of the company

  - `creditAccount` (boolean)
    Indicates if the company has a credit account

  - `companyFinanceAccount` (object)
    The finance account details of the company

  - `companyFinanceAccount.id` (integer)
    Unique identifier of the finance account

  - `companyFinanceAccount.accountCode` (string)
    Account code of the finance account

  - `companyFinanceAccount.contact` (object)
    The primary correspondence contact of the company

  - `companyFinanceAccount.contact.id` (integer)
    Unique identifier of the contact

  - `companyFinanceAccount.contact.firstName` (string)
    First name of the contact

  - `companyFinanceAccount.contact.lastName` (string)
    Last name of the contact

  - `companyFinanceAccount.company` (object)
    Company summary associated with the finance account

  - `companyFinanceAccount.company.id` (integer)
    Unique identifier of the company

  - `companyFinanceAccount.company.companyName` (string)
    Name of the company

  - `companyFinanceAccount.externalId` (string)
    External identifier of the finance account

  - `companyFinanceAccount.exportedDate` (string)
    Date when the finance account was exported

  - `companyFinanceAccount.exportStatus` (string)
    Export status of the finance account
    Enum: "SKIPPED", "CREATED", "PENDING", "SENT", "EXPORTED", "FAILED", "IMPORTED"

  - `billingAddress` (object, required)
    The primary address of the company

  - `billingAddress.id` (integer)
    Unique identifier of the address

  - `billingAddress.addressLine1` (string)
    First line of the address

  - `billingAddress.addressLine2` (string)
    Second line of the address

  - `billingAddress.addressLine3` (string)
    Third line of the address

  - `billingAddress.city` (string)
    City of the address

  - `billingAddress.postCode` (string)
    Postal code of the address

  - `billingAddress.country` (object)
    Data Transfer Object representing a Country entity in the Property Management System (PMS).

  - `billingAddress.country.id` (integer)
    Unique identifier of the country

  - `billingAddress.country.name` (string, required)
    Name of the country

  - `billingAddress.country.sortOrder` (integer, required)
    Sort order of the country

  - `billingAddress.country.countryCodeAlpha2` (string, required)
    Alpha-2 country code

  - `billingAddress.country.countryCodeAlpha3` (string, required)
    Alpha-3 country code

  - `billingAddress.country.countryCodeNumeric` (string, required)
    Numeric country code

  - `billingAddress.nickname` (string)

  - `primaryCompanyAddress` (object, required)
    The primary address of the company

  - `primaryCompanyEmailAddress` (object)
    The primary email address of the company

  - `primaryCompanyEmailAddress.id` (integer)
    Unique identifier of the email address
    Example: 1

  - `primaryCompanyEmailAddress.email` (string, required)

  - `primaryCompanyEmailAddress.nickname` (string)
    Nickname of the email address
    Example: "Work"

  - `primaryCompanyEmailAddress.primary` (boolean)
    Primary email address
    Example: true

  - `primaryCompanyTelephoneNumber` (object, required)
    The primary telephone number of the company

  - `primaryCompanyTelephoneNumber.id` (integer)
    Unique identifier of the company telephone number

  - `primaryCompanyTelephoneNumber.number` (string)
    Telephone number

  - `primaryCompanyTelephoneNumber.nickname` (string)
    Nickname for the telephone number

  - `primaryCompanyTelephoneNumber.primary` (boolean)
    Indicates if this is the primary telephone number

  - `type` (string)
    The type of the company
    Enum: "CUSTOMER", "BOOKING_AGENT", "SUPPLIER", "NETWORK_PROVIDER", "LANDLORD", "LETTING_AGENT", "MANAGING_AGENT", "BILLING", "PARENT"

  - `parentCompany` (object)
    Company data to update

  - `status` (string)
    The status of the company
    Enum: "ACTIVE", "INACTIVE", "ARCHIVED"

  - `hasPublicLiability` (boolean)
    Indicates if the company has public liability

  - `liabilityAmount` (number)
    The liability amount of the company

  - `riskAssessment` (boolean)
    Indicates if the company has a risk assessment

  - `paymentTerm` (number)
    The payment term of the company

  - `wrapInvoicesManually` (boolean)
    Indicates if the company wraps invoices manually

  - `referrer` (object)
    The referrer details of the company

  - `referrer.id` (integer)
    Unique identifier of the referrer

  - `referrer.code` (string)
    Code of the referrer

  - `referrer.name` (string)
    Name of the referrer

  - `industry` (object)
    The industry of the company

  - `industry.id` (integer)
    Unique identifier of the industry

  - `industry.name` (string)
    Name of the industry

  - `marketSegment` (object)
    The market segment of the company

  - `marketSegment.id` (integer)
    Unique identifier of the market segment

  - `marketSegment.name` (string, required)
    Name of the market segment

  - `primaryCorrespondenceContact` (object)
    The primary correspondence contact of the company

  - `emailTo` (string)
    The email to details for the company
    Enum: "BOOKING_CONTACT", "BOOKING_GUESTS", "BOOKING_CONTACT_AND_GUESTS"

  - `bankName` (string)
    The bank name of the company

  - `bankAccountName` (string)
    The bank account name of the company

  - `bankAccountNo` (string)
    The bank account number of the company

  - `bankSortCode` (string)
    The bank sort code of the company

  - `bankBicCode` (string)
    The bank BIC code of the company

  - `bankIbanCode` (string)
    The bank IBAN code of the company

  - `linkCode` (string)
    The link code of the company

  - `lifecycleStage` (string)
    The lifecycle stage of the company
    Enum: "LEAD", "QUALIFIED", "DISQUALIFIED", "OPPORTUNITY", "CUSTOMER"

  - `source` (string)
    The source of the company
    Enum: "OFFLINE_SOURCE", "ONLINE_ENQUIRY_FORM", "ONLINE_BOOKING", "SALES_CHANNEL", "DIRECT_SALE"

  - `creditCheckOk` (boolean)
    Indicates if the company's credit check is okay

  - `creditCheckDate` (string)
    The date of the company's credit check