Mews · Schema

OrderAdditionParameters

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.
EnterpriseId	string	Unique identifier of the `Enterprise`. Required when using Portfolio Access Tokens, ignored otherwise.
ServiceId	string	Identifier of the `Service` to be ordered.
AccountId	string	Identifier of the `Customer` or `Company` to be charged. Company billing may not be enabled for your integration.
CustomerId	string	Identifier of the [Customer](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) to be charged. Deprecated!
Options	object	Options for the added order.
ProductOrders	array	Parameters of the ordered products.
Items	array	Parameters of the ordered custom items.
ConsumptionUtc	string	Date and time of the order consumption in UTC timezone in ISO 8601 format. If not specified, current date and time is used. Please note, as order consumption is one-time event, the optional parameters
Notes	string	Additional notes of the order.
BusinessSegmentId	string	Unique identifier of the business segment.
BillId	string	Identifier of the `Bill` to which the created order will be assigned. The bill needs to be issued to the same account as the order.
LinkedReservationId	string	Identifier of the `Reservation` to which the created order will be linked.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OrderAdditionParameters",
  "title": "OrderAdditionParameters",
  "required": [
    "AccessToken",
    "AccountId",
    "Client",
    "ClientToken",
    "ServiceId"
  ],
  "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."
    },
    "EnterpriseId": {
      "type": "string",
      "description": "Unique identifier of the `Enterprise`. Required when using Portfolio Access Tokens, ignored otherwise.",
      "format": "uuid",
      "nullable": true
    },
    "ServiceId": {
      "type": "string",
      "description": "Identifier of the `Service` to be ordered.",
      "format": "uuid"
    },
    "AccountId": {
      "type": "string",
      "description": "Identifier of the `Customer` or `Company` to be charged. Company billing may not be enabled for your integration.",
      "format": "uuid"
    },
    "CustomerId": {
      "type": "string",
      "description": "Identifier of the [Customer](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) to be charged.  **Deprecated!**",
      "format": "uuid",
      "nullable": true,
      "deprecated": true,
      "x-deprecatedMessage": "Use `AccountId`."
    },
    "Options": {
      "title": "Order addition options",
      "allOf": [
        {
          "$ref": "#/components/schemas/OrderAdditionOptions"
        }
      ],
      "description": "Options for the added order.",
      "nullable": true
    },
    "ProductOrders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProductOrderAdditionData"
      },
      "description": "Parameters of the ordered products.",
      "nullable": true
    },
    "Items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderItemAdditionData"
      },
      "description": "Parameters of the ordered custom items.",
      "nullable": true
    },
    "ConsumptionUtc": {
      "type": "string",
      "description": "Date and time of the order consumption in UTC timezone in ISO 8601 format. If not specified, current date and time is used. Please note, as order consumption is one-time event, the optional parameters `StartUtc` and `EndUtc` in `ProductOrders` should not be used.",
      "format": "date-time",
      "nullable": true
    },
    "Notes": {
      "type": "string",
      "description": "Additional notes of the order.",
      "nullable": true
    },
    "BusinessSegmentId": {
      "type": "string",
      "description": "Unique identifier of the business segment.",
      "format": "uuid",
      "nullable": true
    },
    "BillId": {
      "type": "string",
      "description": "Identifier of the `Bill` to which the created order will be assigned. The bill needs to be issued to the same account as the order.",
      "format": "uuid",
      "nullable": true
    },
    "LinkedReservationId": {
      "type": "string",
      "description": "Identifier of the `Reservation` to which the created order will be linked.",
      "format": "uuid",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "OrderAdditionParameters"
}