Events: Create or Update Credit Catalogue

Updated June 14, 2023 16:13

Create or Update Credit Catalogue

POST /v2/event/save/catl/credits

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

Parameters

Id Long

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

TemplateId Long

The id of the credit catalogue item.

Event Object {Id}

The event to which the catalogue item should be associated with. The event must exist in your Priava Account. Passed in JSON format where:
Id = Id of an 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 to. The contact must exist in your Priava Account. Passed in JSON format where:
ContactId = Id of the contact

Venue (optional) Object {Id}

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

VenueBookingId (optional) Array [Id]

List of Venue Booking with which the catalogue item should be associated. The booking must exist in your Priava Account. Passed in an 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 the case of Create scenario, it will create one Event Catalogue per booking passed.

In the case of Update scenario, it will accept only one value in the array. As you can not associate multiple venue Booking to a single Event Catalogue Item.

NOTE: If both VenueBookingId and Venue data are passed, VenueBookingId arrays takes precedence over Venue.

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.

UnitPrice Double

The unit price of one catalogue item.

TaxType Object {Id, Name}

The tax type to be associated with the 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 comment to be associated with the catalogue item.

FinancialComments String

The financial comment to be associated with the catalogue item.

JSON

{
   "Venue": {
      "Id": 100172339,
      "Name": "Venue Name"
   },
   "EndDate": "31/03/2019 01:00",
   "VenueBooking": {},
   "Contact": {
      "ContactId": 99964
   },
   "StartDate": "30/03/2019 15:30",
   "Formula": {},
   "TaxType": {
      "Id": 28,
      "Name": "(no tax) internal only"
   },
   "UnitPrice": "100.00",
   "FinancialComments": "",
   "Qty": 2,
   "Event": {
      "Id": 101550014,
      "Name": "Catalogue API DND"
   },
   "Id": "",
   "CreditOrDebit": "Debit",
   "CatalogueComments": "test this comment",
   "TemplateId": 484
}

Response:

{
   "success": true,
   "result": {
      "Abbreviation": "CR",
      "Venue": {
         "Id": 100172339,
         "Name": "Venue Name"
      },
      "RefPkgId": "",
      "Tax": "0.00",
      "FormulaToolTip": "",
      "EndDate": "31/03/2019 01:00",
      "VenueBooking": {},
      "NetTotalExTax": "200.00",
      "Name": "Catering Credit",
      "Contact": {
         "Firstname": "Jhet",
         "Email": "jw@priava.com",
         "Organisation": "Test Mandatory Field",
         "Phone": "8383430000",
         "Lastname": "Willis",
         "Inactive": false,
         "ContactId": 99964,
         "JobTitle": "Test"
      },
      "StartDate": "30/03/2019 15:30",
      "Formula": {},
      "TaxType": {
         "TaxPercentage": 0,
         "Position": 11,
         "TaxIncluded": false,
         "Inactive": false,
         "Id": 28,
         "Name": "(no tax) internal only"
      },
      "UnitPrice": "100.00",
      "FinancialComments": "",
      "GrandTotal": "200.00",
      "Qty": 2,
      "Event": {
         "Id": 101550014,
         "Name": "Catalogue API DND"
      },
      "Id": 104545472,
      "CreditOrDebit": "Debit",
      "CatalogueComments": "test this comment",
      "TemplateId": 484
   }
}

Was this article helpful?

Have more questions? Submit a request