Events: Get Allowed Catalogue Items Without Tree Structure

Updated June 14, 2023 16:13

Get Allowed Catalogue Items

POST /v2/event/get/allowedCatl

This API returns the list of catalogue items that are allowed to be added in an event. If the Event contains Venue Bookings, then Catalogue items associated to the corresponding Venues, as defined by Admin, are returned. If the Event does not contain any Venue Bookings, all the Catalogue items are returned.

Parameters

EventNumber Integer

The number of an Event for which allowed catalogue items are to be fetched.

CatalogueType String

Name of the Catalogue Type. The allowed values are 'Venues', 'VenueRates', 'Charges', 'PaymentRequest', 'PaymentReceived', 'Credits', 'Bonds', 'EventDetails', 'Food', 'Beverage', 'Inventory', 'Packages'.

TreeStructureResponse Boolean

If "true" then in response the groups are also considered as an item, else group will be considered as a group only.

JSON

{
   "EventNumber": 2508,
   "CatalogueType": "Food",
   "TreeStructureResponse": false
}

Response:

{
   "success": true,
   "result": [{
      "Position": 2,
      "Groups": [{
         "Position": 1,
         "Groups": [{
            "Position": 1,
            "Groups": [

            ],
            "Inactive": false,
            "Items": [{
               "FormulaToolTip": "",
               "Name": "seed sub sub item",
               "Formula": {

               },
               "TaxType": {
                  "Id": 100007009,
                  "Name": "adscd"
               },
               "UnitCost": 0,
               "UnitPrice": 0,
               "CatalogueType": "Food",
               "FinancialComments": "",
               "DiscountType": "$",
               "Qty": 1,
               "Id": 100238553,
               "DiscountValue": 0,
               "CreditOrDebit": "Debit",
               "CatalogueComments": ""
            }],
            "Id": 100061513,
            "Name": "Seed sub sub group"
         }],
         "Inactive": false,
         "Items": [{
            "FormulaToolTip": "Unit Price: 0.00 Qty: 1 ( Unit Price * Qty ) + 200 ",
            "Name": "SeedChilditem3",
            "Formula": {
               "FormulaReportString": "( Unit Price * Qty ) + 200 ",
               "Id": 100001261,
               "CustomFormulaFields": [{
                     "FieldValue": "0.00",
                     "FieldName": "Unit Price",
                     "FieldType": "Currency"
                  },
                  {
                     "FieldValue": "1",
                     "FieldName": "Qty",
                     "FieldType": "Numeric"
                  }
               ],
               "Name": "formula"
            },
            "TaxType": {
               "Id": 27,
               "Name": "GST - Standard 10%"
            },
            "UnitCost": 0,
            "UnitPrice": 140,
            "CatalogueType": "Food",
            "FinancialComments": "",
            "DiscountType": "$",
            "Qty": 1,
            "Id": 100231706,
            "DiscountValue": 0,
            "CreditOrDebit": "Debit",
            "CatalogueComments": ""
         }],
         "Id": 100059731,
         "Name": "SeedParentSubGroup"
      }],
      "Inactive": false,
      "Items": [{
            "FormulaToolTip": "Unit Price: 0.00 Qty: 1 ( Unit Price * Qty ) + 200 ",
            "Name": "SeedChilditem1",
            "Formula": {
               "FormulaReportString": "( Unit Price * Qty ) + 200 ",
               "Id": 100001261,
               "CustomFormulaFields": [{
                     "FieldValue": "0.00",
                     "FieldName": "Unit Price",
                     "FieldType": "Currency"
                  },
                  {
                     "FieldValue": "1",
                     "FieldName": "Qty",
                     "FieldType": "Numeric"
                  }
               ],
               "Name": "formula"
            },
            "TaxType": {
               "Id": 27,
               "Name": "GST - Standard 10%"
            },
            "UnitCost": 0,
            "UnitPrice": 120,
            "CatalogueType": "Food",
            "FinancialComments": "",
            "DiscountType": "$",
            "Qty": 1,
            "Id": 100231704,
            "DiscountValue": 0,
            "CreditOrDebit": "Debit",
            "CatalogueComments": "Comment Test"
         },
         {
            "FormulaToolTip": "Unit Price: 0.00 Qty: 1 ( Unit Price * Qty ) + 200 ",
            "Name": "SeedChilditem2",
            "Formula": {
               "FormulaReportString": "( Unit Price * Qty ) + 200 ",
               "Id": 100001261,
               "CustomFormulaFields": [{
                     "FieldValue": "0.00",
                     "FieldName": "Unit Price",
                     "FieldType": "Currency"
                  },
                  {
                     "FieldValue": "1",
                     "FieldName": "Qty",
                     "FieldType": "Numeric"
                  }
               ],
               "Name": "formula"
            },
            "TaxType": {
               "Id": 27,
               "Name": "GST - Standard 10%"
            },
            "UnitCost": 0,
            "UnitPrice": 150,
            "CatalogueType": "Food",
            "FinancialComments": "",
            "DiscountType": "$",
            "Qty": 1,
            "Id": 100231705,
            "DiscountValue": 0,
            "CreditOrDebit": "Debit",
            "CatalogueComments": ""
         }
      ],
      "Id": 100059730,
      "Name": "SeedParentGroup"
   }]
}

Was this article helpful?

Have more questions? Submit a request