API Reference
Request Access
Start typing to search…

Get expenses

get https://sandbox.hurdlr.com/rest/v5/expenses/expenses

Get all expenses for the authenticated user

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

Year filter (YYYY) - returns all records for the specified year. Null will return all expenses.

type
array of strings

Type filter - returns all expenses for the specified types. Null or empty list will default to PENDING, BUSINESS, & NOT_BUSINESS.

type
status
array of strings

Status filter - returns all expenses for the specified statuses. Null or empty list will default to ACTIVE.

status
boolean

Whether recurring parent expenses should be included in the response. Defaults to true, i.e. all expenses, including recurring parent expenses, will be returned.

Headers
string

Date filter - returns all records modified after the specified date

string

Cursor from the previous paginated response

int32

Page size, i.e. number of items to return per page

Response

Response body
object
data
array of objects

The list of entities

data
object
int64

Id of the expense, required when updating an existing expense

string

Status of the expense

ACTIVE INACTIVE

string

Type of the expense

BUSINESS NOT_BUSINESS PENDING PAYROLL

date-time

Date of the expense

number
required

Total amount of the expense

string

State in which this expense was incurred, used to calculate sales tax amount

UNKNOWN AL AK AS AZ AR CA CO CT DE DC FM FL GA GU HI ID IL IN IA KS KY LA ME MD MH MA MI MN MS MO MT NE NV NH NJ NM NY NC ND MP OH OK OR PW PA PR RI SC SD TN TX UT VT VI VA WA WV WI WY AB BC MB NB NL NT NS NU ON PE QC SK YT

number

Sales tax amount for the expense

string

Description of the expense

int64

Id of the vendor associated with this expense; either vendorName or vendorId is required to create a new expense

string

Name of this vendor associated with this expense; either vendorName or vendorId is required to create a new expense

int64

Id of the business assigned to this expense, required for BUSINESS expenses

int64

Id of the client assigned to this expense

string

Name of the client assigned to this expense

int64

Id of the category associated with this expense, required for BUSINESS expenses

int64

Id of the personal category associated with this expense

int64

Id of the rule that automatically classified this expense

int64

Id of the invoice that this expense is reimbursed on

string

Confidence of a tax deduction, only pertains to PENDING expenses

LIKELY QUESTIONABLE UNLIKELY

string

Frequency of the expense

ONE_TIME WEEKLY MONTHLY YEARLY

int64

Id of the recurring parent expense; populated if this expense is recurring

boolean

Whether this expense is a parent (e.g. to recurring or split children expenses). Parent expenses generally should not be directly displayed to the user, as its children are more pertinent and displaying both results in double counting.

string

Id of the expense on associated API

string

Id of the user's bank account on associated API

string

Mask of the user's bank account, often the last 4 digits of the account number

string

Display name for the bank account from which this expense originated

string

Name or id of the institution from which the transaction originated

int64

Id of the user's bank account associated with this expense

string

Transaction description, similar to what will show on the user's bank statement

int64

Id of the bill that this expense paid for

int64

Bank transfer that paid out this expense

childExpenses
array of objects
childExpenses
object
int64

Id of the expense

string
required

Type of the expense

BUSINESS NOT_BUSINESS PENDING

number
required

Total amount of the expense

int64

Id of business assigned to this expense, required for BUSINESS expenses

int64

Id of client assigned to this expense

int64

Id of the category associated with this expense, required for BUSINESS expenses

int64

Id of the personal category associated with this expense

int64

Id of the invoice that this expense is reimbursed on

string

Description of expense

string
required

Status of the expense

ACTIVE DELETED

number

Sales tax amount for the expense

string

State value for expense sales tax amount

UNKNOWN AL AK AS AZ AR CA CO CT DE DC FM FL GA GU HI ID IL IN IA KS KY LA ME MD MH MA MI MN MS MO MT NE NV NH NJ NM NY NC ND MP OH OK OR PW PA PR RI SC SD TN TX UT VT VI VA WA WV WI WY AB BC MB NB NL NT NS NU ON PE QC SK YT

customData
object

Custom JSON in which you can store any data with max length of 2000 characters

Has additional fields
string

Review status of the expense

PARTNER_REVIEW_REQUIRED USER_REVIEW_REQUIRED ACCOUNTANT_REVIEW_REQUIRED RECONCILIATION_STAGED RECONCILED RECONCILIATION_DISCREPANCY ADJUSTMENT_USER_REVIEW_REQUIRED ADJUSTMENT_ACCOUNTANT_REVIEW_REQUIRED ADJUSTMENT_RECONCILIATION_STAGED

string

Access level for the user. This field uses the default configuration for the Partner; however, it can be overridden to manipulate how a user can interact with this expense.

NONE READ_ONLY READ_WRITE

string

Access level for the accountant. This field uses the default configuration for the Partner; however, it can be overridden to manipulate how an accountant can interact with this expense.

NONE READ_ONLY READ_WRITE

string

Id of the order associated with this expense

date-time

Date filter - to be used in your subsequent request

string

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.

deletedIds
array of int32s

Ids of entities that no longer match the request's filter criteria since the request's lastUpdatedDate

deletedIds

Updated about 1 year ago

Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago