Skip to content

Commit afb5fc0

Browse files
StoneFrogStoneFrog
authored
Update docs #2 - endpoints starting with letter b (#226)
1 parent 7c13590 commit afb5fc0

19 files changed

+374
-71
lines changed

‎api_calls/reference/bathrooms/public-rentals_write-scope-response.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,7 @@
1717
"created_at": "CREATED_AT",
1818
"updated_at": "UPDATED_AT"
1919
}
20-
]
20+
],
21+
"meta": {
22+
}
2123
}

‎api_calls/reference/bedrooms/public-rentals_write-scope-response.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,7 @@
2020
"created_at": "CREATED_AT",
2121
"updated_at": "UPDATED_AT"
2222
}
23-
]
23+
],
24+
"meta": {
25+
}
2426
}

‎api_calls/reference/bedrooms/update-request.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
22
"bedrooms": [
33
{
4-
"name": "bedroom",
4+
"name": {
5+
"en": "bedroom"
6+
},
57
"bunk_beds_count": 0,
68
"double_beds_count": 1,
79
"kingsize_beds_count": 0,

‎api_calls/reference/booking_comments/bookings_read-scope-response.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
{
22
"links": {
3+
"booking_comments.account": "https://www.bookingsync.com/api/v3/accounts/{booking_comments.account}",
34
"booking_comments.booking": "https://www.bookingsync.com/api/v3/bookings/{booking_comments.booking}"
45
},
56
"booking_comments": [
67
{
78
"links": {
9+
"account": 3,
810
"booking": 1
911
},
1012
"id": 3,

‎api_calls/reference/booking_comments/bookings_write-bookings_write_owned-scope-response.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
{
22
"links": {
3+
"booking_comments.account": "https://www.bookingsync.com/api/v3/accounts/{booking_comments.account}",
34
"booking_comments.booking": "https://www.bookingsync.com/api/v3/bookings/{booking_comments.booking}"
45
},
56
"booking_comments": [
67
{
78
"links": {
9+
"account": 3,
810
"booking": 1
911
},
1012
"id": 3,

‎api_calls/reference/bookings/bookings_read-bookings_write-scope-response.json‎

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,46 +5,67 @@
55
"bookings.client": "https://www.bookingsync.com/api/v3/clients/{bookings.client}",
66
"bookings.rental_agreement": "https://www.bookingsync.com/api/v3/rental_agreements/{bookings.rental_agreement}",
77
"bookings.source": "https://www.bookingsync.com/api/v3/sources/{bookings.source}",
8+
"bookings.inquiry": "https://www.bookingsync.com/api/v3/inquiries/{bookings.inquiry}",
9+
"bookings.booking_comments": "https://www.bookingsync.com/api/v3/booking_comments/{bookings.booking_comments}",
810
"bookings.bookings_fees": "https://www.bookingsync.com/api/v3/bookings_fees/{bookings.bookings_fees}",
911
"bookings.bookings_taxes": "https://www.bookingsync.com/api/v3/bookings_taxes/{bookings.bookings_taxes}",
10-
"bookings.bookings_tags": "https://www.bookingsync.com/api/v3/bookings_tags/{bookings.bookings_tags}",
11-
"bookings.booking_comments": "https://www.bookingsync.com/api/v3/booking_comments/{bookings.booking_comments}"
12+
"bookings.payments": "https://www.bookingsync.com/api/v3/payments/{bookings.payments}",
13+
"bookings.bookings_payments": "https://www.bookingsync.com/api/v3/bookings_payments/{bookings.bookings_payments}",
14+
"bookings.bookings_tags": "https://www.bookingsync.com/api/v3/bookings_tags/{bookings.bookings_tags}"
1215
},
1316
"bookings": [
1417
{
1518
"links": {
1619
"account": 1,
1720
"rental": 16,
1821
"client": 37,
22+
"inquiry": null,
1923
"rental_agreement": null,
2024
"source": null,
2125
"bookings_fees": [],
26+
"bookings_payments": [23],
2227
"bookings_taxes": [],
2328
"bookings_tags": [1, 2],
24-
"booking_comments": []
29+
"booking_comments": [],
30+
"payments": [23]
2531
},
2632
"id": 80,
2733
"start_at": "START_AT",
2834
"end_at": "END_AT",
2935
"status": "Booked",
3036
"updated_at": "UPDATED_AT",
37+
"reference": "0000EG",
3138
"booked": true,
3239
"unavailable": false,
3340
"tentative_expires_at": null,
3441
"initial_price": "3000.0",
42+
"initial_rental_price": "3000.0",
43+
"channel_price": null,
3544
"discount": "10%",
3645
"final_price": "2700.0",
46+
"final_rental_price": "2700.0",
3747
"downpayment": null,
38-
"paid_amount": "0.0",
48+
"paid_amount": "2700.0",
3949
"currency": "USD",
4050
"notes": "",
51+
"damage_deposit": "0.0",
52+
"charge_damage_deposit_on_arrival": true,
4153
"adults": 5,
4254
"children": null,
43-
"bookings_payments_count": 0,
55+
"bookings_payments_count": 1,
4456
"review_requests_count": 0,
4557
"locked": null,
4658
"created_at": "CREATED_AT",
47-
"canceled_at": null
59+
"canceled_at": null,
60+
"expected_checkin_time": "14:45",
61+
"expected_checkout_time": "11:30",
62+
"payment_url": null,
63+
"balance_due_at": "BALANCE_DUE_AT",
64+
"rental_payback_to_owner": null,
65+
"final_payback_to_owner": "0.0",
66+
"commission": null,
67+
"contract_updated_at": "CONTRACT_UPDATED_AT",
68+
"owned_by_app": false
4869
}
4970
],
5071
"meta": {

‎api_calls/reference/bookings/bookings_read-bookings_write_with_comments_fees_and_taxes-scope-response.json‎

Lines changed: 127 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,46 +5,165 @@
55
"bookings.client": "https://www.bookingsync.com/api/v3/clients/{bookings.client}",
66
"bookings.rental_agreement": "https://www.bookingsync.com/api/v3/rental_agreements/{bookings.rental_agreement}",
77
"bookings.source": "https://www.bookingsync.com/api/v3/sources/{bookings.source}",
8+
"bookings.inquiry": "https://www.bookingsync.com/api/v3/inquiries/{bookings.inquiry}",
9+
"bookings.booking_comments": "https://www.bookingsync.com/api/v3/booking_comments/{bookings.booking_comments}",
810
"bookings.bookings_fees": "https://www.bookingsync.com/api/v3/bookings_fees/{bookings.bookings_fees}",
911
"bookings.bookings_taxes": "https://www.bookingsync.com/api/v3/bookings_taxes/{bookings.bookings_taxes}",
10-
"bookings.bookings_tags": "https://www.bookingsync.com/api/v3/bookings_tags/{bookings.bookings_tags}",
11-
"bookings.booking_comments": "https://www.bookingsync.com/api/v3/booking_comments/{bookings.booking_comments}"
12+
"bookings.payments": "https://www.bookingsync.com/api/v3/payments/{bookings.payments}",
13+
"bookings.bookings_payments": "https://www.bookingsync.com/api/v3/bookings_payments/{bookings.bookings_payments}",
14+
"bookings.bookings_tags": "https://www.bookingsync.com/api/v3/bookings_tags/{bookings.bookings_tags}"
1215
},
1316
"bookings": [
1417
{
1518
"links": {
1619
"account": 1,
17-
"rental": 16,
20+
"rental": 1,
1821
"client": 37,
22+
"inquiry": null,
1923
"rental_agreement": null,
2024
"source": null,
2125
"bookings_fees": [10, 11],
22-
"bookings_taxes": [22, 23],
26+
"bookings_payments": [23],
27+
"bookings_taxes": [22, 23, 24],
2328
"bookings_tags": [],
24-
"booking_comments": [1, 2]
29+
"booking_comments": [1, 2],
30+
"payments": [23]
2531
},
2632
"id": 80,
2733
"start_at": "START_AT",
2834
"end_at": "END_AT",
2935
"status": "Booked",
3036
"updated_at": "UPDATED_AT",
37+
"reference": "0000EG",
3138
"booked": true,
3239
"unavailable": false,
3340
"tentative_expires_at": null,
3441
"initial_price": "3000.0",
42+
"initial_rental_price": "3000.0",
43+
"channel_price": null,
3544
"discount": "10%",
3645
"final_price": "2700.0",
46+
"final_rental_price": "2700.0",
47+
"damage_deposit": "0.0",
48+
"charge_damage_deposit_on_arrival": true,
3749
"downpayment": null,
38-
"paid_amount": "0.0",
50+
"paid_amount": "2700.0",
3951
"currency": "USD",
4052
"notes": "",
4153
"adults": 5,
4254
"children": null,
43-
"bookings_payments_count": 0,
55+
"bookings_payments_count": 1,
4456
"review_requests_count": 0,
4557
"locked": null,
4658
"created_at": "CREATED_AT",
47-
"canceled_at": null
59+
"canceled_at": null,
60+
"expected_checkin_time": "14:45",
61+
"expected_checkout_time": "11:30",
62+
"payment_url": null,
63+
"balance_due_at": "BALANCE_DUE_AT",
64+
"rental_payback_to_owner": null,
65+
"final_payback_to_owner": "0.0",
66+
"commission": null,
67+
"contract_updated_at": "CONTRACT_UPDATED_AT",
68+
"owned_by_app": false,
69+
"bookings_fees": [
70+
{
71+
"links": {
72+
"account": 1,
73+
"booking": 80,
74+
"bookings_taxes": [
75+
],
76+
"fee": 1,
77+
"rentals_fee": 10
78+
},
79+
"id": 10,
80+
"name": {
81+
"en": "Fee1"
82+
},
83+
"price": "50.0",
84+
"required": null,
85+
"included_in_price": true,
86+
"times_booked": 2,
87+
"created_at": "2017-08-10T09:36:10Z",
88+
"updated_at": "2017-08-10T09:36:10Z"
89+
},
90+
{
91+
"links": {
92+
"account": 1,
93+
"booking": 80,
94+
"bookings_taxes": [
95+
],
96+
"fee": 1,
97+
"rentals_fee": 10
98+
},
99+
"id": 11,
100+
"name": {
101+
"en": "Fee2"
102+
},
103+
"price": "30.0",
104+
"required": null,
105+
"included_in_price": true,
106+
"times_booked": 1,
107+
"created_at": "2017-08-10T09:36:10Z",
108+
"updated_at": "2017-08-10T09:36:10Z"
109+
}
110+
],
111+
"bookings_taxes": [
112+
{
113+
"links": {
114+
"account": 1,
115+
"booking": 80,
116+
"tax": 5,
117+
"taxable": {
118+
"id": 1,
119+
"type": "Rental"
120+
}
121+
},
122+
"id": 22,
123+
"name": {
124+
"en": "Tax1"
125+
},
126+
"tax_included_in_price": false,
127+
"percentage": "0.0",
128+
"amount": "60.0"
129+
},
130+
{
131+
"links": {
132+
"account": 1,
133+
"booking": 80,
134+
"tax": 7,
135+
"taxable": {
136+
"id": 1,
137+
"type": "Rental"
138+
}
139+
},
140+
"id": 23,
141+
"name": {
142+
"en": "Tax2"
143+
},
144+
"tax_included_in_price": false,
145+
"percentage": "0.0",
146+
"amount": "40.0"
147+
},
148+
{
149+
"links": {
150+
"account": 1,
151+
"booking": 80,
152+
"tax": 4,
153+
"taxable": {
154+
"id": 1,
155+
"type": "Rental"
156+
}
157+
},
158+
"id": 24,
159+
"name": {
160+
"en": "Tax3"
161+
},
162+
"tax_included_in_price": true,
163+
"percentage": "0.0",
164+
"amount": "10.0"
165+
}
166+
]
48167
}
49168
],
50169
"meta": {

‎api_calls/reference/bookings/create_with_comments_fees_and_taxes-request.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@
1515
{ "content": "Comment two" }
1616
],
1717
"bookings_fees": [
18-
{ "price": "50", "times_booked": "2", "rentals_fee_id": "10" },
19-
{ "price": "30", "times_booked": "1", "rentals_fee_id": "10" }
18+
{ "price": "50", "times_booked": "2", "rentals_fee_id": "10", "name": "Fee1" },
19+
{ "price": "30", "times_booked": "1", "rentals_fee_id": "10", "name": "Fee2" }
2020
],
2121
"bookings_taxes": [
22-
{ "taxable_type": "Rental", "taxable_id": "1", "amount": "60", "tax_id": "5", "included": false },
23-
{ "taxable_type": "Rental", "taxable_id": "1", "amount": "40", "tax_id": "7", "included": false },
24-
{ "taxable_type": "Rental", "taxable_id": "1", "amount": "10", "tax_id": "4", "included": true }
22+
{ "taxable_type": "Rental", "taxable_id": "1", "amount": "60", "tax_id": "5", "included": false, "name": "Tax1" },
23+
{ "taxable_type": "Rental", "taxable_id": "1", "amount": "40", "tax_id": "7", "included": false, "name": "Tax2" },
24+
{ "taxable_type": "Rental", "taxable_id": "1", "amount": "10", "tax_id": "4", "included": true, "name": "Tax3" }
2525
]
2626
}
2727
]

‎api_calls/reference/bookings_fees/bookings_read-bookings_write-bookings_write_owned-scope-response.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"links": {
3+
"bookings_fees.account": "https://www.bookingsync.com/api/v3/accounts/{bookings_fees.account}",
4+
"bookings_fees.rentals_fee": "https://www.bookingsync.com/api/v3/rentals_fees/{bookings_fees.rentals_fee}",
5+
"bookings_fees.booking": "https://www.bookingsync.com/api/v3/bookings/{bookings_fees.booking}",
6+
"bookings_fees.fee": "https://www.bookingsync.com/api/v3/fees/{bookings_fees.fee}",
7+
"bookings_fees.bookings_taxes": "https://www.bookingsync.com/api/v3/bookings_taxes/{bookings_fees.bookings_taxes}"
8+
},
9+
"bookings_fees": [
10+
{
11+
"links": {
12+
"account": 3,
13+
"rentals_fee": 6,
14+
"booking": 1313,
15+
"fee": 9,
16+
"bookings_taxes": []
17+
},
18+
"id": 13,
19+
"name": {
20+
"en": "Bookings Fee"
21+
},
22+
"price": "12.0",
23+
"required": false,
24+
"included_in_price": false,
25+
"times_booked": 0,
26+
"created_at": "2015-03-20T16:04:05Z",
27+
"updated_at": "2015-03-20T16:04:05Z"
28+
}
29+
],
30+
"meta": {}
31+
}

‎api_calls/reference/bookings_fees/public-scope-response.json‎

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)