List Expense Entries
List your Expense Entries
Query Parameters
- start_cursor string
The start cursor for Keyset pagination.
- per_page integer
Possible values:
>= 2
and<= 100
Default value:
50
The number of records per page to return.
- filter object
The fields, operations, and values to filter the records by.
vendor_id object
eq string requiredvehicle_id object
eq string requiredexpense_entry_type_id object
eq string requiredoccurred_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string required
- sort object
The fields and direction to sort the results by.
- id string
Possible values: [
asc
,desc
]Default value:
desc
- occurred_at string
Possible values: [
asc
,desc
] - created_at string
Possible values: [
asc
,desc
] - updated_at string
Possible values: [
asc
,desc
]
- 200
- 400
- 401
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- start_cursor string
The current start cursor of the records returned.
- next_cursor string
The next cursor to retrieve the next page of records.
- per_page integer
The maxumum number of records returned.
- estimated_remaining_count integer
The number of remaining records including the returned records, up to a maximum of 500.
filtered_by object[]
The filters applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
- MOD6
vendor_id object
eq stringvehicle_id object
eq stringexpense_entry_type_id object
eq stringoccurred_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringsorted_by object[]
The sorts applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
- MOD4
occurred_at stringPossible values: [
asc
,desc
]created_at stringPossible values: [
asc
,desc
]updated_at stringPossible values: [
asc
,desc
]id stringPossible values: [
asc
,desc
]records object[]
id integercreated_at date-timeupdated_at date-timetotal_amount_cents integerThe total amount of the expense in cents.
notes stringAdditional comments.
expense_entry_type_id integerexpense_entry_type_name stringName of the Expense Entry Type associated with this entry.
occurred_at date-timeDate and time of the expense.
vehicle_id integerThe ID of the associated
Vehicle
.vendor_id integerThe ID of the associated
Vendor
custom_fields object*Full details on working with Custom Fields here.
vehicle object
A Vehicle
id integername stringThis vehicle's name.
color stringThe color of this Vehicle.
license_plate stringThe license plate number of this Vehicle.
vin stringThe Vehicle Identification Number of this Vehicle.
year stringThis Vehicle's model year.
make stringThe name of this Vehicle's manufacturer.
model stringThe name of the model of this Vehicle.
trim stringThe trim level of this Vehicle.
registration_expiration_month integerPossible values:
<= 12
The month in which this Vehicle's registration expires.
registration_state stringThe state, province, or territory in which this Vehicle is registered.
default_image_url_small stringThe URL of a small-sized version of the default image for this Vehicle.
vendor object
A Vendor
name stringThe name of the Vendor.
phone stringThe phone number of the Vendor.
city stringThe city of the Vendor.
region stringThe region, state, province, or territory of the Vendor.
postal_code stringThe postal code or ZIP code of the Vendor.
country stringThe country of the Vendor.
external_id stringThe external identifier of the Vendor.
{
"start_cursor": "string",
"next_cursor": "string",
"per_page": 0,
"estimated_remaining_count": 0,
"filtered_by": [
{
"vendor_id": {
"eq": "string"
}
},
{
"vehicle_id": {
"eq": "string"
}
},
{
"expense_entry_type_id": {
"eq": "string"
}
},
{
"occurred_at": {
"lt": "string"
}
},
{
"created_at": {
"lt": "string"
}
},
{
"updated_at": {
"lt": "string"
}
}
],
"sorted_by": [
{
"occurred_at": "asc"
},
{
"created_at": "asc"
},
{
"updated_at": "asc"
},
{
"id": "asc"
}
],
"records": [
{
"id": 0,
"created_at": "2024-10-07",
"updated_at": "2024-10-07",
"total_amount_cents": 0,
"notes": "string",
"expense_entry_type_id": 0,
"expense_entry_type_name": "string",
"occurred_at": "2023-03-14T13:46:27-06:00",
"vehicle_id": 0,
"vendor_id": 0,
"custom_fields": {},
"vehicle": {
"id": 0,
"name": "string",
"color": "string",
"license_plate": "string",
"vin": "string",
"year": "string",
"make": "string",
"model": "string",
"trim": "string",
"registration_expiration_month": 0,
"registration_state": "string",
"default_image_url_small": "string"
},
"vendor": {
"name": "string",
"phone": "string",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string",
"external_id": "string"
}
}
]
}
The format or parameters of the request was invalid
- application/json
- Schema
- Example (from schema)
Schema
errors object
typeitems string
{
"errors": {}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}