Property

Get a property

Get a property by id.<br>You need to be authorized (no particular scope required)

get/inventory/v1/properties/{id}

Path parameters

idstring required

The id of the property.

Query parameters

languagesstring[]

'all' or comma separated list of two-letter language codes (ISO Alpha-2)

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.

Response

Return all the property data.

idstring required

The property id

codestring required

The code for the property that can be shown in reports and table views

propertyTemplateIdstring nullable

The id of the property used as a template while creating the property

isTemplateboolean required

Whether the property can be used as a template for other properties

nameobject required

The name for the property

descriptionobject nullable

The description for the property

companyNamestring required

The legal name of the company running the property.

managingDirectorsstring nullable

The managing director(s) of the company, as they should appear on invoices

commercialRegisterEntrystring required

The entry in the Commercial Register of the company running the property, as it should appear on invoices

taxIdstring required

The Tax-ID of the company running the property, as it should appear on invoices

paymentTermsobject required

The payment terms used for all rate plans

timeZonestring required

The time zone name of the property from the IANA Time Zone Database. (see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

currencyCodestring required

The currency a property works with.

createdstring date-time required

Date of creation<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

status'Test' | 'Live' required

The status of the property

isArchivedboolean required

Is the property archived

Example response

{
  "id": "MUC",
  "code": "MUC",
  "propertyTemplateId": "BER",
  "isTemplate": false,
  "name": {
    "en": "Demo Hotel Munich",
    "de": "Demo Hotel München"
  },
  "description": {
    "en": "This is the demo hotel Munich",
    "de": "Dies ist das Demo Hotel München"
  },
  "companyName": "Hotel Münchner GmbH",
  "managingDirectors": "Franz-Josef Gruber",
  "commercialRegisterEntry": "Amtsgericht München, HRB 279336",
  "taxId": "DE311053702",
  "location": {
    "addressLine1": "Marienplatz 1",
    "postalCode": "80331",
    "city": "München",
    "countryCode": "DE"
  },
  "bankAccount": {
    "iban": "DE44 5001 0517 5407 3249 31",
    "bic": "SSKMDEMMXXX",
    "bank": "Stadtsparkasse München"
  },
  "paymentTerms": {
    "en": "Pay on checkout",
    "de": "Zahlung bei Checkout"
  },
  "timeZone": "Europe/Berlin",
  "currencyCode": "EUR",
  "created": "0001-01-01T00:00:00Z",
  "status": "Test",
  "isArchived": false
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.