List Custom Entry Screens
GET/entry_screens/custom
Retrieve a list of available Custom Entry Screens. This is the entry type that was formerly known as "Mileage" or "Travel". We now recommend using the Expense entry type for travel-related expenses. The label of "Custom" can be changed.
An Entry Screen is the configuration of the Entry Sheet, including the fields and layout of the sheet, as well as the Entry Periods assigned to the sheet, which defines the time period such as weekly, bi-weekly, etc.
The Entry Screen config determines which Entry Columns appear on a user's entry sheet, and in what order, along with many other entry screen configuration options.
Currently, this endpoint is read-only. Support for creating, modifying, and deleting Custom Entry Screens is not yet supported in the REST API, but will be added in a future release.
Note: internally, Custom Entry Screens are stored in the travel_entry_guis
database table, and the "Entry Screen Config" concept is
sometimes referred to as a "GUI" (graphical user interface) in the
legacy codebase.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- 503
A successful response from a paged collection; see the results array in the
response for the list of results for this page. Additional pages may be
available and can be fetched using the @nextLink URL.
Note that the examples given may include keys (fields) that may not always be
present in the response, depending on the fields requested in the $keys
parameter, the user's permissions, and other system settings.
A 400 Bad Request is returned when the client request was malformed,
invalid, or otherwise could not be processed as-is. Usually, the cause for
the error is included in the error.message field of the response, and the
client should correct the request and try again.
See also Core Concepts#Error Responses.
Not authenticated - you must be signed in to access this resource. Please check the section of the documentation on authentication.
A 403 Forbidden response means that you are not authorized to perform
this action or access this object, or the object does not exist at all.
The client request may have been valid but the client does not have permission to access the requested resource or perform the requested action.
:::tip 403 Forbidden also used when objects don't exist
In most cases, the system will not return a 404 Not Found error response;
it returns 403 Forbidden both when the object doesn't exist at all,
and also when it exists but the client does not have permission to access it.
This is a security measure to prevent unauthorized users from determining
whether an object exists or not.
:::
See also Core Concepts#Error Responses.
Not found - the requested resource could not be found or does not exist. This may also include cases where the resource does exist, but the client does not have permission to access that resource.
:::tip 403 Forbidden also used when objects don't exist
In most cases, the system will not return a 404 Not Found error response;
it returns 403 Forbidden both when the object doesn't exist at all,
and also when it exists but the client does not have permission to access it.
This is a security measure to prevent unauthorized users from determining
whether an object exists or not.
:::
See also Core Concepts#Error Responses.
Internal server error; an unexpected error occurred on the server. This could be due to a temporary condition or might be the result of a bug in the server software. Also, in some cases, an incorrect client input can trigger this error, and can be resolved by correcting the input.
If the error persists, please contact support along along with the following details when possible:
- any error messages received from the server
- the full request and response details (full headers and body)
- a description of the steps that led to the error
- the time range when it occurred.
Service unavailable - the server is currently unable to handle the request, usually due to maintenance activity on the server. Check if the server's web interface is currently available, or try again later.