Skip to navigation

Push Bus Booking

View as Markdown

Push Bus Booking

Records a bus booking made outside Dice and links it to the employee’s trip.

Request Parameters

ParamRequiredDescription
bookingMandatoryBooking details. Mandatory.
booking.transIdMandatoryYour unique booking reference (e.g. TMC booking id). Must be unique in your company – it is used to fetch and cancel the booking.
booking.bookingAmountMandatoryTotal amount paid for the booking. Must be greater than 0.
booking.bookingDateMandatoryWhen the booking was made. Epoch time in milliseconds (UTC).
booking.currencyOptionalISO-4217 currency code of bookingAmount. Defaults to the employee’s currency.
booking.employeeCodeConditionalEmployee code of the booking owner. One of employeeCode or employeeEmail is mandatory; the code wins if both are sent.
booking.employeeEmailConditionalEmail of the booking owner. Used when employeeCode is not sent.
booking.passengers[]MandatoryTravellers on this booking. Mandatory – at least one.
booking.passengers[].nameMandatoryPassenger full name.
booking.passengers[].emailMandatoryPassenger email.
booking.passengers[].employeeCodeOptionalPassenger’s employee code, if an employee.
booking.passengers[].mobileOptionalMobile number.
booking.passengers[].genderOptionalGender. Validated only for non-employee passengers. Values: MALE, FEMALE.
booking.passengers[].seatNoOptionalSeat / berth number.
booking.tripIdOptionalDice trip reference to attach the booking to. Optional – if omitted, Dice tries to match one of the owner’s open trips automatically.
booking.tripItineraryIdOptionalItinerary (leg) id from Trip Details to attach the booking to. Only used together with tripId.
booking.vendorNameOptionalVendor / agency name shown as the merchant. Defaults to the airline, hotel or bus operator name.
booking.remarkOptionalFree-text remark.
booking.ticketPdfOptionalPublicly accessible URL of the ticket / voucher PDF.
booking.invoicePdfOptionalPublicly accessible URL of the invoice PDF.
booking.invoiceOptionalTax invoice details of the booking (for GST reporting).
booking.invoice.invoiceNoOptionalInvoice number.
booking.invoice.invoiceDateOptionalInvoice date. Epoch time in milliseconds (UTC).
booking.invoice.vendorGstinOptionalVendor / supplier GSTIN.
booking.invoice.hsnOptionalHSN / SAC code.
booking.invoice.baseAmountOptionalTaxable value.
booking.invoice.cgstOptionalCGST amount.
booking.invoice.sgstOptionalSGST amount.
booking.invoice.igstOptionalIGST amount.
booking.invoice.totalTaxOptionalTotal tax.
booking.gstDetailsOptionalGST details of the billing entity.
booking.gstDetails.gstNumberOptionalCompany GSTIN used for the booking.
booking.gstDetails.companyNameOptionalRegistered company name.
booking.gstDetails.companyAddressOptionalRegistered address.
booking.gstDetails.emailAddressOptionalGST contact email.
booking.gstDetails.mobileNumberOptionalGST contact number.
booking.pnrMandatoryBus ticket PNR.
booking.operatorNameMandatoryBus operator name.
booking.departureCityMandatoryBoarding city name (IATA codes are not accepted for bus).
booking.arrivalCityMandatoryDestination city name.
booking.journeyDateMandatoryDeparture date & time. Epoch time in milliseconds (UTC).
booking.arrivalDateOptionalArrival date & time. Epoch time in milliseconds (UTC).
booking.busTypeOptionalBus type.
booking.boardingPointOptionalBoarding point. Defaults to the departure city.
booking.droppingPointOptionalDropping point. Defaults to the arrival city.

Headers

DICE-APP-IDstringOptional
Company Code of client
X-CLIENT-IDstringOptional
API Client ID
X-CLIENT-SECRETstringOptional
API Client Secret

Request

Request body. All booking fields are wrapped in booking.

bookingobjectRequired

Booking details. Mandatory.

Response

OK
successboolean

Always true on HTTP 200.

transIdstring
Your booking reference.
transactionIdlong
Internal Dice transaction id.
taggedboolean

true when the booking was attached to a trip.

tripIdstringOptional

Trip the booking was attached to (absent when not attached).

tripItineraryIdstringOptional

Itinerary leg the booking was attached to (absent when only the trip matched).