Vendor Payments
Payments to Vendors towards Bills.
Create a vendor payment
Create a payment made to your vendor and you can also apply them to bills either partially or fully.
OAuth Scope : ZohoBooks.vendorpayments.CREATE
Arguments
Update an vendor payment 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 vendor payment 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 vendor payment 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 vendor payments, a new vendor payment will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.vendorpayments.UPDATE
Arguments
List vendor payments
List all the payments made to your vendor.
OAuth Scope : ZohoBooks.vendorpayments.READ
Query Parameters
vendor_name_startswith
and vendor_name_contains
.reference_number_startswith
and reference_number_contains
. In refunds, reference number for the refund recorded.payment_number_startswith
, payment_number_contains
date_start
, date_end
, date_before
and date_after
.amount_less_than
, amount_less_equals
, amount_greater_than
and amount_greater_equals
. In refunds, Amount refunded from the vendor payment.payment_mode_startswith
and payment_mode_contains
.notes_startswith
, notes_contains
description_startswith
and description_contains
.PaymentMode.All
, PaymentMode.Check
, PaymentMode.Cash
, PaymentMode.BankTransfer
, PaymentMode.Paypal
, PaymentMode.CreditCard
, PaymentMode.GoogleCheckout
, PaymentMode.Credit
, PaymentMode.Authorizenet
, PaymentMode.BankRemittance
, PaymentMode.Payflowpro
and PaymentMode.Others
.vendor_name
, date
, reference_number
, amount
and balance
.Update a vendor payment
Update an existing vendor payment. You can also modify the amount applied to the bills.
OAuth Scope : ZohoBooks.vendorpayments.UPDATE
Arguments
Get a vendor payment
Get the details of a vendor payment.
OAuth Scope : ZohoBooks.vendorpayments.READ
Query Parameters
Delete a vendor payment
Delete an existing vendor payment.
OAuth Scope : ZohoBooks.vendorpayments.DELETE
Refund an excess vendor payment
Refund the excess amount paid to the vendor.
OAuth Scope : ZohoBooks.vendorpayments.CREATE
Arguments
List refunds of a vendor payment
List all the refunds pertaining to an existing vendor payment.
OAuth Scope : ZohoBooks.vendorpayments.READ
Update a refund
Update the refunded transaction.
OAuth Scope : ZohoBooks.vendorpayments.UPDATE
Arguments
Details of a refund
Obtain details of a particular refund of a vendor payment.
OAuth Scope : ZohoBooks.vendorpayments.READ
Delete a refund
Delete refund pertaining to an existing vendor payment.
OAuth Scope : ZohoBooks.vendorpayments.DELETE