API Docs
/
No Results Found
Expenses

Expenses

A typical expense is incurred when money goes out of your pocket. Whether its a product you buy from your vendor to run your business, or food that you eat while on business trips, itโ€™s important to track the money you spend.

Attribute

expense_id
string
transaction_id
string
transaction_type
string
gst_no
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
15 digit GST identification number of the vendor.
gst_treatment
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
tax_treatment
string
GCC only
VAT treatment for the expense .Choose whether the contact falls under: vat_registered,vat_not_registered,gcc_vat_not_registered,gcc_vat_registered,non_gcc.
dz_vat_registered and dz_vat_not_registered are supported only for UAE.
destination_of_supply
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)
destination_of_supply_state
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
State to where goods/services are supplied
place_of_supply
string
GCC only
The place of supply is where a transaction is considered to have occurred for VAT purposes. For the supply of goods, the place of supply is the location of the goods when the supply occurs. For the supply of services, the place of supply should be where the supplier is established. (If not given, place of contact given for the contact will be taken)
Supported codes for UAE emirates are :
Abu Dhabi - AB,
Ajman - AJ,
Dubai - DU,
Fujairah - FU,
Ras al-Khaimah - RA,
Sharjah - SH,
Umm al-Quwain - UM.
Supported codes for the GCC countries are :
United Arab Emirates - AE,
Saudi Arabia - SA,
Bahrain - BH,
Kuwait - KW,
Oman - OM,
Qatar - QA.
hsn_or_sac
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Add HSN/SAC code for your goods/services
source_of_supply
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)
paid_through_account_name
string
Enter the name of the paid through account.
vat_reg_no
string
Enter VAT registration number.
reverse_charge_tax_id
string
ID of the reverse charge tax
reverse_charge_tax_name
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Enter name of the reverse charge tax
reverse_charge_tax_percentage
double
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Enter percentage of the reverse charge tax
reverse_charge_tax_amount
integer
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Enter amount of the reverse charge tax
tax_amount
double
is_itemized_expense
boolean
is_pre_gst
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Applicable for transactions that fall before july 1, 2017
trip_id
string
Enter trip ID
trip_number
string
Enter trip number
reverse_charge_vat_total
double
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Enter total of the reverse charge vat tax.
acquisition_vat_total
double
Enter acquisition vat total.
acquisition_vat_summary
array
Show Sub-Attributes arrow
tax
object
Show Sub-Attributes arrow
tax_name
string
tax_amount
double
reverse_charge_vat_summary
array
Show Sub-Attributes arrow
tax
object
Show Sub-Attributes arrow
tax_name
string
tax_amount
double
expense_item_id
string
account_id
string
ID of the expense account.
account_name
string
date
string
Date of the expense
tax_id
string
tax_name
string
tax_percentage
double
currency_id
string
currency_code
string
exchange_rate
double
sub_total
double
total
double
bcy_total
double
amount
double
Amount of the Expense.
is_inclusive_tax
boolean
reference_number
string
Reference number of the expense. Max-length [100]
description
string
Description of the expense. Max-length [100]
is_billable
boolean
is_personal
boolean
customer_id
string
ID of the expense account.
customer_name
string
Name of the Custome for which expense is raised. Max-length [100]
expense_receipt_name
string
expense_receipt_type
string
last_modified_time
string
status
string
Expense status
invoice_id
string
invoice_number
string
project_id
string
ID of the project associated with the customer.
project_name
string
mileage_rate
double
Mileage rate for a particular mileage expense.
mileage_type
string
expense_type
string
start_reading
double
Start reading of odometer when creating a mileage expense where mileage_type is odometer.
end_reading
double
End reading of odometer when creating a mileage expense where mileage_type is odometer.

Example

{ "expense_id": 982000000030049, "transaction_id": " ", "transaction_type": "expense", "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "tax_treatment": "vat_registered", "destination_of_supply": "TN", "destination_of_supply_state": "TN", "place_of_supply": "DU", "hsn_or_sac": 80540, "source_of_supply": "AP", "paid_through_account_name": "Petty Cash", "vat_reg_no": "string", "reverse_charge_tax_id": 982000000561063, "reverse_charge_tax_name": "intra", "reverse_charge_tax_percentage": 10, "reverse_charge_tax_amount": 12, "tax_amount": 11.85, "is_itemized_expense": false, "is_pre_gst": "fasle", "trip_id": "", "trip_number": "", "reverse_charge_vat_total": 1.2, "acquisition_vat_total": 0, "acquisition_vat_summary": [ { "tax": { "tax_name": "SalesTax", "tax_amount": 11.85 } } ], "reverse_charge_vat_summary": [ { "tax": { "tax_name": "SalesTax", "tax_amount": 11.85 } } ], "expense_item_id": 982000000567220, "account_id": 982000000561057, "account_name": "Rent", "date": "2013-11-18", "tax_id": 982000000566007, "tax_name": "SalesTax", "tax_percentage": 10.5, "currency_id": 982000000567001, "currency_code": "USD", "exchange_rate": 1, "sub_total": 90, "total": 100, "bcy_total": 100, "amount": 112.5, "is_inclusive_tax": false, "reference_number": null, "description": "Marketing", "is_billable": true, "is_personal": false, "customer_id": 982000000567001, "customer_name": "Bowman & Co", "expense_receipt_name": " ", "expense_receipt_type": " ", "last_modified_time": " ", "status": "unbilled", "invoice_id": " ", "invoice_number": " ", "project_id": 982000000567226, "project_name": " ", "mileage_rate": " ", "mileage_type": "non_mileage", "expense_type": "non-mileage", "start_reading": " ", "end_reading": " " }

Create an Expense

Create billable or non-billable expense.
oauthscope : ZohoBooks.expenses.CREATE

Arguments

account_id
string
(Required)
ID of the expense account.
date
string
(Required)
Date of the expense
amount
double
(Required)
Amount of the Expense.
tax_id
string
source_of_supply
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)
destination_of_supply
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)
place_of_supply
string
GCC only
The place of supply is where a transaction is considered to have occurred for VAT purposes. For the supply of goods, the place of supply is the location of the goods when the supply occurs. For the supply of services, the place of supply should be where the supplier is established. (If not given, place of contact given for the contact will be taken)
Supported codes for UAE emirates are :
Abu Dhabi - AB,
Ajman - AJ,
Dubai - DU,
Fujairah - FU,
Ras al-Khaimah - RA,
Sharjah - SH,
Umm al-Quwain - UM.
Supported codes for the GCC countries are :
United Arab Emirates - AE,
Saudi Arabia - SA,
Bahrain - BH,
Kuwait - KW,
Oman - OM,
Qatar - QA.
hsn_or_sac
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Add HSN/SAC code for your goods/services
gst_no
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
15 digit GST identification number of the vendor.
reverse_charge_tax_id
string
ID of the reverse charge tax
line_items
array
Show Sub-Attributes arrow
line_item_id
string
account_id
string
(Required)
ID of the expense account.
description
string
Description of the expense. Max-length [100]
amount
double
(Required)
Amount of the Expense.
tax_id
string
item_order
string
product_type
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Type of the expense. This denotes whether the expense is to be treated as a goods or service purchase. Allowed Values: digital_service , goods and service.
acquisition_vat_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
This is the ID of the tax applied in case this is an EU - goods expense and acquisition VAT needs to be reported.
reverse_charge_vat_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
This is the ID of the tax applied in case this is a non UK - service expense and reverse charge VAT needs to be reported.
reverse_charge_tax_id
string
ID of the reverse charge tax
tax_exemption_code
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Enter tax exemption code
tax_exemption_id
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Enter tax exemption ID
is_inclusive_tax
boolean
is_billable
boolean
reference_number
string
Reference number of the expense. Max-length [100]
description
string
Description of the expense. Max-length [100]
customer_id
string
ID of the expense account.
currency_id
string
exchange_rate
double
project_id
string
ID of the project associated with the customer.
mileage_type
string
vat_treatment
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
VAT treatment for the expense. VAT treatment denotes the location of the vendor, if the vendor resides in UK then the VAT treatment is uk. If the vendor is in an EU country & VAT registered, you are resides in Northen Ireland and purchasing Goods then his VAT treatment is eu_vat_registered and if he resides outside the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).
tax_treatment
string
GCC only
VAT treatment for the expense .Choose whether the contact falls under: vat_registered,vat_not_registered,gcc_vat_not_registered,gcc_vat_registered,non_gcc.
dz_vat_registered and dz_vat_not_registered are supported only for UAE.
product_type
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Type of the expense. This denotes whether the expense is to be treated as a goods or service purchase. Allowed Values: digital_service , goods and service.
acquisition_vat_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
This is the ID of the tax applied in case this is an EU - goods expense and acquisition VAT needs to be reported.
reverse_charge_vat_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
This is the ID of the tax applied in case this is a non UK - service expense and reverse charge VAT needs to be reported.
start_reading
double
Start reading of odometer when creating a mileage expense where mileage_type is odometer.
end_reading
double
End reading of odometer when creating a mileage expense where mileage_type is odometer.
distance
string
Distance travelled for a particular mileage expense where mileage_type is manual
mileage_unit
string
Unit of the distance travelled. Allowed Values: km and mile
mileage_rate
double
Mileage rate for a particular mileage expense.
employee_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
ID of the employee who has submitted this mileage expense.
vehicle_type
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Vehicle type for a particular mileage expense. Allowed Values: car, van, motorcycle and bike
can_reclaim_vat_on_mileage
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
To specify if tax can be reclaimed for this mileage expense.
fuel_type
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Fuel type for a particular mileage expense. Allowed Values: petrol, lpg and diesel
engine_capacity_range
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Engine capacity range for a particular mileage expense. Allowed Values: less_than_1400cc, between_1400cc_and_1600cc, between_1600cc_and_2000cc and more_than_2000cc
paid_through_account_id
string
(Required)
Search expenses by paid through account id.
vendor_id
string
ID of the vendor the expense is made.
custom_fields
array
Custom fields for an expense.

Query Parameters

receipt
Expense receipt file to attach. Allowed Extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc and docx.
organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/expenses?organization_id=10234695 -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "account_id": 982000000561057, "date": "2013-11-18", "amount": 112.5, "tax_id": 982000000566007, "source_of_supply": "AP", "destination_of_supply": "TN", "place_of_supply": "DU", "hsn_or_sac": 80540, "gst_no": "22AAAAA0000A1Z5", "reverse_charge_tax_id": 982000000561063, "line_items": [ { "line_item_id": 10763000000140068, "account_id": 982000000561057, "description": "Marketing", "amount": 112.5, "tax_id": 982000000566007, "item_order": 1, "product_type": "goods", "acquisition_vat_id": " ", "reverse_charge_vat_id": " ", "reverse_charge_tax_id": 982000000561063, "tax_exemption_code": "string", "tax_exemption_id": 982000000561067 } ], "is_inclusive_tax": false, "is_billable": true, "reference_number": null, "description": "Marketing", "customer_id": 982000000567001, "currency_id": 982000000567001, "exchange_rate": 1, "project_id": 982000000567226, "mileage_type": "non_mileage", "vat_treatment": "eu_vat_not_registered", "tax_treatment": "vat_registered", "product_type": "goods", "acquisition_vat_id": " ", "reverse_charge_vat_id": " ", "start_reading": " ", "end_reading": " ", "distance": " ", "mileage_unit": " ", "mileage_rate": " ", "employee_id": " ", "vehicle_type": " ", "can_reclaim_vat_on_mileage": " ", "fuel_type": " ", "engine_capacity_range": " ", "paid_through_account_id": 982000000567250, "vendor_id": " ", "custom_fields": [] }

Response Example

{ "code": 0, "message": "The expense has been recorded.", "expense": { "expense_id": 982000000030049, "transaction_id": " ", "transaction_type": "expense", "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "tax_treatment": "vat_registered", "destination_of_supply": "TN", "destination_of_supply_state": "TN", "place_of_supply": "DU", "hsn_or_sac": 80540, "source_of_supply": "AP", "paid_through_account_name": "Petty Cash", "vat_reg_no": "string", "reverse_charge_tax_id": 982000000561063, "reverse_charge_tax_name": "intra", "reverse_charge_tax_percentage": 10, "reverse_charge_tax_amount": 12, "tax_amount": 11.85, "is_itemized_expense": false, "is_pre_gst": "fasle", "trip_id": "", "trip_number": "", "reverse_charge_vat_total": 1.2, "acquisition_vat_total": 0, "acquisition_vat_summary": [ { "tax": { "tax_name": "SalesTax", "tax_amount": 11.85 } } ], "reverse_charge_vat_summary": [ { "tax": { "tax_name": "SalesTax", "tax_amount": 11.85 } } ], "expense_item_id": 982000000567220, "account_id": 982000000561057, "account_name": "Rent", "date": "2013-11-18", "tax_id": 982000000566007, "tax_name": "SalesTax", "tax_percentage": 10.5, "currency_id": 982000000567001, "currency_code": "USD", "exchange_rate": 1, "sub_total": 90, "total": 100, "bcy_total": 100, "amount": 112.5, "is_inclusive_tax": false, "reference_number": null, "description": "Marketing", "is_billable": true, "is_personal": false, "customer_id": 982000000567001, "customer_name": "Bowman & Co", "expense_receipt_name": " ", "expense_receipt_type": " ", "last_modified_time": " ", "status": "unbilled", "invoice_id": " ", "invoice_number": " ", "project_id": 982000000567226, "project_name": " ", "mileage_rate": " ", "mileage_type": "non_mileage", "expense_type": "non-mileage", "start_reading": " ", "end_reading": " " } }

List Expenses

List all the Expenses with pagination.
oauthscope : ZohoBooks.expenses.READ

Query Parameters

description
Search expenses by description.Variants description_startswith and description_contains. Max-length [100]
reference_number
Search expenses by reference number. Variants reference_number_startswith and reference_number_contains. Max-length [100]
date
Search expenses by expense date. Variants date_start, date_end, date_before and date_after. Format [yyyy-mm-dd]
status
Search expenses by expense status. Allowed Values unbilled, invoiced, reimbursed, non-billable and billable
amount
Search expenses by amount. Variants: amount_less_than, amount_less_equals, amount_greater_than and amount_greater_than
account_name
Search expenses by expense account name. Variants account_name_startswith and account_name_contains. Max-length [100]
customer_name
Search expenses by customer name. Variants: customer_name_startswith and customer_name_contains. Max-length [100]
vendor_name
Search expenses by vendor name. Variants: vendor_name_startswith and vendor_name_contains.
customer_id
ID of the expense account.
vendor_id
ID of the vendor the expense is made.
recurring_expense_id
Search expenses by recurring expense id.
paid_through_account_id
Search expenses by paid through account id.
search_text
Search expenses by account name or description or customer name or vendor name. Max-length [100]
sort_column
Sort expenses.Allowed Values date, account_name, total, bcy_total, reference_number, customer_name and created_time
filter_by
Filter expenses by expense status. Allowed Values Status.All, Status.Billable, Status.Nonbillable, Status.Reimbursed, Status.Invoicedand Status.Unbilled
organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/expenses?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "expenses": [ { "expense_id": 982000000030049, "date": "2013-11-18", "account_name": "Rent", "description": "Marketing", "currency_id": 982000000567001, "currency_code": "USD", "bcy_total": 100, "bcy_total_without_tax": 100, "total": 100, "total_without_tax": 100, "is_billable": true, "reference_number": null, "customer_id": 982000000567001, "customer_name": "Bowman & Co", "status": "unbilled", "created_time": "2013-11-18T00:00:00.000Z", "last_modified_time": " ", "expense_receipt_name": " ", "mileage_rate": " ", "mileage_unit": " ", "expense_type": "non-mileage", "start_reading": " ", "end_reading": " " }, {...}, {...} ], "page_context": [ { "sort_column": "total", "filter_by": "Status.Billable", "search_text": "Rent", "applied_filter": "Status.All", "page": 1, "per_page": 100 } ] }

Update an Expense

Update an existing Expense.
oauthscope : ZohoBooks.expenses.UPDATE

Arguments

account_id
string
(Required)
ID of the expense account.
date
string
(Required)
Date of the expense
amount
double
(Required)
Amount of the Expense.
tax_id
string
source_of_supply
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)
destination_of_supply
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)
place_of_supply
string
GCC only
The place of supply is where a transaction is considered to have occurred for VAT purposes. For the supply of goods, the place of supply is the location of the goods when the supply occurs. For the supply of services, the place of supply should be where the supplier is established. (If not given, place of contact given for the contact will be taken)
Supported codes for UAE emirates are :
Abu Dhabi - AB,
Ajman - AJ,
Dubai - DU,
Fujairah - FU,
Ras al-Khaimah - RA,
Sharjah - SH,
Umm al-Quwain - UM.
Supported codes for the GCC countries are :
United Arab Emirates - AE,
Saudi Arabia - SA,
Bahrain - BH,
Kuwait - KW,
Oman - OM,
Qatar - QA.
hsn_or_sac
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Add HSN/SAC code for your goods/services
gst_no
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
15 digit GST identification number of the vendor.
reverse_charge_tax_id
string
ID of the reverse charge tax
line_items
array
Show Sub-Attributes arrow
line_item_id
string
account_id
string
(Required)
ID of the expense account.
description
string
Description of the expense. Max-length [100]
amount
double
(Required)
Amount of the Expense.
tax_id
string
item_order
string
product_type
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Type of the expense. This denotes whether the expense is to be treated as a goods or service purchase. Allowed Values: digital_service , goods and service.
acquisition_vat_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
This is the ID of the tax applied in case this is an EU - goods expense and acquisition VAT needs to be reported.
reverse_charge_vat_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
This is the ID of the tax applied in case this is a non UK - service expense and reverse charge VAT needs to be reported.
reverse_charge_tax_id
string
ID of the reverse charge tax
tax_exemption_code
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Enter tax exemption code
tax_exemption_id
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Enter tax exemption ID
is_inclusive_tax
boolean
is_billable
boolean
reference_number
string
Reference number of the expense. Max-length [100]
description
string
Description of the expense. Max-length [100]
customer_id
string
ID of the expense account.
currency_id
string
exchange_rate
double
project_id
string
ID of the project associated with the customer.
mileage_type
string
vat_treatment
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
VAT treatment for the expense. VAT treatment denotes the location of the vendor, if the vendor resides in UK then the VAT treatment is uk. If the vendor is in an EU country & VAT registered, you are resides in Northen Ireland and purchasing Goods then his VAT treatment is eu_vat_registered and if he resides outside the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).
tax_treatment
string
GCC only
VAT treatment for the expense .Choose whether the contact falls under: vat_registered,vat_not_registered,gcc_vat_not_registered,gcc_vat_registered,non_gcc.
dz_vat_registered and dz_vat_not_registered are supported only for UAE.
product_type
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Type of the expense. This denotes whether the expense is to be treated as a goods or service purchase. Allowed Values: digital_service , goods and service.
acquisition_vat_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
This is the ID of the tax applied in case this is an EU - goods expense and acquisition VAT needs to be reported.
reverse_charge_vat_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
This is the ID of the tax applied in case this is a non UK - service expense and reverse charge VAT needs to be reported.
start_reading
double
Start reading of odometer when creating a mileage expense where mileage_type is odometer.
end_reading
double
End reading of odometer when creating a mileage expense where mileage_type is odometer.
distance
string
Distance travelled for a particular mileage expense where mileage_type is manual
mileage_unit
string
Unit of the distance travelled. Allowed Values: km and mile
mileage_rate
double
Mileage rate for a particular mileage expense.
employee_id
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
ID of the employee who has submitted this mileage expense.
vehicle_type
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Vehicle type for a particular mileage expense. Allowed Values: car, van, motorcycle and bike
can_reclaim_vat_on_mileage
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
To specify if tax can be reclaimed for this mileage expense.
fuel_type
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Fuel type for a particular mileage expense. Allowed Values: petrol, lpg and diesel
engine_capacity_range
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
Engine capacity range for a particular mileage expense. Allowed Values: less_than_1400cc, between_1400cc_and_1600cc, between_1600cc_and_2000cc and more_than_2000cc
paid_through_account_id
string
(Required)
Search expenses by paid through account id.
vendor_id
string
ID of the vendor the expense is made.
custom_fields
array
Custom fields for an expense.

Query Parameters

receipt
Expense receipt file to attach. Allowed Extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc and docx.
delete_receipt
organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/expenses/{expense_id}?organization_id=10234695 -X PUT -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "account_id": 982000000561057, "date": "2013-11-18", "amount": 120.5, "tax_id": 982000000566007, "source_of_supply": "AP", "destination_of_supply": "TN", "place_of_supply": "DU", "hsn_or_sac": 80540, "gst_no": "22AAAAA0000A1Z5", "reverse_charge_tax_id": 982000000561063, "line_items": [ { "line_item_id": 10763000000140068, "account_id": 982000000561057, "description": "Marketing", "amount": 112.5, "tax_id": 982000000566007, "item_order": 1, "product_type": "goods", "acquisition_vat_id": " ", "reverse_charge_vat_id": " ", "reverse_charge_tax_id": 982000000561063, "tax_exemption_code": "string", "tax_exemption_id": 982000000561067 } ], "is_inclusive_tax": false, "is_billable": true, "reference_number": null, "description": "Marketing", "customer_id": 982000000567001, "currency_id": 982000000567001, "exchange_rate": 1, "project_id": 982000000567226, "mileage_type": "non_mileage", "vat_treatment": "eu_vat_not_registered", "tax_treatment": "vat_registered", "product_type": "goods", "acquisition_vat_id": " ", "reverse_charge_vat_id": " ", "start_reading": " ", "end_reading": " ", "distance": " ", "mileage_unit": " ", "mileage_rate": " ", "employee_id": " ", "vehicle_type": " ", "can_reclaim_vat_on_mileage": " ", "fuel_type": " ", "engine_capacity_range": " ", "paid_through_account_id": 982000000567250, "vendor_id": " ", "custom_fields": [] }

Response Example

{ "code": 0, "message": "Expense information has been updated.", "expense": { "expense_id": 982000000030049, "transaction_id": " ", "transaction_type": "expense", "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "tax_treatment": "vat_registered", "destination_of_supply": "TN", "destination_of_supply_state": "TN", "place_of_supply": "DU", "hsn_or_sac": 80540, "source_of_supply": "AP", "paid_through_account_name": "Petty Cash", "vat_reg_no": "string", "reverse_charge_tax_id": 982000000561063, "reverse_charge_tax_name": "intra", "reverse_charge_tax_percentage": 10, "reverse_charge_tax_amount": 12, "tax_amount": 11.85, "is_itemized_expense": false, "is_pre_gst": "fasle", "trip_id": "", "trip_number": "", "reverse_charge_vat_total": 1.2, "acquisition_vat_total": 0, "acquisition_vat_summary": [ { "tax": { "tax_name": "SalesTax", "tax_amount": 11.85 } } ], "reverse_charge_vat_summary": [ { "tax": { "tax_name": "SalesTax", "tax_amount": 11.85 } } ], "expense_item_id": 982000000567220, "account_id": 982000000561057, "account_name": "Rent", "date": "2013-11-18", "tax_id": 982000000566007, "tax_name": "SalesTax", "tax_percentage": 10.5, "currency_id": 982000000567001, "currency_code": "USD", "exchange_rate": 1, "sub_total": 90, "total": 100, "bcy_total": 100, "amount": 120.5, "is_inclusive_tax": false, "reference_number": null, "description": "Marketing", "is_billable": true, "is_personal": false, "customer_id": 982000000567001, "customer_name": "Bowman & Co", "expense_receipt_name": " ", "expense_receipt_type": " ", "last_modified_time": " ", "status": "unbilled", "invoice_id": " ", "invoice_number": " ", "project_id": 982000000567226, "project_name": " ", "mileage_rate": " ", "mileage_type": "non_mileage", "expense_type": "non-mileage", "start_reading": " ", "end_reading": " " } }

Get an Expense

Get the details of the Expense.
oauthscope : ZohoBooks.expenses.READ

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/expenses/{expense_id}?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "expense": { "expense_id": 982000000030049, "transaction_id": " ", "transaction_type": "expense", "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "tax_treatment": "vat_registered", "destination_of_supply": "TN", "destination_of_supply_state": "TN", "place_of_supply": "DU", "hsn_or_sac": 80540, "source_of_supply": "AP", "paid_through_account_name": "Petty Cash", "vat_reg_no": "string", "reverse_charge_tax_id": 982000000561063, "reverse_charge_tax_name": "intra", "reverse_charge_tax_percentage": 10, "reverse_charge_tax_amount": 12, "tax_amount": 11.85, "is_itemized_expense": false, "is_pre_gst": "fasle", "trip_id": "", "trip_number": "", "reverse_charge_vat_total": 1.2, "acquisition_vat_total": 0, "acquisition_vat_summary": [ { "tax": { "tax_name": "SalesTax", "tax_amount": 11.85 } } ], "reverse_charge_vat_summary": [ { "tax": { "tax_name": "SalesTax", "tax_amount": 11.85 } } ], "expense_item_id": 982000000567220, "account_id": 982000000561057, "account_name": "Rent", "date": "2013-11-18", "tax_id": 982000000566007, "tax_name": "SalesTax", "tax_percentage": 10.5, "currency_id": 982000000567001, "currency_code": "USD", "exchange_rate": 1, "sub_total": 90, "total": 100, "bcy_total": 100, "amount": 112.5, "is_inclusive_tax": false, "reference_number": null, "description": "Marketing", "is_billable": true, "is_personal": false, "customer_id": 982000000567001, "customer_name": "Bowman & Co", "expense_receipt_name": " ", "expense_receipt_type": " ", "last_modified_time": " ", "status": "unbilled", "invoice_id": " ", "invoice_number": " ", "project_id": 982000000567226, "project_name": " ", "mileage_rate": " ", "mileage_type": "non_mileage", "expense_type": "non-mileage", "start_reading": " ", "end_reading": " ", "line_item": { "line_item_id": 10763000000140068, "account_id": 982000000561057, "account_name": "Rent", "description": "Marketing", "tax_amount": 11.85, "tax_id": 982000000566007, "tax_name": "SalesTax", "tax_type": "tax", "tax_percentage": 10.5, "item_total": 100, "item_order": 1, "amount": 112.5, "hsn_or_sac": 80540, "reverse_charge_tax_id": 982000000561063, "reverse_charge_tax_name": "intra", "reverse_charge_tax_percentage": 10, "reverse_charge_tax_amount": 12 } } }

Delete an Expense

Delete an existing expense.
oauthscope : ZohoBooks.expenses.DELETE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/expenses/{expense_id}?organization_id=10234695 -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The expense has been deleted." }

List expense History & Comments

Get history and comments of expense.
oauthscope : ZohoBooks.expenses.READ

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/expenses/{expense_id}/comments?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "comments": [ { "comment_id": 982000000567272, "expense_id": 982000000030049, "description": "Marketing", "commented_by_id": 982000000554041, "commented_by": "John David", "date_description": "16 hours ago", "time": "4.22AM", "operation_type": "Added", "transaction_id": " ", "transaction_type": "expense" }, {...}, {...} ] }

Create an employee

Create an employee for an expense.
oauthscope : ZohoBooks.expenses.CREATE

Arguments

name
string
(Required)
email
string
(Required)

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/employees?organization_id=10234695 -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "name": "John David", "email": "johnsmith@zilliuminc.com" }

Response Example

{ "code": 0, "message": "success", "employee": { "employee_id": " ", "name": "John David", "email": "johnsmith@zilliuminc.com" } }

List employees

List employees with pagination.
oauthscope : ZohoBooks.expenses.READ

Arguments

sort_column
string
Sort expenses.Allowed Values date, account_name, total, bcy_total, reference_number, customer_name and created_time
filter_by
string
Filter expenses by expense status. Allowed Values Status.All, Status.Billable, Status.Nonbillable, Status.Reimbursed, Status.Invoiced and Status.Unbilled

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/employees?organization_id=10234695 -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "sort_column": "total", "filter_by": "Status.Billable" }

Response Example

{ "code": 0, "message": "success", "employees": [ { "employee_id": " ", "name": "John David", "email": "johnsmith@zilliuminc.com" }, {...}, {...} ], "page_context": [ { "sort_column": "total", "filter_by": "Status.Billable", "search_text": "Rent", "applied_filter": "Status.All", "page": 1, "per_page": 100 } ] }

Get an employee

Get the details of the employee.
oauthscope : ZohoBooks.expenses.READ

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/employees/{employee_id}?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "employee": { "employee_id": " ", "name": "John David", "email": "johnsmith@zilliuminc.com" } }

Delete an employee

Delete an existing employee.
oauthscope : ZohoBooks.expenses.DELETE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/employee/{employee_id}?organization_id=10234695 -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "Employee has been deleted." }

Add receipt to an expense.

Attach a receipt to an expense.
oauthscope : ZohoBooks.expenses.CREATE

Query Parameters

receipt
Expense receipt file to attach. Allowed Extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc and docx.
organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/expenses/{expense_id}/receipt?organization_id=10234695 -X POST -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The expense receipt has been attached." }

Get an expense receipt

Returns the receipt attached to the expense.
oauthscope : ZohoBooks.expenses.READ

Query Parameters

preview
Get the thumbnail of the receipt.
organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/expenses/{expense_id}/receipt?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success" }

Delete a receipt

Delete the receipt attached to the expense.
oauthscope : ZohoBooks.expenses.DELETE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/expenses/{expense_id}/receipt?organization_id=10234695 -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The attached expense receipt has been deleted." }