Employee expense lines

Details for each expense line on the employee expense report. Employees create and submit expense reports, consisting of individual line items, to receive reimbursement for approved out-of-pocket costs related to their jobs.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List employee expense lines

get/objects/expenses/employee-expense-line

Returns a collection with a key, ID, and link for each employee expense line.

Permissions and other requirements
SubscriptionTime & Expenses
User typeBusiness, Employee, Project Manager (Projects subscription)
PermissionsList and View Expenses
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "100",
      • "id": "100",
      • "href": "/objects/expenses/employee-expense-line/100"
      },
    • {
      • "key": "101",
      • "id": "101",
      • "href": "/objects/expenses/employee-expense-line/101"
      },
    • {
      • "key": "102",
      • "id": "102",
      • "href": "/objects/expenses/employee-expense-line/102"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 5,
    • "next": 0,
    • "previous": 0
    }
}

Create an employee expense line

post/objects/expenses/employee-expense-line

Creates a new employee expense line.

Permissions and other requirements
SubscriptionTime & Expenses
User typeBusiness, Employee, Project Manager (Projects subscription)
PermissionsList, View, Add Expenses
SecurityOAuth2
Request
Request Body schema: application/json

Creates an employee expense line

txnAmount
required
string <decimal-precision-2>

Transaction amount. For multi-currency companies.

Example: "123.45"
entryDate
string or null <date>

Date that the expense was incurred.

Example: "2021-01-23"
txnCurrency
string or null

Transaction currency. For multi-currency companies.

Example: "INR"
quantity
string or null <decimal-precision-2>

Quantity for a rate-based expense such as mileage.

Example: "5.75"
unitRate
string or null <decimal-precision-2>

Monetary amount for a rate-based expense, such as mileage.

Example: "20.00"
paidTo
string or null

Notes regarding to whom the amount was paid.

Example: "Hotel Westin"
paidFor
string or null

Notes regarding what the expense was for.

Example: "2024 Hawaii Conference"
object

General ledger account associated with the line item. Used when no expense type is assigned.

key
string

Unique key for the GL account.

Example: "158"
id
string

Unique identifier for the GL account.

Example: "6775.30"
object

An expense type defined in the company.

key
string

Unique key for the expense type.

Example: "6000"
id
string

Unique identifier for the expense type.

Example: "Meals"
object

Details of the conversion to base currency. For multi-currency companies.

exchangeRate
string or null <decimal-precision-5>

Exchange rate for the transaction.

Example: "65.095"
exchangeRateDate
string or null <date>

Date for the exchange rate.

Example: "2021-01-23"
exchangeRateTypeId
string or null

Exchange rate type.

Example: "-1"
isBillable
boolean
Default: false

Indicates whether a line item is billable.

Example: false
object

Form 1099 information for the line item.

isForm1099
string or null

If set to true, the line item amount is added to the form 1099.

Example: true
type
string or null

Type of form 1099.

Example: "MISC"
box
string or null

Box value of form 1099.

Example: "3"
object

The payment type defined in employee-expense-payment-type.

key
string or null

Unique key for the expense payment type.

Example: "23"
id
string or null

Unique identifier for the payment type.

Example: "Non-reimburse"
object
object
key
string or null

Location key

Example: "1"
id
string or null

Location

Example: "1"
object
key
string or null

Department key

Example: "11"
id
string or null

Department

Example: "1"
object
key
string or null

Employee key

Example: "10"
id
string or null

Employee ID

Example: "EMP-10"
object
key
string or null

Project key

Example: "2"
id
string or null

Project ID

Example: "NET-XML30-2"
object
key
string or null

Customer key

Example: "13"
id
string or null

Customer ID

Example: "CUST-13"
object
key
string or null

Vendor key

Example: "357"
id
string or null

Vendor ID

Example: "1605212096809"
object
key
string or null

Item key

Example: "13"
id
string or null

Item ID

Example: "Case 13"
object
key
string or null

Warehouse key

Example: "6"
id
string or null

Warehouse ID

Example: "WH01"
object
key
string or null

Class key

Example: "731"
id
string or null

Class ID

Example: "REST_CLS_001"
object
id
string or null

Task ID

Example: "1"
key
string or null

Task key

Example: "1"
object
id
string or null

Cost Type ID

Example: "2"
key
string or null

Cost Type key

Example: "2"
object
id
string or null

Asset ID

Example: "A001"
key
string or null

Asset key

Example: "1"
object
id
string or null

Contract ID

Example: "CON-0045-1"
key
string or null

Contract key

Example: "12"
object
key
string or null

Affiliate entity key.

Example: "23"
id
string or null

Affiliate entity ID.

Example: "AFF-23"
object
id
string

Unique identifier for the employee expense.

Example: "124"
key
string

Unique key for the employee expense.

Example: "124"
Responses
201

Created

400

Bad Request

Request samples
application/json
{
  • "account": {
    • "id": "6775.3"
    },
  • "paidTo": "Stella Johnson",
  • "paidFor": "Hotel stay",
  • "isBillable": false,
  • "form1099": {
    • "isForm1099": "true",
    • "type": "MISC",
    • "box": "3"
    },
  • "paymentType": {
    • "key": "1",
    • "id": "Non-reimburse",
    • "isNonreimbursable": false
    },
  • "quantity": "10",
  • "unitrate": "20",
  • "txnCurrency": "INR",
  • "txnAmount": "100",
  • "transactionToReimburseConversion": {
    • "exchangeRateDate": "2021-03-11",
    • "exchangeRateTypeId": "Intacct Daily Rate"
    },
  • "dimensions": {
    • "location": {
      • "id": "1"
      },
    • "department": {
      • "id": "1"
      },
    • "class": {
      • "id": "REST_CLS_001"
      },
    • "item": {
      • "id": "Case 13"
      },
    • "employee": {
      • "id": "10"
      },
    • "vendor": {
      • "id": "1605212096809"
      },
    • "customer": {
      • "id": "113"
      },
    • "project": {
      • "id": "NET-XML30-2"
      },
    • "warehouse": {
      • "id": "WH01"
      },
    • "task": {
      • "id": "tet"
      }
    }
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "124",
    • "id": "124",
    • "href": "/objects/expenses/employee-expense-line/124"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}

Get an employee expense line

get/objects/expenses/employee-expense-line/{key}

Returns detailed information for a specified employee expense line.

Permissions and other requirements
SubscriptionTime & Expenses
User typeBusiness, Employee, Project Manager (Projects subscription)
PermissionsList and View Expenses
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the employee expense line.

Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "312",
    • "id": "312",
    • "employee-expense": {
      • "id": "136",
      • "key": "136",
      • "href": "/objects/expenses/employee-expense/136"
      },
    • "glAccount": {
      • "key": "158",
      • "id": "6775.30",
      • "name": "Travel",
      • "href": "/objects/account/158"
      },
    • "entryDate": "2021-03-11",
    • "paidTo": "Stella Johnson",
    • "paidFor": "Hotel stay",
    • "reimburseToBase": {
      • "baseAmount": "1.38",
      • "exchangeRateDate": "2021-03-11",
      • "exchangeRateTypeId": "-1",
      • "exchangeRate": "1.1899"
      },
    • "dimensions": {
      • "location": {
        },
      • "department": {
        },
      • "class": {
        },
      • "item": {
        },
      • "employee": {
        },
      • "vendor": {
        },
      • "customer": {
        },
      • "project": {
        },
      • "task": {
        },
      • "warehouse": {
        }
      },
    • "lineNumber": 1,
    • "expenseType": {
      • "key": "Meals",
      • "id": "6000"
      },
    • "reimbursement": {
      • "reimbursementAmount": "1.16",
      • "totalSelected": "0",
      • "totalPaid": "0"
      },
    • "isBillable": false,
    • "isBilled": false,
    • "state": "approved",
    • "form1099": {
      • "isForm1099": "true",
      • "type": "MISC",
      • "box": "3"
      },
    • "paymentType": {
      • "key": "1",
      • "id": "Non-reimburse",
      • "isNonreimbursable": false
      },
    • "quantity": "5",
    • "unitRate": "20",
    • "currency": {
      • "txnCurrency": "INR",
      • "txnAmount": "4444",
      • "exchangeRateDate": "2021-03-11",
      • "exchangeRateTypeId": "-1",
      • "exchangeRate": "65",
      • "userExchangeRate": "5"
      },
    • "href": "/objects/expenses/employee-expense-line/312"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Update an employee expense line

patch/objects/expenses/employee-expense-line/{key}

Updates an existing employee expense line by setting field values. Any fields not provided remain unchanged.

Permissions and other requirements
SubscriptionTime & Expenses
User typeBusiness, Employee, Project Manager (Projects subscription)
PermissionsList, View, Edit Expenses
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the employee expense line.

Request Body schema: application/json
entryDate
string or null <date>

Date that the expense was incurred.

Example: "2021-01-23"
txnCurrency
string or null

Transaction currency. For multi-currency companies.

Example: "INR"
txnAmount
string <decimal-precision-2>

Transaction amount. For multi-currency companies.

Example: "123.45"
quantity
string or null <decimal-precision-2>

Quantity for a rate-based expense such as mileage.

Example: "5.75"
unitRate
string or null <decimal-precision-2>

Monetary amount for a rate-based expense, such as mileage.

Example: "20.00"
paidTo
string or null

Notes regarding to whom the amount was paid.

Example: "Hotel Westin"
paidFor
string or null

Notes regarding what the expense was for.

Example: "2024 Hawaii Conference"
object

General ledger account associated with the line item. Used when no expense type is assigned.

key
string

Unique key for the GL account.

Example: "158"
id
string

Unique identifier for the GL account.

Example: "6775.30"
object

An expense type defined in the company.

key
string

Unique key for the expense type.

Example: "6000"
id
string

Unique identifier for the expense type.

Example: "Meals"
object

Details of the conversion to base currency. For multi-currency companies.

exchangeRate
string or null <decimal-precision-5>

Exchange rate for the transaction.

Example: "65.095"
exchangeRateDate
string or null <date>

Date for the exchange rate.

Example: "2021-01-23"
exchangeRateTypeId
string or null

Exchange rate type.

Example: "-1"
isBillable
boolean
Default: false

Indicates whether a line item is billable.

Example: false
object

Form 1099 information for the line item.

isForm1099
string or null

If set to true, the line item amount is added to the form 1099.

Example: true
type
string or null

Type of form 1099.

Example: "MISC"
box
string or null

Box value of form 1099.

Example: "3"
object

The payment type defined in employee-expense-payment-type.

key
string or null

Unique key for the expense payment type.

Example: "23"
id
string or null

Unique identifier for the payment type.

Example: "Non-reimburse"
object
object
key
string or null

Location key

Example: "1"
id
string or null

Location

Example: "1"
object
key
string or null

Department key

Example: "11"
id
string or null

Department

Example: "1"
object
key
string or null

Employee key

Example: "10"
id
string or null

Employee ID

Example: "EMP-10"
object
key
string or null

Project key

Example: "2"
id
string or null

Project ID

Example: "NET-XML30-2"
object
key
string or null

Customer key

Example: "13"
id
string or null

Customer ID

Example: "CUST-13"
object
key
string or null

Vendor key

Example: "357"
id
string or null

Vendor ID

Example: "1605212096809"
object
key
string or null

Item key

Example: "13"
id
string or null

Item ID

Example: "Case 13"
object
key
string or null

Warehouse key

Example: "6"
id
string or null

Warehouse ID

Example: "WH01"
object
key
string or null

Class key

Example: "731"
id
string or null

Class ID

Example: "REST_CLS_001"
object
id
string or null

Task ID

Example: "1"
key
string or null

Task key

Example: "1"
object
id
string or null

Cost Type ID

Example: "2"
key
string or null

Cost Type key

Example: "2"
object
id
string or null

Asset ID

Example: "A001"
key
string or null

Asset key

Example: "1"
object
id
string or null

Contract ID

Example: "CON-0045-1"
key
string or null

Contract key

Example: "12"
object
key
string or null

Affiliate entity key.

Example: "23"
id
string or null

Affiliate entity ID.

Example: "AFF-23"
object
id
string

Unique identifier for the employee expense.

Example: "124"
key
string

Unique key for the employee expense.

Example: "124"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "paidTo": "Travel expense"
}
Response samples
application/json
{
  • "ia::result": {
    • "key": "124",
    • "id": "124",
    • "href": "/objects/expenses/employee-expense-line/124"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}

Delete an employee expense line

delete/objects/expenses/employee-expense-line/{key}

Deletes an employee expense line.

Permissions and other requirements
SubscriptionTime & Expenses
User typeBusiness, Employee, Project Manager (Projects subscription)
PermissionsList, View, Delete Expenses
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the employee expense line.

Responses
204

No Content

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}

Query employee expense lines

post/services/core/query

Queries an object for filtered data.

SecurityOAuth2
Request
Request Body schema: application/json
object
string

Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.

Example: "expenses/employee-expense-line"
fields
Array of strings

List of fields to include in the response. Can be any combination of these:

  • The name of a field in the object that you are querying, such as id.

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:

    • count
    • avg
    • sum
    • min
    • max
  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.

Example: ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)

Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".

Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
Array
Any of:

Field value must be equal to this specified value.

For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:

  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear

These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.

For example, {"eq":{"postingDate":"priorYear"}}.

object

The field name and value to be compared with object values.

Example: {"status":"active"}
filterExpression
string
Default: "and"

Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.

Shortcuts:

  • and by itself means that all conditions must be true.
  • or by itself means that at least one condition must be true.
Example: "(1 and 2) or 3"
object

Pre-defined filter options.

asOfDate
string <date>

The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".

The current date is used if asOfDate is not set.

Example: "2022-04-01"
includeHierarchyFields
boolean
Default: false

Set to true to include hierarchical structure information with each object in the response.

Example: false
caseSensitiveComparison
boolean
Default: true

Queries are case-sensitive by default. Set to false to ignore case in a query.

Example: true
includePrivate
boolean
Default: false

By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.

Example: false
Array of objects

Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.

Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
Array
property name*
additional property
string
Enum: "asc" "desc"
start
integer

First record of the result set to include in the response.

Example: 1
size
integer

Number of records to include in the response.

Example: 100
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "object": "expenses/employee-expense-line",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "reimbursementAmount",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "267",
      • "id": "267",
      • "reimbursementAmount": "130.00",
      • "href": "/objects/expenses/employee-expense-line/267"
      },
    • {
      • "key": "269",
      • "id": "269",
      • "reimbursementAmount": "600.00",
      • "href": "/objects/expenses/employee-expense-line/269"
      },
    • {
      • "key": "271",
      • "id": "271",
      • "reimbursementAmount": "350.00",
      • "href": "/objects/expenses/employee-expense-line/271"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}