Bookings

Get Bookings

get

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Query parameters

FilterstringOptional

Filter the results. See developer resources for more information

Example: name eq 'Adam' and age gt 20

OrderBystringOptional

Sorting the results. See developer resources for more information

Example: accountNumber Desc

ModifiedAfterstring · date-timeOptional

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 2025-12-01

ModifiedBeforestring · date-timeOptional

Filter is also applied on sub entities: 'bookingLines'

Example: 2025-12-01

PageSizeinteger · int32Optional

Page Size

Example: 20

PageNumberinteger · int32Optional

Page Number

Example: 1

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get

/Bookings

HTTPcURLJavaScriptPython

GET /Bookings HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "currency": "text",
      "bookingType": "New",
      "accountCategory": "New",
      "changeType": "Upsell",
      "cmrr": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "acv": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "emrr": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "oneTimeFees": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "tcv": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "fmrr": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "effectiveDate": "2025-12-12T22:09:45.493Z",
      "bookingLines": [
        {
          "charge": {
            "name": "text",
            "chargeNumber": "OPC-000001",
            "description": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-12T22:09:45.493Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-12T22:09:45.493Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-12T22:09:45.493Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-12T22:09:45.493Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-12T22:09:45.493Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "fmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-12T22:09:45.493Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "created": "2025-12-12T22:09:45.493Z",
          "modified": "2025-12-12T22:09:45.493Z"
        }
      ],
      "classification": {
        "name": "text",
        "description": "text",
        "chartColor": "text",
        "isSystemClassification": true,
        "classificationType": "NewCustomer"
      },
      "created": "2025-12-12T22:09:45.493Z",
      "modified": "2025-12-12T22:09:45.493Z",
      "order": {
        "orderNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "notes": "text"
    }
  ]
}

Get Bookings by Id

get

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

get

/Bookings/{id}

HTTPcURLJavaScriptPython

GET /Bookings/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "currency": "text",
  "bookingType": "New",
  "accountCategory": "New",
  "changeType": "Upsell",
  "cmrr": {
    "amount": 1,
    "amountInBaseCurrency": 1
  },
  "acv": {
    "amount": 1,
    "amountInBaseCurrency": 1
  },
  "emrr": {
    "amount": 1,
    "amountInBaseCurrency": 1
  },
  "oneTimeFees": {
    "amount": 1,
    "amountInBaseCurrency": 1
  },
  "tcv": {
    "amount": 1,
    "amountInBaseCurrency": 1
  },
  "fmrr": {
    "amount": 1,
    "amountInBaseCurrency": 1
  },
  "effectiveDate": "2025-12-12T22:09:45.493Z",
  "bookingLines": [
    {
      "charge": {
        "name": "text",
        "chargeNumber": "OPC-000001",
        "description": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-12T22:09:45.493Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-12T22:09:45.493Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-12T22:09:45.493Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-12T22:09:45.493Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-12T22:09:45.493Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "fmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-12T22:09:45.493Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "created": "2025-12-12T22:09:45.493Z",
      "modified": "2025-12-12T22:09:45.493Z"
    }
  ],
  "classification": {
    "name": "text",
    "description": "text",
    "chartColor": "text",
    "isSystemClassification": true,
    "classificationType": "NewCustomer"
  },
  "created": "2025-12-12T22:09:45.493Z",
  "modified": "2025-12-12T22:09:45.493Z",
  "order": {
    "orderNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "notes": "text"
}

---