Update docs #3 - update endpoints starting with letters c-p (#227)

StoneFrog · web-flow · commit dd2a2fc9171e · 2017-08-11T14:28:20.000+04:00
diff --git a/api_calls/reference/clients/clients_read-clients_write-scope-response.json b/api_calls/reference/clients/clients_read-clients_write-scope-response.json
@@ -46,7 +46,11 @@
       "lastname": "Kling",
       "notes": "",
       "passport": "AHJ4678956",
-      "preferred_locale": "en"
+      "preferred_locale": "en",
+      "company": "Great Company",
+      "vat_number": "ES65465465"
     }
-  ]
+  ],
+  "meta": {
+  }
 }
diff --git a/api_calls/reference/clients/create-request.json b/api_calls/reference/clients/create-request.json
@@ -39,7 +39,9 @@
       "lastname": "Kling",
       "notes": "",
       "passport": "AHJ4678956",
-      "preferred_locale": "en"
+      "preferred_locale": "en",
+      "company": "Great Company",
+      "vat_number": "ES65465465"
     }
   ]
 }
diff --git a/api_calls/reference/clients/update-request.json b/api_calls/reference/clients/update-request.json
@@ -39,7 +39,9 @@
       "lastname": "Kling",
       "notes": "",
       "passport": "AHJ4678956",
-      "preferred_locale": "en"
+      "preferred_locale": "en",
+      "company": "Great Company",
+      "vat_number": "ES65465465"
     }
   ]
 }
diff --git a/api_calls/reference/destinations/public-scope-response.json b/api_calls/reference/destinations/public-scope-response.json
@@ -12,9 +12,13 @@
         "en": "world/europe"
       },
       "aliases": {
-        "en": null
       },
-      "counter":1
+      "counter":1,
+      "ancestor_ids": [
+        1
+      ]
     }
-  ]
+  ],
+  "meta": {
+  }
 }
diff --git a/api_calls/reference/fees/create-request.json b/api_calls/reference/fees/create-request.json
@@ -5,7 +5,8 @@
       "kind": "other",
       "rate": "12.0",
       "rate_kind": "fixed",
-      "downpayment_percentage": "0.0"
+      "downpayment_percentage": "0.0",
+      "currency": "EUR"
     }
   ]
 }
diff --git a/api_calls/reference/fees/public-rates_write-scope-response.json b/api_calls/reference/fees/public-rates_write-scope-response.json
@@ -17,7 +17,10 @@
       "archived_at": null,
       "created_at": "2015-03-18T09:33:45Z",
       "updated_at": "2015-03-18T09:33:45Z",
-      "downpayment_percentage": "0.0"
+      "downpayment_percentage": "0.0",
+      "currency": "EUR",
+      "original_currency": "EUR",
+      "exchange_rate": "1.0"
     }
   ]
 }
diff --git a/api_calls/reference/fees/update-request.json b/api_calls/reference/fees/update-request.json
@@ -5,7 +5,8 @@
       "kind": "other",
       "rate": "12.0",
       "rate_kind": "fixed",
-      "downpayment_percentage": "0.0"
+      "downpayment_percentage": "0.0",
+      "currency": "EUR"
     }
   ]
 }
diff --git a/api_calls/reference/fees_taxes/create-request.json b/api_calls/reference/fees_taxes/create-request.json
@@ -0,0 +1,8 @@
+{
+  "fees_taxes": [
+    {
+      "tax_id": 2,
+      "tax_included_in_rate": true
+    }
+  ]
+}
diff --git a/api_calls/reference/fees_taxes/public-rates_write-scope-response.json b/api_calls/reference/fees_taxes/public-rates_write-scope-response.json
@@ -14,5 +14,7 @@
       "created_at": "2015-08-04T15:23:57Z",
       "updated_at": "2015-08-04T15:23:57Z"
     }
-  ]
+  ],
+  "meta": {
+  }
 }
diff --git a/api_calls/reference/fees_taxes/update-request.json b/api_calls/reference/fees_taxes/update-request.json
@@ -0,0 +1,8 @@
+{
+  "fees_taxes": [
+    {
+      "tax_id": 2,
+      "tax_included_in_rate": true
+    }
+  ]
+}
diff --git a/api_calls/reference/inquiries/inquiries_read-inquiries_write-inquiries_write_owned-scope-response.json b/api_calls/reference/inquiries/inquiries_read-inquiries_write-inquiries_write_owned-scope-response.json
@@ -1,11 +1,15 @@
 {
   "links": {
-    "inquiries.rental": "https://www.bookingsync.com/api/v3/rentals/{inquiries.rental}"
+    "inquiries.rental": "https://www.bookingsync.com/api/v3/rentals/{inquiries.rental}",
+    "inquiries.source": "https://www.bookingsync.com/api/v3/sources/{inquiries.source}",
+    "inquiries.booking": "https://www.bookingsync.com/api/v3/bookings/{inquiries.booking}"
   },
   "inquiries": [
     {
       "links": {
-        "rental": 2
+        "booking": null,
+        "rental": 2,
+        "source": null
       },
       "id": 1,
       "firstname": "John",
@@ -18,6 +22,7 @@
       "adults": 4,
       "children": 2,
       "message": "Important message",
+      "locked": null,
       "created_at": "CREATED_AT",
       "updated_at": "UPDATED_AT"
     }
diff --git a/api_calls/reference/inquiries/inquiries_write-inquiries_write_owned-scope-response.json b/api_calls/reference/inquiries/inquiries_write-inquiries_write_owned-scope-response.json
@@ -1,11 +1,15 @@
 {
   "links": {
-    "inquiries.rental": "https://www.bookingsync.com/api/v3/rentals/{inquiries.rental}"
+    "inquiries.rental": "https://www.bookingsync.com/api/v3/rentals/{inquiries.rental}",
+    "inquiries.source": "https://www.bookingsync.com/api/v3/sources/{inquiries.source}",
+    "inquiries.booking": "https://www.bookingsync.com/api/v3/bookings/{inquiries.booking}"
   },
   "inquiries": [
     {
       "links": {
-        "rental": 2
+        "booking": null,
+        "rental": 2,
+        "source": null
       },
       "id": 1,
       "firstname": "John",
@@ -18,6 +22,7 @@
       "adults": 4,
       "children": 2,
       "message": "Important message",
+      "locked": null,
       "created_at": "CREATED_AT",
       "updated_at": "UPDATED_AT"
     }
diff --git a/api_calls/reference/inquiries/inquiries_write_owned-scope-response.json b/api_calls/reference/inquiries/inquiries_write_owned-scope-response.json
diff --git a/api_calls/reference/inquiries/update-request.json b/api_calls/reference/inquiries/update-request.json
@@ -10,7 +10,8 @@
       "phone": 7273647616,
       "adults": 4,
       "children": 2,
-      "message": "Important message"
+      "message": "Important message",
+      "rental_id": 3
     }
   ]
 }
diff --git a/api_calls/reference/living_rooms/public-rentals_write-scope-response.json b/api_calls/reference/living_rooms/public-rentals_write-scope-response.json
@@ -17,5 +17,7 @@
       "created_at": "CREATED_AT",
       "updated_at": "UPDATED_AT"
     }
-  ]
+  ],
+  "meta": {
+  }
 }
diff --git a/api_calls/reference/los_records/public-scope-response.json b/api_calls/reference/los_records/public-scope-response.json
@@ -51,4 +51,4 @@
     }
   ],
   "meta": {}
-}
+}
diff --git a/api_calls/reference/nightly_rate_maps/rates_read-rates_write-scope-response.json b/api_calls/reference/nightly_rate_maps/rates_read-rates_write-scope-response.json
@@ -13,5 +13,7 @@
       "start_date": "BEGINNING_OF_MONTH",
       "updated_at": "UPDATED_AT"
     }
-  ]
+  ],
+  "meta": {
+  }
 }
diff --git a/api_calls/reference/payments/payments_write_owned-payments_read-payments_write-scope-response.json b/api_calls/reference/payments/payments_write_owned-payments_read-payments_write-scope-response.json
@@ -33,6 +33,7 @@
       "updated_at": "UPDATED_AT",
       "rejected_at": null,
       "canceled_at": null,
+      "description": "Payment for Awesome Rental from Friday 01 Jun 2017, 04:00 PM to Friday 8 Jun 2017, 10:00 AM",
       "address1": "Bernhard Creek",
       "address2": null,
       "zip": "07671-8254",
diff --git a/api_calls/reference/photos/public-rentals_write-scope-response.json b/api_calls/reference/photos/public-rentals_write-scope-response.json
@@ -1,10 +1,12 @@
 {
   "links": {
+    "photos.account": "https://www.bookingsync.com/api/v3/accounts/{photos.account}",
     "photos.rental": "https://www.bookingsync.com/api/v3/rentals/{photos.rental}"
   },
   "photos": [
     {
       "links": {
+        "account": 1,
         "rental": 3
       },
       "id": 1,
@@ -23,7 +25,7 @@
       "giant_url": "http://bs-eu.s3.amazonaws.com/app/production/photo/photo/1/giant_1c4a6fb74004bb654fbb7972e4c78625.jpg",
       "position": 1,
       "height": 2000,
-      "ratio": 1.5,
+      "ratio": "1.5",
       "width": 3000,
       "created_at": "CREATED_AT",
       "updated_at": "UPDATED_AT"
diff --git a/content/reference/changelog.md b/content/reference/changelog.md
@@ -10,6 +10,15 @@
   * [doc update] Update `bookings_fees` endpoint.
   * [api improvment] Add `bookings_tags` endpoint.
   * [doc update] Update response of `bookings_taxes` endpoint.
+  * [doc update] Update `clients` endpoint.
+  * [doc update] Update `destinations` endpoint.
+  * [doc update] Update `fees` endpoint.
+  * [doc update] Update `fees_taxes` endpoint.
+  * [doc update] Update `inuqiries` endpoint.
+  * [doc update] Update `living_rooms` endpoint.
+  * [doc update] Update `nightly_rate_maps` endpoint.
+  * [doc update] Update `payments` endpoint.
+  * [doc update] Update `photos` endpoint.
 
 ## 2017-07-13
 
diff --git a/content/reference/endpoints/clients.md b/content/reference/endpoints/clients.md
@@ -15,12 +15,14 @@ Group     | Name             | Type    | Read/Write | Description
 ----------|------------------|---------|------------|------------
           | id               | Integer | Read       | Client's id.
 ----------|------------------|---------|------------|------------
+          | company          | String  | Read       | Client's company name.
           | fullname         | String  | Read       | Client's fullname.
           | firstname        | String  | Read       | Client's first name.
           | lastname         | String  | Read       | Client's last name.
           | notes            | Text    | Read       | Client's notes.
           | passport         | String  | Read       | Client's passport id.
           | preferred_locale | String  | Read       | Client's contact language preference.
+          | vat_number       | String  | Read       | Client's company vat number.
 ----------|------------------|---------|------------|------------
           | created_at       | [Time](/reference/enums#formats) | Read       | Client's create time.
           | updated_at       | [Time](/reference/enums#formats) | Read       | Client's update time.
@@ -48,12 +50,14 @@ Group     | Name             | Type    | Read/Write | Description
 ----------|------------------|---------|------------|------------
           | id               | Integer | Read       | Client's id.
 ----------|------------------|---------|------------|------------
+          | company          | String  | Read/Write | Client's company name.
           | fullname         | String  | Read/Write | **Required**. Client's fullname. (150 characters max)
           | firstname        | String  | Read/Write | Client's first name. (150 characters max)
           | lastname         | String  | Read/Write | Client's last name. (150 characters max)
-          | notes            | Text    | Read/Write | Client's notes. (1000 characters max)
+          | notes            | Text    | Read/Write | Client's notes. (5000 characters max)
           | passport         | String  | Read/Write | Client's passport id. (50 characters max)
           | preferred_locale | String  | Read/Write | Client's contact language preference.
+          | vat_number       | String  | Read/Write | Client's company vat number.
 ----------|------------------|---------|------------|------------
           | created_at       | [Time](/reference/enums#formats) | Read       | Client's create time.
           | updated_at       | [Time](/reference/enums#formats) | Read       | Client's update time.
diff --git a/content/reference/endpoints/destinations.md b/content/reference/endpoints/destinations.md
@@ -15,7 +15,8 @@ Name                            | Type     | Read/Write | Description
 id                              | Integer  | Read       | Destination's id.
 --------------------------------|----------|-------------------------
 aliases                         | [Object](/reference/enums#formats)     | Read       | Destination's aliases, list of locales described in [enums section](/reference/enums#locales).
-counter                         | String   | Read       | Destination's use counter for rentals.
+ancestor_ids                    | Array    | Read       | Array of destination's ancestor destinations ids.
+counter                         | Integer  | Read       | Destination's use counter for rentals.
 fullname                        | [Object](/reference/enums#formats)     | Read       | Destination's fullname, list of locales described in [enums section](/reference/enums#locales).
 name                            | [Object](/reference/enums#formats)     | Read       | Destination's name, list of locales described in [enums section](/reference/enums#locales).
 permalink                       | [Object](/reference/enums#formats)     | Read       | Destination's permalink, list of locales described in [enums section](/reference/enums#locales).
diff --git a/content/reference/endpoints/fees.md b/content/reference/endpoints/fees.md
diff --git a/content/reference/endpoints/fees_taxes.md b/content/reference/endpoints/fees_taxes.md
diff --git a/content/reference/endpoints/inquiries.md b/content/reference/endpoints/inquiries.md
diff --git a/content/reference/endpoints/payments.md b/content/reference/endpoints/payments.md
diff --git a/content/reference/endpoints/photos.md b/content/reference/endpoints/photos.md

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,11 @@`
`46`	`46`	`"lastname": "Kling",`
`47`	`47`	`"notes": "",`
`48`	`48`	`"passport": "AHJ4678956",`
`49`		`- "preferred_locale": "en"`
	`49`	`+ "preferred_locale": "en",`
	`50`	`+ "company": "Great Company",`
	`51`	`+ "vat_number": "ES65465465"`
`50`	`52`	`}`
`51`		`- ]`
	`53`	`+ ],`
	`54`	`+ "meta": {`
	`55`	`+ }`
`52`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,9 @@`
`39`	`39`	`"lastname": "Kling",`
`40`	`40`	`"notes": "",`
`41`	`41`	`"passport": "AHJ4678956",`
`42`		`- "preferred_locale": "en"`
	`42`	`+ "preferred_locale": "en",`
	`43`	`+ "company": "Great Company",`
	`44`	`+ "vat_number": "ES65465465"`
`43`	`45`	`}`
`44`	`46`	`]`
`45`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,8 @@`
`5`	`5`	`"kind": "other",`
`6`	`6`	`"rate": "12.0",`
`7`	`7`	`"rate_kind": "fixed",`
`8`		`- "downpayment_percentage": "0.0"`
	`8`	`+ "downpayment_percentage": "0.0",`
	`9`	`+ "currency": "EUR"`
`9`	`10`	`}`
`10`	`11`	`]`
`11`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,10 @@`
`17`	`17`	`"archived_at": null,`
`18`	`18`	`"created_at": "2015-03-18T09:33:45Z",`
`19`	`19`	`"updated_at": "2015-03-18T09:33:45Z",`
`20`		`- "downpayment_percentage": "0.0"`
	`20`	`+ "downpayment_percentage": "0.0",`
	`21`	`+ "currency": "EUR",`
	`22`	`+ "original_currency": "EUR",`
	`23`	`+ "exchange_rate": "1.0"`
`21`	`24`	`}`
`22`	`25`	`]`
`23`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,7 @@`
`14`	`14`	`"created_at": "2015-08-04T15:23:57Z",`
`15`	`15`	`"updated_at": "2015-08-04T15:23:57Z"`
`16`	`16`	`}`
`17`		`- ]`
	`17`	`+ ],`
	`18`	`+ "meta": {`
	`19`	`+ }`
`18`	`20`	`}`