Lodgix Public API

https://www.lodgix.com/public-api/v2/documentation
Admin
The Lodgix Public API provides developers with programmatic access to Lodgix.com's vacation rental...
Tokens:97,222
Snippets:247
Trust Score:9.7
Update:11 months ago
Show doc for...
Tokens:
Raw
### Create Rate Response Example (JSON)

Source: https://www.lodgix.com/public-api/v2/documentation/index

Example JSON response after successfully creating a rate. Returns the created rate object with its details.

```json
{
  "id": 0,
  "name": "string",
  "period": {
    "from_date": "2019-08-24",
    "to_date": "2019-08-24"
  },
  "min_nights": 1,
  "daily_rate": "string",
  "weekend_rate": "string",
  "weekly_rate": "string",
  "monthly_rate": "string",
  "extra_person_base": -2147483648,
  "extra_person_rate": "string",
  "default": true,
  "arrival_day": 6,
  "departure_day": 6
}
```

--------------------------------

### Create Photo Payload Example (JSON)

Source: https://www.lodgix.com/public-api/v2/documentation/index

Example JSON payload for creating a photo associated with a property. Requires title and order_no.

```json
{
  "title": "string",
  "order_no": 1
}
```

--------------------------------

### List Rates Response Example (JSON)

Source: https://www.lodgix.com/public-api/v2/documentation/index

Example JSON response when listing all rates for a property. Includes pagination details and a list of rate objects.

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "name": "string",
      "period": {
        "from_date": "2019-08-24",
        "to_date": "2019-08-24"
      },
      "min_nights": 1,
      "daily_rate": "string",
      "weekend_rate": "string",
      "weekly_rate": "string",
      "monthly_rate": "string",
      "extra_person_base": -2147483648,
      "extra_person_rate": "string",
      "default": true,
      "arrival_day": 6,
      "departure_day": 6
    }
  ]
}
```

--------------------------------

### Photo Response Example (JSON)

Source: https://www.lodgix.com/public-api/v2/documentation/index

Example JSON response when retrieving photo details. Includes ID, title, URLs, dimensions, and ordering information.

```json
{
  "id": 0,
  "title": "string",
  "url": "http://example.com",
  "preview_url": "http://example.com",
  "thumbnail_url": "http://example.com",
  "p_thumbnail_url": "http://example.com",
  "height": -2147483648,
  "width": -2147483648,
  "order_no": 0,
  "is_primary": true,
  "place_id": "string"
}
```

--------------------------------

### Create Rate Payload Example (JSON)

Source: https://www.lodgix.com/public-api/v2/documentation/index

Example JSON payload for creating a rate for a property. Includes details like name, date range, pricing, and day restrictions.

```json
{
  "name": "string",
  "from_date": "2019-08-24",
  "to_date": "2019-08-24",
  "min_nights": 1,
  "daily_rate": "string",
  "weekend_rate": "string",
  "weekly_rate": "string",
  "monthly_rate": "string",
  "extra_person_base": -2147483648,
  "extra_person_rate": "string",
  "arrival_day": 6,
  "departure_day": 6
}
```

--------------------------------

### GET /public-api/v2/discount-templates/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Retrieves a list of all discount templates with pagination support.

```APIDOC
## GET /public-api/v2/discount-templates/

### Description
Retrieves a list of all discount templates with pagination support.

### Method
GET

### Endpoint
/public-api/v2/discount-templates/

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of results to return per page.
- **offset** (integer) - Optional - The initial index from which to return the results.

### Response
#### Success Response (200)
- **count** (integer) - The total number of discount templates.
- **next** (string) - URL for the next page of results.
- **previous** (string) - URL for the previous page of results.
- **results** (array of objects) - A list of discount templates.
  - **id** (integer) - The ID of the discount template.
  - **type** (integer) - The type of discount.
  - **status** (integer) - The status of the discount.
  - **name** (string) - The name of the discount.
  - **value** (string) - The value of the discount.
  - **value_type** (integer) - The type of value for the discount.
  - **automatic** (boolean) - Indicates if the discount is automatic.
  - **code** (string) - The discount code.
  - **min_nights** (integer) - Minimum number of nights required for the discount.
  - **start_date** (string) - The start date for the discount (YYYY-MM-DD).
  - **end_date** (string) - The end date for the discount (YYYY-MM-DD).
  - **validity_start_date** (string) - The validity start date for the discount (YYYY-MM-DD).
  - **validity_end_date** (string) - The validity end date for the discount (YYYY-MM-DD).
  - **max_use** (integer) - Maximum number of times the discount can be used.
  - **modifiers** (array of objects) - Modifiers for the discount.
    - **id** (integer) - The ID of the modifier.
    - **min_nights** (integer) - Minimum number of nights for the modifier.
    - **value** (string) - The value of the modifier.

#### Response Example
```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "type": 0,
      "status": 0,
      "name": "string",
      "value": "string",
      "value_type": 0,
      "automatic": true,
      "code": "string",
      "min_nights": 1,
      "start_date": "2019-08-24",
      "end_date": "2019-08-24",
      "validity_start_date": "2019-08-24",
      "validity_end_date": "2019-08-24",
      "max_use": -2147483648,
      "modifiers": [
        {
          "id": 0,
          "min_nights": -2147483648,
          "value": "string"
        }
      ]
    }
  ]
}
```
```

--------------------------------

### GET /public-api/v2/guests/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Lists all guests with optional filtering and pagination.

```APIDOC
## GET /public-api/v2/guests/

### Description
Lists all guests with optional filtering and pagination.

### Method
GET

### Endpoint
/public-api/v2/guests/

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The number of results to return per page.
- **offset** (integer) - Optional - The initial index from which to return the results.
- **email** (string) - Optional - Filter guests by email address.
- **full_name** (string) - Optional - Filter guests by full name.

### Response
#### Success Response (200)
This endpoint returns a list of guest objects. The exact structure of the guest object is not detailed in the provided text, but typically includes fields like ID, name, email, etc.

### Response Example
(Response example not provided in the input text, but would typically be a JSON array of guest objects)
```

--------------------------------

### GET /public-api/v2/tax-templates/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Retrieves a list of all tax templates with optional pagination.

```APIDOC
## GET /public-api/v2/tax-templates/

### Description
Retrieves a list of all tax templates. You can control the number of results and the offset for pagination.

### Method
GET

### Endpoint
/public-api/v2/tax-templates/

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of results to return per page.
- **offset** (integer) - Optional - The initial index from which to return the results.

### Response
#### Success Response (200)
- **count** (integer) - The total number of tax templates.
- **next** (string) - URL for the next page of results.
- **previous** (string) - URL for the previous page of results.
- **results** (Array of objects) - A list of tax templates.
  - **id** (integer) - The ID of the tax template.
  - **title** (string) - The title of the tax template.
  - **type** (string) - The type of the tax template (CITYTAX, LOCALTAX, OTHERTAX, PROVINCETAX, SALESTAX, STATETAX).
  - **value** (string) - The value of the tax template.
  - **is_flat** (boolean) - True if the value is a fixed amount, false otherwise.
  - **is_advanced** (boolean) - True if the tax template is advanced.
  - **advanced_value** (string) - The advanced value of the tax template.
  - **advanced_nights** (integer) - The number of nights for the advanced tax calculation.
  - **frequency** (string) - The frequency of the tax (DAILY, ONETIME).

#### Response Example
```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "title": "string",
      "type": "CITYTAX",
      "value": "string",
      "is_flat": true,
      "is_advanced": true,
      "advanced_value": "string",
      "advanced_nights": 0,
      "frequency": "DAILY"
    }
  ]
}
```
```

--------------------------------

### GET /public-api/v2/deposit-templates/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Retrieves a list of all deposit templates with pagination support.

```APIDOC
## GET /public-api/v2/deposit-templates/

### Description
Retrieves a list of all deposit templates with pagination support.

### Method
GET

### Endpoint
/public-api/v2/deposit-templates/

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of results to return per page.
- **offset** (integer) - Optional - The initial index from which to return the results.

### Response
#### Success Response (200)
- **count** (integer) - The total number of deposit templates.
- **next** (string) - URL for the next page of results.
- **previous** (string) - URL for the previous page of results.
- **results** (array of objects) - A list of deposit templates.
  - **id** (integer) - The ID of the deposit template.
  - **title** (string) - The title of the deposit template.
  - **value** (string) - The value of the deposit template.
  - **pre_auth** (boolean) - Indicates if pre-authorization is enabled.

#### Response Example
```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "title": "string",
      "value": "string",
      "pre_auth": true
    }
  ]
}
```
```

--------------------------------

### GET /public-api/v2/properties/{property_pk}/reviews/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Retrieves a list of reviews for a specific property, with options for pagination and language filtering.

```APIDOC
## GET /public-api/v2/properties/{property_pk}/reviews/

### Description
Retrieves a list of reviews for a specific property, with options for pagination and language filtering.

### Method
GET

### Endpoint
`/public-api/v2/properties/{property_pk}/reviews/`

### Parameters
#### Path Parameters
- **property_pk** (string) - Required - The unique identifier for the property.

#### Query Parameters
- **limit** (integer) - Optional - Number of results to return per page.
- **offset** (integer) - Optional - The initial index from which to return the results.
- **language** (string) - Optional - Review language code (e.g., 'en', 'es').

### Response
#### Success Response (200)
- **count** (integer) - Total number of reviews.
- **next** (string) - URL for the next page of results.
- **previous** (string) - URL for the previous page of results.
- **results** (array) - An array of review objects.
  - **id** (integer) - The unique identifier for the review.
  - **name** (string) - The name of the reviewer.
  - **title** (string) - The title of the review.
  - **description** (string) - The content of the review.
  - **stars** (integer) - The star rating given in the review.
  - **date** (string) - The date and time the review was posted (ISO 8601 format).
  - **language** (string) - The language of the review.
  - **channel** (string) - The channel through which the review was submitted.
  - **host_response** (object) - An object containing the host's response to the review.

#### Response Example
```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "name": "string",
      "title": "string",
      "description": "string",
      "stars": -2147483648,
      "date": "2019-08-24T14:15:22Z",
      "language": "sq",
      "channel": "string",
      "host_response": {}
    }
  ]
}
```
```

--------------------------------

### Get Owner Properties - API Response Sample

Source: https://www.lodgix.com/public-api/v2/documentation/index

Example JSON response for the GET /public-api/v2/owner-properties/ endpoint. It includes pagination details and a list of owner properties with their associated information.

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "order": 0,
      "rental_property_id": "string",
      "owner_id": "string",
      "name": "string",
      "deleted": true,
      "disabled": true,
      "commission": "string",
      "is_flat": true,
      "commission_calculation": "string",
      "assess_channel_commissions_to_owner": true,
      "display_guest_name_in_owner_statement": true,
      "pass_cancellation_fees_to_owner": true,
      "pass_cancellation_fees_to_owner_mode": "string",
      "rental_fee": "string",
      "rental_fee_is_flat": true,
      "rental_fee_include_taxes": true,
      "rental_fee_include_fees": true,
      "rental_fee_name": "string",
      "cleaning_fee": "string",
      "cleaning_fee_is_flat": true,
      "cleaning_fee_name": "string",
      "other_fee": "string",
      "other_fee_is_flat": true,
      "other_fee_name": "string",
      "commissions_details": [
        {
          "position": 0,
          "team_member_id": 0,
          "commission": 0
        }
      ]
    }
  ]
}
```

--------------------------------

### POST /public-api/v2/guests/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Creates a new guest in the system. Requires basic guest information and optionally includes address details.

```APIDOC
## POST /public-api/v2/guests/

### Description
Creates a new guest in the system. Requires basic guest information and optionally includes address details.

### Method
POST

### Endpoint
/public-api/v2/guests/

### Parameters
#### Request Body
- **first_name** (string) - Required - Guest first name (<= 64 characters)
- **last_name** (string) - Required - Guest last name (<= 64 characters)
- **title** (string) - Optional - Guest title (e.g., DR, MISS, MISSIS, MISTER, MRMRS)
- **company** (string) - Optional - Guest company (<= 96 characters)
- **email** (string) - Optional - Guest email (must be a valid email format)
- **address** (object) - Optional - Guest address details
  - **address1** (string) - Optional
  - **address2** (string) - Optional
  - **city** (string) - Optional
  - **zip** (string) - Optional
  - **country** (string) - Optional
  - **state** (string) - Optional
  - **phone** (string) - Optional
  - **fax** (string) - Optional
  - **work_phone** (string) - Optional
  - **work_phone_ext** (string) - Optional
- **status_id** (integer) - Optional - Unique guest status identifier

### Request Example
```json
{
  "first_name": "string",
  "last_name": "string",
  "title": "string",
  "company": "string",
  "email": "user@example.com",
  "address": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "zip": "string",
    "country": "string",
    "state": "string",
    "phone": "string",
    "fax": "string",
    "work_phone": "string",
    "work_phone_ext": "strin"
  },
  "status_id": 0
}
```

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the created guest
- **type** (string) - Type of the created entity (e.g., "Guest")
- **first_name** (string) - Guest's first name
- **last_name** (string) - Guest's last name
- **full_name** (string) - Guest's full name
- **title** (string) - Guest's title
- **company** (string) - Guest's company
- **date_of_birth** (string) - Guest's date of birth
- **email** (string) - Guest's email address
- **mobile_phone** (string) - Guest's mobile phone number
- **address** (object) - Guest's address details
  - **address1** (string)
  - **address2** (string)
  - **city** (string)
  - **zip** (string)
  - **country** (object)
    - **name** (string)
    - **code** (string)
  - **state** (object)
    - **name** (string)
    - **code** (string)
  - **phone** (string)
  - **fax** (string)
  - **work_phone** (string)
  - **work_phone_ext** (string)
- **status** (object) - Guest's status details
  - **id** (integer)
  - **name** (string)
  - **description** (string)
  - **is_blocklist** (boolean)
  - **is_vip** (boolean)
- **num_stays** (integer) - Number of stays associated with the guest
- **last_stay_date** (string) - Date of the guest's last stay

#### Response Example
```json
{
  "id": 0,
  "type": "Guest",
  "first_name": "string",
  "last_name": "string",
  "full_name": "string",
  "title": "DR",
  "company": "string",
  "date_of_birth": "string",
  "email": "string",
  "mobile_phone": "string",
  "address": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "zip": "string",
    "country": {
      "name": "string",
      "code": "st"
    },
    "state": {
      "name": "string",
      "code": "stri"
    },
    "phone": "string",
    "fax": "string",
    "work_phone": "string",
    "work_phone_ext": "strin"
  },
  "status": {
    "id": 0,
    "name": "string",
    "description": "string",
    "is_blocklist": true,
    "is_vip": true
  },
  "num_stays": 0,
  "last_stay_date": "2019-08-24"
}
```
```

--------------------------------

### Error Response Schema Example

Source: https://www.lodgix.com/public-api/v2/documentation/index

Provides an example of the JSON structure for API error responses. Errors include a 'message', an error 'code', and optionally a 'field' if the error is specific to an input field.

```json
{
    "errors": [
        {
            "message": "Delete or cancel all reservations first.",
            "code": "invalid"
        },
        {
            "message": "Ensure this field has no more than 21 characters.",
            "code": "max_length",
            "field": "address.work_phone"
        },
        {
            "message": "This email already exists",
            "code": "unique",
            "field": "login_email"
        }
    ]
}
```

--------------------------------

### POST /public-api/v2/reservations/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Creates a new reservation.

```APIDOC
## POST /public-api/v2/reservations/

### Description
Creates a new reservation.

### Method
POST

### Endpoint
/public-api/v2/reservations/

### Parameters
#### Request Body
- **from_date** (string) - Required - Beginning of the date range.
- **to_date** (string) - Required - Reservation to date.
- **adults** (integer) - Required - Number of adults for the reservation (>= 1).
- **children** (integer) - Optional - Number of children for the reservation (>= 0).
- **pets** (integer) - Optional - Number of pets for the reservation (>= 0).
- **guest_id** (integer) - Required - Reservation guest ID.
- **stay_type** (string) - Optional - Stay Type. Enum: "GUEST", "OWNER".
- **entities** (array) - Required - Array of objects representing reservation entities.
  - **property_id** (integer) - Required - ID of the property.
  - **room_ids** (array) - Required - Array of room IDs.

### Request Example
```json
{
  "from_date": "2019-08-24",
  "to_date": "2019-08-24",
  "adults": 1,
  "children": 0,
  "pets": 0,
  "guest_id": 0,
  "stay_type": "GUEST",
  "entities": [
    {
      "property_id": 0,
      "room_ids": [
        0
      ]
    }
  ]
}
```

### Response
#### Success Response (201)
- The response will be empty upon successful creation.
```

--------------------------------

### GET /public-api/v2/owners/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Retrieves a list of all owners, with options for pagination.

```APIDOC
## GET /public-api/v2/owners/

### Description
Retrieves a list of all owners. Supports pagination to control the number of results returned.

### Method
GET

### Endpoint
/public-api/v2/owners/

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of results to return per page.
- **offset** (integer) - Optional - The initial index from which to return the results.

### Request Example
```
GET /public-api/v2/owners/?limit=10&offset=0
```

### Response
#### Success Response (200)
- **count** (integer) - The total number of owners.
- **next** (string) - URL for the next page of results.
- **previous** (string) - URL for the previous page of results.
- **results** (array) - An array of owner objects.
  - **id** (integer) - The unique identifier for the owner.
  - **first_name** (string) - The owner's first name.
  - **last_name** (string) - The owner's last name.
  - **login_email** (string) - The owner's login email.
  - **contact_email** (string) - The owner's contact email.
  - **title** (string) - The owner's title (e.g., DR).
  - **address** (object) - The owner's address details.
    - **address1** (string)
    - **address2** (string)
    - **city** (string)
    - **zip** (string)
    - **country** (object)
      - **name** (string)
      - **code** (string)
    - **state** (object)
      - **name** (string)
      - **code** (string)
    - **phone** (string)
    - **fax** (string)
    - **work_phone** (string)
    - **work_phone_ext** (string)
  - **is_active** (boolean) - Indicates if the owner is active.
  - **properties** (array) - An array of properties associated with the owner.
    - **id** (integer)
    - **rental_property_id** (string)
    - **name** (string)
    - **commission** (string)

#### Response Example
```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "first_name": "string",
      "last_name": "string",
      "login_email": "user@example.com",
      "contact_email": "user@example.com",
      "title": "DR",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "zip": "string",
        "country": {
          "name": "string",
          "code": "st"
        },
        "state": {
          "name": "string",
          "code": "stri"
        },
        "phone": "string",
        "fax": "string",
        "work_phone": "string",
        "work_phone_ext": "strin"
      },
      "is_active": true,
      "properties": [
        {
          "id": 0,
          "rental_property_id": "string",
          "name": "string",
          "commission": "string"
        }
      ]
    }
  ]
}
```
```

--------------------------------

### POST /public-api/v2/deposit-templates/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Creates a new deposit template.

```APIDOC
## POST /public-api/v2/deposit-templates/

### Description
Creates a new deposit template.

### Method
POST

### Endpoint
/public-api/v2/deposit-templates/

### Parameters
#### Request Body
- **title** (string) - Required - Deposit template title (<= 255 characters).
- **value** (string) - Required - Deposit template value (decimal places <= 2, range: -10000000000000000 to 10000000000000000).
- **pre_auth** (boolean) - Optional - Deposit template pre-auth setting.

### Request Example
```json
{
  "title": "string",
  "value": "string",
  "pre_auth": true
}
```

### Response
#### Success Response (201)
- **id** (integer) - The ID of the newly created deposit template.
- **title** (string) - The title of the deposit template.
- **value** (string) - The value of the deposit template.
- **pre_auth** (boolean) - Indicates if pre-authorization is enabled.

#### Response Example
```json
{
  "id": 0,
  "title": "string",
  "value": "string",
  "pre_auth": true
}
```
```

--------------------------------

### GET /public-api/v2/guest-statuses/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Lists all guest statuses with optional pagination.

```APIDOC
## GET /public-api/v2/guest-statuses/

### Description
Lists all guest statuses with optional pagination.

### Method
GET

### Endpoint
/public-api/v2/guest-statuses/

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The number of results to return per page.
- **offset** (integer) - Optional - The initial index from which to return the results.

### Response
#### Success Response (200)
- **count** (integer) - The total number of guest statuses.
- **next** (string) - URL for the next page of results.
- **previous** (string) - URL for the previous page of results.
- **results** (array) - A list of guest status objects.
  - **id** (integer) - The guest status ID.
  - **name** (string) - The name of the guest status.
  - **description** (string) - The description of the guest status.
  - **is_blocklist** (boolean) - Indicates if the status is on the blocklist.
  - **is_vip** (boolean) - Indicates if the status is VIP.

### Response Example
```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "is_blocklist": true,
      "is_vip": true
    }
  ]
}
```
```

--------------------------------

### List Rental Expenses Response Sample

Source: https://www.lodgix.com/public-api/v2/documentation/index

A sample JSON response for listing rental expenses, including count, pagination links, and an array of expense results.

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "amount": "string",
      "description": "string"
    }
  ]
}
```

--------------------------------

### Create Review (POST)

Source: https://www.lodgix.com/public-api/v2/documentation/index

Creates a new review for a property. Requires the property's primary key. Accepts a JSON payload including name, title, description, and stars. Optionally, a language can be provided.

```json
{
  "name": "string",
  "title": "string",
  "description": "string",
  "stars": -2147483648,
  "language": "string"
}
```

--------------------------------

### GET /public-api/v2/tax-templates/{id}/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Retrieves a specific tax template by its ID.

```APIDOC
## GET /public-api/v2/tax-templates/{id}/

### Description
Retrieves a specific tax template by its ID.

### Method
GET

### Endpoint
/public-api/v2/tax-templates/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the tax template to retrieve.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the tax template.
- **title** (string) - The title of the tax template.
- **type** (string) - The type of the tax template.
- **value** (string) - The value of the tax template.
- **is_flat** (boolean) - Whether the value is flat.
- **is_advanced** (boolean) - Whether the tax template is advanced.
- **advanced_value** (string) - The advanced value of the tax template.
- **advanced_nights** (integer) - The number of nights for the advanced tax calculation.
- **frequency** (string) - The frequency of the tax.
```

--------------------------------

### POST /public-api/v2/guests/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Creates a new guest record in the Lodgix system. Requires essential guest details such as first name, last name, title, and email.

```APIDOC
## POST /public-api/v2/guests/

### Description
Creates a new guest record in the Lodgix system. Requires essential guest details such as first name, last name, title, and email.

### Method
POST

### Endpoint
/public-api/v2/guests/

### Parameters
#### Request Body
- **first_name** (string) - Required - Guest first name (max 64 characters)
- **last_name** (string) - Required - Guest last name (max 64 characters)
- **title** (string) - Required - Guest title (e.g., DR, MISS, MISSIS, MISTER, MRMRS)
- **company** (string or null) - Optional - Guest company (max 96 characters)
- **email** (string) - Required - Guest email (must be a valid email format)
- **address** (object or null) - Optional - Guest address details
  - **address1** (string) - Optional
  - **address2** (string) - Optional
  - **city** (string) - Optional
  - **zip** (string) - Optional
  - **country** (string) - Optional
  - **state** (string) - Optional
  - **phone** (string) - Optional
  - **fax** (string) - Optional
  - **work_phone** (string) - Optional
  - **work_phone_ext** (string) - Optional
- **status_id** (integer or null) - Optional - Unique guest status identifier

### Request Example
```json
{
  "first_name": "string",
  "last_name": "string",
  "title": "string",
  "company": "string",
  "email": "user@example.com",
  "address": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "zip": "string",
    "country": "string",
    "state": "string",
    "phone": "string",
    "fax": "string",
    "work_phone": "string",
    "work_phone_ext": "strin"
  },
  "status_id": 0
}
```

### Response
#### Success Response (201)
- **id** (integer) - Unique identifier for the created guest
- **type** (string) - Type of the record (e.g., Guest)
- **first_name** (string) - Guest's first name
- **last_name** (string) - Guest's last name
- **full_name** (string) - Guest's full name
- **title** (string) - Guest's title
- **company** (string) - Guest's company
- **date_of_birth** (string) - Guest's date of birth
- **email** (string) - Guest's email address
- **mobile_phone** (string) - Guest's mobile phone number
- **address** (object) - Guest's address details
  - **address1** (string)
  - **address2** (string)
  - **city** (string)
  - **zip** (string)
  - **country** (object)
    - **name** (string)
    - **code** (string)
  - **state** (object)
    - **name** (string)
    - **code** (string)
  - **phone** (string)
  - **fax** (string)
  - **work_phone** (string)
  - **work_phone_ext** (string)
- **status** (object)
  - **id** (integer)
  - **name** (string)
  - **description** (string)
  - **is_blocklist** (boolean)
  - **is_vip** (boolean)
- **num_stays** (integer) - Number of stays recorded for the guest
- **last_stay_date** (string) - Date of the guest's last stay

#### Response Example (201)
```json
{
  "id": 0,
  "type": "Guest",
  "first_name": "string",
  "last_name": "string",
  "full_name": "string",
  "title": "DR",
  "company": "string",
  "date_of_birth": "string",
  "email": "string",
  "mobile_phone": "string",
  "address": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "zip": "string",
    "country": {
      "name": "string",
      "code": "st"
    },
    "state": {
      "name": "string",
      "code": "stri"
    },
    "phone": "string",
    "fax": "string",
    "work_phone": "string",
    "work_phone_ext": "strin"
  },
  "status": {
    "id": 0,
    "name": "string",
    "description": "string",
    "is_blocklist": true,
    "is_vip": true
  },
  "num_stays": 0,
  "last_stay_date": "2019-08-24"
}
```
```

--------------------------------

### Lodgix API v2 Property Payload Example (JSON)

Source: https://www.lodgix.com/public-api/v2/documentation/index

This JSON payload represents a sample request for creating or updating a property listing in the Lodgix Public API v2. It includes comprehensive details about the property, address, location specifics, rate and rule settings, and owner information. This structure is essential for accurately submitting property data.

```JSON
{
  "name": "string",
  "description": "string",
  "property_type": "string",
  "marketing_title": "string",
  "marketing_info": "string",
  "address": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "zip": "string",
    "country": "string",
    "state": "string",
    "phone": "string",
    "fax": "string",
    "work_phone": "string",
    "work_phone_ext": "strin"
  },
  "area": 0,
  "locations": {
    "car": 0,
    "show_exact_location": true,
    "nearest_airport": "string",
    "nearest_airport_distance": "string",
    "nearest_airport_distance_unit": "MILES",
    "nearest_beach": "string",
    "nearest_beach_distance": "string",
    "nearest_beach_distance_unit": "MILES",
    "nearest_ferry": "string",
    "nearest_ferry_distance": "string",
    "nearest_ferry_distance_unit": "MILES",
    "nearest_train": "string",
    "nearest_train_distance": "string",
    "nearest_train_distance_unit": "MILES",
    "nearest_highway": "string",
    "nearest_highway_distance": "string",
    "nearest_highway_distance_unit": "MILES",
    "nearest_bar": "string",
    "nearest_bar_distance": "string",
    "nearest_bar_distance_unit": "MILES",
    "nearest_ski": "string",
    "nearest_ski_distance": "string",
    "nearest_ski_distance_unit": "MILES",
    "nearest_golf": "string",
    "nearest_golf_distance": "string",
    "nearest_golf_distance_unit": "MILES",
    "nearest_restaurant": "string",
    "nearest_restaurant_distance": "string",
    "nearest_restaurant_distance_unit": "MILES"
  },
  "rate_settings": {
    "use_weekly_rates": true,
    "use_monthly_rates": true,
    "use_per_person_rates": true,
    "use_children_rates": true,
    "require_guest_names": true,
    "require_guest_age": true,
    "require_guest_email": true,
    "prorate_partial_period": "PRORATE",
    "several_rates_available": "LOWER",
    "monthly_length_calculation": "RESERVATION_START_MONTH_LENGTH"
  },
  "rule_settings": {
    "arrival_day_rule_enabled": true,
    "departure_day_rule_enabled": true,
    "ignore_min_nights_rules_if_needed": true,
    "ignore_min_nights_threshold": 1,
    "ignore_arrival_rules_if_needed": true,
    "ignore_departure_rules_if_needed": true
  },
  "default_weekly_rate": "string",
  "default_monthly_rate": "string",
  "how_big_unit": "METERS_SQUARED",
  "how_big": -2147483648,
  "additional_info": "string",
  "check_in": "string",
  "check_out": "string",
  "city_registration_code": "string",
  "no_booking_widget": 0,
  "url": "http://example.com",
  "tags": "string",
  "wifi_details": {
    "name": "string",
    "password": "string"
  },
  "check_in_options": {
    "category": "string",
    "instruction": "string"
  },
  "max_guests": -2147483648,
  "bedrooms": -2147483648,
  "baths": 0,
  "owner_story": {
    "owner_listing_story": "string",
    "why_purchased": "string",
    "year_purchased": 1000
  }
}
```

--------------------------------

### GET /public-api/v2/properties/

Source: https://www.lodgix.com/public-api/v2/documentation/index

Retrieves a list of all properties with various filtering options.

```APIDOC
## GET /public-api/v2/properties/

### Description
Retrieves a list of all properties. Supports filtering by date, status, and WordPress site association.

### Method
GET

### Endpoint
/public-api/v2/properties/

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of results to return per page.
- **offset** (integer) - Optional - The initial index from which to return the results.
- **from_date** (string) - Optional - Property from date.
- **to_date** (string) - Optional - Property to date.
- **only_inn** (string) - Optional - Show only inn properties.
- **with_disabled** (string) - Optional - Show enabled and disabled properties.
- **wordpress_site** (string) - Optional - Wordpress site identifier.

### Request Example
```
GET /public-api/v2/properties/?limit=20&offset=0&wordpress_site=site123
```

### Response
#### Success Response (200)
- **count** (integer) - The total number of properties.
- **next** (string) - URL for the next page of results.
- **previous** (string) - URL for the previous page of results.
- **results** (array) - An array of property objects.
  - **id** (integer) - The unique identifier for the property.
  - **rental_property_id** (string) - The Lodgix rental property ID.
  - **name** (string) - The name of the property.
  - **commission** (string) - The commission rate for the property.

#### Response Example
```json
{
  "count": 123,
  "next": "http://api.example.org/properties/?offset=400&limit=100",
  "previous": "http://api.example.org/properties/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "rental_property_id": "string",
      "name": "string",
      "commission": "string"
    }
  ]
}
```
```
Tokens:
Raw