Invoices
Invoice is a document sent to your client that indicates the products/services sold by you with the payment information that the client has to make.
Attribute
invoice_number_startswith
and invoice_number_contains
. Max-length [100]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
. business_gst
, business_none
, overseas
, consumer
.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
.return_of_merchandise
, substitution_previous_cfdi
, transfer_of_goods
, invoice_generated_from_order
, cfdi_for_advance
.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
).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.
Variants: date_start, date_end, date_before and date_after
.sent
, draft
, overdue
, paid
, void
, unpaid
, partially_paid
and viewed
Variants: due_date_start, due_date_end, due_date_before and due_date_after
entity_level
and item_level
.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 an invoice
Create an invoice for your customer.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
invoice_number_startswith
and invoice_number_contains
. Max-length [100]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
).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.
business_gst
, business_none
, overseas
, consumer
.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
. Variants: date_start, date_end, date_before and date_after
. Variants: due_date_start, due_date_end, due_date_before and due_date_after
entity_level
and item_level
.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
Note:
You need to create a billing address with the address API and pass the address ID here.Note:
You need to create a shipping address with the address API and pass the address ID here.Query Parameters
true
and false
.true
and false
Update an 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 an 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 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 invoices, a new invoice will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.invoices.UPDATE
Arguments
invoice_number_startswith
and invoice_number_contains
. Max-length [100]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
).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.
business_gst
, business_none
, overseas
, consumer
.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
.return_of_merchandise
, substitution_previous_cfdi
, transfer_of_goods
, invoice_generated_from_order
, cfdi_for_advance
. Variants: date_start, date_end, date_before and date_after
. Variants: due_date_start, due_date_end, due_date_before and due_date_after
entity_level
and item_level
.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
List invoices
List all invoices with pagination.
OAuth Scope : ZohoBooks.invoices.READ
Query Parameters
invoice_number_startswith
and invoice_number_contains
. Max-length [100]item_name_startswith
and item_name_contains
. Max-length [100]item_description_startswith
and item_description_contains
. Max-length [100]custom_field_startswith
and custom_field_contains
Variants: date_start, date_end, date_before and date_after
. Variants: due_date_start, due_date_end, due_date_before and due_date_after
YYYY-MM-DDTHH:MM:SS-UTC
Eg: 2018-11-18T02:02:51-0800
,2018-11-18T02:02:51+0530
. Pass the valid UTC time of your time zone for the last 4 digits of the last_modified_time.sent
, draft
, overdue
, paid
, void
, unpaid
, partially_paid
and viewed
Status.All
, Status.Sent
, Status.Draft
, Status.OverDue
, Status.Paid
, Status.Void
, Status.Unpaid
, Status.PartiallyPaid
, Status.Viewed
and Date.PaymentExpectedDate
customer_name
, invoice_number
, date
, due_date
, total
, balance
and created_time
Update an invoice
Update an existing invoice. To delete a line item just remove it from the line_items list.
OAuth Scope : ZohoBooks.invoices.UPDATE
Arguments
invoice_number_startswith
and invoice_number_contains
. Max-length [100]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
).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.
business_gst
, business_none
, overseas
, consumer
.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
.return_of_merchandise
, substitution_previous_cfdi
, transfer_of_goods
, invoice_generated_from_order
, cfdi_for_advance
. Variants: date_start, date_end, date_before and date_after
. Variants: due_date_start, due_date_end, due_date_before and due_date_after
entity_level
and item_level
.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
Query Parameters
true
and false
Get an invoice
Get the details of an invoice.
OAuth Scope : ZohoBooks.invoices.READ
Query Parameters
json
pdf
and html
Delete an invoice
Delete an existing invoice. Invoices which have payment or credits note applied cannot be deleted.
OAuth Scope : ZohoBooks.invoices.DELETE
Mark an invoice as sent
Mark a draft invoice as sent.
OAuth Scope : ZohoBooks.invoices.CREATE
Void an invoice
Mark an invoice status as void. Upon voiding, the payments and credits associated with the invoices will be unassociated and will be under customer credits.
OAuth Scope : ZohoBooks.invoices.CREATE
Mark as draft
Mark a voided invoice as draft.
OAuth Scope : ZohoBooks.invoices.CREATE
Email invoices
Send invoices to your customers by email. Maximum of 10 invoices can be sent at once.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
Query Parameters
Create an instant invoice
Create an instant invoice for all the confirmed sales orders you have selected.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
Submit an invoice for approval
Submit an invoice for approval.
OAuth Scope : ZohoBooks.invoices.CREATE
Approve an invoice.
Approve an invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Email an invoice
Email an invoice to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
Query Parameters
Get invoice email content
Get the email content of an invoice.
OAuth Scope : ZohoBooks.invoices.READ
Query Parameters
Remind Customer
Remind your customer about an unpaid invoice by email. Reminder will be sent, only for the invoices which are in open or overdue status.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
Query Parameters
Get payment reminder mail content
Get the mail content of the payment reminder.
OAuth Scope : ZohoBooks.invoices.READ
Bulk invoice reminder
Remind your customer about an unpaid invoices by email. Reminder mail will be send, only for the invoices is in open or overdue status. Maximum 10 invoices can be reminded at once.
OAuth Scope : ZohoBooks.invoices.CREATE
Query Parameters
Bulk export Invoices
Maximum of 25 invoices can be exported in a single pdf.
OAuth Scope : ZohoBooks.invoices.READ
Query Parameters
Bulk print invoices
Export invoices as pdf and print them. Maximum of 25 invoices can be printed.
OAuth Scope : ZohoBooks.invoices.READ
Query Parameters
Disable payment reminder
Disable automated payment reminders for an invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Enable payment reminder
Enable automated payment reminders for an invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Write off invoice
Write off the invoice balance amount of an invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Cancel write off
Cancel the write off amount of an invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Update billing address
Updates the billing address for this invoice alone.
OAuth Scope : ZohoBooks.invoices.UPDATE
Arguments
Update shipping address
Updates the shipping address for this invoice alone.
OAuth Scope : ZohoBooks.invoices.UPDATE
Arguments
List invoice templates
Get all invoice pdf templates.
OAuth Scope : ZohoBooks.invoices.READ
Update invoice template
Update the pdf template associated with the invoice.
OAuth Scope : ZohoBooks.invoices.UPDATE
List invoice payments
Get the list of payments made for an invoice.
OAuth Scope : ZohoBooks.invoices.READ
List credits applied
Get the list of credits applied for an invoice.
OAuth Scope : ZohoBooks.invoices.READ
Apply credits
Apply the customer credits either from credit notes or excess customer payments to an invoice. Multiple credits can be applied at once.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
Delete a payment
Delete a payment made to an invoice.
OAuth Scope : ZohoBooks.invoices.DELETE
Delete applied credit
Delete a particular credit applied to an invoice.
OAuth Scope : ZohoBooks.invoices.DELETE
Add attachment to an invoice
Attach a file to an invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Query Parameters
gif
, png
, jpeg
, jpg
, bmp
and pdf
Update attachment preference
Set whether you want to send the attached file while emailing the invoice.
OAuth Scope : ZohoBooks.invoices.UPDATE
Query Parameters
Get an invoice attachment
Returns the file attached to the invoice.
OAuth Scope : ZohoBooks.invoices.READ
Query Parameters
Delete an attachment
Delete the file attached to the invoice.
OAuth Scope : ZohoBooks.invoices.DELETE
Delete the expense receipt
Delete the expense receipts attached to an invoice which is raised from an expense.
OAuth Scope : ZohoBooks.invoices.DELETE
Update custom field in existing invoices
Update the value of the custom field in existing invoices.
OAuth Scope : ZohoBooks.invoices.UPDATE
Arguments
Query Parameters
Add comment
Add a comment for an invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Query Parameters
List invoice comments & history
Get the complete history and comments of an invoice.
OAuth Scope : ZohoBooks.invoices.READ
Update comment
Update an existing comment of an invoice.
OAuth Scope : ZohoBooks.invoices.UPDATE
Query Parameters
Delete a comment
Delete an invoice comment.
OAuth Scope : ZohoBooks.invoices.DELETE
Generate payment link
This API generates a payment link for the invoice with an expiry date.
OAuth Scope : ZohoBooks.settings.ALL
Query Parameters
yyyy-MM-dd