Expense
Expenses are the costs incurred on your company's operating activities and overheads. Expense object allows you to perform the following operations:
- Retrieve a specific or a list of expenses
- Create an expense
- Update an expense
- Delete an expense
- cURL
- NODE.JS
- PHP
- C#
- PYTHON
- JAVA
The Expense Object
asterisk denotes requiredName | Description | Format | Attributes |
---|---|---|---|
code | Represents an expense item code | string | MaxLength = 100 Filterable |
description | Represents the description of an expense | string | MaxLength = 100 Filterable, Sortable |
billable | Indicates whether an expense is billable or not. If true, the expense is billable | boolean | Filterable, Sortable |
class | Name of the class | string | Filterable, Sortable |
classId | Identifier of the class | uuid | Filterable |
costRate | The per unit cost of an expense item | double | |
createdById | Identifier of the user who created this object | uuid | Filterable |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
customFields []Array: Parent object can have multiple instances of this nested object under it. | Represents a list of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. | |
defaultGroup | Name of the default group to which an expense item belongs | string | |
defaultGroupId | Identifier of the default group to which an expense item belongs | uuid | |
expenseAccount | Name of an expense account associated with an expense | string | |
expenseAccountId | Identifier of an expense account used to track the expenditure associated with expenses incurred | uuid | |
id | Object identifier | uuid | Filterable |
incomeAccount | Name of an income account associated with an expense | string | |
incomeAccountId | Identifier of an income account used to track the income associated with expenses incurred | uuid | |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string | Filterable, Sortable |
isActive | Indicates the status of an expense item. If true, status is active | boolean | Filterable, Sortable |
isProduct | Determines whether this is a product or not | boolean | Filterable, Sortable |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
lastUpdatedById | Identifier of the user who last updated this object | uuid | Filterable |
markup | Percentage increase in the cost rate to determine the cost amount | double | |
memo | Records any extra information or details about an expense | string | |
name | Name of the expense | string | Filterable, Sortable MaxLength = 31 |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectState Enumerated type: Click to see possible values and their descriptions. | |
purchaseTaxRate | Tax paid by a company on an expense subtracted from the expense amount to avoid double-taxation for the client | double | |
reimbursable | Indicates whether an expense is reimbursable or not. If true, expense is reimbursable | boolean | Filterable, Sortable |
sub | Represents an expense item sub-code | string | MaxLength = 15 |
tax1 | In addition to the main expense tax, Tax1 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double | |
tax2 | In addition to the main expense tax, Tax2 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double | |
tax3 | In addition to the main expense tax, Tax3 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double | |
token | Represents the token for update operations | int32 | |
type | Represents the expense types, e.g inventory, non-inventory, etc. | ExpenseType Enumerated type: Click to see possible values and their descriptions. | Filterable, Sortable |
version | Implements concurrency on this object | byte |
Expense List
Use this method to retrieve a list of expenses. Optionally pass where, orderBy and page as the query parameters to filter the result. Use the fields parameter to request a subset of the model. By default, a complete model is returned. The expand parameter is used to request nested properties in the model.
Request URL
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Expense
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
fields | Query | Specifies the model properties you want in the response body | string |
where | Query | Specifies only those records that match an expression in the query | string |
orderBy | Query | Specifies the order of the records | string |
page | Query | Specifies the page number and number of records on each page | string |
expand | Query | Specifies the nested model properties you want in the response body | string |
Response Body
Name | Description | Format |
---|---|---|
code | Represents an expense item code | string |
description | Represents the description of an expense | string |
billable | Indicates whether an expense is billable or not. If true, the expense is billable | boolean |
class | Name of the class | string |
classId | Identifier of the class | uuid |
costRate | The per unit cost of an expense item | double |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
customFields []Array: Parent object can have multiple instances of this nested object under it. | Represents a list of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
defaultGroup | Name of the default group to which an expense item belongs | string |
defaultGroupId | Identifier of the default group to which an expense item belongs | uuid |
expenseAccount | Name of an expense account associated with an expense | string |
expenseAccountId | Identifier of an expense account used to track the expenditure associated with expenses incurred | uuid |
id | Object identifier | uuid |
incomeAccount | Name of an income account associated with an expense | string |
incomeAccountId | Identifier of an income account used to track the income associated with expenses incurred | uuid |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
isActive | Indicates the status of an expense item. If true, status is active | boolean |
isProduct | Determines whether this is a product or not | boolean |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
markup | Percentage increase in the cost rate to determine the cost amount | double |
memo | Records any extra information or details about an expense | string |
name | Name of the expense | string |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
purchaseTaxRate | Tax paid by a company on an expense subtracted from the expense amount to avoid double-taxation for the client | double |
reimbursable | Indicates whether an expense is reimbursable or not. If true, expense is reimbursable | boolean |
sub | Represents an expense item sub-code | string |
tax1 | In addition to the main expense tax, Tax1 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
tax2 | In addition to the main expense tax, Tax2 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
tax3 | In addition to the main expense tax, Tax3 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
token | Represents the token for update operations | int32 |
type | Represents the expense types, e.g inventory, non-inventory, etc. | ExpenseTypeEnumerated type: Click to see possible values and their descriptions. |
version | Implements concurrency on this object | byte |
[
{
"code": "6011",
"description": "Expense Description",
"billable": true,
"class": "class",
"classId": "45988e44-ba5c-424d-a3d8-5c428485d6b9",
"costRate": 1,
"createdById": "0c675587-6f1c-42ac-b8e1-aa5d388a25be",
"createdOn": "2024-12-12T05:27:02Z",
"customFields": [
{
"definitionId": "d831c7ef-9093-4b70-b7fc-3aaa0d11ad01",
"createdById": "00bcfa42-3831-4d31-a3d7-0c264a1294ea",
"createdOn": "2024-12-12T05:27:02Z",
"description": "CustomFieldData Description",
"id": "b746ed42-6d1b-48eb-89ef-49f86efabad6",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2024-12-12T05:27:02Z",
"lastUpdatedById": "f2fbd897-a3f7-49c4-9e9b-ab9b9b878793",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"defaultGroup": "defaultGroup",
"defaultGroupId": "0c2277ea-4b6d-4266-ba49-e742682e169a",
"expenseAccount": "expenseAccount",
"expenseAccountId": "e4b40e09-91a3-4642-9d6b-3bd3e988e0b2",
"id": "b6a6733d-cec7-4075-9054-cb89bb14da62",
"incomeAccount": "incomeAccount",
"incomeAccountId": "ec3ec3c9-28c2-478f-8ff8-a0b04fe0edb4",
"integrationSourceId": "integrationSourceId",
"isActive": true,
"isProduct": true,
"lastUpdated": "2024-12-12T05:27:02Z",
"lastUpdatedById": "bd2c97c8-00a6-47ea-b5f6-a050c458a4da",
"markup": 1,
"memo": "memo",
"name": "Expense",
"objectState": null,
"purchaseTaxRate": 1,
"reimbursable": true,
"sub": "sub",
"tax1": 1,
"tax2": 1,
"tax3": 1,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]
Retrieve an Expense
Use this method to retrieve a specific expense. Pass id as the parameter.
Request URL
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Expense
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Expense identifier | string |
Response Body
Name | Description | Format |
---|---|---|
code | Represents an expense item code | string |
description | Represents the description of an expense | string |
billable | Indicates whether an expense is billable or not. If true, the expense is billable | boolean |
class | Name of the class | string |
classId | Identifier of the class | uuid |
costRate | The per unit cost of an expense item | double |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
customFields []Array: Parent object can have multiple instances of this nested object under it. | Represents a list of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
defaultGroup | Name of the default group to which an expense item belongs | string |
defaultGroupId | Identifier of the default group to which an expense item belongs | uuid |
expenseAccount | Name of an expense account associated with an expense | string |
expenseAccountId | Identifier of an expense account used to track the expenditure associated with expenses incurred | uuid |
id | Object identifier | uuid |
incomeAccount | Name of an income account associated with an expense | string |
incomeAccountId | Identifier of an income account used to track the income associated with expenses incurred | uuid |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
isActive | Indicates the status of an expense item. If true, status is active | boolean |
isProduct | Determines whether this is a product or not | boolean |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
markup | Percentage increase in the cost rate to determine the cost amount | double |
memo | Records any extra information or details about an expense | string |
name | Name of the expense | string |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
purchaseTaxRate | Tax paid by a company on an expense subtracted from the expense amount to avoid double-taxation for the client | double |
reimbursable | Indicates whether an expense is reimbursable or not. If true, expense is reimbursable | boolean |
sub | Represents an expense item sub-code | string |
tax1 | In addition to the main expense tax, Tax1 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
tax2 | In addition to the main expense tax, Tax2 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
tax3 | In addition to the main expense tax, Tax3 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
token | Represents the token for update operations | int32 |
type | Represents the expense types, e.g inventory, non-inventory, etc. | ExpenseTypeEnumerated type: Click to see possible values and their descriptions. |
version | Implements concurrency on this object | byte |
{
"code": "6011",
"description": "Expense Description",
"billable": true,
"class": "class",
"classId": "37eb75ef-d748-4fe3-9a0e-9254dddb750b",
"costRate": 1,
"createdById": "39203f9d-fb94-4afd-accd-c7298c78d040",
"createdOn": "2024-12-12T05:27:02Z",
"customFields": [
{
"definitionId": "e2a23645-69b2-48af-9bbb-fd5459edc77c",
"createdById": "de61cec1-6388-43da-9ecd-3f6329c34b05",
"createdOn": "2024-12-12T05:27:02Z",
"description": "CustomFieldData Description",
"id": "5b38c785-9cb2-4c28-8f3d-27030d07504f",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2024-12-12T05:27:02Z",
"lastUpdatedById": "56a0e441-f64d-4d0d-868b-c366b5eb984e",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"defaultGroup": "defaultGroup",
"defaultGroupId": "2bd9583b-2437-4d9b-ae64-d8a1cffcb7b1",
"expenseAccount": "expenseAccount",
"expenseAccountId": "85617c7b-2faf-453f-b6d8-5d7be261ef7b",
"id": "025d8dd3-61b2-4180-aa4a-73b6df0add38",
"incomeAccount": "incomeAccount",
"incomeAccountId": "37205c78-d04a-46ab-87d4-9c5c45d9f9d5",
"integrationSourceId": "integrationSourceId",
"isActive": true,
"isProduct": true,
"lastUpdated": "2024-12-12T05:27:02Z",
"lastUpdatedById": "ff71b032-dab1-4eee-89e1-070d16558c97",
"markup": 1,
"memo": "memo",
"name": "Expense",
"objectState": null,
"purchaseTaxRate": 1,
"reimbursable": true,
"sub": "sub",
"tax1": 1,
"tax2": 1,
"tax3": 1,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
Create an Expense
Use this method to save an expense. Pass expense as the parameter.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Expense
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
body | Body | Expense object | Expense |
Response Body
Name | Description | Format |
---|---|---|
code | Represents an expense item code | string |
description | Represents the description of an expense | string |
billable | Indicates whether an expense is billable or not. If true, the expense is billable | boolean |
class | Name of the class | string |
classId | Identifier of the class | uuid |
costRate | The per unit cost of an expense item | double |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
customFields []Array: Parent object can have multiple instances of this nested object under it. | Represents a list of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
defaultGroup | Name of the default group to which an expense item belongs | string |
defaultGroupId | Identifier of the default group to which an expense item belongs | uuid |
expenseAccount | Name of an expense account associated with an expense | string |
expenseAccountId | Identifier of an expense account used to track the expenditure associated with expenses incurred | uuid |
id | Object identifier | uuid |
incomeAccount | Name of an income account associated with an expense | string |
incomeAccountId | Identifier of an income account used to track the income associated with expenses incurred | uuid |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
isActive | Indicates the status of an expense item. If true, status is active | boolean |
isProduct | Determines whether this is a product or not | boolean |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
markup | Percentage increase in the cost rate to determine the cost amount | double |
memo | Records any extra information or details about an expense | string |
name | Name of the expense | string |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
purchaseTaxRate | Tax paid by a company on an expense subtracted from the expense amount to avoid double-taxation for the client | double |
reimbursable | Indicates whether an expense is reimbursable or not. If true, expense is reimbursable | boolean |
sub | Represents an expense item sub-code | string |
tax1 | In addition to the main expense tax, Tax1 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
tax2 | In addition to the main expense tax, Tax2 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
tax3 | In addition to the main expense tax, Tax3 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
token | Represents the token for update operations | int32 |
type | Represents the expense types, e.g inventory, non-inventory, etc. | ExpenseTypeEnumerated type: Click to see possible values and their descriptions. |
version | Implements concurrency on this object | byte |
{
"code": "6011",
"description": "Expense Description",
"billable": true,
"class": "class",
"classId": "e02ce8b1-62d4-411a-9ef9-e95c9203f4c2",
"costRate": 1,
"createdById": "70f8e830-b410-47f7-a560-f4508982acb5",
"createdOn": "2024-12-12T05:27:02Z",
"customFields": [
{
"definitionId": "3b582e32-371d-4aac-a03b-8d978a7ebe42",
"createdById": "0528822b-7158-4e93-8b66-c876008a400d",
"createdOn": "2024-12-12T05:27:02Z",
"description": "CustomFieldData Description",
"id": "b3acff45-8074-49ea-9dcf-999164731701",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2024-12-12T05:27:02Z",
"lastUpdatedById": "75b1dcaf-8b5c-4873-9237-0af13c8c9af6",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"defaultGroup": "defaultGroup",
"defaultGroupId": "377d4680-f213-4f4b-9694-e25771889a43",
"expenseAccount": "expenseAccount",
"expenseAccountId": "3db3c7dd-0a73-4509-813e-b652e88cf3d2",
"id": "6af866dc-5a30-407a-85af-9689e8d610c5",
"incomeAccount": "incomeAccount",
"incomeAccountId": "3055759e-5f05-4d12-9f6b-0a48acfc89f7",
"integrationSourceId": "integrationSourceId",
"isActive": true,
"isProduct": true,
"lastUpdated": "2024-12-12T05:27:02Z",
"lastUpdatedById": "15bedcb7-457b-4872-b3b7-b3badf4b7b8b",
"markup": 1,
"memo": "memo",
"name": "Expense",
"objectState": null,
"purchaseTaxRate": 1,
"reimbursable": true,
"sub": "sub",
"tax1": 1,
"tax2": 1,
"tax3": 1,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
Create an Expense List
Use this method to save multiple expense. Pass model as the parameter.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Expense
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
body | Body | Expense object | ExpenseBatchRequest |
Response Body
Name | Description | Format |
---|---|---|
batchSize | Represents the number of entities in a batch | int64 |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
id | Object identifier | uuid |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
progress | Represents the total number of entities processed | int64 |
status | Represents the status of a job e.g., ready, running, completed, or terminated | string |
token | Represents the token for update operations | int32 |
type | Represents the type of a job e.g., create, update, or delete | string |
version | Implements concurrency on this object | byte |
{
"batchSize": 0,
"createdById": "8139a32d-0651-4dfa-b3f7-7b4594df89f1",
"createdOn": "2024-12-12T05:27:02Z",
"id": "457939ae-8bb8-4918-baa5-8c9b6f589483",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2024-12-12T05:27:02Z",
"lastUpdatedById": "703676e1-b57f-4f26-ab87-ec4e1f570090",
"objectState": null,
"progress": 0,
"status": "status",
"token": 0,
"type": "type",
"version": "U3dhZ2dlciByb2Nrcw=="
}
Update an Expense
Use this method to update an expense. Pass id and expense as the parameters.
Request URL
Method Overview
HTTP Method:
PUT
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Expense
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Expense identifier | string |
body | Body | Expense object | Expense |
Response Body
Name | Description | Format |
---|---|---|
code | Represents an expense item code | string |
description | Represents the description of an expense | string |
billable | Indicates whether an expense is billable or not. If true, the expense is billable | boolean |
class | Name of the class | string |
classId | Identifier of the class | uuid |
costRate | The per unit cost of an expense item | double |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
customFields []Array: Parent object can have multiple instances of this nested object under it. | Represents a list of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
defaultGroup | Name of the default group to which an expense item belongs | string |
defaultGroupId | Identifier of the default group to which an expense item belongs | uuid |
expenseAccount | Name of an expense account associated with an expense | string |
expenseAccountId | Identifier of an expense account used to track the expenditure associated with expenses incurred | uuid |
id | Object identifier | uuid |
incomeAccount | Name of an income account associated with an expense | string |
incomeAccountId | Identifier of an income account used to track the income associated with expenses incurred | uuid |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
isActive | Indicates the status of an expense item. If true, status is active | boolean |
isProduct | Determines whether this is a product or not | boolean |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
markup | Percentage increase in the cost rate to determine the cost amount | double |
memo | Records any extra information or details about an expense | string |
name | Name of the expense | string |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
purchaseTaxRate | Tax paid by a company on an expense subtracted from the expense amount to avoid double-taxation for the client | double |
reimbursable | Indicates whether an expense is reimbursable or not. If true, expense is reimbursable | boolean |
sub | Represents an expense item sub-code | string |
tax1 | In addition to the main expense tax, Tax1 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
tax2 | In addition to the main expense tax, Tax2 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
tax3 | In addition to the main expense tax, Tax3 rate is applied to an invoice. These taxes (Tax1,Tax2,Tax3) are combined to calculate the charge amount | double |
token | Represents the token for update operations | int32 |
type | Represents the expense types, e.g inventory, non-inventory, etc. | ExpenseTypeEnumerated type: Click to see possible values and their descriptions. |
version | Implements concurrency on this object | byte |
{
"code": "6011",
"description": "Expense Description",
"billable": true,
"class": "class",
"classId": "6bd042f4-016c-4182-84d7-8a7b7b2a8624",
"costRate": 1,
"createdById": "e7f6d71b-4918-434c-ac8b-e19c7c42ad54",
"createdOn": "2024-12-12T05:27:02Z",
"customFields": [
{
"definitionId": "f07bd890-a159-4f8a-b382-974d5187d968",
"createdById": "93cfb3a1-5e6d-47f0-b27a-35f5476b2350",
"createdOn": "2024-12-12T05:27:02Z",
"description": "CustomFieldData Description",
"id": "07ec5159-799d-4d7d-a924-7890e32f39e1",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2024-12-12T05:27:02Z",
"lastUpdatedById": "60cf0de1-6682-43c4-ae80-dcb721d724de",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"defaultGroup": "defaultGroup",
"defaultGroupId": "d83e52cd-9b63-4c31-99e4-98eb504343ab",
"expenseAccount": "expenseAccount",
"expenseAccountId": "49e8534e-86d9-46d0-a279-002183fa7e37",
"id": "e392e2e5-f4d3-4203-ac3e-6bb230fbf4e4",
"incomeAccount": "incomeAccount",
"incomeAccountId": "ef6196bf-7d86-42d0-9226-7a8ca8eb053a",
"integrationSourceId": "integrationSourceId",
"isActive": true,
"isProduct": true,
"lastUpdated": "2024-12-12T05:27:02Z",
"lastUpdatedById": "2200b78f-68a4-4f3c-9ac7-9960d7a459cd",
"markup": 1,
"memo": "memo",
"name": "Expense",
"objectState": null,
"purchaseTaxRate": 1,
"reimbursable": true,
"sub": "sub",
"tax1": 1,
"tax2": 1,
"tax3": 1,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
Delete an Expense
Use this method to delete an expense. Pass id as the parameter.
Request URL
Method Overview
HTTP Method:
DELETE
Content Type:
application/json
Response Format:
N/A
Requires Authentication?
Yes
Headers:
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Expense identifier | string |
Patch an Expense
Use this method to perform partial modifications to an expense. Pass id and patch document as parameters.
Request URL
Method Overview
HTTP Method:
PATCH
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Expense
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Expense identifier | string |
body | Body | A document containing an array of objects with each object representing a single operation | ExpensePatchDocument |
Response Body
Name | Description | Format |
---|