For the complete documentation index, see llms.txt. This page is also available as Markdown.

Driver journal entry

A trip that has been categorised, so transport use can be split between business and private.

A driver journal entry is a trip that has been categorised. The journal is how a fleet accounts for how its vehicles were used, most often by separating business travel from private, which is what a tax authority or an employer wants to see.

Entries are created from trip proposals, which are the raw trips the Navixy platform has already detected over a period. For a walkthrough, see how to use driver journals.

Driver journal entry object

API actions

API base path: /driver/journal/entry.

All these calls need the driver_journal feature on the tracker's plan.

There are two ways to get entries: by their IDs, or by specifying a date range. Without entry_ids, entries are selected by intersecting their own date range with the range in the request.


List driver journal entries

post
/driver/journal/entry/list

Return driver journal entries for one tracker.

There are two ways to select them. Give entry_ids to fetch entries by ID, or give from and to to fetch every entry whose own date range intersects that period.

Needs the driver_journal feature on the tracker's plan, and returns error 236 without it.

A request with an empty body reports interval as the missing parameter. That is the internal name of the field holding both dates; the public parameters are from and to.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
tracker_idinteger · min: 1Required

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

fromstringRequired

Start of the period. Include entries whose range ends after this date.

Example: 2026-08-24 09:00:00
tostringRequired

End of the period. Include entries whose range ends after this date. Must be after from.

Example: 2026-08-24 09:00:00
entry_idsinteger[] · min: 1Optional

Optional. Entry IDs to return. When given, from and to are ignored and only these entries are looked up.

sortstring[] · max: 6Optional

Optional. Sort options, each a column and direction such as start_date=asc. At most 6 options. Defaults to ["start_date=asc"]. Columns: start_date sorts by date only, ignoring the time; start_datetime sorts by the raw value; end_date and end_datetime are the same pair for the end; start_address and end_address sort by address; driver sorts by last, first and middle name rather than by employee ID; type sorts by entry type.

Responses
200

Matching entries

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/driver/journal/entry/list
POST /v2/driver/journal/entry/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "tracker_id": 1,
  "from": "2026-08-24 09:00:00",
  "to": "2026-08-24 09:00:00",
  "entry_ids": [
    1
  ],
  "types": [
    "work"
  ],
  "sort": [
    "text"
  ]
}
{
  "success": true,
  "list": [
    {
      "id": 1,
      "tracker_id": 1,
      "start_date": "text",
      "end_date": "text",
      "employee_id": null,
      "type": "work",
      "comment": null,
      "start_location": {
        "lat": 1,
        "lng": 1,
        "address": "text"
      },
      "end_location": {
        "lat": 1,
        "lng": 1,
        "address": "text"
      },
      "length": 1,
      "start_odometer": null,
      "end_odometer": null
    }
  ]
}

Errors

These errors come in addition to the general error codes:

  • 236 - The tracker's plan does not include the driver journal feature.


Required sub-user rights: vehicle_update.

Create driver journal entries

post
/driver/journal/entry/create

Create one or more driver journal entries.

Each entry needs tracker_id, start_date, end_date, type, start_location, end_location and length. It must not carry an id.

Three rules are checked before anything is written, and any one of them fails the whole request: every start_date must be before its end_date; the entries in the request must not overlap each other; and none may overlap an entry already stored for the same tracker. Any employee_id given must exist.

Needs the driver_journal feature on the tracker's plan, and returns error 236 without it.

Requires the vehicle_update right.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
Responses
200

Entries created

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/driver/journal/entry/create
POST /v2/driver/journal/entry/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "entries": [
    {
      "id": 1,
      "tracker_id": 1,
      "start_date": "text",
      "end_date": "text",
      "employee_id": null,
      "type": "work",
      "comment": null,
      "start_location": {
        "lat": 1,
        "lng": 1,
        "address": "text"
      },
      "end_location": {
        "lat": 1,
        "lng": 1,
        "address": "text"
      },
      "length": 1,
      "start_odometer": null,
      "end_odometer": null
    }
  ]
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 201 - if a tracker or an employee not found, 242 - if a start date is not before its end date, 247 - if an entry overlaps another.


Only two fields, type and comment, are available to update. Every other field of an entry is rejected rather than ignored.

Required sub-user rights: vehicle_update.

Update driver journal entry

post
/driver/journal/entry/update

Update the type and comment of one driver journal entry.

Only type and comment may be sent, and both id and type are required. Every other field of an entry is rejected rather than ignored: sending tracker_id, a date, a location, employee_id, length or an odometer value fails the request with error 7 saying that field "must be null". type is required even when only the comment is changing.

Needs the driver_journal feature on the tracker's plan, and returns error 236 without it.

Requires the vehicle_update right.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
Responses
200

Entry updated

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/driver/journal/entry/update
POST /v2/driver/journal/entry/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "entry": {
    "id": 1,
    "type": "work",
    "comment": null
  }
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 201 - if tracker not found, 204 - if entry not found.


Required sub-user rights: vehicle_update.

Delete driver journal entries

post
/driver/journal/entry/delete

Delete driver journal entries by ID.

All or nothing. If any ID in entry_ids does not exist, nothing is deleted and the call returns error 217.

Needs the driver_journal feature on the tracker's plan, and returns error 236 without it.

Also accepts GET with the same parameters as query-string values.

Requires the vehicle_update right.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
entry_idsinteger[] · min: 1Required

IDs of the entries to delete. Must not be empty.

Responses
200

Entries deleted

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/driver/journal/entry/delete
POST /v2/driver/journal/entry/delete HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "entry_ids": [
    1
  ]
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 217 - if any of the given IDs does not exist, in which case nothing is deleted.


The response is a driver journal report file, a standard file download, rather than a JSON envelope.

Download driver journal

post
/driver/journal/entry/download

Return the driver journal for one tracker as a report file. Entries are selected exactly as in driver/journal/entry/list.

format is required in practice. It carries no validation annotation, so omitting it is not reported as a missing parameter: the request fails later with error 6, "Unexpected error".

The response is the file itself, not a JSON envelope. With add_filename_header left at its default the response carries a Content-Disposition header naming a file such as Driver_Journal-20260818-2210.pdf.

The number of report downloads per user is capped by the report.download.maxPerUser config option.

Needs the driver_journal feature on the tracker's plan, and returns error 236 without it.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
tracker_idinteger · min: 1Required

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

fromstringRequired

Start of the period. Include entries whose range ends after this date.

Example: 2026-08-24 09:00:00
tostringRequired

End of the period. Include entries whose range ends after this date. Must be after from.

Example: 2026-08-24 09:00:00
entry_idsinteger[] · min: 1Optional

Optional. Entry IDs to return. When given, from and to are ignored and only these entries are looked up.

sortstring[] · max: 6Optional

Optional. Sort options, each a column and direction such as start_date=asc. At most 6 options. Defaults to ["start_date=asc"]. Columns: start_date sorts by date only, ignoring the time; start_datetime sorts by the raw value; end_date and end_datetime are the same pair for the end; start_address and end_address sort by address; driver sorts by last, first and middle name rather than by employee ID; type sorts by entry type.

formatstring · enumRequired

File format of the report.

Possible values:
group_bystring · enumOptional

Optional. Put grouped entries into separate sections of the table. type groups by entry type, date groups by start date per day.

Possible values:
add_filename_headerbooleanOptional

Optional. Default true. Append a Content-Disposition header to the response.

Responses
200

The driver journal report file

string · binaryOptional
post/driver/journal/entry/download
POST /v2/driver/journal/entry/download HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "tracker_id": 1,
  "from": "2026-08-24 09:00:00",
  "to": "2026-08-24 09:00:00",
  "entry_ids": [
    1
  ],
  "types": [
    "work"
  ],
  "sort": [
    "text"
  ],
  "format": "pdf",
  "group_by": "type",
  "add_filename_header": true
}
binary

Errors

These errors come in addition to the general error codes:

  • 236 - The tracker's plan does not include the driver journal feature.

Last updated

Was this helpful?