APapaleo
Property

Creates a property

Use this call to create a new property.<br>You must have at least one of these scopes: 'properties.create, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.properties.create'.

post/inventory/v1/properties

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/inventory/v1/properties
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: properties.create, setup.manage, admin

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

codestring required

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

nameobject required

The name 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 Reigster 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

descriptionobject nullable

The description for the property

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)

defaultCheckInTimestring required

The default check-in time<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

defaultCheckOutTimestring required

The default check-out time<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

currencyCodestring required

The currency a property works with.

Example request

{
  "code": "MUC",
  "name": {
    "en": "Demo Hotel Munich",
    "de": "Demo Hotel München"
  },
  "companyName": "Hotel Münchner GmbH",
  "managingDirectors": "Franz-Josef Gruber",
  "commercialRegisterEntry": "Amtsgericht München, HRB 279336",
  "taxId": "DE311053702",
  "description": {
    "en": "This is the demo hotel Munich",
    "de": "Dies ist das Demo Hotel München"
  },
  "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",
  "defaultCheckInTime": "17:00:00",
  "defaultCheckOutTime": "11:00:00",
  "currencyCode": "EUR"
}

Response

Creation of the new property was successful.

idstring required

The property id

Example response

{
  "id": "MUC"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.