A purchased product or service.
Example
{
"id": "77f5ccdc-4226-4ff1-877e-5644d0a04522",
"statusId": "approved",
"vendor": "Delta",
"notes": "Flight to LAS",
"date": "2022-03-11",
"currency": "USD",
"amount": 345.36,
"unitCount": 23,
"unitAmount": 0.575,
"isReimbursable": true,
"isBillable": true,
"invoiced": false,
"createdAt": "2022-03-18T16:51:51.148Z",
"expenseReport": {
"id": "2bdab00d-86fb-46dc-ae05-7cc9c4aedc80",
"title": "Las Vegas Convention"
},
"expenseCategory": {
"id": "175e0635-ac9e-4880-8492-07fa584f1b15",
"name": "Airfare",
"unitName": "mile"
},
"member": {
"id": "ec5543de-3b0f-47a0-b8ef-a6e18dc4b885",
"name": "John Smith"
},
"project": {
"id": "095e0780-48bf-472c-8deb-2fc3ebc7d90c",
"name": "Vendor Portal",
"client": {
"id": "4cacdf11-71d1-4fbb-90ee-b091803581b0",
"name": "Joe's Shop"
}
}
}
Attributes
Name | Type | Description |
---|---|---|
id | uuid | The unique identifier for the object. |
statusId | string | The status of the expense item. |
vendor | string | Can be either "not_submitted" (Not Submitted), "pending_approval" (Pending Approval), "approved" (Approved), or "rejected" (Rejected). |
notes | string | Any notes for the expense item. |
date | date | The date of the expense item. Will be in the form YYYY-MM-DD . |
currency | string | The currency code for this expense item's amount. This is a read-only property. |
amount | number | The total amount of the expense item. |
unitCount | number | The number of units for the expense item. This is only available for an expenseCategory that has a unitName . A typical example would be the "number of miles" for a mileage category. |
unitAmount | number | The cost per unit for the expense item. This is only available for an expenseCategory that has a unitName . A typical example would be the "rate per mile" for a mileage category. |
isReimbursable | boolean | A flag to determine if the expense is reimbursable to the associated workspace member. |
isBillable | boolean | A flag to determine if the expense item is able to be billed back to the client. |
invoiced | boolean | A flag to indicate if the expense item has been invoiced. |
createdAt | timestamp | The timestamp when the object was created. |
expenseReport | object | A simple object to the related expense report. See attributes. |
expenseCategory | object | A simple object to the related expense category. See attributes. |
member | object | A simple object to the related workspace member. See attributes. |
project | object | A simple object to the related project, if available. See attributes. |
Expense report attributes
Name | Type | Description |
---|---|---|
id | uuid | The unique identifier for the object. |
title | string | The title of the expense report. |
Expense category attributes
Name | Type | Description |
---|---|---|
id | uuid | The unique identifier for the object. |
name | string | The name of the expense category. |
unitName | string | The unit name for the expense category. If provided, this implies the related expense item will have a unitCount and unitAmount . A typical example would be the "mile" for a mileage category. |
Member attributes
Name | Type | Description |
---|---|---|
id | uuid | The unique identifier for the object. |
name | string | The name of the workspace member. |
Project attributes
Name | Type | Description |
---|---|---|
id | uuid | The unique identifier for the object. |
name | string | The name of the project. |
client | object | A simple object to the related client. See attributes. |
Client attributes
Name | Type | Description |
---|---|---|
id | uuid | The unique identifier for the object. |
name | string | The name of the client. |