Checkout Reservation

POST 
/api/reservations/:id/checkout

Checkout Reservation

Request

Path Parameters

id integerrequired

Header Parameters

X-Company-Slug stringrequired

application/json

Body

status ReservationStatusEnum (string)required

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

tips numberrequired
discount numberrequired
payment_method TransactionPaymentMethodEnums (string)required

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

account_id number

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]

source_id numbernullable
custom_fields objectnullable
transaction_id string

company

get_company

id stringrequired

whitelabel_id numberrequired

code stringrequired

slug stringrequired

Possible values: <= 25 characters

name stringrequired

about stringnullablerequired

address stringnullablerequired

email stringnullablerequired

created_at stringrequired

updated_at stringrequired

country_id numbernullablerequired

package_id numberrequired

valid_until stringrequired

phone numbernullablerequired

full_phone numbernullablerequired

cf_vendor objectnullablerequired

cf_customer objectnullablerequired

settings objectnullablerequired

cf_reservation objectnullablerequired

modules string[]nullablerequired

city stringnullablerequired

working_hours

object

monday stringnullable

tuesday stringnullable

wednesday stringnullable

thursday stringnullable

friday stringnullable

saturday stringnullable

sunday stringnullable

last_payment date-timerequired

employees object[]required

package

object

required

id numberrequired

name stringrequired

price numberrequired

currency stringrequired

whitelabel_id numberrequired

modules string[]nullablerequired

created_at date-timerequired

updated_at date-timerequired

interval stringnullablerequired

Possible values: [yearly, monthly]

type stringnullablerequired

Possible values: [subscription, email, sms]

code stringrequired

quantity numberrequired

transaction

get_transaction_single

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",
  "source_id": 1,
  "custom_fields": {},
  "transaction_id": 1,
  "company": {
    "id": "string",
    "whitelabel_id": 0,
    "code": "string",
    "slug": "string",
    "name": "string",
    "about": "string",
    "address": "string",
    "email": "string",
    "created_at": "string",
    "updated_at": "string",
    "country_id": 0,
    "package_id": 0,
    "valid_until": "string",
    "phone": 0,
    "full_phone": 0,
    "cf_vendor": {},
    "cf_customer": {},
    "settings": {},
    "cf_reservation": {},
    "modules": [
      "string"
    ],
    "city": "string",
    "working_hours": {
      "monday": "07:30-18:00",
      "tuesday": "07:30-18:00",
      "wednesday": "07:30-18:00",
      "thursday": "07:30-18:00",
      "friday": "07:30-18:00",
      "saturday": "07:30-18:00",
      "sunday": "07:30-18:00"
    },
    "last_payment": "2024-08-12T09:09:28.178Z",
    "employees": [
      {
        "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": {
          "pivot_working_hours": {
            "monday": "07:30-18:00",
            "tuesday": "07:30-18:00",
            "wednesday": "07:30-18:00",
            "thursday": "07:30-18:00",
            "friday": "07:30-18:00",
            "saturday": "07:30-18:00",
            "sunday": "07:30-18:00"
          },
          "pivot_company_id": "string",
          "pivot_user_id": "string",
          "pivot_is_admin": true,
          "pivot_is_active": true,
          "pivot_created_at": "string",
          "pivot_updated_at": "string"
        }
      }
    ],
    "package": {
      "id": 0,
      "name": "string",
      "price": 0,
      "currency": "string",
      "whitelabel_id": 0,
      "modules": [
        "string"
      ],
      "created_at": "2024-08-12T09:09:28.179Z",
      "updated_at": "2024-08-12T09:09:28.179Z",
      "interval": "yearly",
      "type": "subscription",
      "code": "string",
      "quantity": 0
    }
  },
  "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...