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.

POST /api/3.0/booking/notes
Query Parameters:
 
  • date (string/timestamp) – 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.
Response JSON Array of Objects:
 
  • note_id (integer) – the ID of the note on that booking.
  • account_id (integer) – If made by a staff or partner account, this represents their unique identifier, otherwise it represents a customer booking with the value of 0.
  • date (string) – The date the note was created. It appears in ISO-8601 format.
  • body (string) – The body of the note.
  • private (bool) – The visibility of the note on the invoice. True means it is hidden from the invoice, false means it shows.
  • booking_id (string) – The unique identifier for the booking that contains the note.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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"
        }
    ]
}