• Venue and event management in the cloud

How Can We Help?


Events: Save Package Catalogue

In this article


Save Beverage Catalogue

POST /v2/event/save/catl/package

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


Parameters
Id    Long

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

TemplateId    Long

The Id of a package 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.

VenueBookingId   Array [Id]

List of Venue Booking with which the catalogue item should be associated. The booking must exist for the event for which the package is to be saved. Passed in an array format where:
Id = Id of the Venue Booking.
Can pass multiple Venue Booking Ids in an array while creating a package and only one venue booking Id can be passed while updating a package.

In the create package scenario, it will create one Event Catalogue per booking passed.

In the update package scenario, only one value will be accepted in an array, as you can not associate multiple venue bookings to a single event catalogue item.

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 the percentile discount and 'C' is a 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 the package catalogue item.

CatalogueComments    String

The catalogue comment to be associated with the package catalogue.

FinancialComments    String

The Financial comment to be associated with the package catalogue.

PackageBreakDown    Array[{}]

Breakdown catalogue items of the package.

PackageBreakDown - Id    Long

The Id of the breakdown catalogue item. Required only if you are updating the catalogue. If empty, a new catalogue item will be created.

PackageBreakDown - PackageBalancer    String

True or False.

PackageBreakDown - RefPkgId    Long

The Id of the referenced package catalogue.

PackageBreakDown - StartDate    DateTime

The Start Date and time of breakdown catalogue item.

PackageBreakDown - Formula    Object

Formula associated with the catalogue item contains the following:

  Name    String

Name of the Formula

CustomFormulaFields    Array[{}]

  The Custom Formula Fields passed in JSON Format where:
  FieldName = Name of the Custom Formula Field
  FieldValue = Value of the Custom Formula Field

PackageBreakDown - CatalogueTypeName    String

The Catalogue Type of breakdown catalogue item.

PackageBreakDown - Qty    Double

The Quantity of the breakdown item.

PackageBreakDown - CreditOrDebit    String

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

PackageBreakDown - TemplateId    Long

The Template Id of the breakdown catalogue item.

PackageBreakDown - CatalogueComments    String

The Comment to be associated with the breakdown catalogue item.

PackageBreakDown - EndDate    DateTime

The End Date and time of breakdown catalogue item.

PackageBreakDown - Quote  Object { Id, QuoteNumber }

Quote to which the catalogue item is to be associated. The Quote must exist in your Priava Account. Passed in JSON format where:
Id = the ID of the Quote.
QuoteNumber = the number of the quote.

PackageBreakDown - UnitPrice    Double

The Unit Price of the breakdown catalogue item.

PackageBreakDown - FinancialComments    String

The Financial Comment to be associated with the breakdown catalogue item.

PackageBreakDown - DiscountType    Double

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

PackageBreakDown - DiscountValue    Double

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

PackageBreakDown - TaxType    Object { Id, Name }

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

PackageBreakDown - QtyModifier    String

The Quantity Modifier of the breakdown item.

PackageBreakDown - QtyType    String

The Quantity Type of the breakdown item.

RefPkgId    Long

The Id of the referenced package catalogue.

{
"Abbreviation": "PK",
"TaxIncluded": true,
"Name": "Distributed Packages - Tax Incl",
"StartDate": "18/02/2015 18:30",
"InvoicePrefix": "",
"Qty": 1,
"InvoiceNumber": "",
"InvoiceDate": "",
"CreditOrDebit": "Debit",
"CatalogueComments": "This is my comment",
"TemplateId": 100174908,
"PackageBreakDown": [
{
"Abbreviation": "FB",
"PackageBalancer": true,
"RefPkgId": 102120547,
"Name": "ANTIPASTO - Tax Incl",
"StartDate": "18/02/2015 18:30",
"Formula": {},
"InvoicePrefix": "",
"Qty": 1,
"InvoiceNumber": "",
"InvoiceDate": "",
"CreditOrDebit": "Debit",
"CatalogueComments": "This is my comment",
"TemplateId": 17901,
"Venue": {
"Id": 100172893,
"Name": "Box15-01"
},
"QtyModifier": 1,
"QtyType": "Fixed",
"EndDate": "19/02/2015 03:00",
"VenueBooking": {},
"Contact": {
"ContactId": 12332
},
"UnitCost": "0.00",
"TaxType": {
"Id": 100006379,
"Name": "Tax Included"
},
"UnitPrice": "60.00",
"FinancialComments": "This is my comment",
"DiscountType": "P",
"Event": {
"Id": 150612006,
"Name": "Venue Catch-up"
},
"Id": 102120548,
"DiscountValue": "0.00"
},
{
"Abbreviation": "FB",
"PackageBalancer": false,
"RefPkgId": 102120547,
"Name": "SUSHI - Tax Incl",
"StartDate": "18/02/2015 18:30",
"Formula": {},
"InvoicePrefix": "",
"Qty": 1,
"InvoiceNumber": "",
"InvoiceDate": "",
"CreditOrDebit": "Debit",
"CatalogueComments": "",
"TemplateId": 17902,
"Venue": {
"Id": 100172893,
"Name": "Box15-01"
},
"QtyModifier": 1,
"QtyType": "Multiplier",
"EndDate": "19/02/2015 03:00",
"VenueBooking": {},
"Contact": {
"ContactId": 12332
},
"UnitCost": "35.00",
"TaxType": {
"Id": 100006379,
"Name": "Tax Included"
},
"UnitPrice": "40.00",
"FinancialComments": "",
"DiscountType": "P",
"Event": {
"Id": 150612006,
"Name": "Venue Catch-up"
},
"Id": 102120549,
"DiscountValue": "0.00"
}
],
"Venue": {
"Id": 100172893,
"Name": "Box15-01"
},
"EndDate": "19/02/2015 03:00",
"VenueBooking": {},
"Contact": {
"ContactId": 12332
},
"UnitCost": "35.00",
"UnitPrice": 100,
"FinancialComments": "This is my comment",
"DiscountType": "C",
"Event": {
"Id": 150612006,
"Name": "Venue Catch-up"
},
"Id": 102120547,
"DiscountValue": 0,
"BalancingOptions": "ADJUSTMENT"
}
Response:
{
"result": {
"Abbreviation": "PK",
"TaxIncluded": true,
"CatalogueHierarchy": "Packages > Distributed Packages - Tax Incl",
"Tax": "16.67",
"Difference": "0.00",
"TotalUnitCost": "35.00",
"NetTotalExTax": "83.33",
"Name": "Distributed Packages - Tax Incl",
"StartDate": "18/02/2015 13:00",
"InvoicePrefix": "",
"Qty": 1,
"ProfitAmount": "48.33",
"ProfitPercentage": "58.00",
"InvoiceNumber": "",
"InvoiceDate": "",
"CreditOrDebit": "Debit",
"CatalogueComments": "This is my comment",
"TemplateId": 100174908,
"PackageBreakDown": [
{
"Abbreviation": "FB",
"PackageBalancer": true,
"RefPkgId": 102120547,
"CatalogueHierarchy": "TVE Catering > ANTIPASTO - Tax Incl",
"Tax": "10.00",
"FormulaToolTip": "",
"TotalUnitCost": "0.00",
"NetTotalExTax": "50.00",
"Name": "ANTIPASTO - Tax Incl",
"StartDate": "18/02/2015 13:00",
"Formula": {},
"InvoicePrefix": "",
"Qty": 1,
"Permission": {
"CanDelete": true,
"CanView": true,
"CanEdit": true,
"CanAdd": true
},
"ProfitAmount": "50.00",
"ProfitPercentage": "100.00",
"InvoiceNumber": "",
"InvoiceDate": "",
"CreditOrDebit": "Debit",
"CatalogueComments": "",
"TemplateId": 17901,
"DiscountValueCalc": "0.0",
"Venue": {
"Id": 100172893,
"Name": "Box15-01"
},
"NetTotalInclDiscount": "60.00",
"QtyModifier": 1,
"QtyType": "Fixed",
"EndDate": "18/02/2015 21:30",
"VenueBooking": {},
"DiscountAmount": "0.00",
"Contact": {
"Firstname": "Kendra",
"Anonymised": false,
"Email": "kendra.tuckwell@gmail.com",
"Organisation": "",
"Phone": "0406 862 806",
"Lastname": "Tuckwell",
"Inactive": false,
"GDPRProcessed": false,
"ContactId": 12332,
"Deleted": false,
"Pseudonymised": false,
"JobTitle": ""
},
"UnitCost": "0.00",
"TaxType": {
"TaxPercentage": "20.00",
"Position": 5,
"TaxIncluded": true,
"Inactive": false,
"Id": 100006379,
"Name": "Tax Included"
},
"UnitPrice": "60.00",
"FinancialComments": "",
"DiscountType": "P",
"GrandTotal": "60.00",
"Event": {
"Id": 150612006,
"Name": "Venue Catch-up"
},
"GrandTotalForCalc": 60,
"Id": 102120548,
"DiscountValue": "0.00"
},
{
"Abbreviation": "FB",
"PackageBalancer": false,
"RefPkgId": 102120547,
"CatalogueHierarchy": "TVE Catering > SUSHI - Tax Incl",
"Tax": "6.67",
"FormulaToolTip": "",
"TotalUnitCost": "35.00",
"NetTotalExTax": "33.33",
"Name": "SUSHI - Tax Incl",
"StartDate": "18/02/2015 13:00",
"Formula": {},
"InvoicePrefix": "",
"Qty": 1,
"Permission": {
"CanDelete": true,
"CanView": true,
"CanEdit": true,
"CanAdd": true
},
"ProfitAmount": "-1.67",
"ProfitPercentage": "-5.01",
"InvoiceNumber": "",
"InvoiceDate": "",
"CreditOrDebit": "Debit",
"CatalogueComments": "",
"TemplateId": 17902,
"DiscountValueCalc": "0.0",
"Venue": {
"Id": 100172893,
"Name": "Box15-01"
},
"NetTotalInclDiscount": "40.00",
"QtyModifier": 1,
"QtyType": "Multiplier",
"EndDate": "18/02/2015 21:30",
"VenueBooking": {},
"DiscountAmount": "0.00",
"Contact": {
"Firstname": "Kendra",
"Anonymised": false,
"Email": "kendra.tuckwell@gmail.com",
"Organisation": "",
"Phone": "0406 862 806",
"Lastname": "Tuckwell",
"Inactive": false,
"GDPRProcessed": false,
"ContactId": 12332,
"Deleted": false,
"Pseudonymised": false,
"JobTitle": ""
},
"UnitCost": "35.00",
"TaxType": {
"TaxPercentage": "20.00",
"Position": 5,
"TaxIncluded": true,
"Inactive": false,
"Id": 100006379,
"Name": "Tax Included"
},
"UnitPrice": "40.00",
"FinancialComments": "",
"DiscountType": "P",
"GrandTotal": "40.00",
"Event": {
"Id": 150612006,
"Name": "Venue Catch-up"
},
"GrandTotalForCalc": 40,
"Id": 102120549,
"DiscountValue": "0.00"
}
],
"Venue": {
"Id": 100172893,
"Name": "Box15-01"
},
"EndDate": "18/02/2015 21:30",
"VenueBooking": {},
"DiscountAmount": "0.00",
"Contact": {
"Firstname": "Kendra",
"Anonymised": false,
"Email": "kendra.tuckwell@gmail.com",
"Organisation": "",
"Phone": "0406 862 806",
"Lastname": "Tuckwell",
"Inactive": false,
"GDPRProcessed": false,
"ContactId": 12332,
"Deleted": false,
"Pseudonymised": false,
"JobTitle": ""
},
"UnitCost": "35.00",
"UnitPrice": "100.00",
"PackageTotal": "100.00",
"FinancialComments": "This is my comment",
"DiscountType": "C",
"BreakDownPrice": "100.00",
"GrandTotal": "100.00",
"Event": {
"Id": 150612006,
"Name": "Venue Catch-up"
},
"GrandTotalForCalc": 100,
"Id": 102120547,
"DiscountValue": "0.00",
"BalancingOptions": "ADJUSTMENT"
},
"success": true
}