API Docs
/
No Results Found
Vendor-Payments

Create a vendor payment

Create a payment made to your vendor and you can also apply them to bills either partially or fully.
oauthscope : ZohoBooks.vendorpayments.CREATE

Arguments

vendor_id
string
ID of the vendor associated with the Vendor Payment.
bills
array
Individual bill payment details as array.
Show Sub-Attributes arrow
bill_payment_id
string
ID of the Bill Payment
bill_id
string
ID of the bill the payment is to be applied.
amount_applied
double
Amount applied to the bill.
tax_amount_withheld
double
🌎 Global
, 🇮🇳 India
, 🇦🇺 Australia
only
Tax Amount Withheld during Bill Payment
date
string
Date the payment is made.
exchange_rate
double
Exchange rate of the currency.
amount
double
(Required)
Total Amount of Vendor Payment
paid_through_account_id
string
ID of the cash/ bank account from which the payment is made.
payment_mode
string
Mode of Vendor Payment
description
string
Description for the Vendor Payment recorded.
reference_number
string
Reference number for the Vendor Payment recorded.
check_details
array
🇺🇸 United States
, 🇨🇦 Canada
only
is_paid_via_print_check
boolean
🇺🇸 United States
, 🇨🇦 Canada
only
Check if the Bill Payment is paid Via Print Check Option
custom_fields
array
Show Sub-Attributes arrow
index
integer
Index of the Custom Field
value
string
Value for the Custom Field

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorpayments?organization_id=10234695 -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "vendor_id": "460000000026049", "bills": [ { "bill_payment_id": "460000000053221", "bill_id": "460000000053199", "amount_applied": 150, "tax_amount_withheld": 0 } ], "date": "2013-10-07", "exchange_rate": 1, "amount": 500, "paid_through_account_id": "460000000000358", "payment_mode": "Stripe", "description": "string", "reference_number": "REF#912300", "check_details": [ "string" ], "is_paid_via_print_check": false, "custom_fields": [ { "index": 0, "value": "string" } ] }

Response Example

{ "code": 0, "message": "The payment made to the vendor has been recorded.", "ach_payment_status": "string", "amount": 500, "balance": 300, "billing_address": [ "address", "city", "state", "zip", "country", "fax", "attention" ], "bills": [ { "bill_payment_id": "460000000053221", "bill_id": "460000000053199", "amount_applied": 150, "tax_amount_withheld": 0, "balance": 300, "bill_number": "B-1000", "date": "2013-10-07", "due_date": "2013-10-07", "price_precision": 2, "total": 450 } ], "check_details": { "amount_in_words": "string", "check_id": "string", "check_number": "string", "check_status": "string", "memo": "string" }, "comments": "Payment of amount $150.00 made and applied for b-01", "created_time": "2016-12-16T00:18:42-0500", "currency_id": "460000000000099", "currency_symbol": "$", "custom_fields": [ { "custom_field_id": "string", "index": 0, "label": "string", "value": "string" } ], "date": "2013-10-07", "description": "string", "exchange_rate": 1, "imported_transactions": [ "string" ], "documents": [ "string" ], "is_ach_payment": false, "is_paid_via_print_check": false, "last_modified_time": "string", "paid_through_account_id": "460000000000358", "paid_through_account_name": "Undeposited Funds", "paid_through_account_type": "cash", "payment_id": "460000000053219", "payment_mode": "Stripe", "payment_number": 4, "reference_number": "REF#912300", "tax_account_name": "string", "tax_amount_withheld": 0, "vendor_id": "460000000026049", "vendor_name": "Bowman and Co", "vendorpayment_refunds": [ { "vendorpayment_refund_id": "460000000003017", "date": "2017-01-10", "refund_mode": "cash", "reference_number": "string", "description": "Payment Refund", "amount_bcy": 4, "amount_fcy": 4 } ] }

List vendor payments

List all the payments made to your vendor.
oauthscope : ZohoBooks.vendorpayments.READ

Query Parameters

vendor_name
Search payments by vendor name. Variants: vendor_name_startswith and vendor_name_contains.
reference_number
Search payments by reference number. Variants: reference_number_startswith and reference_number_contains. In refunds, reference number for the refund recorded.
payment_number
Search with Payment Number. Variant: payment_number_startswith, payment_number_contains
date
Date the payment is made. Search payments by payment made date. Variants: date_start, date_end, date_before and date_after.
amount
Payment amount made to the vendor. Search payments by payment amount. Variants: amount_less_than, amount_less_equals, amount_greater_than and amount_greater_equals. In refunds, Amount refunded from the vendor payment.
payment_mode
Search payments by payment mode. Variants: payment_mode_startswith and payment_mode_contains.
notes
Search with Payment Notes. Variant: notes_startswith, notes_contains
vendor_id
ID of the vendor. Search payments by vendor id.
last_modified_time
Search with the Last Modified Time of the Vendor Payment
bill_id
Search payments by Bill ID.
description
Search payments by description. Variants: description_startswith and description_contains.
filter_by
Filter payments by mode. Allowed Values: 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.
search_text
Search payments by reference number or vendor name or payment description.
sort_column
Sort the payment list. Allowed Values: vendor_name, date, reference_number, amount and balance.
organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorpayments?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "vendorpayments": [ { "payment_id": "460000000053219", "vendor_id": "460000000026049", "vendor_name": "Bowman and Co", "bill_numbers": "string", "payment_mode": "Stripe", "payment_number": 4, "description": "string", "date": "2013-10-07", "reference_number": "REF#912300", "exchange_rate": 1, "amount": 500, "bcy_amount": 76, "paid_through_account_id": "460000000000358", "paid_through_account_name": "Undeposited Funds", "balance": 300, "bcy_balance": 76, "created_time": "2016-12-16T00:18:42-0500", "last_modified_time": "string", "is_paid_via_print_check": false, "has_attachment": false, "is_ach_payment": false, "ach_payment_status": "string", "ach_gw_transaction_id": "string", "check_details": [ { "check_id": "string", "check_status": "string", "check_number": "string", "memo": "string" } ] }, {...}, {...} ] }

Update a vendor payment

Update an existing vendor payment. You can also modify the amount applied to the bills.
oauthscope : ZohoBooks.vendorpayments.UPDATE

Arguments

vendor_id
string
ID of the vendor associated with the Vendor Payment.
bills
array
Individual bill payment details as array.
Show Sub-Attributes arrow
bill_payment_id
string
ID of the Bill Payment
bill_id
string
ID of the bill the payment is to be applied.
amount_applied
double
Amount applied to the bill.
tax_amount_withheld
double
🌎 Global
, 🇮🇳 India
, 🇦🇺 Australia
only
Tax Amount Withheld during Bill Payment
date
string
Date the payment is made.
exchange_rate
double
Exchange rate of the currency.
amount
double
(Required)
Total Amount of Vendor Payment
paid_through_account_id
string
ID of the cash/ bank account from which the payment is made.
payment_mode
string
Mode of Vendor Payment
description
string
Description for the Vendor Payment recorded.
reference_number
string
Reference number for the Vendor Payment recorded.
is_paid_via_print_check
boolean
🇺🇸 United States
, 🇨🇦 Canada
only
Check if the Bill Payment is paid Via Print Check Option
check_details
array
🇺🇸 United States
, 🇨🇦 Canada
only
custom_fields
array
Show Sub-Attributes arrow
index
integer
Index of the Custom Field
value
string
Value for the Custom Field

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorpayments/{payment_id}?organization_id=10234695 -X PUT -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "vendor_id": "460000000026049", "bills": [ { "bill_payment_id": "460000000053221", "bill_id": "460000000053199", "amount_applied": 150, "tax_amount_withheld": 0 } ], "date": "2013-10-07", "exchange_rate": 1, "amount": 500, "paid_through_account_id": "460000000000358", "payment_mode": "Stripe", "description": "string", "reference_number": "REF#912300", "is_paid_via_print_check": false, "check_details": [ "string" ], "custom_fields": [ { "index": 0, "value": "string" } ] }

Response Example

{ "code": 0, "message": "The details of the payment made to the vendor has been updated", "vendorpayment": [ { "payment_id": "460000000053219", "vendor_id": "460000000026049", "vendor_name": "Bowman and Co", "payment_mode": "Stripe", "payment_number": 4, "custom_fields": [ { "custom_field_id": "string", "index": 0, "label": "string", "value": "string" } ], "description": "string", "documents": [ "string" ], "date": "2013-10-07", "reference_number": "REF#912300", "exchange_rate": 1, "tax_account_name": "string", "tax_amount_withheld": 0, "amount": 500, "balance": 300, "currency_id": "460000000000099", "currency_symbol": "$", "created_time": "2016-12-16T00:18:42-0500", "last_modified_time": "string", "paid_through_account_id": "460000000000358", "paid_through_account_name": "Undeposited Funds", "paid_through_account_type": "cash", "is_paid_via_print_check": false, "is_ach_payment": false, "ach_payment_status": "string", "check_details": [ "string" ], "billing_address": [ "address", "city", "state", "zip", "country", "fax", "attention" ], "bills": [ { "bill_payment_id": "460000000053221", "bill_id": "460000000053199", "amount_applied": 150, "tax_amount_withheld": 0 } ], "vendorpayment_refunds": [ { "vendorpayment_refund_id": "460000000003017", "date": "2017-01-10", "refund_mode": "cash", "reference_number": "string", "description": "Payment Refund", "amount_bcy": 4, "amount_fcy": 4 } ], "imported_transactions": [ "string" ] }, {...}, {...} ] }

Get a vendor payment

Get the details of a vendor payment.
oauthscope : ZohoBooks.vendorpayments.READ

Query Parameters

fetchTaxInfo
Check if tax information should be fetched
fetchstatementlineinfo
Check is Statement Line Information for Vendor Payment be fetched
print
Check if Vendor Payment must be printed.
is_bill_payment_id
Check if the ID is Bill Payment or Vendor Payment
organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorpayments/{payment_id}?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "vendorpayment": { "payment_id": "460000000053219", "vendor_id": "460000000026049", "vendor_name": "Bowman and Co", "payment_mode": "Stripe", "payment_number": 4, "description": "string", "date": "2013-10-07", "reference_number": "REF#912300", "exchange_rate": 1, "tax_account_name": "string", "tax_amount_withheld": 0, "amount": 500, "balance": 300, "currency_id": "460000000000099", "currency_symbol": "$", "created_time": "2016-12-16T00:18:42-0500", "last_modified_time": "string", "paid_through_account_id": "460000000000358", "paid_through_account_name": "Undeposited Funds", "paid_through_account_type": "cash", "is_paid_via_print_check": false, "is_ach_payment": false, "ach_payment_status": "string", "check_details": { "amount_in_words": "string", "check_id": "string", "check_number": "string", "check_status": "string", "memo": "string" }, "billing_address": [ "address", "city", "state", "zip", "country", "fax", "attention" ], "comments": "Payment of amount $150.00 made and applied for b-01", "vendorpayment_refunds": [ { "vendorpayment_refund_id": "460000000003017", "date": "2017-01-10", "refund_mode": "cash", "reference_number": "string", "description": "Payment Refund", "amount_bcy": 4, "amount_fcy": 4 } ], "bills": [ { "bill_payment_id": "460000000053221", "bill_id": "460000000053199", "amount_applied": 150, "tax_amount_withheld": 0 } ], "documents": [ "string" ], "custom_fields": [ { "custom_field_id": "string", "index": 0, "label": "string", "value": "string" } ] } }

Delete a vendor payment

Delete an existing vendor payment.
oauthscope : ZohoBooks.vendorpayments.DELETE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorpayments/{payment_id}?organization_id=10234695 -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The payment has been deleted." }

Refund an excess vendor payment

Refund the excess amount paid to the vendor.
oauthscope : ZohoBooks.vendorpayments.CREATE

Arguments

date
string
(Required)
Date of the Vendor Payment Refund.
refund_mode
string
Mode in which refund is made.
reference_number
string
Reference Number of the Payment Refund
amount
double
(Required)
Total Amount of Vendor Payment
exchange_rate
double
Exchange rate of the currency.
to_account_id
string
(Required)
The account to which payment is refunded.
description
string
Description of the Payment Refund

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorpayments/{payment_id}/refunds?organization_id=10234695 -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "date": "2017-01-10", "refund_mode": "cash", "reference_number": "string", "amount": 500, "exchange_rate": 1, "to_account_id": "460000000000385", "description": "Payment Refund" }

Response Example

{ "code": 0, "message": "Vendor Payment Refunded successfully", "vendorpayment_refund": [ { "vendorpayment_refund_id": "460000000003017", "vendorpayment_id": "460000000003001", "date": "2013-10-07", "refund_mode": "cash", "reference_number": "REF#912300", "amount": 500, "exchange_rate": 1, "to_account_id": "460000000000385", "to_account_name": "Petty Cash", "description": "string" }, {...}, {...} ] }

List refunds of a vendor payment

List all the refunds pertaining to an existing vendor payment.
oauthscope : ZohoBooks.vendorpayments.READ

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorpayments/{payment_id}/refunds?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "vendorpayment_refunds": [ { "vendorpayment_refund_id": "460000000003017", "date": "2017-01-10", "refund_mode": "cash", "reference_number": "string", "description": "Payment Refund", "amount_bcy": 4, "amount_fcy": 4 }, {...}, {...} ] }

Details of a refund

Obtain details of a particular refund of a vendor payment.
oauthscope : ZohoBooks.vendorpayments.READ

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorpayments/{payment_id}/refunds/{vendorpayment_refund_id}?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "vendorpayment_refund": [ { "vendorpayment_refund_id": "460000000003017", "vendorpayment_id": "460000000003001", "date": "2013-10-07", "refund_mode": "cash", "reference_number": "REF#912300", "amount": 500, "exchange_rate": 1, "to_account_id": "460000000000385", "to_account_name": "Petty Cash", "description": "string" }, {...}, {...} ] }

Update a refund

Update the refunded transaction.
oauthscope : ZohoBooks.vendorpayments.UPDATE

Arguments

date
string
(Required)
Date of the Vendor Payment Refund.
refund_mode
string
Mode in which refund is made.
reference_number
string
Reference Number of the Payment Refund
amount
double
(Required)
Total Amount of Vendor Payment
exchange_rate
double
Exchange rate of the currency.
to_account_id
string
(Required)
The account to which payment is refunded.
description
string
Description of the Payment Refund

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorpayments/{payment_id}/refunds/{refund_id}?organization_id=10234695 -X PUT -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "date": "2017-01-10", "refund_mode": "cash", "reference_number": "string", "amount": 500, "exchange_rate": 1, "to_account_id": "460000000000385", "description": "Payment Refund" }

Response Example

{ "code": 0, "message": "The refund information has been saved.", "vendorpayment_refund": [ { "vendorpayment_refund_id": "460000000003017", "vendorpayment_id": "460000000003001", "date": "2013-10-07", "refund_mode": "cash", "reference_number": "REF#912300", "amount": 500, "exchange_rate": 1, "to_account_id": "460000000000385", "to_account_name": "Petty Cash", "description": "string" }, {...}, {...} ] }

Delete a refund

Delete refund pertaining to an existing vendor payment.
oauthscope : ZohoBooks.vendorpayments.DELETE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/vendorpayments/{payment_id}/refunds/{refund_id}?organization_id=10234695 -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The refund has been deleted." }