Vendor Credits
Vendor credits are credits that you receive from your vendor, and is treated as an equivalent of physical cash that the vendor owes you. This helps you track the money you’re owed until it is either paid by said vendor at a later date i.e refunded, or subtracted from any future bill amount due to that vendor.
Attribute
place of contact
given for the contact will be taken)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
.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.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).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
, digital_service
and service
.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 KSA are
ksa_reimbursed_expense
.Create a vendor credit
Create a vendor credit for a vendor.
OAuth Scope : ZohoBooks.debitnotes.CREATE
Arguments
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
). 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
are 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).place of contact
given for the contact will be taken)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
.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 KSA are
ksa_reimbursed_expense
.Query Parameters
List vendor credits
List vendor credits with pagination.
OAuth Scope : ZohoBooks.debitnotes.READ
Query Parameters
vendor_credit_number.startswith
and vendor_credit_number.contains
date_start
, date_end
, date_before
and date_after
open
, closed
and void
total.start
, total.end
, total.less_than
, total.less_equals
, total.greater_than
and total.greater_equals
reference_number.startswith
and reference_number.contains
customer_name.startswith
and customer_name.contains
item_name.startswith
and item_name.contains
item_description.startswith
and item_description.contains
notes.startswith
and notes.contains
custom_field_startswith
and custom_field_contains
Status.All
, Status.Open
, Status.Draft
, Status.Closed
and Status.Void
.vendor_name
, vendor_credit_number
, balance
, total
, date
, created_time
, last_modified_time
and reference_number
.Update vendor credit
Update an existing vendor credit.
OAuth Scope : ZohoBooks.debitnotes.UPDATE
Arguments
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
). 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
are 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).place of contact
given for the contact will be taken)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
.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 KSA are
ksa_reimbursed_expense
.Get vendor credit
Get details of a vendor credit.
OAuth Scope : ZohoBooks.debitnotes.READ
Query Parameters
true
, false
, on
and off
.json
, xml
, csv
, xls
, pdf
, html
and jhtml
.Delete vendor credit
Delete a vendor credit.
OAuth Scope : ZohoBooks.debitnotes.DELETE
Convert to open
Change an existing vendor credit status to open.
OAuth Scope : ZohoBooks.debitnotes.CREATE
Void vendor credit
Mark an existing vendor credit as void.
OAuth Scope : ZohoBooks.debitnotes.CREATE
Submit a Vendor credit for approval
Submit a Vendor credit for approval.
OAuth Scope : ZohoBooks.debitnotes.CREATE
Approve a Vendor credit
Approve a Vendor credit.
OAuth Scope : ZohoBooks.debitnotes.CREATE
Apply credits to a bill
Apply vendor credit to existing bills.
OAuth Scope : ZohoBooks.debitnotes.CREATE
Arguments
List bills credited
List bills to which the vendor credit is applied.
OAuth Scope : ZohoBooks.debitnotes.READ
Delete bills credited
Delete the credits applied to a bill. Note:
You should pass the vendor_credit_bill_id from "Get vendor credits > bills credited > vendor_credit_bill_id" section
OAuth Scope : ZohoBooks.debitnotes.DELETE
Refund a vendor credit
Refund vendor credit amount.
OAuth Scope : ZohoBooks.debitnotes.CREATE
Arguments
List refunds of a vendor credit
List all refunds of an existing vendor credit.
OAuth Scope : ZohoBooks.debitnotes.READ
Update vendor credit refund
Update the refunded transaction.
OAuth Scope : ZohoBooks.debitnotes.UPDATE
Arguments
Get vendor credit refund
Get refund of a particular vendor credit.
OAuth Scope : ZohoBooks.debitnotes.READ
Delete vendor credit refund
Delete a vendor credit refund.
OAuth Scope : ZohoBooks.debitnotes.DELETE
List vendor credit refunds
List all refunds with pagination.
OAuth Scope : ZohoBooks.debitnotes.READ
Query Parameters
vendor_name
, vendor_credit_number
, balance
, total
, date
, created_time
, last_modified_time
and reference_number
.Add a comment
Add a comment to an existing vendor credit.
OAuth Scope : ZohoBooks.debitnotes.CREATE
Arguments
List vendor credit comments & history
Get history and comments of a vendor credit.
OAuth Scope : ZohoBooks.debitnotes.READ
Delete a comment
Delete a vendor credit comment.
OAuth Scope : ZohoBooks.debitnotes.DELETE