> ## Documentation Index
> Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a booking's information

> Returns a booking's header under `order`.

Returns the booking's header details, such as `name`, `description`, `status` and `account`, under `order`.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md).


## OpenAPI

````yaml GET /booking/{booking_id}/information
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /booking/{booking_id}/information:
    get:
      tags:
        - Bookings
      summary: Retrieve a booking's information
      description: >-
        Returns the booking's header details, such as `name`, `description`,
        `status` and `account`, under `order`.
      operationId: bookings_get_booking_information
      parameters:
        - name: booking_id
          in: path
          required: true
          description: >-
            The booking's `id`. Any order's `id` works here, whatever the
            order's type.
          schema:
            type: string
      responses:
        '200':
          description: The booking, under `order`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BookingResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X GET
            "$EXSITED_BASE_URL/api/v4/booking/BOOKING_ID/information" \
              -H "Authorization: Bearer $ACCESS_TOKEN"
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.bookings.get_booking_information("BOOKING_ID")
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: >
            import {buildClient} from 'exsited';


            const client = await buildClient();


            const response = await
            client.bookings.getBookingInformation('BOOKING_ID');

            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->bookings->getBookingInformation('BOOKING_ID');
            print_r($response->data);
        - lang: java
          label: Java
          source: >
            import com.exsited.client.ApiResponse;

            import com.exsited.client.ClientRegistry;

            import com.exsited.client.ExsitedClient;

            import
            com.exsited.resources.bookings.bookings_dto.BookingsDto.BookingById;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<BookingById> response =
            client.bookings().getBookingInformation("BOOKING_ID");

            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await
            client.Bookings.GetBookingInformationAsync("BOOKING_ID");


            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: >
            import 'package:exsited/exsited.dart';


            final client = buildClient();


            final response = await
            client.bookings.getBookingInformation('BOOKING_ID');

            print(response.map);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.Bookings().GetBookingInformation(context.Background(), \"BOOKING_ID\", nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    BookingResponse:
      type: object
      required:
        - order
      properties:
        order:
          $ref: '#/components/schemas/BookingById'
    BookingById:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/BookingByIdAccount'
        activity_logs:
          type: array
          description: Returned by the writes, not by the reads, and empty.
        allow_contract:
          type: boolean
        billing_address:
          $ref: '#/components/schemas/BookingByIdBillingAddress'
        billing_preferences:
          $ref: '#/components/schemas/BookingByIdBillingPreferences'
        billing_start_date:
          type: string
        communication_preferences:
          type: array
          items:
            $ref: '#/components/schemas/BookingByIdCommunicationPreference'
        created_by:
          type: 'null'
          description: Returned as `null`.
        created_on:
          type: string
        currency:
          $ref: '#/components/schemas/BookingByIdCurrency'
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/BookingByIdCustomAttribute'
        custom_form:
          $ref: '#/components/schemas/BookingByIdCustomForm'
        customer_purchase_order_id:
          type: string
        description:
          type: string
        discount_profile:
          type: 'null'
          description: Returned as `null`.
        display_name:
          type: string
        id:
          type: string
        invoice_note:
          type: string
        kpis:
          $ref: '#/components/schemas/BookingByIdKpis'
        last_updated_by:
          type: 'null'
          description: Returned as `null`.
        last_updated_on:
          type: string
        lines:
          type: array
          items:
            $ref: '#/components/schemas/BookingByIdLine'
        manager:
          $ref: '#/components/schemas/BookingByIdManager'
        name:
          type: string
        next_billing_from_date:
          type: string
        next_billing_from_date_utc:
          type: string
        object:
          type: string
        order_start_date:
          type: string
        order_type:
          type: string
        origin:
          type: string
        original_total:
          type: 'null'
          description: Returned as `null`.
        pre_order:
          type: boolean
        price_tax_inclusive:
          type: boolean
        quote_converted:
          type: boolean
        quote_order:
          type: boolean
        referral_account:
          type: 'null'
          description: Returned as `null`.
        sales_rep:
          type: 'null'
          description: Returned as `null`.
        shipping_address:
          type: 'null'
          description: Returned as `null`.
        shipping_cost:
          type: number
        shipping_line_items:
          type: array
        shipping_profile:
          type: 'null'
          description: Returned as `null`.
        status:
          type: string
        subtotal:
          type: string
        tax:
          type: string
        time_zone:
          $ref: '#/components/schemas/BookingByIdTimeZone'
        total:
          type: string
        version:
          type: integer
    BookingByIdAccount:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    BookingByIdBillingAddress:
      type: object
      properties:
        address_line_1:
          type: string
        address_line_2:
          type: string
        address_line_3:
          type: 'null'
          description: Returned as `null`.
        address_line_4:
          type: 'null'
          description: Returned as `null`.
        address_line_5:
          type: 'null'
          description: Returned as `null`.
        city:
          type: string
        country:
          type: string
        name:
          type: string
        postal_code:
          type: string
        state:
          type: string
    BookingByIdBillingPreferences:
      type: object
      properties:
        billing_period:
          type: string
        communication_profile:
          type: string
        consolidate_invoice:
          type: boolean
        fulfillment_mode:
          type: string
        fulfillment_term:
          type: string
        invoice_mode:
          type: string
        invoice_term:
          type: string
        payment_mode:
          type: string
        payment_processor:
          type: string
        payment_term:
          type: string
        payment_term_alignment:
          type: string
        proforma_properties:
          $ref: '#/components/schemas/BookingByIdBillingPreferencesProformaProperties'
    BookingByIdCommunicationPreference:
      type: object
      properties:
        channel:
          type: string
        enabled:
          type: boolean
    BookingByIdCurrency:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
    BookingByIdCustomAttribute:
      type: object
      properties:
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
        type:
          type: string
        value:
          type:
            - string
            - array
          description: A string or a list; both appear in responses.
    BookingByIdCustomForm:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    BookingByIdKpis:
      type: object
      properties:
        deleted_at:
          type: 'null'
          description: Returned as `null`.
        estimated_total:
          type: string
        last_cancelled_at:
          type: 'null'
          description: Returned as `null`.
        last_changed_at:
          type: 'null'
          description: Returned as `null`.
        last_invoice_issue_date:
          type: 'null'
          description: Returned as `null`.
        last_invoice_total:
          type: string
        last_reactivated_at:
          type: 'null'
          description: Returned as `null`.
        monthly_recurring_revenue:
          type: string
        next_invoice_issue_date:
          type: 'null'
          description: Returned as `null`.
        object:
          type: string
        start_date:
          type: 'null'
          description: Returned as `null`.
        total_collected:
          type: string
        total_due:
          type: string
        total_invoice:
          type: integer
        total_outstanding:
          type: string
        total_revenue:
          type: string
    BookingByIdLine:
      type: object
      properties:
        charge_item_uuid:
          type: string
        expected_delivery_date:
          type: string
        id:
          type: string
        item:
          $ref: '#/components/schemas/BookingByIdLineItem'
        item_accounting_code:
          $ref: '#/components/schemas/BookingByIdLineItemAccountingCode'
        item_charge_type:
          type: string
        item_custom_attributes:
          type: array
        item_description:
          type: string
        item_invoice_note:
          type: string
        item_order_quantity:
          type: integer
        item_price_snapshot:
          $ref: '#/components/schemas/BookingByIdLineItemPriceSnapshot'
        item_price_tax:
          $ref: '#/components/schemas/BookingByIdLineItemPriceTax'
        item_properties:
          $ref: '#/components/schemas/BookingByIdLineItemProperties'
        item_sale_tax_configuration:
          $ref: '#/components/schemas/BookingByIdLineItemSaleTaxConfiguration'
        item_type:
          type: string
        object:
          type: string
        pre_order_stock_details:
          $ref: '#/components/schemas/BookingByIdLinePreOrderStockDetails'
        shipping_cost:
          type: number
        subtotal:
          type: string
        tax:
          type: string
        tax_exempt_when_sold:
          type: boolean
        total:
          type: string
        version:
          type: integer
    BookingByIdManager:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    BookingByIdTimeZone:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    BookingByIdBillingPreferencesProformaProperties:
      type: object
      properties:
        acceptance_date:
          type: 'null'
          description: Returned as `null`.
        acceptance_required:
          type: boolean
        acceptance_term:
          type: 'null'
          description: Returned as `null`.
        payment_required:
          type: boolean
        terms_and_conditions:
          type: 'null'
          description: Returned as `null`.
    BookingByIdLineItem:
      type: object
      properties:
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
        uuid:
          type: string
    BookingByIdLineItemAccountingCode:
      type: object
      properties:
        sales_revenue:
          description: Any JSON value.
    BookingByIdLineItemPriceSnapshot:
      type: object
      properties:
        pricing_rule:
          $ref: '#/components/schemas/BookingByIdLineItemPriceSnapshotPricingRule'
    BookingByIdLineItemPriceTax:
      type: object
      properties:
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
        rate:
          type: number
    BookingByIdLineItemProperties:
      type: object
      properties:
        billing_mode:
          type: string
        charging_and_billing_alignment:
          type: string
        charging_start_date:
          type: string
        pro_rata_partial_pricing_period:
          type: string
    BookingByIdLineItemSaleTaxConfiguration:
      type: object
      properties:
        sale_price_is_based_on:
          type: string
        tax_code:
          $ref: '#/components/schemas/BookingByIdLineItemSaleTaxConfigurationTaxCode'
    BookingByIdLinePreOrderStockDetails:
      type: object
      properties:
        pending_reserve:
          type: string
        reserved:
          type: string
        sold:
          type: string
    BookingByIdLineItemPriceSnapshotPricingRule:
      type: object
      properties:
        price:
          type: number
        price_period:
          type: string
        price_type:
          type: string
        pricing_level:
          type: string
        pricing_method:
          type: string
        pricing_schedule:
          type: string
        uom:
          type: string
        uuid:
          type: string
        version:
          type: string
        warehouse:
          type: string
    BookingByIdLineItemSaleTaxConfigurationTaxCode:
      type: object
      properties:
        code:
          type: string
        link:
          type: string
        rate:
          type:
            - string
            - number
        uuid:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.