Expenses
An expense object allows you to maintain details of an expense.
End Points
Create an expense
List all expenses
Update an expense
Merge expenses
Attribute
expense_id
long
Unique ID for expense. This is used as an identifier.
total
double
Total.
bcy_total
double
Total in base currency.
is_billable
boolean
Whether the expense is billable. It can either be
true
or false
. is_reimbursable
boolean
Whether the expense is reimbursable. It can either be
true
or false
. date
string
Date of the expense.
currency_id
long
Unique ID for currency.
currency_code
string
Currency code.
exchange_rate
double
Exchange rate.
is_inclusive_tax
boolean
Whether the expense amount is inclusive of tax. It can either be
true
or false
. customer_id
long
Unique ID for the customer.
customer_name
string
Name of the customer.
project_id
long
Unique ID for the project.
project_name
string
Name of the project.
paid_through_account_id
long
Unique ID for the paid through account.
paid_through_account_name
string
Name of the paid through account.
created_time
string
Time when the expense was created.
last_modified_time
string
Time when the expense was last modified.
status
string
Status of the expense report with which the expense is associated.
merchant_id
long
Unique ID for merchant.
merchant_name
string
Name of the merchant.
report_id
long
Unique ID for report.
report_name
string
Name of the expense report.
mileage_type
string
Mileage type. Possible values can be
non_mileage
or manual
or odometer
or gps
or imaps
or gmaps
or wmaps
. due_days
string
Number of days till the due date.
is_expired
boolean
Whether the expense is expired. It can either be
true
or false
. gl_code
string
A unique reference code for the category.
payment_mode
string
Payment mode.
attendees
array
Attendees for the expense.
attendee_id
long
Unique ID for the attendee.
user_id
long
Unique ID for user.
department_id
long
Unique ID of the department.
department_name
string
Name of the department.
name
string
Name of the User.
employee_number
string
Employee Number.
customer_id
long
Unique ID for the customer.
email
string
Email Id of the User.
custom_fields
array
Custom Fields.
customfield_id
long
Unique Id for the Custom Field.
label
string
Label of the Custom Field.
value
string
Value of the Custom Field.
line_items
array
Line Items of the expense.
line_item_id
long
Unique ID for the line item.
category_id
long
Unique ID for expense category.
category_name
string
Name of the expense category.
description
string
Description about the line item.
tax_id
long
Unique ID for tax.
tax_name
string
Name of the tax.
tax_percentage
double
Tax percentage.
item_total
double
Total amount for the line item.
amount
double
Amount.
item_order
integer
Order of the line item.
tags
array
Tags associated with the Line Item.
tag_id
long
(Required)
Unique ID for Tag generated by the server.
tag_name
string
Name of the Tag.
tag_option_id
long
(Required)
Unique ID for Tag option generated by the server.
tag_option_name
string
Name of the Tag Option.
Create an expense
Create a new expense.
Arguments
currency_id
long
(Required)
Unique ID for currency.
date
string
Date of the expense.
is_reimbursable
boolean
Whether the expense is reimbursable. It can either be
true
or false
. paid_through_account_id
long
Unique ID for the paid through account.
distance
double
Distance travelled.
merchant_id
long
Unique ID for merchant.
report_id
long
Unique ID for report.
payment_mode
string
Payment mode.
customer_id
long
Unique ID for the customer.
project_id
long
Unique ID for the project.
is_billable
boolean
Whether the expense is billable. It can either be
true
or false
. is_inclusive_tax
boolean
Whether the expense amount is inclusive of tax. It can either be
true
or false
. attendees
array
Attendees for the expense.
user_id
long
Unique ID for user.
custom_fields
array
Custom Fields.
customfield_id
long
(Required)
Unique Id for the Custom Field.
value
string
(Required)
Value of the Custom Field.
line_items
array
(Required)
Line Items of the expense.
category_id
long
(Required)
Unique ID for expense category.
amount
double
(Required)
Amount.
tax_id
long
Unique ID for tax.
description
string
Description about the line item.
tags
array
Tags associated with the Line Item.
tag_id
long
(Required)
Unique ID for Tag generated by the server.
tag_name
string
Name of the Tag.
tag_option_id
long
(Required)
Unique ID for Tag option generated by the server.
tag_option_name
string
Name of the Tag Option.
List all expenses
List of all existing expenses.
Query Parameters
status
Status of the expense report with which the expense is associated.
date_start
Starting Date
date_end
Ending Date
user_id
Unique ID for user.
category_id
Unique ID for expense category.
merchant_id
Unique ID for merchant.
customer_id
Unique ID for the customer.
project_id
Unique ID for the project.
Update an expense
Update the details of an expense.
Arguments
paid_through_account_id
long
Unique ID for the paid through account.
date
string
Date of the expense.
is_reimbursable
boolean
Whether the expense is reimbursable. It can either be
true
or false
. currency_id
long
Unique ID for currency.
merchant_id
long
Unique ID for merchant.
report_id
long
Unique ID for report.
payment_mode
string
Payment mode.
customer_id
long
Unique ID for the customer.
project_id
long
Unique ID for the project.
is_billable
boolean
Whether the expense is billable. It can either be
true
or false
. is_inclusive_tax
boolean
Whether the expense amount is inclusive of tax. It can either be
true
or false
. attendees
array
Attendees for the expense.
attendee_id
long
Unique ID for the attendee.
user_id
long
Unique ID for user.
custom_fields
array
Custom Fields.
customfield_id
long
(Required)
Unique Id for the Custom Field.
value
string
(Required)
Value of the Custom Field.
line_items
array
(Required)
Line Items of the expense.
line_item_id
long
Unique ID for the line item.
category_id
long
Unique ID for expense category.
description
string
Description about the line item.
tax_id
long
Unique ID for tax.
amount
double
Amount.
item_order
integer
Order of the line item.
tags
array
Tags associated with the Line Item.
tag_id
long
(Required)
Unique ID for Tag generated by the server.
tag_name
string
Name of the Tag.
tag_option_id
long
(Required)
Unique ID for Tag option generated by the server.
tag_option_name
string
Name of the Tag Option.
Merge expenses
Merge multiple expenses.
Query Parameters
duplicate_expense_id
(Required)
Unique ID of the expense to be merged.