Recurring Expenses
Recurring expenses are those expenses that repeat itself after a fixed interval of time.
Possible error codes:
Error Code | Message |
---|---|
4027 | Please select a valid date range |
5012 | Recurrence Name already exists |
5015 | Enter a valid expense amount |
Attribute
Maximum length [100]
Format [yyyy-mm-dd]
.Format [yyyy-mm-dd]
.place of contact
given for the contact will be taken) business_gst
, business_none
, overseas
, consumer
.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 EU then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).goods
and service
.Maximum length [100]
Maximum length [100]
{
"account_id": 982000000561057,
"recurrence_name": "Monthly Rental",
"start_date": "2016-11-19T00:00:00.000Z",
"end_date": " ",
"is_pre_gst": false,
"source_of_supply": "AP",
"destination_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"destination_of_supply_state": "AP",
"hsn_or_sac": 80540,
"vat_treatment": "eu_vat_not_registered",
"reverse_charge_tax_id": 982000000567254,
"reverse_charge_tax_name": "inter",
"reverse_charge_tax_percentage": 10,
"reverse_charge_tax_amount": 10,
"is_reverse_charge_applied": false,
"acquisition_vat_total": 0,
"reverse_charge_vat_total": 10,
"acquisition_vat_summary": [
{
"tax_name": "SalesTax",
"tax_amount": 11.85
}
],
"reverse_charge_vat_summary": [
{
"tax_name": "SalesTax",
"tax_amount": 11.85
}
],
"recurrence_frequency": "months",
"repeat_every": 1,
"amount": 112.5,
"total": 128.25,
"sub_total": 90,
"bcy_total": 100,
"product_type": "goods",
"acquisition_vat_id": " ",
"reverse_charge_vat_id": " ",
"tax_id": 982000000566007,
"tax_name": "SalesTax",
"tax_percentage": 10.5,
"created_time": "2013-11-18T02:17:40-0800",
"last_modified_time": "2013-12-18T02:17:40-0800",
"is_inclusive_tax": false,
"is_billable": true,
"customer_id": 982000000567001,
"currency_id": 982000000567001,
"exchange_rate": 1,
"project_id": " ",
"project_name": " ",
"line_item": {
"line_item_id": 10763000000140068,
"account_id": 982000000561057,
"account_name": "Rent",
"description": " ",
"tax_amount": 11.85,
"tax_id": 982000000566007,
"tax_name": "SalesTax",
"tax_type": "tax",
"tax_percentage": 10.5,
"item_total": 100,
"item_order": 1,
"hsn_or_sac": 80540,
"reverse_charge_tax_id": 982000000567254,
"reverse_charge_tax_name": "inter",
"reverse_charge_tax_percentage": 10,
"reverse_charge_tax_amount": 10
}
}
Create a recurring expense
Create a new recurring expense. oauthscope : ZohoInvoice.expenses.CREATE
Arguments
Maximum length [100]
Format [yyyy-mm-dd]
.place of contact
given for the contact will be taken)Maximum length [100]
goods
and service
.Format [yyyy-mm-dd]
.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 EU then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).goods
and service
.$ curl https://invoice.zoho.com/api/v3/recurringexpenses
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"account_id": 982000000561057,
"recurrence_name": "Monthly Rental",
"start_date": "2016-11-19T00:00:00.000Z",
"gst_no": "22AAAAA0000A1Z5",
"source_of_supply": "AP",
"destination_of_supply": "TN",
"reverse_charge_tax_id": 982000000567254,
"line_items": [
{
"line_item_id": 10763000000140068,
"account_id": 982000000561057,
"description": " ",
"amount": 112.5,
"tax_id": 982000000566007,
"item_order": 1,
"product_type": "goods",
"acquisition_vat_id": " ",
"reverse_charge_vat_id": " ",
"reverse_charge_tax_id": 982000000567254,
"tax_exemption_code": "string",
"tax_exemption_id": 982000000567267
}
],
"end_date": " ",
"recurrence_frequency": "months",
"repeat_every": 1,
"amount": 112.5,
"vat_treatment": "eu_vat_not_registered",
"product_type": "goods",
"acquisition_vat_id": " ",
"reverse_charge_vat_id": " ",
"tax_id": 982000000566007,
"is_inclusive_tax": false,
"is_billable": true,
"customer_id": 982000000567001,
"project_id": " ",
"currency_id": 982000000567001,
"exchange_rate": 1
}
{
"code": 0,
"message": "The recurring expense has been created",
"recurring_expense": {
"account_id": 982000000561057,
"recurrence_name": "Monthly Rental",
"start_date": "2016-11-19T00:00:00.000Z",
"end_date": " ",
"is_pre_gst": false,
"source_of_supply": "AP",
"destination_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"destination_of_supply_state": "AP",
"hsn_or_sac": 80540,
"vat_treatment": "eu_vat_not_registered",
"reverse_charge_tax_id": 982000000567254,
"reverse_charge_tax_name": "inter",
"reverse_charge_tax_percentage": 10,
"reverse_charge_tax_amount": 10,
"is_reverse_charge_applied": false,
"acquisition_vat_total": 0,
"reverse_charge_vat_total": 10,
"acquisition_vat_summary": [
{
"tax_name": "SalesTax",
"tax_amount": 11.85
}
],
"reverse_charge_vat_summary": [
{
"tax_name": "SalesTax",
"tax_amount": 11.85
}
],
"recurrence_frequency": "months",
"repeat_every": 1,
"amount": 112.5,
"total": 128.25,
"sub_total": 90,
"bcy_total": 100,
"product_type": "goods",
"acquisition_vat_id": " ",
"reverse_charge_vat_id": " ",
"tax_id": 982000000566007,
"tax_name": "SalesTax",
"tax_percentage": 10.5,
"created_time": "2013-11-18T02:17:40-0800",
"last_modified_time": "2013-12-18T02:17:40-0800",
"is_inclusive_tax": false,
"is_billable": true,
"customer_id": 982000000567001,
"currency_id": 982000000567001,
"exchange_rate": 1,
"project_id": " ",
"project_name": " ",
"line_item": {
"line_item_id": 10763000000140068,
"account_id": 982000000561057,
"account_name": "Rent",
"description": " ",
"tax_amount": 11.85,
"tax_id": 982000000566007,
"tax_name": "SalesTax",
"tax_type": "tax",
"tax_percentage": 10.5,
"item_total": 100,
"item_order": 1,
"hsn_or_sac": 80540,
"reverse_charge_tax_id": 982000000567254,
"reverse_charge_tax_name": "inter",
"reverse_charge_tax_percentage": 10,
"reverse_charge_tax_amount": 10
}
}
}
List recurring expenses
List all the Expenses with pagination. oauthscope : ZohoInvoice.expenses.READ
Query Parameters
recurrence_name_startswith
and recurrence_name_contains
. Maximum length [100]
last_created_date_start
, last_created_date_end
, last_created_date_before
and last_created_date_after
. Format [yyyy-mm-dd]
next_expense_date_start
, next_expense_date_end
, next_expense_date_before
and next_expense_date_after
. Format [yyyy-mm-dd]
active
, stopped
and expired
account_name_startswith
and account_name_contains
. Maximum length [100]
amount_less_than
, amount_less_equals
, amount_greater_than
and amount_greater_than
customer_name_startswith
and customer_name_contains
. Maximum length [100]
Status.All
, Status.Active
, Status.Expired
and Status.Stopped
customer name
or vendor name
. Maximum length [100]
.next_expense_date
, account_name
, total
, last_created_date
, recurrence_name
, customer_name
and created_time
$ curl https://invoice.zoho.com/api/v3/recurringexpenses
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"recurring_expenses": [
{
"recurring_expense_id": 982000000567240,
"recurrence_name": "Monthly Rental",
"recurrence_frequency": "months",
"repeat_every": 1,
"last_created_date": "2013-11-18T00:00:00.000Z",
"next_expense_date": "2013-12-18T00:00:00.000Z",
"account_name": "Rent",
"description": " ",
"currency_id": 982000000567001,
"currency_code": "USD",
"total": 128.25,
"is_billable": true,
"customer_name": "Bowman & Co",
"status": "active",
"created_time": "2013-11-18T02:17:40-0800",
"last_modified_time": "2013-12-18T02:17:40-0800"
},
{...},
{...}
]
}
Update a recurring expense
Update an existing recurring expense. oauthscope : ZohoInvoice.expenses.UPDATE
Arguments
Maximum length [100]
Format [yyyy-mm-dd]
.place of contact
given for the contact will be taken)Maximum length [100]
goods
and service
.Format [yyyy-mm-dd]
.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 EU then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).goods
and service
.$ curl https://invoice.zoho.com/api/v3/recurringexpenses/{recurring_expense_id}
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"account_id": 982000000561057,
"recurrence_name": "Monthly Rental",
"start_date": "2016-11-19T00:00:00.000Z",
"gst_no": "22AAAAA0000A1Z5",
"source_of_supply": "AP",
"destination_of_supply": "TN",
"reverse_charge_tax_id": 982000000567254,
"line_items": [
{
"line_item_id": 10763000000140068,
"account_id": 982000000561057,
"description": " ",
"amount": 112.5,
"tax_id": 982000000566007,
"item_order": 1,
"product_type": "goods",
"acquisition_vat_id": " ",
"reverse_charge_vat_id": " ",
"reverse_charge_tax_id": 982000000567254,
"tax_exemption_code": "string",
"tax_exemption_id": 982000000567267
}
],
"end_date": " ",
"recurrence_frequency": "months",
"repeat_every": 1,
"amount": 112.5,
"vat_treatment": "eu_vat_not_registered",
"product_type": "goods",
"acquisition_vat_id": " ",
"reverse_charge_vat_id": " ",
"tax_id": 982000000566007,
"is_inclusive_tax": false,
"is_billable": true,
"customer_id": 982000000567001,
"project_id": " ",
"currency_id": 982000000567001,
"exchange_rate": 1
}
{
"code": 0,
"message": "Recurring expense information has been updated",
"recurring_expense": {
"account_id": 982000000561057,
"recurrence_name": "Monthly Rental",
"start_date": "2016-11-19T00:00:00.000Z",
"end_date": " ",
"is_pre_gst": false,
"source_of_supply": "AP",
"destination_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"destination_of_supply_state": "AP",
"hsn_or_sac": 80540,
"vat_treatment": "eu_vat_not_registered",
"reverse_charge_tax_id": 982000000567254,
"reverse_charge_tax_name": "inter",
"reverse_charge_tax_percentage": 10,
"reverse_charge_tax_amount": 10,
"is_reverse_charge_applied": false,
"acquisition_vat_total": 0,
"reverse_charge_vat_total": 10,
"acquisition_vat_summary": [
{
"tax_name": "SalesTax",
"tax_amount": 11.85
}
],
"reverse_charge_vat_summary": [
{
"tax_name": "SalesTax",
"tax_amount": 11.85
}
],
"recurrence_frequency": "months",
"repeat_every": 1,
"amount": 120.5,
"total": 128.25,
"sub_total": 90,
"bcy_total": 100,
"product_type": "goods",
"acquisition_vat_id": " ",
"reverse_charge_vat_id": " ",
"tax_id": 982000000566007,
"tax_name": "SalesTax",
"tax_percentage": 10.5,
"created_time": "2013-11-18T02:17:40-0800",
"last_modified_time": "2013-12-18T02:17:40-0800",
"is_inclusive_tax": false,
"is_billable": true,
"customer_id": 982000000567001,
"currency_id": 982000000567001,
"exchange_rate": 1,
"project_id": " ",
"project_name": " ",
"line_item": {
"line_item_id": 10763000000140068,
"account_id": 982000000561057,
"account_name": "Rent",
"description": " ",
"tax_amount": 11.85,
"tax_id": 982000000566007,
"tax_name": "SalesTax",
"tax_type": "tax",
"tax_percentage": 10.5,
"item_total": 100,
"item_order": 1,
"hsn_or_sac": 80540,
"reverse_charge_tax_id": 982000000567254,
"reverse_charge_tax_name": "inter",
"reverse_charge_tax_percentage": 10,
"reverse_charge_tax_amount": 10
}
}
}
Get a recurring expense
Get the details of the recurring expense. oauthscope : ZohoInvoice.expenses.READ
$ curl https://invoice.zoho.com/api/v3/recurringexpenses/{recurring_expense_id}
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"recurring_expense": {
"recurring_expense_id": 982000000567240,
"recurrence_name": "Monthly Rental",
"start_date": "2016-11-19T00:00:00.000Z",
"end_date": " ",
"is_pre_gst": false,
"source_of_supply": "AP",
"destination_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"destination_of_supply_state": "AP",
"hsn_or_sac": 80540,
"vat_treatment": "eu_vat_not_registered",
"reverse_charge_tax_id": 982000000567254,
"reverse_charge_tax_name": "inter",
"reverse_charge_tax_percentage": 10,
"reverse_charge_tax_amount": 10,
"is_reverse_charge_applied": false,
"acquisition_vat_total": 0,
"reverse_charge_vat_total": 10,
"acquisition_vat_summary": [
{
"tax_name": "SalesTax",
"tax_amount": 11.85
}
],
"reverse_charge_vat_summary": [
{
"tax_name": "SalesTax",
"tax_amount": 11.85
}
],
"recurrence_frequency": "months",
"repeat_every": 1,
"last_created_date": "2013-11-18T00:00:00.000Z",
"next_expense_date": "2013-12-18T00:00:00.000Z",
"account_id": 982000000561057,
"account_name": "Rent",
"currency_id": 982000000567001,
"currency_code": "USD",
"exchange_rate": 1,
"tax_id": 982000000566007,
"tax_name": "SalesTax",
"tax_percentage": 10.5,
"tax_amount": 11.85,
"sub_total": 90,
"total": 128.25,
"bcy_total": 100,
"amount": 112.5,
"description": " ",
"is_inclusive_tax": false,
"is_billable": true,
"customer_id": 982000000567001,
"customer_name": "Bowman & Co",
"status": "active",
"created_time": "2013-11-18T02:17:40-0800",
"last_modified_time": "2013-12-18T02:17:40-0800",
"project_id": " ",
"project_name": " ",
"line_item": {
"line_item_id": 10763000000140068,
"account_id": 982000000561057,
"account_name": "Rent",
"description": " ",
"tax_amount": 11.85,
"tax_id": 982000000566007,
"tax_name": "SalesTax",
"tax_type": "tax",
"tax_percentage": 10.5,
"item_total": 100,
"item_order": 1,
"hsn_or_sac": 80540,
"reverse_charge_tax_id": 982000000567254,
"reverse_charge_tax_name": "inter",
"reverse_charge_tax_percentage": 10,
"reverse_charge_tax_amount": 10
}
}
}
Delete a recurring expense
Deleting an existing recurring expense. oauthscope : ZohoInvoice.expenses.DELETE
$ curl https://invoice.zoho.com/api/v3/recurringexpenses/{recurring_expense_id}
-X DELETE
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "The recurring expense has been deleted."
}
Stop a recurring expense
Stop an active recurring expense. oauthscope : ZohoInvoice.expenses.CREATE
$ curl https://invoice.zoho.com/api/v3/recurringexpenses/{recurring_expense_id}/status/stop
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "The recurring expense has been stopped."
}
Resume a recurring Expense
Resume a stopped recurring expense. oauthscope : ZohoInvoice.expenses.CREATE
$ curl https://invoice.zoho.com/api/v3/recurringexpenses/{recurring_expense_id}/status/resume
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "The recurring expense has been activated."
}
List child expenses created
List child expenses created from recurring expense. oauthscope : ZohoInvoice.expenses.READ
Query Parameters
next_expense_date
, account_name
, total
, last_created_date
, recurrence_name
, customer_name
and created_time
$ curl https://invoice.zoho.com/api/v3/recurringexpenses/{recurring_expense_id}/expenses
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"expensehistory": [
{
"expense_id": 982000000567250,
"date": "2013-11-18",
"account_name": "Rent",
"customer_name": "Bowman & Co",
"total": 128.25,
"status": "active",
"vendor_name": " ",
"paid_through_account_name": "Undeposited Funds"
},
{...},
{...}
]
}
List recurring expense history
Get history and comments of a recurring expense. oauthscope : ZohoInvoice.expenses.READ
$ curl https://invoice.zoho.com/api/v3/recurringexpenses/{recurring_expense_id}/comments
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"comments": [
{
"comment_id": 982000000567272,
"recurring_expense_id": 982000000567240,
"description": " ",
"commented_by_id": 982000000554041,
"commented_by": "John David",
"date": "2013-11-18",
"time": "2.41 AM",
"operation_type": "Added",
"transaction_id": " ",
"transaction_type": "expense"
},
{...},
{...}
]
}