Reservation

Overview

The reservation module synchronizes reservation data, including guest information, room details, folio data, and reservation rates. Reservation records reference company and other previously synchronized master data.

Request

Method: POST
Path: {{base_url}}/api/sync-reservation

Request Envelope

The Reservation module uses reservation as the module name and sends reservation records as an array in data.

{
  "module": "reservation",
  "data": [
    {}
  ],
  "chunk_metadata": {}
}

For details on when to use sync modules versus initialization_* modules, see Module Behavior.

Request Body Fields

Field	Type	Required	Description	Example
`reservation_id`	string	Yes	Reservation identifier.	`RES-1001`
`company`	object	Yes	Company information (See below).	`{...}`
`reservation_date`	string	yes	Reservation date.	`2026-08-20`
`agent_id`	string / null	Yes	Agent identifier.	`AGT-01`
`total_of_room`	number	Optional	Total reserved rooms.	`1`
`guest_profile`	object	Optional	Guest information (see below).	`{...}`
`reservation_detail`	array of object	yes	Reservation detail records (See below).	`[...]`
`rates`	array of object	yes	Reservation rate records (see below).	`[...]`

Company Fields

Field	Type	Required	Description	Example
`id`	string	Yes	Company identifier.	`HTL-001`
`code`	string	Optional	Company code.	`HTL001`

Guest Profile Fields

Field	Type	Required	Description	Example
`id`	string	Optional	Guest identifier.	`GST-01`
`email`	string	Optional	Guest email.	`[email protected]`
`address`	string	Optional	Guest address.	`Jl. Melati No. 5, Jakarta`
`countrycode`	string	Optional	Guest country code.	`ID`

Reservation Detail Fields

Field	Type	Required	Description	Example
`id`	string	yes	Reservation detail identifier.	`DET-1001`
`room_type_id`	string	yes	Room type identifier.	`RT-01`
`arrival_date`	string	yes	Arrival date.	`2026-09-01`
`departure_date`	string	yes	Departure date.	`2026-09-03`
`reservation_status`	string	yes	Reservation status.	`CHECK_IN`
`nights`	number	Optional	Number of nights.	`2`
`main_folio`	string / null	Yes	Main folio identifier.	`FOL-1001`
`reservation_folio`	object	Optional	Reservation folio information (see below).	`{...}`

Rates Fields

Field	Type	Required	Description	Example
`id`	string / null	Yes	Rate line identifier.	`RATE-LINE-1`
`rates_id`	string / null	Yes	Rate identifier.	`RATE-01`
`room_id`	string / null	Yes	Room identifier.	`RM-101`
`room_type_id`	string / null	Yes	Room type identifier.	`RT-01`
`net_rates`	number	yes	Net rate amount.	`750000`
`taxes_amount`	number	Yes	Tax amount.	`0`
`service_amount`	number	Yes	Service amount.	`0`
`commission_amount`	number	Yes	Commission amount.	`0`
`total_pos`	number	Yes	Total POS amount.	`0`
`total_pos_taxes`	number	Yes	Total POS tax amount.	`0`
`adult`	number	Optional	Number of adults.	`2`
`child`	number	Optional	Number of children.	`0`
`is_virtual_room`	boolean	Optional	Virtual room indicator.	`false`
`dates`	string / null	Yes	Rate date.	`2026-09-01`
`reservation_rates_type`	string	Yes	Reservation rate type.	`ROOM_CHARGE`
`remark`	string	Yes	Rate remark.	`Room Charge`

Reservation Folio Fields

Field	Type	Required	Description	Example
`id`	string	yes	Folio identifier.	`FOL-1001`
`total_pos`	number	yes	Total POS amount.	`0`
`total_payment`	number	yes	Total payment amount.	`1500000`

Request Example

{
  "module": "reservation",
  "data": [
    {
      "reservation_id": "RES-1001",
      "company": {
          "id": "HTL-001",
          "code": "HTL001"
        },
      "reservation_date": "2026-08-20",
      "agent_id": "AGT-01",
      "total_of_room": 1,
      "guest_profile": {
        "id": "GST-01",
        "email": "[email protected]",
        "address": "Jl. Melati No. 5, Jakarta",
        "countrycode": "ID"
      },
      "reservation_detail": [
        {
          "id": "DET-1001",
          "room_type_id": "RT-01",
          "arrival_date": "2026-09-01",
          "departure_date": "2026-09-03",
          "reservation_status": "CHECK_IN",
          "nights": 2,
          "main_folio": "FOL-1001",
          "reservation_folio": {
            "id": "FOL-1001",
            "total_pos": 0,
            "total_payment": 1500000
          },
          "rates": [
            {
              "id": "RATE-LINE-1",
              "rates_id": "RATE-01",
              "room_id": "RM-101",
              "room_type_id": "RT-01",
              "dates": "2026-09-01",
              "net_rates": 750000,
              "taxes_amount": 0,
              "service_amount": 0,
              "commission_amount": 0,
              "total_pos": 0,
              "total_pos_taxes": 0,
              "adult": 2,
              "child": 0,
              "is_virtual_room": false,
              "reservation_rates_type": "ROOM_CHARGE",
              "remark": "Room Charge"
            },
            {
              "id": "RATE-LINE-2",
              "rates_id": "RATE-01",
              "room_id": "RM-101",
              "room_type_id": "RT-01",
              "dates": "2026-09-02",
              "net_rates": 750000,
              "taxes_amount": 0,
              "service_amount": 0,
              "commission_amount": 0,
              "total_pos": 0,
              "total_pos_taxes": 0,
              "adult": 2,
              "child": 0,
              "is_virtual_room": false,
              "reservation_rates_type": "ROOM_CHARGE",
              "remark": "Room Charge"
            },
            {
              "id": "RATE-LINE-3",
              "rates_id": "RATE-01",
              "room_id": "RM-101",
              "room_type_id": "RT-01",
              "dates": "2026-09-03",
              "net_rates": 750000,
              "taxes_amount": 0,
              "service_amount": 0,
              "commission_amount": 0,
              "total_pos": 0,
              "total_pos_taxes": 0,
              "adult": 2,
              "child": 0,
              "is_virtual_room": false,
              "reservation_rates_type": "ROOM_CHARGE",
              "remark": "Room Charge"
            },
            {
              "id": "RATE-LINE-4",
              "rates_id": "RATE-01",
              "room_id": "RM-101",
              "room_type_id": "RT-01",
              "dates": "2026-09-03",
              "net_rates": 750000,
              "taxes_amount": 0,
              "service_amount": 0,
              "commission_amount": 0,
              "total_pos": 0,
              "total_pos_taxes": 0,
              "adult": 2,
              "child": 0,
              "is_virtual_room": false,
              "reservation_rates_type": "EXTRA_ADULT",
              "remark": "Extra Adult"
            }
          ]
        }
      ]
    }
  ],
  "chunk_metadata": {
    "process_id": "postman-reservation-001",
    "chunk_sequence": 1,
    "is_last_chunk": true,
    "total_records_in_chunk": 1
  }
}

Overview​

Request​

Request Envelope​

Request Body Fields​

Company Fields​

Guest Profile Fields​

Reservation Detail Fields​

Rates Fields​

Reservation Folio Fields​

Request Example​