-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document the booking/notes endpoint
- Loading branch information
Showing
2 changed files
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
{ | ||
"version": "3.0", | ||
"account_id": 1, | ||
"host_id": "your-company.checkfront.com", | ||
"name": "Your Company", | ||
"locale": { | ||
"id": "en_CA", | ||
"lang": "en", | ||
"currency": "CAD" | ||
}, | ||
"request": { | ||
"status": "OK", | ||
"resource": "booking", | ||
"id": "notes", | ||
"records": 26, | ||
"limit": 0, | ||
"page": 1, | ||
"pages": 1, | ||
"time": 0.003, | ||
"timestamp": 1524984437.018568, | ||
"method": "get" | ||
}, | ||
"notes": [ | ||
{ | ||
"note_id": 1, | ||
"account_id": 0, | ||
"date": "2018-04-26T17:40:25-07:00", | ||
"body": "Quis error quo molestias rerum", | ||
"private": false, | ||
"booking_id": "PSGS-260418" | ||
}, | ||
{ | ||
"note_id": 3, | ||
"account_id": 1, | ||
"date": "2018-04-21T23:30:19-07:00", | ||
"body": "test 2", | ||
"private": true, | ||
"booking_id": "LLXF-230318" | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
booking/notes | ||
-------------- | ||
This is a call to your Checkfront account that pulls all the notes from all of your bookings. This defaults to pulling all of the notes from your bookings for the past thirty days. | ||
|
||
.. http:post:: /api/3.0/booking/notes | ||
:query string/timestamp date: Filter the booking notes by a date. This can be in ISO-8601 or "YYYY-MM-DD" format. This can also be a month and will show all notes from that month. | ||
|
||
:>jsonarr integer note_id: the ID of the note on that booking. | ||
:>jsonarr integer account_id: If made by a staff or partner account, this represents their unique identifier, otherwise it represents a customer booking with the value of 0. | ||
:>jsonarr string date: The date the note was created. It appears in ISO-8601 format. | ||
:>jsonarr string body: The body of the note. | ||
:>jsonarr bool private: The visibility of the note on the invoice. True means it is hidden from the invoice, false means it shows. | ||
:>jsonarr string booking_id: The unique identifier for the booking that contains the note. | ||
|
||
.. literalinclude:: ../../examples/response/booking-notes.json | ||
:language: json | ||
:linenos: | ||
:emphasize-lines: 23-40 |