Automated bookings report

POST/v1/AutomatedBookingReport/GetAutomatedBookings
Scope: automatedbooking.read

Retrieve a paginated list of automated bookings.

Use this report to export or monitor bookings that were created through automated channels. Results can be filtered by status, booking type, booker details, and date ranges.

Request body

Parameters

pageNumberintegerOptional
Page number for pagination. Defaults to 1.
pageSizeintegerOptional
Page size for pagination. Defaults to 100.
statusinteger[]Optional
Filter to one or more booking status identifiers.
bookingTypesinteger[]Optional
Filter to one or more booking type identifiers.
currencyCodestringRequired
ISO 4217 currency code for monetary values in the report.
reservationIdintegerOptional
Filter to a specific reservation identifier.
bookerEmailstringOptional
Filter to bookings where the booker email contains this value.
bookerCompanystringOptional
Filter to bookings where the booker company contains this value.
bookerNamestringOptional
Filter to bookings where the booker name contains this value.
startDatedate-timeOptional
Filter reservations with a start date on or after this value.
endDatedate-timeOptional
Filter reservations with an end date on or before this value.
createdSincedate-timeOptional
Filter reservations created on or after this value.
createdUntildate-timeOptional
Filter reservations created on or before this value.
modifiedSincedate-timeOptional
Filter reservations modified on or after this value.
modifiedUntildate-timeOptional
Filter reservations modified on or before this value.
expand.reservationDaysbooleanOptional
Include reservation day details.
expand.reservationDayFoodDrinksbooleanOptional
Include food and drink details.
expand.reservationDayEquipmentsbooleanOptional
Include equipment details.
expand.vatratesbooleanOptional
Include VAT rate details.
expand.costCentersbooleanOptional
Include cost centre details.
expand.currenciesbooleanOptional
Include currency details.
expand.approverbooleanOptional
Include approver details.
expand.transactionsbooleanOptional
Include transaction details.

Response

Returns a paginated list of AutomatedReport objects.

The AutomatedReport object

reservationIdinteger

Unique reservation identifier.

companyIdinteger

Identifier of the company that owns the booking.

affiliateGroupIdinteger

Identifier of the affiliate group, if applicable.

statusstring

Current booking status name.

statusIdinteger

Current booking status identifier.

startDatedate-time

Start date and time of the booking.

endDatedate-time

End date and time of the booking.

recordCreateddate-time

When the booking was created.

recordModifieddate-time

When the booking was last modified.

attendeesinteger

Total number of attendees.

totalinteger

Total amount in cents.

netValueinteger

Net value in cents.

vatinteger

VAT amount in cents.

vatRatedecimal

VAT rate applied.

totalSavingsinteger

Total savings in cents.

commissioninteger

Commission amount in cents.

totalCommissioninteger

Total commission in cents.

exchangeRatedecimal

Exchange rate used for currency conversion.

bookingCurrencyISOCodestring

ISO 4217 currency code of the booking.

meetingNamestring

Name of the meeting.

bookingTypeIdinteger

Identifier of the booking type.

bookingTypeNamestring

Name of the booking type.

amountPaidinteger

Amount paid in cents.

amountRefundedinteger

Amount refunded in cents.

billingReferenceNumberstring

Billing reference number.

isCompanyPrefferredboolean

Whether the venue is preferred by the company.

isAffiliatePreferredboolean

Whether the venue is preferred by the affiliate.

dateCancelleddate-time

Date the booking was cancelled, if applicable.

acceptedDatedate-time

Date the booking was accepted.

Expandable collections

venueobject

Venue details. Included when venue data is expanded.

bookerobject

Booker details. Included when user details are expanded.

companyobject

Company details. Included when company details are expanded.

approverobject

Approver details. Requires expand.approver.

cancellationPolicyobject

Cancellation policy for the booking. Included when cancellation policy is expanded.

reservationDaysarray

Day-by-day breakdown of the booking. Requires expand.reservationDays.

transactionRequestarray

Payment transactions. Requires expand.transactions.

customFieldDatasarray

Custom field values. Requires expand.costCenters.

Pagination

pageNumberinteger

Current page number.

pageSizeinteger

Number of items per page.

totalCountinteger

Total number of matching entries.

Errors

StatusMeaning
400 Bad RequestValidation failed. Check the response for property-level errors.
401 UnauthorizedThe Bearer token is missing, expired, or lacks the required scope.
403 ForbiddenThe client is not permitted to view automated bookings.
Example request
curl -X POST https://dashboard.alpha.meetingsbooker.com/reportingapi/v1/AutomatedBookingReport/GetAutomatedBookings \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "currencyCode": "EUR",
    "status": [1, 2],
    "pageSize": 50
  }'
Example response
{
  "items": [
    {
      "reservationId": 98765,
      "companyId": 1001,
      "affiliateGroupId": 55,
      "status": "Confirmed",
      "statusId": 1,
      "startDate": "2025-06-01T09:00:00Z",
      "endDate": "2025-06-03T17:00:00Z",
      "recordCreated": "2025-01-10T11:00:00Z",
      "recordModified": "2025-01-15T14:30:00Z",
      "attendees": 24,
      "total": 50000,
      "netValue": 42000,
      "vat": 8000,
      "vatRate": 0.20,
      "totalSavings": 2000,
      "commission": 1000,
      "totalCommission": 1200,
      "exchangeRate": 1.0,
      "bookingCurrencyISOCode": "EUR",
      "meetingName": "Annual Conference",
      "bookingTypeId": 1,
      "bookingTypeName": "Meeting",
      "amountPaid": 50000,
      "amountRefunded": 0,
      "billingReferenceNumber": "INV-2025-98765",
      "isCompanyPrefferred": true,
      "isAffiliatePreferred": false,
      "dateCancelled": null,
      "acceptedDate": "2025-01-12T10:00:00Z",
      "venue": {
        "venueId": 42,
        "venueName": "Grand Hotel Dublin",
        "venueCountry": "Ireland",
        "venueCity": "Dublin",
        "venueAddress": "1 Merrion Square, Dublin 2",
        "latitude": 53.3389,
        "longitude": -6.2505,
        "folderText": "Dublin venues"
      },
      "booker": {
        "userId": 101,
        "name": "Alice Smith",
        "companyName": "Example Ltd",
        "email": "alice@example.com"
      },
      "company": {
        "companyId": 1001,
        "companyName": "Example Ltd",
        "costCentreName": "Marketing",
        "costCentreId": 10,
        "costCentreCode": "MKT-001",
        "departmentId": 5,
        "departmentName": "Events",
        "affiliateCorporateId": "CORP-001",
        "affiliateCompanyId": "AFF-001"
      },
      "approver": {
        "approverUserId": 201,
        "name": "Bob Jones",
        "email": "bob@example.com"
      },
      "cancellationPolicy": {
        "partialRefundExpires": null,
        "fullRefundExpires": "2025-05-25T23:59:59Z"
      },
      "reservationDays": [
        {
          "reservationDayId": 1001,
          "reservationDurationTypeId": 1,
          "reservationDurationType": "Full day",
          "reservationVersionId": 5001,
          "reservationDayDate": "2025-06-01T00:00:00Z",
          "reservationDayRooms": [
            {
              "reservationDayRoomId": 2001,
              "reservationDayId": 1001,
              "venueRoomId": 301,
              "venueRoomShapeId": 2,
              "venueRoomShape": "Theatre",
              "reservationVersionId": 5001,
              "attendees": 24,
              "venueRoomPrice": 15000,
              "venueRoomPriceExVat": 12500,
              "venueRoomVAT": 2500,
              "vatRate": 0.20,
              "venueRoom": {
                "venueRoomId": 301,
                "venueId": 42,
                "venueRoomName": "Wicklow Suite",
                "venueRoomImageUrl": "https://cdn.hubli.com/rooms/301.jpg"
              }
            }
          ],
          "reservationDayFoodDrinks": [
            {
              "reservationDayFoodDrinkId": 3001,
              "reservationDayId": 1001,
              "reservationVersionId": 5001,
              "venueFoodDrinkId": 401,
              "foodDrinkGroupId": 1,
              "foodDrinkGroup": "Lunch",
              "foodDrinkText": "Working lunch",
              "serveOnArrival": false,
              "quantity": 24,
              "foodDrinkPrice": 1200,
              "foodDrinkPriceExVat": 1000,
              "foodDrinkVAT": 200,
              "vatRate": 0.20,
              "pricePerPerson": 50,
              "pricePerPersonVAT": 10,
              "breakNumber": 1
            }
          ],
          "reservationDayEquipments": []
        }
      ],
      "transactionRequest": [
        {
          "transactionRequestId": 4001,
          "transactionDescription": "Deposit",
          "totalAmountInCents": 5000000,
          "transactionResultId": 1,
          "transactionResultText": "Success",
          "captured": true,
          "recordCreated": "2025-01-10T11:00:00Z",
          "recordModified": "2025-01-10T11:00:00Z",
          "transactionRefunds": []
        }
      ],
      "customFieldDatas": [
        {
          "id": 5001,
          "value": "CC-4412",
          "text": "CC-4412",
          "label": "Cost centre",
          "fieldName": "cost_centre",
          "typeId": 1,
          "typeName": "Text"
        }
      ]
    }
  ],
  "pageNumber": 1,
  "pageSize": 50,
  "totalCount": 1
}