Customer Payments
Payments from Customers towards Invoices.
Attribute
check
, cash
, creditcard
, banktransfer
, bankremittance
, autotransaction
or others
. Max-length [100]autotransaction
. Refunds would be made to the respective card provided by the customer.success
or failure
.invoice_id
, invoice_number
, date
, invoice_amount
, amount_applied
and balance_amount
.Create a payment
Create a new payment.
OAuth Scope : ZohoBooks.customerpayments.CREATE
Arguments
check
, cash
, creditcard
, banktransfer
, bankremittance
, autotransaction
or others
. Max-length [100]invoice_id
, invoice_number
, date
, invoice_amount
, amount_applied
and balance_amount
.Update a 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 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 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 payments, a new payment will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.customerpayments.UPDATE
Arguments
check
, cash
, creditcard
, banktransfer
, bankremittance
, autotransaction
or others
. Max-length [100]invoice_id
, invoice_number
, date
, invoice_amount
, amount_applied
and balance_amount
.List Customer Payments
List all the payments made by your customer.
OAuth Scope : ZohoBooks.customerpayments.READ
Query Parameters
customer_name_startswith
and customer_name_contains
. Max-len [100]reference_number_startswith
and reference_number_contains
. Max-len [100]amount_less_than
, amount_less_equals
, amount_greater_than
and amount_greater_equals
notes_startswith
and notes_contains
payment_mode_startswith
and payment_mode_contains
PaymentMode.All
, PaymentMode.Check
, PaymentMode.Cash
, PaymentMode.BankTransfer
, PaymentMode.Paypal
, PaymentMode.CreditCard
, PaymentMode.GoogleCheckout
, PaymentMode.Credit
, PaymentMode.Authorizenet
, PaymentMode.BankRemittance
, PaymentMode.Payflowpro
, PaymentMode.Stripe
, PaymentMode.TwoCheckout
, PaymentMode.Braintree
and PaymentMode.Others
Update a payment
Update an existing payment information.
OAuth Scope : ZohoBooks.customerpayments.UPDATE
Arguments
check
, cash
, creditcard
, banktransfer
, bankremittance
, autotransaction
or others
. Max-length [100]invoice_id
, invoice_number
, date
, invoice_amount
, amount_applied
and balance_amount
.Retrieve a payment
Details of an existing payment.
OAuth Scope : ZohoBooks.customerpayments.READ
Delete a payment
Delete an existing payment.
OAuth Scope : ZohoBooks.customerpayments.DELETE
Refund an excess customer payment
Refund the excess amount paid by the customer.
OAuth Scope : ZohoBooks.customerpayments.CREATE
Arguments
List refunds of a customer payment
List all the refunds pertaining to an existing customer payment.
OAuth Scope : ZohoBooks.customerpayments.READ
Update custom field in existing customerpayments
Update the value of the custom field in existing customerpayments.
OAuth Scope : ZohoBooks.customerpayments.UPDATE
Arguments
Query Parameters
Update a refund
Update the refunded transaction.
OAuth Scope : ZohoBooks.customerpayments.UPDATE
Arguments
Details of a refund
Obtain details of a particular refund of a customer payment.
OAuth Scope : ZohoBooks.customerpayments.READ
Delete a Refund
Delete refund pertaining to an existing customer payment.
OAuth Scope : ZohoBooks.customerpayments.DELETE