Mews · Schema

CompanyUpdateParameters

HospitalityHotelsPMSProperty Management

Properties

Name	Type	Description
ClientToken	string	Token identifying the client application.
AccessToken	string	Access token of the client application.
Client	string	Name and version of the client application.
ChainId	string	Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
CompanyId	string	Unique identifier of the [Company](https://mews-systems.gitbook.io/connector-api/operations/#company).
Name	object	Name of the company (or `null` if the name should not be updated).
MotherCompanyId	object	Unique identifier of the mother company (or `null` if the mother company should not be updated).
InvoicingEmail	object	Email for issuing invoices to the company (or `null` if the email for issuing invoices should not be updated).
WebsiteUrl	object	The website url of the company (or `null` if the website url should not be updated).
InvoiceDueInterval	object	The maximum time, when the invoice has to be be paid in ISO 8601 duration format (or `null` if the interval should not be updated).
Options	object	Options of the company (or `null` if the company options should not be updated).
CreditRating	object	Credit rating to define creditworthiness of the company (or `null` if the credit rating should not be updated).
Department	object	The internal segmentation of a company, e.g. sales department (or `null` if the department should not be updated).
DunsNumber	object	The Dun & Bradstreet unique 9-digit DUNS number (or `null` if the Duns number should not be updated).
ReferenceIdentifier	object	External system identifier - custom identifier used by an external system such as an external database (or `null` if the identifier should not be updated).
AccountingCode	object	Accounting code of the company (or `null` if the accounting code should not be updated).
AdditionalTaxIdentifier	object	Additional tax identifier of the company (or `null` if the additional tax identifier should not be updated).
BillingCode	object	Billing code of the company (or `null` if the billing code should not be updated).
Contact	object	Other contact details, such as telephone, email or similar (or `null` if the contact should not be updated).
ContactPerson	object	Contact person of the company (or `null` if the contact person should not be updated).
Identifier	object	Fiscal or legal identifier of the company (or `null` if the identifier should not be updated).
Iata	object	Iata of the company (or `null` if the Iata should not be updated).
Notes	object	Notes of the company (or `null` if the notes should not be updated).
TaxIdentifier	object	Tax identification number of the company (or `null` if the tax identifier should not be updated).
Telephone	object	Contact telephone number (or `null` if the telephone number should not be updated).
ExternalIdentifier	object	Identifier of the company from external system (or `null` if the External Identifier should not be updated).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CompanyUpdateParameters",
  "title": "CompanyUpdateParameters",
  "required": [
    "AccessToken",
    "Client",
    "ClientToken",
    "CompanyId"
  ],
  "type": "object",
  "properties": {
    "ClientToken": {
      "minLength": 1,
      "type": "string",
      "description": "Token identifying the client application."
    },
    "AccessToken": {
      "minLength": 1,
      "type": "string",
      "description": "Access token of the client application."
    },
    "Client": {
      "minLength": 1,
      "type": "string",
      "description": "Name and version of the client application."
    },
    "ChainId": {
      "type": "string",
      "description": "Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.",
      "format": "uuid",
      "nullable": true
    },
    "CompanyId": {
      "type": "string",
      "description": "Unique identifier of the [Company](https://mews-systems.gitbook.io/connector-api/operations/#company).",
      "format": "uuid"
    },
    "Name": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Name of the company (or `null` if the name should not be updated).",
      "nullable": true
    },
    "MotherCompanyId": {
      "title": "Guid update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/GuidNullableUpdateValue"
        }
      ],
      "description": "Unique identifier of the mother company (or `null` if the mother company should not be updated).",
      "nullable": true
    },
    "InvoicingEmail": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Email for issuing invoices to the company  (or `null` if the email for issuing invoices should not be updated).",
      "format": "email",
      "nullable": true
    },
    "WebsiteUrl": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "The website url of the company (or `null` if the website url should not be updated).",
      "format": "uri",
      "nullable": true
    },
    "InvoiceDueInterval": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "The maximum time, when the invoice has to be be paid in ISO 8601 duration format (or `null` if the interval should not be updated).",
      "nullable": true
    },
    "Options": {
      "title": "Company update options",
      "allOf": [
        {
          "$ref": "#/components/schemas/CompanyOptionUpdateParameters"
        }
      ],
      "description": "Options of the company (or `null` if the company options should not be updated).",
      "nullable": true
    },
    "CreditRating": {
      "title": "Credit rating update parameters",
      "allOf": [
        {
          "$ref": "#/components/schemas/CreditRatingUpdateParameters"
        }
      ],
      "description": "Credit rating to define creditworthiness of the company (or `null` if the credit rating should not be updated).",
      "nullable": true
    },
    "Department": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "The internal segmentation of a company, e.g. sales department (or `null` if the department should not be updated).",
      "nullable": true
    },
    "DunsNumber": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "The Dun & Bradstreet unique 9-digit DUNS number (or `null` if the Duns number should not be updated).",
      "nullable": true
    },
    "ReferenceIdentifier": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "External system identifier - custom identifier used by an external system such as an external database (or `null` if the identifier should not be updated).",
      "nullable": true
    },
    "AccountingCode": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Accounting code of the company (or `null` if the accounting code should not be updated).",
      "nullable": true
    },
    "AdditionalTaxIdentifier": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Additional tax identifier of the company (or `null` if the additional tax identifier should not be updated).",
      "nullable": true
    },
    "BillingCode": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Billing code of the company (or `null` if the billing code should not be updated).",
      "nullable": true
    },
    "Contact": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Other contact details, such as telephone, email or similar (or `null` if the contact should not be updated).",
      "nullable": true
    },
    "ContactPerson": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Contact person of the company (or `null` if the contact person should not be updated).",
      "nullable": true
    },
    "Identifier": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Fiscal or legal identifier of the company (or `null` if the identifier should not be updated).",
      "nullable": true
    },
    "Iata": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Iata of the company (or `null` if the Iata should not be updated).",
      "nullable": true
    },
    "Notes": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Notes of the company (or `null` if the notes should not be updated).",
      "nullable": true
    },
    "TaxIdentifier": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Tax identification number of the company (or `null` if the tax identifier should not be updated).",
      "nullable": true
    },
    "Telephone": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Contact telephone number (or `null` if the telephone number should not be updated).",
      "format": "tel",
      "nullable": true
    },
    "ExternalIdentifier": {
      "title": "String update value",
      "maxLength": 255,
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Identifier of the company from external system (or `null` if the External Identifier should not be updated).",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "CompanyUpdateParameters"
}