Get Single Reservation

GET 
/api/reservations/:id

Get Single Reservation

Request

Path Parameters

id integerrequired

Header Parameters

X-Company-Slug stringrequired

Responses

200

Successful response

application/json

Schema

Schema

id string
code string
customer_id string
created_by_id string
updated_by_id string
notes stringnullable
total float
starting_at date-time
finishing_at date-time
created_at date-time
updated_at date-time
status ReservationStatusEnum (string)

Possible values: [new, accepted, cancelled, no-show, success]

customer

object

id string

name string

surname stringnullable

type ContactTypeEnum (string)nullable

Possible values: [vendor, customer]

email emailnullable

phone phonenullable

gender ContactGenderEnum (string)nullable

Possible values: [male, female, other]

birthdate datenullable

address stringnullable

custom_fields objectnullable

created_at date-time

updated_at date-time

default_photo_id numbernullable

services

object[]

Array [

id string

reservation_id string

employee_id string

service_id string

price float

quantity integer

estimated_time integer

starting_at date-time

finishing_at date-time

is_bound boolean

service

object

id string

name string

slug string

description stringnullable

price float

original_price floatnullable

estimated_time integer

category_id string

created_at date-time

updated_at date-time

employee

object

id string

email string

name stringnullable

surname stringnullable

language stringnullable

phone_number stringnullable

remember_me_token booleannullable

birthday datenullable

created_at date-time

updated_at date-time

timezone stringnullable

meta

object

gender ContactGenderEnum (string)nullable

Possible values: [male, female, other]

]

createdBy

object

id string

email string

name stringnullable

surname stringnullable

language stringnullable

phone_number stringnullable

remember_me_token booleannullable

birthday datenullable

created_at date-time

updated_at date-time

timezone stringnullable

meta

object

gender ContactGenderEnum (string)nullable

Possible values: [male, female, other]

updatedBy

object

id string

email string

name stringnullable

surname stringnullable

language stringnullable

phone_number stringnullable

remember_me_token booleannullable

birthday datenullable

created_at date-time

updated_at date-time

timezone stringnullable

meta

object

gender ContactGenderEnum (string)nullable

Possible values: [male, female, other]

source_id numbernullable
custom_fields objectnullable
transaction_id stringnullable

transaction

get_transaction_single

nullable

id string

document_id stringnullable

account_id string

contact_id stringnullable

created_by_id string

amount numbernullable

currency CurrencyEnum (string)

Possible values: [EUR, USD, GBP, TRY]

type TransactionTypeEnum (string)

Possible values: [income, expense, order, reservation]

reference stringnullable

description stringnullable

paid_at string

created_at string

updated_at string

order_id stringnullable

reservation_id stringnullable

tips numbernullable

discount numbernullable

payment_method TransactionPaymentMethodEnums (string)

Possible values: [cash, credit_card, bank_transfer, qr]

account

object

id stringrequired

created_by_id stringrequired

name stringrequired

number stringnullablerequired

currency CurrencyEnum (string)required

Possible values: [EUR, USD, GBP, TRY]

bank_name stringnullablerequired

bank_phone stringnullablerequired

bank_address stringnullablerequired

enabled booleanrequired

created_at date-timerequired

updated_at date-timerequired

deleted_at date-timenullablerequired

total integerrequired

Example (from schema)

{
  "id": "4",
  "code": "A5NZY1",
  "customer_id": "101",
  "created_by_id": "1",
  "updated_by_id": "1",
  "notes": "bla bla",
  "total": 1122,
  "starting_at": "2024-08-01T23:21:53.710+03:00",
  "finishing_at": "2024-08-02T00:21:53.710+03:00",
  "created_at": "2024-08-01T23:21:53.705+03:00",
  "updated_at": "2024-08-01T23:21:53.725+03:00",
  "status": "new",
  "customer": {
    "id": "1",
    "name": "Kris",
    "surname": "Williamson",
    "type": "vendor",
    "email": "[email protected]",
    "phone": "5802777946",
    "gender": "male",
    "birthdate": "2011-05-02",
    "address": "İstanbul",
    "custom_fields": {},
    "created_at": "2024-03-03T11:52:04.398+03:00",
    "updated_at": "2024-04-11T01:11:23.878+03:00",
    "default_photo_id": 1
  },
  "services": [
    {
      "id": "5",
      "reservation_id": "4",
      "employee_id": "8",
      "service_id": "1",
      "price": 1100,
      "quantity": 1,
      "estimated_time": 30,
      "starting_at": "2024-08-01T23:21:53.710+03:00",
      "finishing_at": "2024-08-01T23:51:53.710+03:00",
      "is_bound": false,
      "service": {
        "id": "1",
        "name": "denem",
        "slug": "denem",
        "description": "afa",
        "price": 2200,
        "original_price": 2100,
        "estimated_time": 15,
        "category_id": "5",
        "created_at": "2024-06-16T23:09:57.899+03:00",
        "updated_at": "2024-06-16T23:09:57.899+03:00"
      },
      "employee": {
        "id": "1",
        "email": "[email protected]",
        "name": "Test",
        "surname": "User 1",
        "language": "en",
        "phone_number": "+90123123213",
        "remember_me_token": true,
        "birthday": "1990-01-01",
        "created_at": "2024-02-20T19:18:45.782+03:00",
        "updated_at": "2024-04-11T01:11:24.889+03:00",
        "timezone": "Europe/Istanbul",
        "meta": {
          "gender": "male"
        }
      }
    }
  ],
  "createdBy": {
    "id": "1",
    "email": "[email protected]",
    "name": "Test",
    "surname": "User 1",
    "language": "en",
    "phone_number": "+90123123213",
    "remember_me_token": true,
    "birthday": "1990-01-01",
    "created_at": "2024-02-20T19:18:45.782+03:00",
    "updated_at": "2024-04-11T01:11:24.889+03:00",
    "timezone": "Europe/Istanbul",
    "meta": {
      "gender": "male"
    }
  },
  "updatedBy": {
    "id": "1",
    "email": "[email protected]",
    "name": "Test",
    "surname": "User 1",
    "language": "en",
    "phone_number": "+90123123213",
    "remember_me_token": true,
    "birthday": "1990-01-01",
    "created_at": "2024-02-20T19:18:45.782+03:00",
    "updated_at": "2024-04-11T01:11:24.889+03:00",
    "timezone": "Europe/Istanbul",
    "meta": {
      "gender": "male"
    }
  },
  "source_id": 1,
  "custom_fields": {},
  "transaction_id": null,
  "transaction": {
    "id": "string",
    "document_id": "string",
    "account_id": "string",
    "contact_id": "string",
    "created_by_id": "string",
    "amount": 0,
    "currency": "EUR",
    "type": "income",
    "reference": "string",
    "description": "string",
    "paid_at": "string",
    "created_at": "string",
    "updated_at": "string",
    "order_id": "string",
    "reservation_id": "string",
    "tips": 0,
    "discount": 0,
    "payment_method": "cash",
    "account": {
      "id": "2",
      "created_by_id": "1",
      "name": "YAPI KREDI (KMH)",
      "number": "TR3284972923473",
      "currency": "EUR",
      "bank_name": "yapı kredi",
      "bank_phone": 2521111111,
      "bank_address": "İstanbul",
      "enabled": true,
      "created_at": "2024-07-16T20:35:36.937+03:00",
      "updated_at": "2024-07-16T20:35:36.937+03:00",
      "deleted_at": "2024-07-16T20:35:36.937+03:00",
      "total": 0
    }
  }
}

Loading...