Recurring Invoices
Recurring invoices are invoices that are created and sent to your customers on a recurring schedule.
Attribute
business_gst
, business_none
, overseas
, consumer
.vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. 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).vat_registered
)Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
Allowed values:
acquisition_of_merchandise
, return_discount_bonus
, general_expense
, buildings
, furniture_office_equipment
, transport_equipment
, computer_equipmentdye_molds_tools
, telephone_communication
, satellite_communication
, other_machinery_equipment
, hospital_expense
, medical_expense_disability
, funeral_expense
, donation
, interest_mortage_loans
, contribution_sar
, medical_expense_insurance_pormium
, school_transportation_expense
, deposit_saving_account
, payment_educational_service
, no_tax_effect
, payment
, payroll
.uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered
, if he resides outside of 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
).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
.goods
or services
.For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
Supported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.standard
and adaptive
paypal
, authorize_net
, payflow_pro
, stripe
, 2checkout
and braintree
Create a Recurring Invoice
Creating a new recurring invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
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
.uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered
, if he resides outside of 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
). business_gst
, business_none
, overseas
, consumer
.vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. 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).vat_registered
)Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
Allowed values:
acquisition_of_merchandise
, return_discount_bonus
, general_expense
, buildings
, furniture_office_equipment
, transport_equipment
, computer_equipmentdye_molds_tools
, telephone_communication
, satellite_communication
, other_machinery_equipment
, hospital_expense
, medical_expense_disability
, funeral_expense
, donation
, interest_mortage_loans
, contribution_sar
, medical_expense_insurance_pormium
, school_transportation_expense
, deposit_saving_account
, payment_educational_service
, no_tax_effect
, payment
, payroll
.false
for PPU-Single Payments and true
for PPD-Installment Paymentsgoods
or services
.For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
Supported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.standard
and adaptive
paypal
, authorize_net
, payflow_pro
, stripe
, 2checkout
and braintree
entity_level
and item_level
.Update a recurring invoice 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 invoice 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 invoice 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 invoices, a new recurring invoice will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.invoices.UPDATE
Arguments
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
.uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered
, if he resides outside of 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
). business_gst
, business_none
, overseas
, consumer
.vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. 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).vat_registered
)Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
Allowed values:
acquisition_of_merchandise
, return_discount_bonus
, general_expense
, buildings
, furniture_office_equipment
, transport_equipment
, computer_equipmentdye_molds_tools
, telephone_communication
, satellite_communication
, other_machinery_equipment
, hospital_expense
, medical_expense_disability
, funeral_expense
, donation
, interest_mortage_loans
, contribution_sar
, medical_expense_insurance_pormium
, school_transportation_expense
, deposit_saving_account
, payment_educational_service
, no_tax_effect
, payment
, payroll
.false
for PPU-Single Payments and true
for PPD-Installment PaymentsSupported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.goods
or services
.For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
standard
and adaptive
paypal
, authorize_net
, payflow_pro
, stripe
, 2checkout
and braintree
List all Recurring Invoice
List the details of all recurring invoice.
OAuth Scope : ZohoBooks.invoices.READ
Query Parameters
item_name_startswith
and profileitemname_contains
.item_description_startswith
and item_description_contains
.active
, stopped
or expired
. Status.All
, Status.Active
, Status.Stopped
, Status.Expired
Update Recurring Invoice
Update the recurring invoice.
OAuth Scope : ZohoBooks.invoices.UPDATE
Arguments
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
.uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered
, if he resides outside of 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
). business_gst
, business_none
, overseas
, consumer
.vat_registered
,vat_not_registered
,gcc_vat_not_registered
,gcc_vat_registered
,non_gcc
.dz_vat_registered
and dz_vat_not_registered
supported only for UAE.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX. 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).vat_registered
)Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.
Allowed values:
acquisition_of_merchandise
, return_discount_bonus
, general_expense
, buildings
, furniture_office_equipment
, transport_equipment
, computer_equipmentdye_molds_tools
, telephone_communication
, satellite_communication
, other_machinery_equipment
, hospital_expense
, medical_expense_disability
, funeral_expense
, donation
, interest_mortage_loans
, contribution_sar
, medical_expense_insurance_pormium
, school_transportation_expense
, deposit_saving_account
, payment_educational_service
, no_tax_effect
, payment
, payroll
.false
for PPU-Single Payments and true
for PPD-Installment PaymentsSupported values for UAE are
uae_same_tax_group
, uae_reimbursed_expense
and uae_others
.Supported values for Bahrain are
bahrain_same_tax_group
, bahrain_transfer_of_concern
, bahrain_disbursement
, bahrain_head_to_branch_transaction
, bahrain_warranty_repair_services
and bahrain_others
.Supported values for Saudi Arabia are
ksa_pvt_health
, ksa_pvt_edu
, ksa_reimbursed_expense
and ksa_house_sales
.goods
or services
.For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
standard
and adaptive
paypal
, authorize_net
, payflow_pro
, stripe
, 2checkout
and braintree
Get a Recurring Invoice
Get the details of a recurring invoice.
OAuth Scope : ZohoBooks.invoices.READ
Delete a Recurring Invoice
Delete an existing recurring invoice.
OAuth Scope : ZohoBooks.invoices.DELETE
Stop a Recurring Invoice
Stop an active recurring invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
Resume a Recurring Invoice
Resume a stopped recurring invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
Update Recurring Invoice template
Update the pdf template associated with the recurring invoice.
OAuth Scope : ZohoBooks.invoices.UPDATE
Arguments
List Recurring Invoice History
Get the complete history and comments of a recurring invoice.
OAuth Scope : ZohoBooks.invoices.READ