Navigation
Navigation
Csharp cURL JavaScript

ReportingApi Documentation

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Welcome to TryBooking Reporting API documentation. This should provide you with the info you need to retrieve bookings for reporting purposes. From a high-level perspective, the API allows you to read bookings related to an account using REST service connector that you want.

Getting Started

  1. Request
  2. API Keys

Request

Almost all requests need to includ a valid key and secret which can be generated in TryBooking Portal site under Integration Tools > API Management.

API Keys

API Keys look like this:

Key Secret Key
4DD41AEBAE4B86B2**************** B7BB86660E1E767E****************

Authentication

With each HTTP request, you need to use HTTP Basic Authentication Scheme. The API key and Secret key are used as the username and password in this scheme.

To use Basic Authentication you need to:

Basic Auth Credentials Sample

Username 4DD41AEBAE4B86B2**************** (Key)
Password B7BB86660E1E767E**************** (Secret Key)

Example Authorization HTTP header

An HTTP header like this needs to be included on each request

Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

Account

Get By Date

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/account?startDate=string&endDate=string"); // date format: yyyy-MM-dd | UTC format,// date format: yyyy-MM-dd | UTC format,// TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/account?startDate=string&endDate=string \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/account',
  method: 'get',
  data: '?startDate=string&endDate=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/account

Get Account Transactions by Date Range

Get Account Transactions By Date Range using yyyy-MM-dd as date format

Parameters

Parameter In Type Required Description
startDate query string true date format: yyyy-MM-dd
endDate query string true date format: yyyy-MM-dd
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Example responses

200 Response

{
  "accountId": 0,
  "pendingFundTransfer": 0,
  "balance": 0,
  "transactions": [
    {
      "transactionTypeName": "string",
      "description": "string",
      "debitAmount": 0,
      "creditAmount": 0,
      "transactionDate": "2020-06-22T10:38:40Z",
      "customerName": "string",
      "bookingURLId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success AccountTransactionDto
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Transactions

Get By TransactionId

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/bookings/{transactionId}"); 
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/bookings/{transactionId} \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/bookings/{transactionId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/bookings/{transactionId}

Get Transaction by Transaction ID

Get specific Transaction by Transaction Id

Parameters

Parameter In Type Required Description
transactionId path string true Otherwise known as the Booking ID or Donation ID
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Example responses

200 Response

{
  "bookingUrlId": "string",
  "date": "2020-06-22T10:38:40Z",
  "bookingFirstName": "string",
  "bookingLastName": "string",
  "bookingEmail": "string",
  "bookingPhone": "string",
  "permissionToContact": true,
  "bookingAddress1": "string",
  "bookingAddress2": "string",
  "bookingCity": "string",
  "bookingState": "string",
  "bookingPostCode": "string",
  "bookingCountry": "string",
  "totalAmount": 0,
  "totalCardFee": 0,
  "totalProcessingFee": 0,
  "totalBoxOfficeFee": 0,
  "totalRefundedAmount": 0,
  "urlReferrer": "string",
  "customId": "string",
  "bookingDataCollections": [
    {
      "label": "string",
      "value": "string"
    }
  ],
  "bookingTickets": [
    {
      "ticketName": "string",
      "seatQuantity": 0,
      "discountAmount": 0,
      "appliedGCOnUnitPrice": 0,
      "sessionId": 0,
      "eventEndDate": "2020-06-22T10:38:40Z",
      "eventStartDate": "2020-06-22T10:38:40Z",
      "alternateLabel": "string",
      "eventName": "string",
      "sectionName": "string",
      "eventCode": "string",
      "totalTicketPrice": 0,
      "refundedAmount": 0,
      "cardFee": 0,
      "processingFee": 0,
      "ticketFee": 0,
      "refundedCardFee": 0,
      "refundedProcessingFee": 0,
      "tax": 0,
      "refundedTax": 0,
      "isVoid": true,
      "bookingTicketDataCollections": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "ticketSeats": [
        {
          "ticketBarcode": "string",
          "rowName": "string",
          "seatNumber": 0,
          "doorName": "string",
          "bookingTicketDataCollection": [
            {
              "label": "string",
              "value": "string"
            }
          ]
        }
      ]
    }
  ],
  "bookingDonations": [
    {
      "value": 0,
      "eventName": "string",
      "eventId": 0,
      "fundraisingPageName": "string",
      "fundraisingPageID": 0,
      "appliedGCValue": 0,
      "cardFee": 0,
      "processingFee": 0,
      "refundedAmount": 0,
      "refundedCardFee": 0,
      "refundedProcessingFee": 0
    }
  ],
  "bookingGiftCertificates": [
    {
      "value": 0,
      "name": "string",
      "cardFee": 0,
      "processingFee": 0,
      "ticketFee": 0,
      "discountAmount": 0,
      "refundedAmount": 0,
      "refundedCardFee": 0,
      "refundedProcessingFee": 0
    }
  ],
  "bookingBoxOfficeFees": [
    {
      "boxOfficeFee": 0,
      "appliedGCValue": 0,
      "cardFee": 0,
      "processingFee": 0,
      "tax": 0,
      "refundedAmount": 0,
      "refundedCardFee": 0,
      "refundedProcessingFee": 0,
      "refundedTax": 0,
      "eventName": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success BookingDto
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Get By Date

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/bookings?date=string"); // date format: yyyy-MM-dd | UTC format,// TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/bookings?date=string \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/bookings',
  method: 'get',
  data: '?date=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/bookings

Get Transaction by Date

Get Transaction By Date using yyyy-MM-dd as date format

Parameters

Parameter In Type Required Description
date query string true date format: yyyy-MM-dd
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Example responses

200 Response

[
  {
    "bookingUrlId": "string",
    "date": "2020-06-22T10:38:40Z",
    "bookingFirstName": "string",
    "bookingLastName": "string",
    "bookingEmail": "string",
    "bookingPhone": "string",
    "permissionToContact": true,
    "bookingAddress1": "string",
    "bookingAddress2": "string",
    "bookingCity": "string",
    "bookingState": "string",
    "bookingPostCode": "string",
    "bookingCountry": "string",
    "totalAmount": 0,
    "totalCardFee": 0,
    "totalProcessingFee": 0,
    "totalBoxOfficeFee": 0,
    "totalRefundedAmount": 0,
    "urlReferrer": "string",
    "customId": "string",
    "bookingDataCollections": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "bookingTickets": [
      {
        "ticketName": "string",
        "seatQuantity": 0,
        "discountAmount": 0,
        "appliedGCOnUnitPrice": 0,
        "sessionId": 0,
        "eventEndDate": "2020-06-22T10:38:40Z",
        "eventStartDate": "2020-06-22T10:38:40Z",
        "alternateLabel": "string",
        "eventName": "string",
        "sectionName": "string",
        "eventCode": "string",
        "totalTicketPrice": 0,
        "refundedAmount": 0,
        "cardFee": 0,
        "processingFee": 0,
        "ticketFee": 0,
        "refundedCardFee": 0,
        "refundedProcessingFee": 0,
        "tax": 0,
        "refundedTax": 0,
        "isVoid": true,
        "bookingTicketDataCollections": [
          {
            "label": "string",
            "value": "string"
          }
        ],
        "ticketSeats": [
          {
            "ticketBarcode": "string",
            "rowName": "string",
            "seatNumber": 0,
            "doorName": "string",
            "bookingTicketDataCollection": [
              {
                "label": "string",
                "value": "string"
              }
            ]
          }
        ]
      }
    ],
    "bookingDonations": [
      {
        "value": 0,
        "eventName": "string",
        "eventId": 0,
        "fundraisingPageName": "string",
        "fundraisingPageID": 0,
        "appliedGCValue": 0,
        "cardFee": 0,
        "processingFee": 0,
        "refundedAmount": 0,
        "refundedCardFee": 0,
        "refundedProcessingFee": 0
      }
    ],
    "bookingGiftCertificates": [
      {
        "value": 0,
        "name": "string",
        "cardFee": 0,
        "processingFee": 0,
        "ticketFee": 0,
        "discountAmount": 0,
        "refundedAmount": 0,
        "refundedCardFee": 0,
        "refundedProcessingFee": 0
      }
    ],
    "bookingBoxOfficeFees": [
      {
        "boxOfficeFee": 0,
        "appliedGCValue": 0,
        "cardFee": 0,
        "processingFee": 0,
        "tax": 0,
        "refundedAmount": 0,
        "refundedCardFee": 0,
        "refundedProcessingFee": 0,
        "refundedTax": 0,
        "eventName": "string"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Success Inline
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BookingDto] false none none
» bookingUrlId string|null false none none
» date string(date-time) false none none
» bookingFirstName string|null false none none
» bookingLastName string|null false none none
» bookingEmail string|null false none none
» bookingPhone string|null false none none
» permissionToContact boolean false none none
» bookingAddress1 string|null false none none
» bookingAddress2 string|null false none none
» bookingCity string|null false none none
» bookingState string|null false none none
» bookingPostCode string|null false none none
» bookingCountry string|null false none none
» totalAmount number(double) false none none
» totalCardFee number(double) false none none
» totalProcessingFee number(double) false none none
» totalBoxOfficeFee number(double) false none none
» totalRefundedAmount number(double) false none none
» urlReferrer string|null false none none
» customId string|null false none none
» bookingDataCollections [BookingDataCollectionDto]|null false none none
»» label string|null false none none
»» value string|null false none none
» bookingTickets [BookingTicketDto]|null false none none
»» ticketName string|null false none none
»» seatQuantity integer(int32) false none none
»» discountAmount number(double) false none none
»» appliedGCOnUnitPrice number(double) false none none
»» sessionId integer(int32) false none none
»» eventEndDate string(date-time) false none none
»» eventStartDate string(date-time) false none none
»» alternateLabel string|null false none none
»» eventName string|null false none none
»» sectionName string|null false none none
»» eventCode string|null false none none
»» totalTicketPrice number(double) false none none
»» refundedAmount number(double) false none none
»» cardFee number(double) false none none
»» processingFee number(double) false none none
»» ticketFee number(double) false none none
»» refundedCardFee number(double) false none none
»» refundedProcessingFee number(double) false none none
»» tax number(double) false none none
»» refundedTax number(double) false none none
»» isVoid boolean false none none
»» bookingTicketDataCollections [BookingTicketDataCollectionDto]|null false none none
»»» label string|null false none none
»»» value string|null false none none
»» ticketSeats [TicketSeatDto]|null false none none
»»» ticketBarcode string|null false none none
»»» rowName string|null false none none
»»» seatNumber integer(int32)|null false none none
»»» doorName string|null false none none
»»» bookingTicketDataCollection [BookingTicketDataCollectionDto]|null false none none
»» bookingDonations [BookingDonationDto]|null false none none
»»» value number(double) false none none
»»» eventName string|null false none none
»»» eventId integer(int32)|null false none none
»»» fundraisingPageName string|null false none none
»»» fundraisingPageID integer(int32)|null false none none
»»» appliedGCValue number(double) false none none
»»» cardFee number(double) false none none
»»» processingFee number(double) false none none
»»» refundedAmount number(double) false none none
»»» refundedCardFee number(double) false none none
»»» refundedProcessingFee number(double) false none none
»» bookingGiftCertificates [BookingGiftCertificateDto]|null false none none
»»» value number(double) false none none
»»» name string|null false none none
»»» cardFee number(double) false none none
»»» processingFee number(double) false none none
»»» ticketFee number(double) false none none
»»» discountAmount number(double) false none none
»»» refundedAmount number(double) false none none
»»» refundedCardFee number(double) false none none
»»» refundedProcessingFee number(double) false none none
»» bookingBoxOfficeFees [BookingBoxOfficeFeeDto]|null false none none
»»» boxOfficeFee number(double) false none none
»»» appliedGCValue number(double) false none none
»»» cardFee number(double) false none none
»»» processingFee number(double) false none none
»»» tax number(double) false none none
»»» refundedAmount number(double) false none none
»»» refundedCardFee number(double) false none none
»»» refundedProcessingFee number(double) false none none
»»» refundedTax number(double) false none none
»»» eventName string|null false none none

Event

Get By AccountId

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/event"); 
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/event \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/event',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/event

Get Events by Account Id

Get Events by Account Id

Parameters

Parameter In Type Required Description
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Example responses

200 Response

{
  "name": "string",
  "eventCode": "string",
  "description": "string",
  "venue": "string",
  "venueLatitude": "string",
  "venueLongitude": "string",
  "onlineEventLink": "string",
  "contactName": "string",
  "contactEmail": "string",
  "contactNumber": "string",
  "isPublic": true,
  "allowWaitingList": true,
  "timeZone": "string",
  "bookingUrl": "string",
  "homepageTemplate": "string",
  "isOpen": true,
  "listOfImages": [
    {
      "imageFileName": "string",
      "purpose": "string",
      "imageOrder": 0
    }
  ],
  "sessionList": [
    {
      "eventStartDate": "2020-06-22T10:38:40Z",
      "eventEndDate": "2020-06-22T10:38:40Z",
      "bookingStartDate": "2020-06-22T10:38:40Z",
      "bookingEndDate": "2020-06-22T10:38:40Z",
      "alternateLabel": "string",
      "description": "string",
      "id": 0,
      "sessionStatus": "string",
      "sessionCapacity": 0,
      "sessionAvailability": 0,
      "sessionBookingUrl": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success AccountEventListDto
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Get By SessionId

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/event/session"); // undefined,// TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/event/session \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/event/session',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/event/session

Get Event Session by Session Id

Get Event Session by Session Id

Parameters

Parameter In Type Required Description
sessionId query integer(int32) false none
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Example responses

200 Response

{
  "eventStartDate": "2020-06-22T10:38:40Z",
  "eventEndDate": "2020-06-22T10:38:40Z",
  "bookingStartDate": "2020-06-22T10:38:40Z",
  "bookingEndDate": "2020-06-22T10:38:40Z",
  "alternateLabel": "string",
  "description": "string",
  "id": 0,
  "eventId": 0,
  "sessionStatus": "string",
  "sessionCapacity": 0,
  "sessionAvailability": 0,
  "sessionBookingUrl": "string"
}

Responses

Status Meaning Description Schema
200 OK Success SessionAvailabilityDto
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Fundraising

Get By AccountId

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/fundraising"); 
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/fundraising \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/fundraising',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/fundraising

Get Fundraising pages by Account Id

Get Fundraising pages by Account Id

Parameters

Parameter In Type Required Description
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Example responses

200 Response

[
  {
    "fundraisingPageName": "string",
    "fundraisingPageId": 0,
    "description": "string",
    "contactEmail": "string",
    "isActive": true,
    "presetDonationValues": [
      0
    ],
    "listOfImages": [
      {
        "imageFileName": "string",
        "purpose": "string"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Success Inline
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [FundraisingDto] false none none
» fundraisingPageName string|null false none none
» fundraisingPageId integer(int32) false none none
» description string|null false none none
» contactEmail string|null false none none
» isActive boolean false none none
» presetDonationValues [integer]|null false none none
» listOfImages [FundraisingImageDto]|null false none none
»» imageFileName string|null false none none
»» purpose string|null false none none

Sales

GetAccountTicketSalesByTimePeriod

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/sales/ticket?fromDate=string&toDate=string&datePeriod=1"); // undefined,// date format: yyyy-MM-dd | UTC format,// date format: yyyy-MM-dd | UTC format,// 1 - Day, 2 - Week, 3 - Month, 4 - Year,// TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/sales/ticket?fromDate=string&toDate=string&datePeriod=1 \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/sales/ticket',
  method: 'get',
  data: '?fromDate=string&toDate=string&datePeriod=1',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/sales/ticket

Generate Ticket Sales Report

Endpoint for generating Sales Report per Ticket Type at specified date range.

Parameters

Parameter In Type Required Description
eventId query integer(int32) false none
fromDate query string true date format: yyyy-MM-dd
toDate query string true date format: yyyy-MM-dd
datePeriod query integer(int32) true 1 - Day, 2 - Week, 3 - Month, 4 - Year
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Enumerated Values

Parameter Value
datePeriod 1
datePeriod 2
datePeriod 3
datePeriod 4

Example responses

200 Response

[
  {
    "ticketName": "string",
    "transactionDate": "2020-06-22T10:38:40Z",
    "totalBookings": 0,
    "totalSold": 0,
    "totalSales": 0,
    "trend": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success Inline
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [TicketSalesDto] false none none
» ticketName string|null false none none
» transactionDate string(date-time) false none none
» totalBookings integer(int32) false none none
» totalSold integer(int32) false none none
» totalSales number(double) false none none
» trend string|null false none none

GetAccountBookingSalesByTimePeriod

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/sales/booking?fromDate=string&toDate=string&datePeriod=1"); // undefined,// date format: yyyy-MM-dd | UTC format,// date format: yyyy-MM-dd | UTC format,// 1 - Day, 2 - Week, 3 - Month, 4 - Year,// TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/sales/booking?fromDate=string&toDate=string&datePeriod=1 \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/sales/booking',
  method: 'get',
  data: '?fromDate=string&toDate=string&datePeriod=1',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/sales/booking

Generate Booking Sales Report

Endpoint for generating Sales Report per Booking at specified date range. Maximum of 180 days per report.

Parameters

Parameter In Type Required Description
eventId query integer(int32) false none
fromDate query string true date format: yyyy-MM-dd
toDate query string true date format: yyyy-MM-dd
datePeriod query integer(int32) true 1 - Day, 2 - Week, 3 - Month, 4 - Year
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Enumerated Values

Parameter Value
datePeriod 1
datePeriod 2
datePeriod 3
datePeriod 4

Example responses

200 Response

[
  {
    "transactionDate": "2020-06-22T10:38:40Z",
    "totalBookings": 0,
    "totalSold": 0,
    "totalSales": 0,
    "trend": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success Inline
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [BookingSalesDto] false none none
» transactionDate string(date-time) false none none
» totalBookings integer(int32) false none none
» totalSold integer(int32) false none none
» totalSales number(double) false none none
» trend string|null false none none

GetAccountEventSalesByTimePeriod

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/sales/event?fromDate=string&toDate=string&datePeriod=1"); // undefined,// date format: yyyy-MM-dd | UTC format,// date format: yyyy-MM-dd | UTC format,// 1 - Day, 2 - Week, 3 - Month, 4 - Year,// TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/sales/event?fromDate=string&toDate=string&datePeriod=1 \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/sales/event',
  method: 'get',
  data: '?fromDate=string&toDate=string&datePeriod=1',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/sales/event

Generate Event Sales Report

Endpoint for generating Sales Report per Event at specified date range. Maximum of 180 days per report.

Parameters

Parameter In Type Required Description
eventId query integer(int32) false none
fromDate query string true date format: yyyy-MM-dd
toDate query string true date format: yyyy-MM-dd
datePeriod query integer(int32) true 1 - Day, 2 - Week, 3 - Month, 4 - Year
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Enumerated Values

Parameter Value
datePeriod 1
datePeriod 2
datePeriod 3
datePeriod 4

Example responses

200 Response

[
  {
    "eventName": "string",
    "transactionDate": "2020-06-22T10:38:40Z",
    "totalBookings": 0,
    "totalSold": 0,
    "totalSales": 0,
    "trend": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success Inline
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [EventSalesDto] false none none
» eventName string|null false none none
» transactionDate string(date-time) false none none
» totalBookings integer(int32) false none none
» totalSold integer(int32) false none none
» totalSales number(double) false none none
» trend string|null false none none

GetAccountFundraisingSalesByTimePeriod

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/sales/fundraising?fromDate=string&toDate=string&datePeriod=1"); // undefined,// date format: yyyy-MM-dd | UTC format,// date format: yyyy-MM-dd | UTC format,// 1 - Day, 2 - Week, 3 - Month, 4 - Year,// TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/sales/fundraising?fromDate=string&toDate=string&datePeriod=1 \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/sales/fundraising',
  method: 'get',
  data: '?fromDate=string&toDate=string&datePeriod=1',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/sales/fundraising

Generate Fundraising Sales Report

Endpoint for generating Sales Report per Fundraising at specified date range.

Parameters

Parameter In Type Required Description
fundraisingPageId query integer(int32) false none
fromDate query string true date format: yyyy-MM-dd
toDate query string true date format: yyyy-MM-dd
datePeriod query integer(int32) true 1 - Day, 2 - Week, 3 - Month, 4 - Year
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Example responses

200 Response

[
  {
    "fundraisingPageName": "string",
    "totalTransactions": 0,
    "totalSales": 0,
    "transactionDate": "2020-06-22T10:38:40Z",
    "trend": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Success Inline
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [FundraisingSalesDto] false none none
» fundraisingPageName string|null false none none
» totalTransactions integer(int32) false none none
» totalSales number(double) false none none
» transactionDate string(date-time) false none none
» trend string|null false none none

Scans

Get Attendance Scans

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/scans/{sessionId}/attendance"); 
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/scans/{sessionId}/attendance \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/scans/{sessionId}/attendance',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/scans/{sessionId}/attendance

Get Ticket Scans for an Event Session ID

This API method gets a single TicketScan record per ticket in the session if the ticket was scanned at the event session. It allows you to confirm attendance of ticket buyers. You can use the ticketBarcode field to line up Ticket Scans with Booked Tickets.

Parameters

Parameter In Type Required Description
sessionId path integer(int32) true session id: integer
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Example responses

200 Response

{
  "sessionId": 0,
  "totalAttendance": 0,
  "listOfTicketScans": [
    {
      "ticketBarcode": "string",
      "ticketScanId": "string",
      "scanDateTime": "2020-06-22T10:38:40Z",
      "scanEvent": "string",
      "scanDeviceName": "string",
      "scanDeviceLocation": "string",
      "ruleId": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success TicketAttendanceScanListDto
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Get All Scans

Code samples

// using http://restsharp.org/
var client = new RestClient("https://api.trybooking.com/{region}/reporting/v1/scans/{sessionId}/all"); 
client.Authenticator = new HttpBasicAuthenticator("***", "***");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept","application/json");

IRestResponse response = client.Execute(request);
# You can also use wget
curl -X --user {username}:{password} GET https://api.trybooking.com/{region}/reporting/v1/scans/{sessionId}/all \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

var username = '4DD41AEBAE4B86B2****************';
var password = 'B7BB86660E1E767E****************'

$.ajax({
  url: 'https://api.trybooking.com/{region}/reporting/v1/scans/{sessionId}/all',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  },
  beforeSend: function (xhr) {
    xhr.setRequestHeader ("Authorization", "Basic " + btoa(username + ":" + password));
  },
})

GET /{region}/reporting/v1/scans/{sessionId}/all

Get All Ticket Scans for an Event Session ID

This API method gets All Ticket Scans (including all scan in and scan out events) for all tickets scanned at the event session. It allows you to obtain all successful scan In and Out events for all tickets at the session.

Parameters

Parameter In Type Required Description
sessionId path integer(int32) true session id: integer
region path string true TryBooking operates four systems depending on region, please enter the region of your account: AU = Australia, NZ = New Zealand, UK = United Kingdom, US = United States.

Example responses

200 Response

{
  "sessionId": 0,
  "listOfTicketScans": [
    {
      "ticketBarcode": "string",
      "ticketScanId": "string",
      "scanDateTime": "2020-06-22T10:38:40Z",
      "scanEvent": "string",
      "scanDeviceName": "string",
      "scanDeviceLocation": "string",
      "ruleId": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Success TicketScanListDto
401 Unauthorized Unauthorized None
500 Internal Server Error Internal Server Error None

Web Hook

You can setup a webhook through TryBooking Portal using the following:

  1. Notify URL

Notify URL

This endpoint is used by TryBooking to notify the Event Organizer at the end of every booking transaction.

alt text

Setting Default Notify URL

You can set the default Notify URL in Account Dashboard so that it will automatically set the Notify URL of an Event when creating new events.

Default Notify URL

Portal > Account Dashboard > Integration Tools > Notify URL

Setting Event Notify URL

You can set Notify URL of an Event through Event Dashboard:

Portal > Event Dashboard > Event Promotion > Event publication > Passwords (tab) > Notify URL (section)

Format

{YOUR-URL}?sessionId=[sessionid]&customId=[cid]&amount=[transaction-amount]&tickets=[ticket-count]&bookingId=[booking-id]&status=[status]

Sample

https://your-url.com?sessionId=[sessionid]&customId=[cid]&amount=[transaction-amount]&tickets=[ticket-count]&bookingId=[booking-id]&status=[status]

URL Properties

Property Description
[sessionid] Session ID of Event
[cid] Custom ID
[transaction-amount] Amount of the transaction
[ticket-count] Number of tickets booked
[booking-id] ID of Booking
[status] Booking status

Change policy

We may periodically make changes to this API which include but are not limited to:

Whenever we make a potentially breaking change, we will contact you via your account holder's email address if you have an API key that is being used.

Schemas

TransactionDto

{
  "transactionTypeName": "string",
  "description": "string",
  "debitAmount": 0,
  "creditAmount": 0,
  "transactionDate": "2020-06-22T10:38:40Z",
  "customerName": "string",
  "bookingURLId": "string"
}

Properties

Name Type Required Restrictions Description
transactionTypeName string|null false none none
description string|null false none none
debitAmount number(double)|null false none none
creditAmount number(double)|null false none none
transactionDate string(date-time)|null false none none
customerName string|null false none none
bookingURLId string|null false none none

AccountTransactionDto

{
  "accountId": 0,
  "pendingFundTransfer": 0,
  "balance": 0,
  "transactions": [
    {
      "transactionTypeName": "string",
      "description": "string",
      "debitAmount": 0,
      "creditAmount": 0,
      "transactionDate": "2020-06-22T10:38:40Z",
      "customerName": "string",
      "bookingURLId": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
accountId integer(int32)|null false none none
pendingFundTransfer number(double) false none none
balance number(double) false none none
transactions [TransactionDto]|null false none none

BookingDataCollectionDto

{
  "label": "string",
  "value": "string"
}

Properties

Name Type Required Restrictions Description
label string|null false none none
value string|null false none none

BookingTicketDataCollectionDto

{
  "label": "string",
  "value": "string"
}

Properties

Name Type Required Restrictions Description
label string|null false none none
value string|null false none none

TicketSeatDto

{
  "ticketBarcode": "string",
  "rowName": "string",
  "seatNumber": 0,
  "doorName": "string",
  "bookingTicketDataCollection": [
    {
      "label": "string",
      "value": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
ticketBarcode string|null false none none
rowName string|null false none none
seatNumber integer(int32)|null false none none
doorName string|null false none none
bookingTicketDataCollection [BookingTicketDataCollectionDto]|null false none none

BookingTicketDto

{
  "ticketName": "string",
  "seatQuantity": 0,
  "discountAmount": 0,
  "appliedGCOnUnitPrice": 0,
  "sessionId": 0,
  "eventEndDate": "2020-06-22T10:38:40Z",
  "eventStartDate": "2020-06-22T10:38:40Z",
  "alternateLabel": "string",
  "eventName": "string",
  "sectionName": "string",
  "eventCode": "string",
  "totalTicketPrice": 0,
  "refundedAmount": 0,
  "cardFee": 0,
  "processingFee": 0,
  "ticketFee": 0,
  "refundedCardFee": 0,
  "refundedProcessingFee": 0,
  "tax": 0,
  "refundedTax": 0,
  "isVoid": true,
  "bookingTicketDataCollections": [
    {
      "label": "string",
      "value": "string"
    }
  ],
  "ticketSeats": [
    {
      "ticketBarcode": "string",
      "rowName": "string",
      "seatNumber": 0,
      "doorName": "string",
      "bookingTicketDataCollection": [
        {
          "label": "string",
          "value": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
ticketName string|null false none none
seatQuantity integer(int32) false none none
discountAmount number(double) false none none
appliedGCOnUnitPrice number(double) false none none
sessionId integer(int32) false none none
eventEndDate string(date-time) false none none
eventStartDate string(date-time) false none none
alternateLabel string|null false none none
eventName string|null false none none
sectionName string|null false none none
eventCode string|null false none none
totalTicketPrice number(double) false none none
refundedAmount number(double) false none none
cardFee number(double) false none none
processingFee number(double) false none none
ticketFee number(double) false none none
refundedCardFee number(double) false none none
refundedProcessingFee number(double) false none none
tax number(double) false none none
refundedTax number(double) false none none
isVoid boolean false none none
bookingTicketDataCollections [BookingTicketDataCollectionDto]|null false none none
ticketSeats [TicketSeatDto]|null false none none

BookingDonationDto

{
  "value": 0,
  "eventName": "string",
  "eventId": 0,
  "fundraisingPageName": "string",
  "fundraisingPageID": 0,
  "appliedGCValue": 0,
  "cardFee": 0,
  "processingFee": 0,
  "refundedAmount": 0,
  "refundedCardFee": 0,
  "refundedProcessingFee": 0
}

Properties

Name Type Required Restrictions Description
value number(double) false none none
eventName string|null false none none
eventId integer(int32)|null false none none
fundraisingPageName string|null false none none
fundraisingPageID integer(int32)|null false none none
appliedGCValue number(double) false none none
cardFee number(double) false none none
processingFee number(double) false none none
refundedAmount number(double) false none none
refundedCardFee number(double) false none none
refundedProcessingFee number(double) false none none

BookingGiftCertificateDto

{
  "value": 0,
  "name": "string",
  "cardFee": 0,
  "processingFee": 0,
  "ticketFee": 0,
  "discountAmount": 0,
  "refundedAmount": 0,
  "refundedCardFee": 0,
  "refundedProcessingFee": 0
}

Properties

Name Type Required Restrictions Description
value number(double) false none none
name string|null false none none
cardFee number(double) false none none
processingFee number(double) false none none
ticketFee number(double) false none none
discountAmount number(double) false none none
refundedAmount number(double) false none none
refundedCardFee number(double) false none none
refundedProcessingFee number(double) false none none

BookingBoxOfficeFeeDto

{
  "boxOfficeFee": 0,
  "appliedGCValue": 0,
  "cardFee": 0,
  "processingFee": 0,
  "tax": 0,
  "refundedAmount": 0,
  "refundedCardFee": 0,
  "refundedProcessingFee": 0,
  "refundedTax": 0,
  "eventName": "string"
}

Properties

Name Type Required Restrictions Description
boxOfficeFee number(double) false none none
appliedGCValue number(double) false none none
cardFee number(double) false none none
processingFee number(double) false none none
tax number(double) false none none
refundedAmount number(double) false none none
refundedCardFee number(double) false none none
refundedProcessingFee number(double) false none none
refundedTax number(double) false none none
eventName string|null false none none

BookingDto

{
  "bookingUrlId": "string",
  "date": "2020-06-22T10:38:40Z",
  "bookingFirstName": "string",
  "bookingLastName": "string",
  "bookingEmail": "string",
  "bookingPhone": "string",
  "permissionToContact": true,
  "bookingAddress1": "string",
  "bookingAddress2": "string",
  "bookingCity": "string",
  "bookingState": "string",
  "bookingPostCode": "string",
  "bookingCountry": "string",
  "totalAmount": 0,
  "totalCardFee": 0,
  "totalProcessingFee": 0,
  "totalBoxOfficeFee": 0,
  "totalRefundedAmount": 0,
  "urlReferrer": "string",
  "customId": "string",
  "bookingDataCollections": [
    {
      "label": "string",
      "value": "string"
    }
  ],
  "bookingTickets": [
    {
      "ticketName": "string",
      "seatQuantity": 0,
      "discountAmount": 0,
      "appliedGCOnUnitPrice": 0,
      "sessionId": 0,
      "eventEndDate": "2020-06-22T10:38:40Z",
      "eventStartDate": "2020-06-22T10:38:40Z",
      "alternateLabel": "string",
      "eventName": "string",
      "sectionName": "string",
      "eventCode": "string",
      "totalTicketPrice": 0,
      "refundedAmount": 0,
      "cardFee": 0,
      "processingFee": 0,
      "ticketFee": 0,
      "refundedCardFee": 0,
      "refundedProcessingFee": 0,
      "tax": 0,
      "refundedTax": 0,
      "isVoid": true,
      "bookingTicketDataCollections": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "ticketSeats": [
        {
          "ticketBarcode": "string",
          "rowName": "string",
          "seatNumber": 0,
          "doorName": "string",
          "bookingTicketDataCollection": [
            {
              "label": "string",
              "value": "string"
            }
          ]
        }
      ]
    }
  ],
  "bookingDonations": [
    {
      "value": 0,
      "eventName": "string",
      "eventId": 0,
      "fundraisingPageName": "string",
      "fundraisingPageID": 0,
      "appliedGCValue": 0,
      "cardFee": 0,
      "processingFee": 0,
      "refundedAmount": 0,
      "refundedCardFee": 0,
      "refundedProcessingFee": 0
    }
  ],
  "bookingGiftCertificates": [
    {
      "value": 0,
      "name": "string",
      "cardFee": 0,
      "processingFee": 0,
      "ticketFee": 0,
      "discountAmount": 0,
      "refundedAmount": 0,
      "refundedCardFee": 0,
      "refundedProcessingFee": 0
    }
  ],
  "bookingBoxOfficeFees": [
    {
      "boxOfficeFee": 0,
      "appliedGCValue": 0,
      "cardFee": 0,
      "processingFee": 0,
      "tax": 0,
      "refundedAmount": 0,
      "refundedCardFee": 0,
      "refundedProcessingFee": 0,
      "refundedTax": 0,
      "eventName": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
bookingUrlId string|null false none none
date string(date-time) false none none
bookingFirstName string|null false none none
bookingLastName string|null false none none
bookingEmail string|null false none none
bookingPhone string|null false none none
permissionToContact boolean false none none
bookingAddress1 string|null false none none
bookingAddress2 string|null false none none
bookingCity string|null false none none
bookingState string|null false none none
bookingPostCode string|null false none none
bookingCountry string|null false none none
totalAmount number(double) false none none
totalCardFee number(double) false none none
totalProcessingFee number(double) false none none
totalBoxOfficeFee number(double) false none none
totalRefundedAmount number(double) false none none
urlReferrer string|null false none none
customId string|null false none none
bookingDataCollections [BookingDataCollectionDto]|null false none none
bookingTickets [BookingTicketDto]|null false none none
bookingDonations [BookingDonationDto]|null false none none
bookingGiftCertificates [BookingGiftCertificateDto]|null false none none
bookingBoxOfficeFees [BookingBoxOfficeFeeDto]|null false none none

EventImageDto

{
  "imageFileName": "string",
  "purpose": "string",
  "imageOrder": 0
}

Properties

Name Type Required Restrictions Description
imageFileName string|null false none none
purpose string|null false none none
imageOrder integer(int32) false none none

EventSessionDto

{
  "eventStartDate": "2020-06-22T10:38:40Z",
  "eventEndDate": "2020-06-22T10:38:40Z",
  "bookingStartDate": "2020-06-22T10:38:40Z",
  "bookingEndDate": "2020-06-22T10:38:40Z",
  "alternateLabel": "string",
  "description": "string",
  "id": 0,
  "sessionStatus": "string",
  "sessionCapacity": 0,
  "sessionAvailability": 0,
  "sessionBookingUrl": "string"
}

Properties

Name Type Required Restrictions Description
eventStartDate string(date-time) false none none
eventEndDate string(date-time) false none none
bookingStartDate string(date-time) false none none
bookingEndDate string(date-time) false none none
alternateLabel string|null false none none
description string|null false none none
id integer(int32) false none none
sessionStatus string|null false none none
sessionCapacity integer(int32) false none none
sessionAvailability integer(int32) false none none
sessionBookingUrl string|null false none none

AccountEventListDto

{
  "name": "string",
  "eventCode": "string",
  "description": "string",
  "venue": "string",
  "venueLatitude": "string",
  "venueLongitude": "string",
  "onlineEventLink": "string",
  "contactName": "string",
  "contactEmail": "string",
  "contactNumber": "string",
  "isPublic": true,
  "allowWaitingList": true,
  "timeZone": "string",
  "bookingUrl": "string",
  "homepageTemplate": "string",
  "isOpen": true,
  "listOfImages": [
    {
      "imageFileName": "string",
      "purpose": "string",
      "imageOrder": 0
    }
  ],
  "sessionList": [
    {
      "eventStartDate": "2020-06-22T10:38:40Z",
      "eventEndDate": "2020-06-22T10:38:40Z",
      "bookingStartDate": "2020-06-22T10:38:40Z",
      "bookingEndDate": "2020-06-22T10:38:40Z",
      "alternateLabel": "string",
      "description": "string",
      "id": 0,
      "sessionStatus": "string",
      "sessionCapacity": 0,
      "sessionAvailability": 0,
      "sessionBookingUrl": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string|null false none none
eventCode string|null false none none
description string|null false none none
venue string|null false none none
venueLatitude string|null false none none
venueLongitude string|null false none none
onlineEventLink string|null false none none
contactName string|null false none none
contactEmail string|null false none none
contactNumber string|null false none none
isPublic boolean false none none
allowWaitingList boolean false none none
timeZone string|null false none none
bookingUrl string|null false none none
homepageTemplate string|null false none none
isOpen boolean false none none
listOfImages [EventImageDto]|null false none none
sessionList [EventSessionDto]|null false none none

SessionAvailabilityDto

{
  "eventStartDate": "2020-06-22T10:38:40Z",
  "eventEndDate": "2020-06-22T10:38:40Z",
  "bookingStartDate": "2020-06-22T10:38:40Z",
  "bookingEndDate": "2020-06-22T10:38:40Z",
  "alternateLabel": "string",
  "description": "string",
  "id": 0,
  "eventId": 0,
  "sessionStatus": "string",
  "sessionCapacity": 0,
  "sessionAvailability": 0,
  "sessionBookingUrl": "string"
}

Properties

Name Type Required Restrictions Description
eventStartDate string(date-time) false none none
eventEndDate string(date-time) false none none
bookingStartDate string(date-time) false none none
bookingEndDate string(date-time) false none none
alternateLabel string|null false none none
description string|null false none none
id integer(int32) false none none
eventId integer(int32) false none none
sessionStatus string|null false none none
sessionCapacity integer(int32) false none none
sessionAvailability integer(int32) false none none
sessionBookingUrl string|null false none none

FundraisingImageDto

{
  "imageFileName": "string",
  "purpose": "string"
}

Properties

Name Type Required Restrictions Description
imageFileName string|null false none none
purpose string|null false none none

FundraisingDto

{
  "fundraisingPageName": "string",
  "fundraisingPageId": 0,
  "description": "string",
  "contactEmail": "string",
  "isActive": true,
  "presetDonationValues": [
    0
  ],
  "listOfImages": [
    {
      "imageFileName": "string",
      "purpose": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
fundraisingPageName string|null false none none
fundraisingPageId integer(int32) false none none
description string|null false none none
contactEmail string|null false none none
isActive boolean false none none
presetDonationValues [integer]|null false none none
listOfImages [FundraisingImageDto]|null false none none

TicketSalesDto

{
  "ticketName": "string",
  "transactionDate": "2020-06-22T10:38:40Z",
  "totalBookings": 0,
  "totalSold": 0,
  "totalSales": 0,
  "trend": "string"
}

Properties

Name Type Required Restrictions Description
ticketName string|null false none none
transactionDate string(date-time) false none none
totalBookings integer(int32) false none none
totalSold integer(int32) false none none
totalSales number(double) false none none
trend string|null false none none

BookingSalesDto

{
  "transactionDate": "2020-06-22T10:38:40Z",
  "totalBookings": 0,
  "totalSold": 0,
  "totalSales": 0,
  "trend": "string"
}

Properties

Name Type Required Restrictions Description
transactionDate string(date-time) false none none
totalBookings integer(int32) false none none
totalSold integer(int32) false none none
totalSales number(double) false none none
trend string|null false none none

EventSalesDto

{
  "eventName": "string",
  "transactionDate": "2020-06-22T10:38:40Z",
  "totalBookings": 0,
  "totalSold": 0,
  "totalSales": 0,
  "trend": "string"
}

Properties

Name Type Required Restrictions Description
eventName string|null false none none
transactionDate string(date-time) false none none
totalBookings integer(int32) false none none
totalSold integer(int32) false none none
totalSales number(double) false none none
trend string|null false none none

FundraisingSalesDto

{
  "fundraisingPageName": "string",
  "totalTransactions": 0,
  "totalSales": 0,
  "transactionDate": "2020-06-22T10:38:40Z",
  "trend": "string"
}

Properties

Name Type Required Restrictions Description
fundraisingPageName string|null false none none
totalTransactions integer(int32) false none none
totalSales number(double) false none none
transactionDate string(date-time) false none none
trend string|null false none none

TicketScanDto

{
  "ticketBarcode": "string",
  "ticketScanId": "string",
  "scanDateTime": "2020-06-22T10:38:40Z",
  "scanEvent": "string",
  "scanDeviceName": "string",
  "scanDeviceLocation": "string",
  "ruleId": 0
}

Properties

Name Type Required Restrictions Description
ticketBarcode string|null false none none
ticketScanId string|null false none none
scanDateTime string(date-time)|null false none none
scanEvent string|null false none none
scanDeviceName string|null false none none
scanDeviceLocation string|null false none none
ruleId integer(int32)|null false none none

TicketAttendanceScanListDto

{
  "sessionId": 0,
  "totalAttendance": 0,
  "listOfTicketScans": [
    {
      "ticketBarcode": "string",
      "ticketScanId": "string",
      "scanDateTime": "2020-06-22T10:38:40Z",
      "scanEvent": "string",
      "scanDeviceName": "string",
      "scanDeviceLocation": "string",
      "ruleId": 0
    }
  ]
}

Properties

Name Type Required Restrictions Description
sessionId integer(int32) false none none
totalAttendance integer(int32) false read-only none
listOfTicketScans [TicketScanDto]|null false none none

TicketScanListDto

{
  "sessionId": 0,
  "listOfTicketScans": [
    {
      "ticketBarcode": "string",
      "ticketScanId": "string",
      "scanDateTime": "2020-06-22T10:38:40Z",
      "scanEvent": "string",
      "scanDeviceName": "string",
      "scanDeviceLocation": "string",
      "ruleId": 0
    }
  ]
}

Properties

Name Type Required Restrictions Description
sessionId integer(int32) false none none
listOfTicketScans [TicketScanDto]|null false none none