NTAK objects

On this page, you can access the reusable objects for NTAK reports. These objects are designed to be used across different reports in the NTAK system, providing consistency and reusability of data structures.

Expense

The expenditure is a gross item paid by the guest without VAT, the amount and type of which the NTAK system takes into account. It must be sent to the PMS interface on the date of issue of the invoice.

Multiple spends and multiple debits can be sent for one guest night.

It is possible that a charge appears in the system as a spend on the same day. This is not a problem, it should be sent as a separate item to the PMS interface.

`date`

Type	Format	Required
datetime	`Y-m-d H:i:s`	Yes

`amount`

Type	Format	Required
number		Yes

⚠️

The amount must be converted to HUF currency by the PMS!

`paymentOption`

Type	Format	Required
enum	Payment Options	Yes

`paymentOptionSubtype`

Type	Format	Required
enum	Payment Option Subtypes	Required when `paymentOption` is `szep`.

{
  "date": "2023-04-14 14:50:23",
  "amount": 13500,
  "paymentOption": "szep",
  "paymentOptionSubtype": "hospitality"
}

Load

Gross amount with VAT rate and service category charged to the guest's account for a service. It must be sent to the PMS interface on the day the product or service is recorded.

The value of the accommodation fee and IFA booked for the given day is also considered a charge.

`date`

Type	Format	Required
datetime	`Y-m-d H:i:s`	Yes

`amount`

Type	Format	Required
number		Yes

⚠️

The amount must be converted to HUF currency by the PMS!

`category`

Type	Format	Required
enum	Charge Item Category	Yes

`isTouristTax`

Type	Format	Required
boolean		Yes

taxPercentage

Type	Format	Required
number		Yes

{
  "date": "2023-04-14 14:52:04",
  "amount": 890,
  "category": "drink",
  "isTouristTax": false,
  "taxPercentage": 21
}

Guest

`gender`

Type	Format	Required
enum	Gender	Yes

`guestNumber`

The unique identifier of the guest.

Type	Format	Required
string or number		Yes

`touristTaxStatus`

Type	Format	Required
enum	Tourist Tax	Yes

`yearOfBirth`

Type	Format	Required
number	>1900	Yes

`residenceCountryCode`

Type	Format	Required
string	ISO 3166-1 alpha-2 (opens in a new tab) or `other`	Yes

If the country code does not included in the official list, NTAK.guru will transform it to other.

`residencePostCode`

Type	Format	Required
string		Yes

`nationalityCountryCode`

Type	Format	Required
string	ISO 3166-1 alpha-2 (opens in a new tab) or `other`	Yes

If the country code does not included in the official list, NTAK.guru will transform it to other.

{
  "gender": "male",
  "guestNumber": "00000000-0000-0000-0000-000000000000",
  "touristTaxStatus": "obliged",
  "yearOfBirth": 1957,
  "residenceCountryCode": "HU",
  "residencePostCode": "04070",
  "nationalityCountryCode": "HU"
}

Residential unit

`type`

Type	Format	Required
enum	Residential Unit Types	Yes

`building`

Type	Format	Required
string or number		Yes

If your PMS does not handle buildings, we recommend using the letter "a" as value.

`number`

Type	Format	Required
string or number		Yes

Name of the room. For example the room number.

`trundleBedCount`

Type	Format	Required
number	>=0	Yes

`singleBedCount`

Type	Format	Required
number	>=0	Yes

`doubleBedCount`

Type	Format	Required
number	>=0	Yes

{
  "type": "standard",
  "building": "a",
  "number": "402",
  "trundleBedCount": 0,
  "singleBedCount": 0,
  "doubleBedCount": 1
}

Callback Constants