Mews · Schema

BillCloseParameters

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](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
BillId	string	Unique identifier of the [Bill](https://mews-systems.gitbook.io/connector-api/operations/#bill) to be closed.
Type	object
BillCounterId	string	Unique identifier of the [Counter](https://mews-systems.gitbook.io/connector-api/operations/counters/#counter) to be used for closing. Default one is used when no value is provided.
FiscalMachineId	string	Unique identifier of the [Fiscal Machine](https://mews-systems.gitbook.io/connector-api/operations/devices/#device) to be used for closing. Default one is used when no value is provided.
Options	object	Options of the bill. If not provided, both DisplayCustomer and DisplayTaxation are set by default.
TaxedDate	object	Date of consumption for tax purposes. Can be used only with `Type` of `Invoice`.
DueDate	object	Deadline when bill is due to be paid. Can be used only with `Type` of `Invoice`.
VariableSymbol	object	Optional unique identifier of requested payment. Can be used only with `Type` of `Invoice`.
TaxIdentifier	object	Tax identifier of account to be put on a bill.
AccountTaxIdentifier	object	Tax identifier of account to be put on a bill.
CompanyTaxIdentifier	object	Tax identifier of company to be put on a bill.
PurchaseOrderNumber	object	Unique number of the purchase order from the buyer.
Notes	object	Notes to be attached to bill.
Address	object	Address of the account to be displayed on bill. Overrides the default one taken from account profile.
AccountAddress	object	Address of the account to be displayed on bill. Overrides the default one taken from account profile.
AssociatedAccountData	array	Account data of the associated account on a bill. Currently one object is supported and only populated when the bill is closed.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BillCloseParameters",
  "title": "BillCloseParameters",
  "required": [
    "AccessToken",
    "BillId",
    "Client",
    "ClientToken",
    "Type"
  ],
  "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](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.",
      "format": "uuid",
      "nullable": true
    },
    "BillId": {
      "type": "string",
      "description": "Unique identifier of the [Bill](https://mews-systems.gitbook.io/connector-api/operations/#bill) to be closed.",
      "format": "uuid"
    },
    "Type": {
      "$ref": "#/components/schemas/BillType"
    },
    "BillCounterId": {
      "type": "string",
      "description": "Unique identifier of the [Counter](https://mews-systems.gitbook.io/connector-api/operations/counters/#counter) to be used for closing. Default one is used when no value is provided.",
      "format": "uuid",
      "nullable": true
    },
    "FiscalMachineId": {
      "type": "string",
      "description": "Unique identifier of the [Fiscal Machine](https://mews-systems.gitbook.io/connector-api/operations/devices/#device) to be used for closing. Default one is used when no value is provided.",
      "format": "uuid",
      "nullable": true
    },
    "Options": {
      "title": "Bill options parameters",
      "allOf": [
        {
          "$ref": "#/components/schemas/BillOptionsParameters"
        }
      ],
      "description": "Options of the bill. If not provided, both DisplayCustomer and DisplayTaxation are set by default.",
      "nullable": true
    },
    "TaxedDate": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Date of consumption for tax purposes. Can be used only with `Type` of `Invoice`.",
      "nullable": true
    },
    "DueDate": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Deadline when bill is due to be paid. Can be used only with `Type` of `Invoice`.",
      "nullable": true
    },
    "VariableSymbol": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Optional unique identifier of requested payment. Can be used only with `Type` of `Invoice`.",
      "nullable": true
    },
    "TaxIdentifier": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Tax identifier of account to be put on a bill.",
      "nullable": true,
      "deprecated": true,
      "x-deprecatedMessage": "Use `AccountTaxIdentifier` or `AssociatedAccountData` instead."
    },
    "AccountTaxIdentifier": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Tax identifier of account to be put on a bill.",
      "nullable": true
    },
    "CompanyTaxIdentifier": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Tax identifier of company to be put on a bill.",
      "nullable": true,
      "deprecated": true,
      "x-deprecatedMessage": "Use `AccountTaxIdentifier` or `AssociatedAccountData` instead."
    },
    "PurchaseOrderNumber": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Unique number of the purchase order from the buyer.",
      "nullable": true
    },
    "Notes": {
      "title": "String update value",
      "allOf": [
        {
          "$ref": "#/components/schemas/StringUpdateValue"
        }
      ],
      "description": "Notes to be attached to bill.",
      "nullable": true
    },
    "Address": {
      "title": "Address parameters",
      "allOf": [
        {
          "$ref": "#/components/schemas/AddressParameters"
        }
      ],
      "description": "Address of the account to be displayed on bill. Overrides the default one taken from account profile.",
      "nullable": true,
      "deprecated": true,
      "x-deprecatedMessage": "Use `AccountAddress` or `AssociatedAccountData` instead."
    },
    "AccountAddress": {
      "title": "Address parameters",
      "allOf": [
        {
          "$ref": "#/components/schemas/AddressParameters"
        }
      ],
      "description": "Address of the account to be displayed on bill. Overrides the default one taken from account profile.",
      "nullable": true
    },
    "AssociatedAccountData": {
      "maxItems": 1,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BillCloseAccountParameters"
      },
      "description": "Account data of the associated account on a bill. Currently one object is supported and only populated when the bill is closed.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "BillCloseParameters"
}