GET Bookings by id

Overview

Retrieve booking by Id

Request

GET /Bookings/[id]

Request Information

Request Parameters

Name
Type
Requirement
Description
id
Integer
Mandatory 
ID of the booking 
 •	Included – Retrieve individual booking 
 •	Not Included - Retrieve up to 100 closest bookings in the future, sorted by departure date

Response Information

Response Properties

Name
Type
Description
status
String
Status of booking: 
•	incomplete
 Booking has not yet been finalised prior to departure 
•	complete
 Booking has been finalised prior to departure 
•	cancelled 
 Booking and all of its components have been cancelled
emailAddress
String
Web access email for booking
currency
String
Currency
depositAmount
Decimal
Deposit amount
depositDueDate
String
Deposit due date (if this exceeds the outstanding balance due date, then outstanding balance due date will be returned)
commission
Decimal
Commission paid by Intrepid to buying agent
totalGrossAmount
Decimal
Total cost paid by purchaser for booking
totalNetAmount
Decimal
Total gross amount minus commission paid to the buying agent
outstandingBalance
Decimal
Outstanding net balance amount
grossOutstandingBalance
Decimal
Outstanding gross balance amount
netOutstandingBalance
Decimal
Outstanding net balance amount
amountPaid
Decimal
Amount paid
outstandingBalanceDueDate
String
Outstanding balance due date
dateOfFirstTravel
String
Date of first travel
customers
HrefWrapper
URI used to retrieve all customers on booking
trips
HrefWrapper
URI used to retrieve all trips on booking
accommodation
HrefWrapper
URI used to retrieve all accommodation on booking
transfers
HrefWrapper
URI used to retrieve all transfers on booking
sightseeing
HrefWrapper
URI used to retrieve all sightseeing on booking
additionalServices
HrefWrapper
URI used to retrieve all additional services on booking
leadPaxName
String
Lead Pax Name
travelConsultantName
String
Travel Consultant Name
lastTravelDate
String
Date of last travel
paxCount
Integer
Number of customers in Booking
invoices
HrefWrapper
URI to get the latest Invoice for the booking
payments
HrefWrapper
URI to get the list of payments for the booking or the customer
flights
HrefWrapper
URI to get the latest Flight for the booking
lastUpdatedDate
String
Last updated date
travelConsultantFirstName
String
Travel Consultant First Name
travelConsultantSurname
String
Travel Consultant Surname
buyingAgent
HrefWrapper
URI to get the buying agent in the booking
buyingAgentName
String
Buying Agent Name
storeAgentName
String
Store Agent Name (only applicable for wholesale transactions)
agentReferenceNumber
String
Agent's reference number
groupPaymentFlag
Boolean
Group Payments enabled for the booking
insurance
HrefWrapper
URI to get the latest insurance for the booking
starshipItineraryNotesAvailable
Boolean
Check Starship notes are available
starshipItineraryNotes
HrefWrapper
URI to get the starship itinerary notes for the booking
elementsItineraryNotesAvailable
Boolean
Check Elements notes are available
elementsItineraryNotes
HrefWrapper
URI to get the elements itinerary notes for the booking
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Customers

Name
Type
Description
href
String
URI of the resource

Trips

Name
Type
Description
href
String
URI of the resource

Accommodation

Name
Type
Description
href
String
URI of the resource

Transfers

Name
Type
Description
href
String
URI of the resource

Sightseeing

Name
Type
Description
href
String
URI of the resource

Additionalservices

Name
Type
Description
href
String
URI of the resource

Invoices

Name
Type
Description
href
String
URI of the resource

Payments

Name
Type
Description
href
String
URI of the resource

Flights

Name
Type
Description
href
String
URI of the resource

Buyingagent

Name
Type
Description
href
String
URI of the resource

Insurance

Name
Type
Description
href
String
URI of the resource

Starshipitinerarynotes

Name
Type
Description
href
String
URI of the resource

Elementsitinerarynotes

Name
Type
Description
href
String
URI of the resource

Response Codes

HTTP status code
Description
200 OK
The resource was retrieved successfully
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server
304 Not Modified
When including the If-Modified-Since HTTP header with a timestamp in UTC . Timestamp format : 2018-08-24T08:55:09.000Z

Response Example

{
  "status": "Incompelete",
  "emailAddress": "sample@sample.com",
  "currency": "aud",
  "depositAmount": 12.5,
  "depositDueDate": "2017-08-25",
  "commission": 10,
  "totalGrossAmount": 2400.5,
  "totalNetAmount": 200.0,
  "outstandingBalance": 10,
  "grossOutstandingBalance": 10,
  "netOutstandingBalance": 10,
  "amountPaid": 3,
  "outstandingBalanceDueDate": "2018-07-12",
  "dateOfFirstTravel": "2017-08-29",
  "customers": {
    "href": "/bookings/5057123/customers"
  },
  "trips": {
    "href": "/bookings/5057123/trips"
  },
  "accommodation": {
    "href": "/bookings/5057123/accommodation"
  },
  "transfers": {
    "href": "/bookings/5057123/transfers"
  },
  "sightseeing": {
    "href": "/bookings/5057123/sightseeing"
  },
  "additionalServices": {
    "href": "/bookings/5057123/additonalservices"
  },
  "leadPaxName": "Homer Simpson",
  "travelConsultantName": "Phil Maye",
  "lastTravelDate": "2017-09-10",
  "paxCount": 3,
  "invoices": {
    "href": "/bookings/5057123/invoices"
  },
  "payments": {
    "href": "/bookings/5057123/payments"
  },
  "flights": {
    "href": "/bookings/5057123/flights"
  },
  "lastUpdatedDate": "2017-08-25",
  "travelConsultantFirstName": "Phil",
  "travelConsultantSurname": "Maye",
  "buyingAgent": {
    "href": "/agent/67416620"
  },
  "buyingAgentName": "Test Buying Agent",
  "storeAgentName": "Test Store Agent",
  "agentReferenceNumber": "ABC123",
  "groupPaymentFlag": "true",
  "insurance": {
    "href": "/bookings/5057123/insurance"
  },
  "starshipItineraryNotesAvailable": "true",
  "starshipItineraryNotes": {
    "href": "/Bookings/7482881/Note?AllItineraryNotes=true"
  },
  "elementsItineraryNotesAvailable": "true",
  "elementsItineraryNotes": {
    "href": "/Bookings/7482881/Note?AllElementsItineraryNotes=true"
  },
  "id": 887124,
  "href": "bookings/887124",
  "sequence": "202403312359580000"
}