• Venue and event management in the cloud

How Can We Help?


Events: Save Inventory Catalogue

In this article


Save Inventory Catalogue

POST /v2/event/save/catl/inventory

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


Parameters
Id    Long

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

TemplateId    Long

The Id of an inventory 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 in your Priava Account. Passed in Array format where:
Id = Id of the Venue Booking.
Can pass multiple Venue Booking Ids in the Array in create case and single Venue Booking Id in update case.

In case of create scenario ,it will create one Event Catalogue per booking passed.

In case of update scenario , it will accept only one value in the array . As you can not associated multiple venue Booking 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 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": "Venue Name"
   },
   "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": 2313,
   "FinancialComments": "Financial comments, if any",
   "DiscountType": "C",
   "Qty": 1,
   "Event": {
      "Id": 101347493,
      "Name": "Catalogue Item"
   },
   "Id": "",
   "DiscountValue": 0,
   "CreditOrDebit": "Debit",
   "CatalogueComments": "Catalogue comments, if any",
   "TemplateId": 100172370,
"VenueBookingId" : [102953627] }
Response:
{
   "success": true,
   "result": {
      "Venue": {
         "Id": 100280085,
         "Name": "Venue Name"
      },
      "NetTotalInclDiscount": 2313,
      "Tax": 231.3,
      "EndDate": "30/03/2019 23:00",
      "NetTotalExTax": 2313,
      "DiscountAmount": 0,
      "Name": "Inventory Item",
      "Contact": {
         "Firstname": "Test",
         "Email": "test@gmail.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": 2313,
      "FinancialComments": "Financial comments, if any",
      "DiscountType": "C",
      "GrandTotal": 2544.3,
      "Qty": 1,
      "Event": {
         "Id": 101347493,
         "Name": "Catalogue Item"
      },
      "Id": 104000428,
      "DiscountValue": 0,
      "CreditOrDebit": "Debit",
      "CatalogueComments": "Catalogue comments, if any",
      "TemplateId": 100172370
   }
}