Customer Payments
A payment object describes details regarding a particular customer payment. There can be multiple payments for a single invoice. Multiple invoices can be paid in a single payment as well.
Possible error codes:
Error Code | Message |
---|---|
3004 | The Customer field can neither be blank nor incorrect. Please enter a correct Customer |
9521 | Partial payment for retainer invoice is not allowed. Please record the full payment |
9523 | Payment amount made to retainer invoice cannot be changed. You could instead delete it and add it back |
24016 | The amount entered is more than the balance due for this invoice |
Attribute
Maximum length allowed [2000]
check
, cash
, creditcard
, banktransfer
, bankremittance
, autotransaction
or others
. Maximum length [100]
autotransaction
. Refunds would be made to the respective card provided by the customer.Date Format [yyyy-mm-dd]
success
or failure
.Maximum length of the reference number [100]
Maximum length [100]
Create a payment
Create a new payment.
OAuth Scope : ZohoInvoice.customerpayments.CREATE
Arguments
check
, cash
, creditcard
, banktransfer
, bankremittance
, autotransaction
or others
. Maximum length [100]
Date Format [yyyy-mm-dd]
Maximum length of the reference number [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 : ZohoInvoice.customerpayments.READ
Query Parameters
customer_name_startswith
and customer_name_contains
. Maximum length [100]
reference_number_startswith
and reference_number_contains
. Maximum length [100]
Date Format [yyyy-mm-dd]
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
Maximum length [100]
Update custom field in existing customerpayments
Update the value of the custom field in existing customerpayments.
OAuth Scope : ZohoInvoice.customerpayments.UPDATE
Arguments
Update a payment
Update an existing payment information.
OAuth Scope : ZohoInvoice.customerpayments.UPDATE
Arguments
check
, cash
, creditcard
, banktransfer
, bankremittance
, autotransaction
or others
. Maximum length [100]
Date Format [yyyy-mm-dd]
Maximum length of the reference number [100]
Retrieve a payment
Details of an existing payment.
OAuth Scope : ZohoInvoice.customerpayments.READ
Delete a payment
Delete an existing payment.
OAuth Scope : ZohoInvoice.customerpayments.DELETE
Refund an excess customer payment
Refund the excess amount paid by the customer.
OAuth Scope : ZohoInvoice.customerpayments.CREATE
Arguments
Date Format [yyyy-mm-dd]
Maximum length [50]
Maximum length of the reference number [100]
List refunds of a customer payment
List all the refunds pertaining to an existing customer payment.
OAuth Scope : ZohoInvoice.customerpayments.READ
Update a refund
Update the refunded transaction.
OAuth Scope : ZohoInvoice.customerpayments.UPDATE
Arguments
Date Format [yyyy-mm-dd]
Maximum length [50]
Maximum length of the reference number [100]
Details of a refund
Obtain details of a particular refund of a customer payment.
OAuth Scope : ZohoInvoice.customerpayments.READ
Delete a Refund
Delete refund pertaining to an existing customer payment.
OAuth Scope : ZohoInvoice.customerpayments.DELETE