Endpoint
GET /bookingsAuthentication
Required: Authorization header with valid token
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| contractId | string | No | Filter by contract ID | 550e8400-e29b-41d4-a716-446655440000 |
| entityId | string | No | Filter by entity ID (equipment/inventory) | 123e4567-e89b-12d3-a456-426614174000 |
| search | string | No | Search in contract title and contract number (case-insensitive) | Contract-2024 |
| statuses | string | No | Filter by booking status (comma-separated: RESERVED, PLANNED, IN_PROGRESS, COMPLETED) | RESERVED,IN_PROGRESS |
| clientIds | string | No | Filter by client IDs (comma-separated) | clientId1,clientId2 |
| bookingIds | string | No | Filter by specific booking IDs (comma-separated) | uuid1,uuid2 |
| startDate | date-time | No | Filter bookings that start on or after this date | 2024-01-01T00:00:00Z |
| endDate | date-time | No | Filter entities that end on or before this date | 2024-12-31T23:59:59Z |
| startDateGte | date-time | No | Filter entities where startDate is more than or equal to this date | 2024-06-01T00:00:00Z |
| startDateLte | date-time | No | Filter entities where startDate is less than or equal to this date | 2024-06-01T00:00:00Z |
| endDateGte | date-time | No | Filter entities where endDate is greater than or equal to this date | 2024-06-01T00:00:00Z |
| endDateLte | date-time | No | Filter entities where endDate is less than or equal to this date | 2024-06-01T00:00:00Z |
| overlapStartDate | date-time | No | Start of overlap range. Use together with overlapEndDate | 2024-04-01T00:00:00Z |
| overlapEndDate | date-time | No | End of overlap range. Use together with overlapStartDate | 2024-04-30T23:59:59Z |
| invoiceStartDate | date-time | No | Billing period start date for invoice filtering | 2024-01-01T00:00:00Z |
| invoiceEndDate | date-time | No | Billing period end date for invoice filtering | 2024-03-31T23:59:59Z |
| updatedAfter | date-time | No | Filter bookings updated on or after this date | 2024-01-01T00:00:00Z |
| warehouseId | string | No | Filter bookings that have this warehouseId in their warehouseDistribution with quantity > 0 | 123e4567-e89b-12d3-a456-426614174000 |
| hasFinalReturn | boolean | No | Filter entities by whether all warehouse returns are partial. | false |
| sortBy | string | No | Field to sort by (contractName, startDate, endDate, updatedAt) | updatedAt |
| sortDirection | string | No | Sort direction (ASC or DESC, default: ASC) | DESC |
| page | number | No | Page number (default: 1) | 1 |
| limit | number | No | Items per page (default: 20) | 20 |
| expand | string | No | Expand entity with passed comma separated relation entities | releases,contract,attachedProducts |
Response
Success (200)
{
"content": [
"BookingEntity"
],
"total": "number"
}Response Field Descriptions:
content- Array of booking objects (BookingEntity Schema)total- Total number of bookings matching the query criteria
Error
See Error Schema documentation
Example Usage
Bash
curl -X GET "https://integration-api.ram.syniotec.com/master-data/v1/booking-management/bookings" \
-H "Authorization: Bearer YOUR_TOKEN"