• Venue and event management in the cloud

How Can We Help?


Events: Save Food Catalogue

In this article


Save Food Catalogue

POST /v2/event/save/catl/food

This API creates a Food Catalogue in an event and returns a unique Id and its associated details. This same API allows you to update an existing Food Catalogue e.g. change the comments or the qty etc.


Parameters
Id    Long

The Id of food catalogue. Required only if you are updating the food catalogue.

TemplateId    Long

The Id of a food item.

Event    Object {Id, Name}

The event to which the catalogue item should be associated. The event must exist in your Priava Account. Passed in JSON format where:
Id = Id of the Event.
Name = Name of the Event.

StartDate    DateTime

The start date and time of the catalogue item.

EndDate   DateTime

The end date and time of the catalogue item.

Contact    Object {Id}

The contact to whom the catalogue item should be associated. The contact must exist in your Priava Account. Passed in JSON format where:
ContactId = Id of the contact

Venue    Object {Id, Name}

The venue with which the catalogue item should be associated. The venue must exist in your Priava Account. Passed in JSON format where:
Id = Id of the Venue.
Name = Name of the Venue.

VenueBookings    Object {Id, Name}

The booking with which the catalogue item should be associated. The booking must exist in your Priava Account. Passed in JSON format where:
Id = Id of the Venue Booking.
Name = Name of the Venue Booking.

CreditOrDebit    String

This represents whether the catalogue item should be credited or debited to the event. Only values supported are Credit or Debit.

Qty    Integer

The required quantity of the catalogue item.

DiscountType    String

This represents the type of discount provided. The possible values could be 'P' and 'C', where 'P' is percentile discount and 'C' is fixed discount amount.

DiscountValue    Double

This represents the discount provided for the catalogue item. The value provided is used along with the discount type to calculate the total discount amount.

UnitPrice    Double

The unit price of one catalogue item.

UnitCost    Double

The unit cost of one catalogue item.

TaxType    Object {Id, Name}

The tax type to be associated with catalogue item. Tax type must exist in your Priava Account. Passed in JSON format where:
Id = Id of the Tax Type.
Name = Name of the Tax Type.

CatalogueComments    String

The Catalogue comment to be associated with the catalogue item.

FinancialComments    String

The Financial comment to be associated with the catalogue item.

{
   "Venue": {
      "Id": 100280085,
      "Name": "VenueName"
   },
   "EndDate": "30/03/2019 23:00",
   "Contact": {
      "ContactId": 100400252
   },
   "StartDate": "30/03/2019 14:30",
   "UnitCost": 0,
   "TaxType": {
      "Id": 27,
      "Name": "GST - Standard 10%"
   },
   "UnitPrice": 450,
   "FinancialComments": "Financial Comments, if any",
   "DiscountType": "C",
   "Qty": 10,
   "Event": {
      "Id": 101347493,
      "Name": "Event Name"
   },
   "Id": "",
   "DiscountValue": 20,
   "CreditOrDebit": "Debit",
   "CatalogueComments": "Catalouge Comments, if any",
   "TemplateId": 100275390
}
Response:
{
   "success": true,
   "result": {
      "Venue": {
         "Id": 100280085,
         "Name": "Venue Name"
      },
      "NetTotalInclDiscount": 4480,
      "Tax": 448,
      "EndDate": "30/03/2019 23:00",
      "NetTotalExTax": 4480,
      "DiscountAmount": 20,
      "Name": "FoodItem2",
      "Contact": {
         "Firstname": "Test",
         "Email": "test@example.com",
         "Organisation": "Ted Baker",
         "Phone": "+61-450450450",
         "Lastname": "Test1",
         "ContactId": 100400252,
         "JobTitle": "QA"
      },
      "StartDate": "30/03/2019 14:30",
      "UnitCost": 0,
      "TaxType": {
         "TaxPercentage": 10,
         "Position": 5,
         "TaxIncluded": false,
         "Inactive": false,
         "Id": 27,
         "Name": "GST - Standard 10%"
      },
      "UnitPrice": 450,
      "FinancialComments": "Financial Comments, if any",
      "DiscountType": "C",
      "GrandTotal": 4928,
      "Qty": 10,
      "Event": {
         "Id": 101347493,
         "Name": "Event Name"
      },
      "Id": 104000413,
      "DiscountValue": 20,
      "CreditOrDebit": "Debit",
      "CatalogueComments": "Catalouge Comments, if any",
      "TemplateId": 100275390
   }
}