Set booking compete
Method PUT
https://my.easyweek.io/api/public/v2/bookings/{booking_uuid}/status/complete
Description: This endpoint is used to mark a booking as complete within the system. It updates the status of a specific booking to reflect that the service has been rendered and handles the accounting aspects of the completed booking.
Example Request
curl -i -X PUT \
https://my.easyweek.io/api/public/v2/bookings/{booking_uuid}/status/complete \
-H 'Authorization: Bearer <YOUR_SECRET>' \
-H 'Workspace: <YOUR_WORKSPACE>'
Request body
{
"account_uuid": "d679011b-f488-4fc4-a436-89b1e6d7e14b",
"internal_notes": "",
"paid_amount": 80000
}
Path Parameters
- booking_uuid (string, required): The unique identifier of the booking to be marked as complete.
Body Parameters
- account_uuid (string, required): The UUID of the financial account where the payment for the booking should be credited.
- internal_notes (string, optional): Optional field for any notes staff members need to record regarding the booking completion.
- paid_amount (string, optional): The amount paid upon completion of the service. By default, if this field is not provided, the system will use the booking's total amount.
- staffer_uuid (string, optional): The UUID of the staff member who closed the booking. This parameter is used to identify the individual who marked the service as complete within the system.
When this API call succeeds, the booking's status will be updated to complete, and any provided financial details will be processed as specified. This allows for the closure of the transaction cycle and proper recording in the financial logs.
Example Response
{
"uuid": "f017724b-d95a-4267-8704-df99a9edaf56",
"location_uuid": "123b2980-3506-4f8c-abce-97e1ab653406",
"start_time": "2023-12-21T10:00:00Z",
"end_time": "2023-12-21T10:30:00Z",
"timezone": "Europe/Berlin",
"duration": {
"value": 30,
"label": "minutes",
"iso_8601": "PT30M"
},
"quantity": 1,
"slots_count": 1,
"cancel_reason": null,
"canceled_by": null,
"is_canceled": false,
"is_completed": true,
"public_notes": "Hello world",
"currency": "EUR",
"policy": {
"policy_text": null,
"is_cancelable": true,
"cancellation_offset": 0,
"cancellation_text": null,
"is_changeable": true,
"change_offset": 0,
"change_text": null
},
"links": [
{
"type": "ical",
"link": "https://my.easyweek.io/api/notifications/bookings/6929741/icalendar"
},
{
"type": "google_meet",
"link": ""
},
{
"type": "zoom",
"link": ""
},
{
"type": "microsoft_teams",
"link": ""
}
],
"order": {
"tax": [],
"subtotal": 10000,
"subtotal_formatted": "€100.00",
"amount_paid": 80000,
"amount_paid_formatted": "€800.00",
"total": 10000,
"total_formatted": "€100.00"
},
"ordered_services": [
{
"uuid": "ce889d66-dbf5-462f-bf67-a0dec4a48941",
"timezone": "Europe/Berlin",
"reserved_on": "2023-12-21T10:00:00Z",
"reserved_until": "2023-12-21T10:30:00Z",
"quantity": 1,
"name": "Beard trim",
"currency": "EUR",
"price": 10000,
"price_formatted": "€100.00",
"discount": 0,
"discount_formatted": "€0.00",
"original_price": 10000,
"original_price_formatted": "€100.00",
"tax_name": null,
"tax_value": null,
"duration": {
"value": 30,
"label": "minutes",
"iso_8601": "PT30M"
},
"original_duration": {
"value": 30,
"label": "minutes",
"iso_8601": "PT30M"
}
}
]
}