Recurring Expenses

Create a recurring expense

Create a recurring expense.
OAuth Scope : ZohoBooks.expenses.CREATE

Arguments

account_id

string

(Required)

recurrence_name

string

(Required)

Name of the Recurring Expense. Max-length [100]

start_date

string

(Required)

Start date of the recurring expense. Expenses will not be generated for dates prior to the current date. Format [yyyy-mm-dd].

end_date

string

Date on which recurring expense has to expire. Can be left as empty to run forever. Format [yyyy-mm-dd].

recurrence_frequency

string

(Required)

repeat_every

string

(Required)

gst_no

string

🇮🇳 India

only

15 digit GST identification number of the vendor.

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.

reverse_charge_tax_id

string

🇮🇳 India

, GCC , 🇿🇦 South Africa

only

Enter reverse charge tax IDFor SouthAfrica edition:(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

line_items

array

Show Sub-Attributes

line_item_id

string

account_id

string

(Required)

description

string

Search recurring expenses by description. Max-length [100]

amount

double

(Required)

Recurring Expense amount.

tax_id

string

item_order

string

product_type

string

🇬🇧 United Kingdom

, 🇿🇦 South Africa

only

Type of the expense. This denotes whether the expense is to be treated as a goods or service or capital asset purchase. Allowed Values:
For UK edition:digital_service, goods and service.
For SouthAfrica Edition: service, goods, capital_service and capital_goods

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

🇮🇳 India

, 🇬🇧 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

🇮🇳 India

, GCC , 🇿🇦 South Africa

only

Enter reverse charge tax IDFor SouthAfrica edition:(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

tax_exemption_code

string

🇮🇳 India

, 🇲🇽 Mexico

only

Enter the code for tax exemption

tax_exemption_id

string

🇮🇳 India

, 🇲🇽 Mexico

only

Enter ID of the tax exemption

amount

double

(Required)

Recurring Expense amount.

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 , 🇲🇽 Mexico

, 🇰🇪 Kenya

, 🇿🇦 South Africa

only

VAT treatment for the recurring 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.
For Kenya Edition: vat_registered ,vat_not_registered ,non_kenya(A business that is located outside Kenya).
For SouthAfrica Edition: vat_registered, vat_not_registered, overseas(A business that is located outside SouthAfrica).

product_type

string

🇬🇧 United Kingdom

, 🇿🇦 South Africa

only

Type of the expense. This denotes whether the expense is to be treated as a goods or service or capital asset purchase. Allowed Values:
For UK edition:digital_service, goods and service.
For SouthAfrica Edition: service, goods, capital_service and capital_goods

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

🇮🇳 India

, 🇬🇧 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.

tax_id

string

is_inclusive_tax

boolean

is_billable

boolean

customer_id

string

Search expenses by customer id.

project_id

string

currency_id

string

exchange_rate

double

custom_fields

array

Custom fields for a recurring-expense.

Show Sub-Attributes

customfield_id

long

value

string

Value of the Custom Field

Update an recurring expense using a custom field's unique value

A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a recurring expense by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header. Based on this value, the corresponding recurring expense will be retrieved and updated. Additionally, there is an optional X-Upsert header. If the X-Upsert header is true and the custom field's unique value is not found in any of the existing recurring expenses, a new recurring expense will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.expenses.UPDATE

Arguments

account_id

string

(Required)

recurrence_name

string

(Required)

Name of the Recurring Expense. Max-length [100]

start_date

string

(Required)

Start date of the recurring expense. Expenses will not be generated for dates prior to the current date. Format [yyyy-mm-dd].

end_date

string

Date on which recurring expense has to expire. Can be left as empty to run forever. Format [yyyy-mm-dd].

recurrence_frequency

string

(Required)

repeat_every

string

(Required)

gst_no

string

🇮🇳 India

only

15 digit GST identification number of the vendor.

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.

reverse_charge_tax_id

string

🇮🇳 India

, GCC , 🇿🇦 South Africa

only

Enter reverse charge tax IDFor SouthAfrica edition:(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

line_items

array

Show Sub-Attributes

line_item_id

string

account_id

string

(Required)

description

string

Search recurring expenses by description. Max-length [100]

amount

double

(Required)

Recurring Expense amount.

tax_id

string

item_order

string

product_type

string

🇬🇧 United Kingdom

, 🇿🇦 South Africa

only

Type of the expense. This denotes whether the expense is to be treated as a goods or service or capital asset purchase. Allowed Values:
For UK edition:digital_service, goods and service.
For SouthAfrica Edition: service, goods, capital_service and capital_goods

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

🇮🇳 India

, 🇬🇧 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

🇮🇳 India

, GCC , 🇿🇦 South Africa

only

Enter reverse charge tax IDFor SouthAfrica edition:(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

tax_exemption_code

string

🇮🇳 India

, 🇲🇽 Mexico

only

Enter the code for tax exemption

tax_exemption_id

string

🇮🇳 India

, 🇲🇽 Mexico

only

Enter ID of the tax exemption

amount

double

(Required)

Recurring Expense amount.

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 , 🇲🇽 Mexico

, 🇰🇪 Kenya

, 🇿🇦 South Africa

only

VAT treatment for the recurring 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.
For Kenya Edition: vat_registered ,vat_not_registered ,non_kenya(A business that is located outside Kenya).
For SouthAfrica Edition: vat_registered, vat_not_registered, overseas(A business that is located outside SouthAfrica).

product_type

string

🇬🇧 United Kingdom

, 🇿🇦 South Africa

only

Type of the expense. This denotes whether the expense is to be treated as a goods or service or capital asset purchase. Allowed Values:
For UK edition:digital_service, goods and service.
For SouthAfrica Edition: service, goods, capital_service and capital_goods

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

🇮🇳 India

, 🇬🇧 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.

tax_id

string

is_inclusive_tax

boolean

is_billable

boolean

customer_id

string

Search expenses by customer id.

project_id

string

currency_id

string

exchange_rate

double

custom_fields

array

Custom fields for a recurring-expense.

Show Sub-Attributes

customfield_id

long

value

string

Value of the Custom Field

List recurring expenses

List all the Expenses with pagination.
OAuth Scope : ZohoBooks.expenses.READ

Query Parameters

Update a recurring expense

Update a recurring expense.
OAuth Scope : ZohoBooks.expenses.UPDATE

Arguments

account_id

string

(Required)

recurrence_name

string

(Required)

Name of the Recurring Expense. Max-length [100]

start_date

string

(Required)

Start date of the recurring expense. Expenses will not be generated for dates prior to the current date. Format [yyyy-mm-dd].

end_date

string

Date on which recurring expense has to expire. Can be left as empty to run forever. Format [yyyy-mm-dd].

recurrence_frequency

string

(Required)

repeat_every

string

(Required)

gst_no

string

🇮🇳 India

only

15 digit GST identification number of the vendor.

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.

reverse_charge_tax_id

string

🇮🇳 India

, GCC , 🇿🇦 South Africa

only

Enter reverse charge tax IDFor SouthAfrica edition:(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

line_items

array

Show Sub-Attributes

line_item_id

string

account_id

string

(Required)

description

string

Search recurring expenses by description. Max-length [100]

amount

double

(Required)

Recurring Expense amount.

tax_id

string

item_order

string

product_type

string

🇬🇧 United Kingdom

, 🇿🇦 South Africa

only

Type of the expense. This denotes whether the expense is to be treated as a goods or service or capital asset purchase. Allowed Values:
For UK edition:digital_service, goods and service.
For SouthAfrica Edition: service, goods, capital_service and capital_goods

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

🇮🇳 India

, 🇬🇧 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

🇮🇳 India

, GCC , 🇿🇦 South Africa

only

Enter reverse charge tax IDFor SouthAfrica edition:(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

tax_exemption_code

string

🇮🇳 India

, 🇲🇽 Mexico

only

Enter the code for tax exemption

tax_exemption_id

string

🇮🇳 India

, 🇲🇽 Mexico

only

Enter ID of the tax exemption

amount

double

(Required)

Recurring Expense amount.

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 , 🇲🇽 Mexico

, 🇰🇪 Kenya

, 🇿🇦 South Africa

only

VAT treatment for the recurring 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.
For Kenya Edition: vat_registered ,vat_not_registered ,non_kenya(A business that is located outside Kenya).
For SouthAfrica Edition: vat_registered, vat_not_registered, overseas(A business that is located outside SouthAfrica).

product_type

string

🇬🇧 United Kingdom

, 🇿🇦 South Africa

only

Type of the expense. This denotes whether the expense is to be treated as a goods or service or capital asset purchase. Allowed Values:
For UK edition:digital_service, goods and service.
For SouthAfrica Edition: service, goods, capital_service and capital_goods

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

🇮🇳 India

, 🇬🇧 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.

tax_id

string

is_inclusive_tax

boolean

is_billable

boolean

customer_id

string

Search expenses by customer id.

project_id

string

currency_id

string

exchange_rate

double

custom_fields

array

Custom fields for a recurring-expense.

Show Sub-Attributes

customfield_id

long

value

string

Value of the Custom Field

Get a recurring expense

Get the details of the recurring expense.
OAuth Scope : ZohoBooks.expenses.READ

Delete a recurring expense

Deleting an existing recurring expense.
OAuth Scope : ZohoBooks.expenses.DELETE

Stop a recurring expense

Stop an active recurring expense.
OAuth Scope : ZohoBooks.expenses.CREATE