Warden API
  1. Booking Engine
Warden External API
  • Warden External API
  • Auth
    • Credential Refresh
      GET
  • Booking Engine
    • Get Property Listings
      GET
    • Get Bed Availability
      POST
    • Get Room Type Listings
      GET
    • Get Plan Options for Channel and Room Types
      POST
    • Generate Plan for Channel and Room Types
      POST
    • Create Booking
      PUT
  • API
    • Get Company Details
      GET
    • Get Channels
      GET
    • Get Bookings
      GET
    • Get Residents
      GET
    • Get Payments
      GET
    • Get Transactions
      GET
  1. Booking Engine

Create Booking

PUT
/api/v1/external-app/create-booking
Last modified:2026-05-03 12:39:06
Creates a booking for a resident in Warden. This is the final step in the booking flow, after you have confirmed bed availability, selected a payment plan, and generated the payment schedule.
Important: The plan and planMeta fields in the request body should be passed directly from the response of Generate Plan for Channel and Room Types. Do not construct these manually.

Booking Flow Summary#

1.
Get Property Listings → get propertyId
2.
Get Room Type Listings → get roomTypeId
3.
Get Channels → get channelId
4.
Get Bed Availability → confirm vacancy for your date range
5.
Get Plan Options → get available payment plans
6.
Generate Plan → generate the payment schedule
7.
Create Booking → submit the booking ✅

Request Body#

FieldTypeRequiredDescription
propertyIdnumberYesThe ID of the property
channelIdnumberYesThe channel ID
startDateTimedatetimeYesMove-in date and time (ISO 8601 with timezone)
endDateTimedatetimeYesMove-out date and time (ISO 8601 with timezone)
occupantCountobjectYesSpecifies the number of people and beds in the booking (see below)
userobjectYesDetails of the booking's point of contact / resident (see below)
bedRequestsarrayYesSame bed request array used in the preceding plan generation steps
planarrayYesThe full plan array from the Generate Plan response
planMetaobjectYesThe full planMeta object from the Generate Plan response
bookingWorkflowConfigobjectNoOptional config to control booking behaviour (see below)

occupantCount Object#

Specifies how many people and how many beds this booking is for.
FieldTypeRequiredDescription
adultsnumberYesNumber of adult occupants in the booking
bedsnumberYesNumber of beds being booked

user Object#

The point of contact (POC) for the booking. This is the person the booking is registered under.
FieldTypeRequiredDescription
namestringYesFull name of the POC
emailstringYesEmail address of the POC
phonestringYesPhone number in international format (e.g. +911234567890)

bedRequests Object#

FieldTypeRequiredDescription
roomTypeIdnumberYesThe ID of the room type
roomTypeRateIdnumberYesThe ID of the rate applied
bedCountnumberYesNumber of beds being booked

bookingWorkflowConfig Object#

Controls how the booking is classified and processed.
FieldTypeRequiredDescription
isPocResidentbooleanNoWhen true, assumes the POC (user) is the sole resident in the booking. This simplifies the flow by treating it as a single-person booking. When not passed or set to false, the booking is treated as a group booking, where the POC may or may not be one of the residents and additional residents must be associated separately
Recommendation: For most standard single-resident bookings, pass { "isPocResident": true } to avoid the overhead of the group booking flow.

What's Returned#

A successful response returns a booking object containing:
FieldDescription
idThe unique booking ID — use this to retrieve the booking via Get Bookings
statusInitial booking status (e.g. Pending)
displayStatusHuman-readable status label
propertyNameName of the property
channelNameName of the channel used
startDateTime / endDateTimeConfirmed tenancy dates
occupantCountThe adults and beds count as submitted
occupanciesAssigned bed(s), including roomName, bedName, roomTypeName, and occupancy dates
userThe resident's profile created or matched in Warden
planMetaThe finalised payment plan details
autoDiscardDateTimeThe deadline by which payment must be made, otherwise the booking is automatically discarded
autoDiscardDataDetails about the auto-discard policy including the stage, reason, and expiry window

Authentication#

This endpoint requires a valid Bearer Token in the Authorization header. Obtain one via the Credential Refresh endpoint.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params application/json

Examples

Responses

🟢200
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://server.wardenera.com/api/v1/external-app/create-booking' \
--header 'User-Agent: insomnia/11.4.0' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "occupantCount": {
    "adults": 1,
    "beds": 1
  }, 
  "bookingWorkflowConfig" : {
    "isPocResident": true
  },
  "user": {
    "name": "Test User",
    "email": "test.user@wardenera.com",
    "phone": "+911111990028"
  },
  "propertyId": 412,
  "channelId": 32,
  "bedRequests": [
    {
      "roomTypeId": 1385,
      "roomTypeRateId": 1419,
      "bedCount": 1
    },
  ],
  "plan": [
    {
      "taxableAmount": 55424.1,
      "deductedTaxAmount": 0,
      "payableAmount": 56075,
      "grossPayableAmount": 56075,
      "baseAmount": 55424.1,
      "taxAmount": 650.9,
      "discount": 0,
      "totalAmount": 56075,
      "entry": "Plan Generator",
      "type": "Rent Collection",
      "category": "Initial Payment",
      "billingDate": "2026-05-03T13:47:36+05:30",
      "dueDate": "2026-05-10T13:47:36+05:30",
      "paymentItems": [
        {
          "id": 0,
          "paymentId": 0,
          "chartOfAccountId": 1376,
          "companyId": 0,
          "description": "Security deposit",
          "inputAmount": 50000,
          "discount": 0,
          "isSettled": false,
          "originalTimezone": "Asia/Kolkata",
          "isDeleted": false,
          "createdById": 0,
          "updatedById": 0,
          "createdAt": "2026-05-03T13:47:36+05:30",
          "updatedAt": "2026-05-03T13:47:36+05:30",
          "taxableAmount": 50000,
          "baseAmount": 50000,
          "taxAmount": 0,
          "computedTaxAmount": 0,
          "exemptedTaxAmount": 0,
          "deductedTaxAmount": 0,
          "payableAmount": 50000,
          "grossPayableAmount": 50000,
          "taxesUsed": [],
          "label": "Security Deposit",
          "SACCode": "",
          "chartOfAccount": {
            "id": 1376,
            "name": "Security Deposit",
            "type": "Security",
            "description": "",
            "SACCode": "",
            "companyId": 11,
            "taxId": null,
            "beneficiaryId": null,
            "advanceCOAId": null,
            "provisionalCOAId": 1377,
            "taxDeductionId": null,
            "isDeleted": false,
            "isArchived": false,
            "createdById": 8091,
            "updatedById": 8091,
            "createdAt": "2025-06-09T18:11:52+05:30",
            "updatedAt": "2025-06-09T18:11:52+05:30",
            "taxConnections": [],
            "taxExemptionConnections": [],
            "taxDeductionConnections": [],
            "taxIds": [],
            "taxes": [],
            "applicableTaxExemptionIds": [],
            "applicableTaxExemptions": [],
            "applicableTaxDeductionIds": [],
            "applicableTaxDeductions": [],
            "classType": "Liability"
          }
        },
        {
          "id": 0,
          "paymentId": 0,
          "chartOfAccountId": 1378,
          "companyId": 0,
          "description": "Rent for the month of Jul 2026",
          "inputAmount": 6075,
          "discount": 0,
          "isSettled": false,
          "originalTimezone": "Asia/Kolkata",
          "isDeleted": false,
          "createdById": 0,
          "updatedById": 0,
          "createdAt": "2026-05-03T13:47:36+05:30",
          "updatedAt": "2026-05-03T13:47:36+05:30",
          "taxableAmount": 5424.1,
          "baseAmount": 5424.1,
          "taxAmount": 650.9,
          "computedTaxAmount": 650.9,
          "exemptedTaxAmount": 0,
          "deductedTaxAmount": 0,
          "payableAmount": 6075,
          "grossPayableAmount": 6075,
          "taxesUsed": [
            {
              "taxId": 60,
              "taxType": "Inclusive",
              "paymentItemId": 0,
              "computedAmount": 325.45,
              "exemptedAmount": 0,
              "amount": 325.45,
              "tax": {
                "id": 60,
                "type": "Inclusive",
                "name": "SGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              },
              "createdAt": "2026-05-03T13:47:36+05:30",
              "updatedAt": "2026-05-03T13:47:36+05:30"
            },
            {
              "taxId": 61,
              "taxType": "Inclusive",
              "paymentItemId": 0,
              "computedAmount": 325.45,
              "exemptedAmount": 0,
              "amount": 325.45,
              "tax": {
                "id": 61,
                "type": "Inclusive",
                "name": "CGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              },
              "createdAt": "2026-05-03T13:47:36+05:30",
              "updatedAt": "2026-05-03T13:47:36+05:30"
            }
          ],
          "label": "Rent",
          "SACCode": "",
          "chartOfAccount": {
            "id": 1378,
            "name": "Rent",
            "type": "Income",
            "description": "",
            "SACCode": "",
            "companyId": 11,
            "taxId": null,
            "beneficiaryId": null,
            "advanceCOAId": 1380,
            "provisionalCOAId": 1379,
            "taxDeductionId": null,
            "isDeleted": false,
            "isArchived": false,
            "createdById": 8091,
            "updatedById": 8091,
            "createdAt": "2025-06-09T18:13:04+05:30",
            "updatedAt": "2025-06-09T18:13:04+05:30",
            "taxConnections": [
              {
                "taxId": 60,
                "chartOfAccountId": 1378,
                "tax": {
                  "id": 60,
                  "type": "Inclusive",
                  "name": "SGST",
                  "percentage": 6,
                  "validFrom": null,
                  "validTo": null,
                  "companyId": 11,
                  "createdById": 13581,
                  "updatedById": 13581,
                  "isDeleted": false,
                  "createdAt": "2024-05-20T03:06:41+05:30",
                  "updatedAt": "2024-05-20T03:06:41+05:30"
                }
              },
              {
                "taxId": 61,
                "chartOfAccountId": 1378,
                "tax": {
                  "id": 61,
                  "type": "Inclusive",
                  "name": "CGST",
                  "percentage": 6,
                  "validFrom": null,
                  "validTo": null,
                  "companyId": 11,
                  "createdById": 13581,
                  "updatedById": 13581,
                  "isDeleted": false,
                  "createdAt": "2024-05-20T03:06:41+05:30",
                  "updatedAt": "2024-05-20T03:06:41+05:30"
                }
              }
            ],
            "taxExemptionConnections": [],
            "taxDeductionConnections": [],
            "taxIds": [
              60,
              61
            ],
            "taxes": [
              {
                "id": 60,
                "type": "Inclusive",
                "name": "SGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              },
              {
                "id": 61,
                "type": "Inclusive",
                "name": "CGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              }
            ],
            "applicableTaxExemptionIds": [],
            "applicableTaxExemptions": [],
            "applicableTaxDeductionIds": [],
            "applicableTaxDeductions": [],
            "classType": "Revenue"
          }
        }
      ]
    },
    {
      "taxableAmount": 12053.58,
      "deductedTaxAmount": 0,
      "payableAmount": 13500,
      "grossPayableAmount": 13500,
      "baseAmount": 12053.58,
      "taxAmount": 1446.42,
      "discount": 0,
      "totalAmount": 13500,
      "entry": "Plan Generator",
      "type": "Rent Collection",
      "category": "Rent",
      "billingDate": "2026-08-01T00:00:00+05:30",
      "dueDate": "2026-08-08T00:00:00+05:30",
      "paymentItems": [
        {
          "id": 0,
          "paymentId": 0,
          "chartOfAccountId": 1378,
          "companyId": 0,
          "description": "Rent for the month of Aug 2026",
          "inputAmount": 13500,
          "discount": 0,
          "isSettled": false,
          "originalTimezone": "Asia/Kolkata",
          "isDeleted": false,
          "createdById": 0,
          "updatedById": 0,
          "createdAt": "2026-05-03T13:47:36+05:30",
          "updatedAt": "2026-05-03T13:47:36+05:30",
          "taxableAmount": 12053.58,
          "baseAmount": 12053.58,
          "taxAmount": 1446.42,
          "computedTaxAmount": 1446.42,
          "exemptedTaxAmount": 0,
          "deductedTaxAmount": 0,
          "payableAmount": 13500,
          "grossPayableAmount": 13500,
          "taxesUsed": [
            {
              "taxId": 60,
              "taxType": "Inclusive",
              "paymentItemId": 0,
              "computedAmount": 723.21,
              "exemptedAmount": 0,
              "amount": 723.21,
              "tax": {
                "id": 60,
                "type": "Inclusive",
                "name": "SGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              },
              "createdAt": "2026-05-03T13:47:36+05:30",
              "updatedAt": "2026-05-03T13:47:36+05:30"
            },
            {
              "taxId": 61,
              "taxType": "Inclusive",
              "paymentItemId": 0,
              "computedAmount": 723.21,
              "exemptedAmount": 0,
              "amount": 723.21,
              "tax": {
                "id": 61,
                "type": "Inclusive",
                "name": "CGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              },
              "createdAt": "2026-05-03T13:47:36+05:30",
              "updatedAt": "2026-05-03T13:47:36+05:30"
            }
          ],
          "label": "Rent",
          "SACCode": "",
          "chartOfAccount": {
            "id": 1378,
            "name": "Rent",
            "type": "Income",
            "description": "",
            "SACCode": "",
            "companyId": 11,
            "taxId": null,
            "beneficiaryId": null,
            "advanceCOAId": 1380,
            "provisionalCOAId": 1379,
            "taxDeductionId": null,
            "isDeleted": false,
            "isArchived": false,
            "createdById": 8091,
            "updatedById": 8091,
            "createdAt": "2025-06-09T18:13:04+05:30",
            "updatedAt": "2025-06-09T18:13:04+05:30",
            "taxConnections": [
              {
                "taxId": 60,
                "chartOfAccountId": 1378,
                "tax": {
                  "id": 60,
                  "type": "Inclusive",
                  "name": "SGST",
                  "percentage": 6,
                  "validFrom": null,
                  "validTo": null,
                  "companyId": 11,
                  "createdById": 13581,
                  "updatedById": 13581,
                  "isDeleted": false,
                  "createdAt": "2024-05-20T03:06:41+05:30",
                  "updatedAt": "2024-05-20T03:06:41+05:30"
                }
              },
              {
                "taxId": 61,
                "chartOfAccountId": 1378,
                "tax": {
                  "id": 61,
                  "type": "Inclusive",
                  "name": "CGST",
                  "percentage": 6,
                  "validFrom": null,
                  "validTo": null,
                  "companyId": 11,
                  "createdById": 13581,
                  "updatedById": 13581,
                  "isDeleted": false,
                  "createdAt": "2024-05-20T03:06:41+05:30",
                  "updatedAt": "2024-05-20T03:06:41+05:30"
                }
              }
            ],
            "taxExemptionConnections": [],
            "taxDeductionConnections": [],
            "taxIds": [
              60,
              61
            ],
            "taxes": [
              {
                "id": 60,
                "type": "Inclusive",
                "name": "SGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              },
              {
                "id": 61,
                "type": "Inclusive",
                "name": "CGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              }
            ],
            "applicableTaxExemptionIds": [],
            "applicableTaxExemptions": [],
            "applicableTaxDeductionIds": [],
            "applicableTaxDeductions": [],
            "classType": "Revenue"
          }
        }
      ]
    },
    {
      "taxableAmount": 7232.14,
      "deductedTaxAmount": 0,
      "payableAmount": 8100,
      "grossPayableAmount": 8100,
      "baseAmount": 7232.14,
      "taxAmount": 867.86,
      "discount": 0,
      "totalAmount": 8100,
      "entry": "Plan Generator",
      "type": "Rent Collection",
      "category": "Rent",
      "billingDate": "2026-09-01T00:00:00+05:30",
      "dueDate": "2026-09-08T00:00:00+05:30",
      "paymentItems": [
        {
          "id": 0,
          "paymentId": 0,
          "chartOfAccountId": 1378,
          "companyId": 0,
          "description": "Rent for the month of Sep 2026",
          "inputAmount": 8100,
          "discount": 0,
          "isSettled": false,
          "originalTimezone": "Asia/Kolkata",
          "isDeleted": false,
          "createdById": 0,
          "updatedById": 0,
          "createdAt": "2026-05-03T13:47:36+05:30",
          "updatedAt": "2026-05-03T13:47:36+05:30",
          "taxableAmount": 7232.14,
          "baseAmount": 7232.14,
          "taxAmount": 867.86,
          "computedTaxAmount": 867.86,
          "exemptedTaxAmount": 0,
          "deductedTaxAmount": 0,
          "payableAmount": 8100,
          "grossPayableAmount": 8100,
          "taxesUsed": [
            {
              "taxId": 60,
              "taxType": "Inclusive",
              "paymentItemId": 0,
              "computedAmount": 433.93,
              "exemptedAmount": 0,
              "amount": 433.93,
              "tax": {
                "id": 60,
                "type": "Inclusive",
                "name": "SGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              },
              "createdAt": "2026-05-03T13:47:36+05:30",
              "updatedAt": "2026-05-03T13:47:36+05:30"
            },
            {
              "taxId": 61,
              "taxType": "Inclusive",
              "paymentItemId": 0,
              "computedAmount": 433.93,
              "exemptedAmount": 0,
              "amount": 433.93,
              "tax": {
                "id": 61,
                "type": "Inclusive",
                "name": "CGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              },
              "createdAt": "2026-05-03T13:47:36+05:30",
              "updatedAt": "2026-05-03T13:47:36+05:30"
            }
          ],
          "label": "Rent",
          "SACCode": "",
          "chartOfAccount": {
            "id": 1378,
            "name": "Rent",
            "type": "Income",
            "description": "",
            "SACCode": "",
            "companyId": 11,
            "taxId": null,
            "beneficiaryId": null,
            "advanceCOAId": 1380,
            "provisionalCOAId": 1379,
            "taxDeductionId": null,
            "isDeleted": false,
            "isArchived": false,
            "createdById": 8091,
            "updatedById": 8091,
            "createdAt": "2025-06-09T18:13:04+05:30",
            "updatedAt": "2025-06-09T18:13:04+05:30",
            "taxConnections": [
              {
                "taxId": 60,
                "chartOfAccountId": 1378,
                "tax": {
                  "id": 60,
                  "type": "Inclusive",
                  "name": "SGST",
                  "percentage": 6,
                  "validFrom": null,
                  "validTo": null,
                  "companyId": 11,
                  "createdById": 13581,
                  "updatedById": 13581,
                  "isDeleted": false,
                  "createdAt": "2024-05-20T03:06:41+05:30",
                  "updatedAt": "2024-05-20T03:06:41+05:30"
                }
              },
              {
                "taxId": 61,
                "chartOfAccountId": 1378,
                "tax": {
                  "id": 61,
                  "type": "Inclusive",
                  "name": "CGST",
                  "percentage": 6,
                  "validFrom": null,
                  "validTo": null,
                  "companyId": 11,
                  "createdById": 13581,
                  "updatedById": 13581,
                  "isDeleted": false,
                  "createdAt": "2024-05-20T03:06:41+05:30",
                  "updatedAt": "2024-05-20T03:06:41+05:30"
                }
              }
            ],
            "taxExemptionConnections": [],
            "taxDeductionConnections": [],
            "taxIds": [
              60,
              61
            ],
            "taxes": [
              {
                "id": 60,
                "type": "Inclusive",
                "name": "SGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              },
              {
                "id": 61,
                "type": "Inclusive",
                "name": "CGST",
                "percentage": 6,
                "validFrom": null,
                "validTo": null,
                "companyId": 11,
                "isDeleted": false,
                "createdById": 13581,
                "updatedById": 13581,
                "createdAt": "2024-05-20T03:06:41+05:30",
                "updatedAt": "2024-05-20T03:06:41+05:30"
              }
            ],
            "applicableTaxExemptionIds": [],
            "applicableTaxExemptions": [],
            "applicableTaxDeductionIds": [],
            "applicableTaxDeductions": [],
            "classType": "Revenue"
          }
        }
      ]
    }
  ],
  "planMeta": {
    "id": 0,
    "planType": "Fixed",
    "planInputs": {
      "reservationMode": "Full Booking",
      "reservation": 2500,
      "security": 50000,
      "rent": 13500
    },
    "displayPlanInputs": {
      "rent": 13500,
      "security": 50000,
      "reservation": 2500,
      "discount": 0,
      "bedCount": 1
    },
    "generatorMethod": {
      "label": "Booking Monthly Plan",
      "form": [
        {
          "name": "planInputs.reservationMode",
          "label": "Reservation Mode",
          "options": [
            {
              "label": "Reserve Now, Book Later",
              "value": "Reserve Now, Book Later"
            },
            {
              "label": "Full Booking",
              "value": "Full Booking"
            }
          ],
          "isHidden": false,
          "fieldType": "SingleSelect",
          "isProtected": false,
          "defaultValue": "Full Booking",
          "isDisplayValue": true,
          "isBookingEngineField": true
        },
        {
          "name": "planInputs.rent",
          "label": "Monthly Rent",
          "isHidden": false,
          "fieldType": "AmountInput",
          "isProtected": false,
          "isDisplayValue": true,
          "chartOfAccountId": 1378
        },
        {
          "name": "planInputs.security",
          "label": "Deposit Amount",
          "options": [],
          "isHidden": false,
          "fieldType": "AmountInput",
          "isProtected": false,
          "isDisplayValue": true,
          "chartOfAccountId": 1376
        },
        {
          "name": "planInputs.reservation",
          "label": "Reservation Amount",
          "options": [],
          "isHidden": false,
          "fieldType": "AmountInput",
          "isProtected": false,
          "isDisplayValue": true,
          "chartOfAccountId": 555
        },
        {
          "name": "planInputs.discount",
          "label": "Discount",
          "options": [],
          "isHidden": false,
          "fieldType": "DiscountInput",
          "isProtected": false,
          "defaultValue": 0,
          "isDisplayValue": true
        }
      ],
      "id": 12,
      "constraints": {
        "maxTermLengthDays": 199,
        "minTermLengthDays": 0
      },
      "contracts": {
        "Booking Folio": 85,
        "Rent Agreement": 48,
        "Resident Rent Agreement": 123
      },
      "name": "Booking Monthly Plan",
      "description": null,
      "status": "Active",
      "isDeleted": false,
      "companyId": 11,
      "customScriptConnections": [],
      "createdById": 8091,
      "updatedById": 8091,
      "createdAt": "2025-06-05T15:57:56+05:30",
      "updatedAt": "2026-02-18T18:51:02+05:30",
      "customScripts": [],
      "value": 12
    },
    "planMessage": {
      "title": "Monthly Plan",
      "description": "Payments are generated upfront, with pro rata calculation in the first and last months.",
      "priceString": "13,500/month"
    },
    "bookingId": 0,
    "createdById": 0,
    "updatedById": 0,
    "createdAt": "2026-05-03T13:47:35+05:30",
    "updatedAt": "2026-05-03T13:47:35+05:30",
    "planEndDate": "2026-09-18T15:40:41+05:30",
    "noticePeriodDays": 30
  },
  "startDateTime": "2026-07-18T15:40:41+05:30",
  "endDateTime": "2026-09-18T15:40:41+05:30",
  "termStartDate": "2026-07-18T15:40:41+05:30",
  "termEndDate": "2026-09-18T15:40:41+05:30",
  "noticePeriodDays": 30,
  "message": "Generated plan for external booking"
}'
Response Response Example
{
    "booking": {
        "id": 15911,
        "status": "Pending",
        "residentType": "Unknown",
        "source": "Website",
        "fileName": null,
        "companyId": 11,
        "propertyId": 412,
        "userId": 31973,
        "channelId": 32,
        "salesPersonPermissionId": 8091,
        "startDateTime": "2026-07-18T00:00:00+05:30",
        "extensionStartDateTime": null,
        "endDateTime": "2026-09-18T23:59:59+05:30",
        "occupantCount": {
            "adults": 1,
            "beds": 1
        },
        "onboardingData": {},
        "offboardingData": {},
        "data": null,
        "legal": null,
        "extensionHistory": [],
        "autoDiscardDateTime": "2026-07-21T00:00:00+05:30",
        "autoDiscardData": {
            "isManuallyUpdated": false,
            "stage": "Check-In Payment Pending",
            "isActive": true,
            "reason": "Auto-discard set for stage Check-In Payment Pending via Channel Warden Booking Engine (ID: 32) with 259200s (72h 0m) expiry",
            "expiryTimeLabel": "3 days"
        },
        "planMetaId": 14689,
        "isDeleted": false,
        "createdAt": "2026-05-03T17:50:08+05:30",
        "updatedAt": "2026-05-03T17:50:18+05:30",
        "createdById": 8091,
        "updatedById": 8091,
        "originalTimezone": "Asia/Kolkata",
        "isClosing": false,
        "rebookedFromId": null,
        "sessionId": null,
        "externalId": null,
        "externalData": null,
        "externalRawData": null,
        "bookingWorkflowConfig": {
            "isPocResident": true
        },
        "endingAlertDateTime": "2026-08-06T00:00:00+05:30",
        "isEndingSoon": false,
        "displayStatus": "Pending",
        "channelName": "Warden Booking Engine",
        "propertyName": "Warden House Koramangala",
        "session": null,
        "occupancies": [
            {
                "id": 131501,
                "companyId": 11,
                "startDateTime": "2026-07-18T00:00:00+05:30",
                "endDateTime": "2026-09-18T23:59:59+05:30",
                "status": "Assigned",
                "bedId": 22745,
                "roomId": 13329,
                "roomTypeId": 1385,
                "propertyId": 412,
                "roomTypeRateId": 1419,
                "note": null,
                "bookingId": 15911,
                "residentId": null,
                "leadId": null,
                "parentOccupancyId": null,
                "originalTimezone": "Asia/Kolkata",
                "fragmentedChildOccupancyId": null,
                "checkedInAt": null,
                "checkedOutAt": null,
                "isDeleted": false,
                "isAbandoned": false,
                "createdAt": "2026-05-03T17:50:11+05:30",
                "updatedAt": "2026-05-03T17:50:11+05:30",
                "createdById": 8091,
                "updatedById": 8091,
                "propertyName": "Warden House Koramangala",
                "roomTypeName": "Twin Sharing Room",
                "roomTypeBedCount": 2,
                "roomAllowedGenders": [],
                "roomName": "G03",
                "bedName": "A",
                "bookingStatus": "Pending",
                "allowedGenders": []
            }
        ],
        "roomTypesList": "Twin Sharing Room",
        "roomsList": "G03 - A",
        "user": {
            "phone": "+911111990028",
            "id": 31973,
            "isPhoneVerified": false,
            "isEmailVerified": false,
            "emailVerificationToken": null,
            "registerMethod": "PHONE",
            "name": "Test User",
            "email": "test.user@wardenera.com",
            "gender": null,
            "photos": [],
            "createdById": 2506,
            "createdAt": "2026-05-03T13:50:39+05:30",
            "updatedAt": "2026-05-03T13:50:39+05:30",
            "isTestAccount": false
        },
        "planMeta": {
            "id": 14689,
            "planType": "Fixed",
            "planEndDate": "2026-09-18T15:40:41+05:30",
            "planInputs": {
                "rent": 13500,
                "security": 50000,
                "reservation": 2500,
                "reservationMode": "Full Booking"
            },
            "displayPlanInputs": {
                "rent": 13500,
                "bedCount": 1,
                "discount": 0,
                "security": 50000,
                "reservation": 2500
            },
            "generatorMethod": {
                "label": "Booking Monthly Plan",
                "form": [
                    {
                        "name": "planInputs.reservationMode",
                        "label": "Reservation Mode",
                        "options": [
                            {
                                "label": "Reserve Now, Book Later",
                                "value": "Reserve Now, Book Later"
                            },
                            {
                                "label": "Full Booking",
                                "value": "Full Booking"
                            }
                        ],
                        "isHidden": false,
                        "fieldType": "SingleSelect",
                        "isProtected": false,
                        "defaultValue": "Full Booking",
                        "isDisplayValue": true,
                        "isBookingEngineField": true
                    },
                    {
                        "name": "planInputs.rent",
                        "label": "Monthly Rent",
                        "isHidden": false,
                        "fieldType": "AmountInput",
                        "isProtected": false,
                        "isDisplayValue": true,
                        "chartOfAccountId": 1378
                    },
                    {
                        "name": "planInputs.security",
                        "label": "Deposit Amount",
                        "options": [],
                        "isHidden": false,
                        "fieldType": "AmountInput",
                        "isProtected": false,
                        "isDisplayValue": true,
                        "chartOfAccountId": 1376
                    },
                    {
                        "name": "planInputs.reservation",
                        "label": "Reservation Amount",
                        "options": [],
                        "isHidden": false,
                        "fieldType": "AmountInput",
                        "isProtected": false,
                        "isDisplayValue": true,
                        "chartOfAccountId": 555
                    },
                    {
                        "name": "planInputs.discount",
                        "label": "Discount",
                        "options": [],
                        "isHidden": false,
                        "fieldType": "DiscountInput",
                        "isProtected": false,
                        "defaultValue": 0,
                        "isDisplayValue": true
                    }
                ],
                "id": 12,
                "name": "Booking Monthly Plan",
                "value": 12,
                "status": "Active",
                "companyId": 11,
                "contracts": {
                    "Booking Folio": 85,
                    "Rent Agreement": 48,
                    "Resident Rent Agreement": 123
                },
                "createdAt": "2025-06-05T15:57:56+05:30",
                "isDeleted": false,
                "updatedAt": "2026-02-18T18:51:02+05:30",
                "constraints": {
                    "maxTermLengthDays": 199,
                    "minTermLengthDays": 0
                },
                "createdById": 8091,
                "updatedById": 8091,
                "customScripts": [],
                "customScriptConnections": []
            },
            "noticePeriodDays": 30,
            "planMessage": {
                "title": "Monthly Plan",
                "description": "Payments are generated upfront, with pro rata calculation in the first and last months."
            },
            "bookingId": 15911,
            "createdById": 8091,
            "updatedById": 8091,
            "createdAt": "2026-05-03T17:50:05+05:30",
            "updatedAt": "2026-05-03T17:50:05+05:30"
        },
        "planEndDate": "2026-09-18T15:40:41+05:30",
        "planType": "Fixed",
        "userName": "Test User",
        "userPhone": "+911111990028",
        "userEmail": "test.user@wardenera.com",
        "userGender": null,
        "documents": [],
        "displayStartDateTime": "Jul 18, 2026",
        "displayEndDateTime": "Sep 18, 2026"
    },
    "message": "Created external booking"
}
Modified at 2026-05-03 12:39:06
Previous
Generate Plan for Channel and Room Types
Next
API
Built with