CustomerPayments

Read, Insert, Update nad Delete Customer Payments.

Table Specific Information

Select

The cmdlet will use the Zoho Inventory API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the cmdlet.

Id supports the '=' comparison.
Amount supports the '=' comparison.
CustomerName supports the '=' comparison.
Notes supports the '=' comparison.
PaymentMode supports the '=' comparison.
ReferenceNumber supports the '=' comparison.
PaymentsFilter supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM CustomerPayments WHERE Id = '3350895000000089001'

SELECT * FROM CustomerPayments WHERE Amount = '100'

SELECT * FROM CustomerPayments WHERE CustomerName = 'name'

SELECT * FROM CustomerPayments WHERE Notes = 'special notes'

SELECT * FROM CustomerPayments WHERE ReferenceNumber = '98900'

Insert

Insert can be executed by specifying the CustomerId, PaymentMode, Amount, Date and Invoices column. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.

INSERT INTO CustomerPayments (CustomerId, PaymentMode, Amount, Date, Invoices) VALUES ('3285934000000104002', 'cash', '5000',\"2022-06-22\", '[{\"invoice_id\":\"3285934000000113001\",\"amount_applied\":5000, \"tax_amount_withheld\":0}]')

Update

Update can be executed by specifying the Id, CustomerId, PaymentMOde, Amount and Invoices in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE CustomerPayments SET CustomerId = 3285934000000104002, PaymentMode = 'cash', Amount = '5000', Date = '2022-06-21', Invoices = '[{\"invoice_id\":\"3285934000000113001\",\"amount_applied\":5000, \"tax_amount_withheld\":0}]' WHERE Id = '3285934000000136008'

Delete

Delete can be executed by specifying the Id in the WHERE Clause For example:

DELETE FROM CustomerPayments WHERE Id = '3350895000000089001'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique ID of the payment generated by the server.
AccountId	String	False		ID of the cash/ bank account the payment has to be deposited.
AccountName	String	True		Name of the cash/ bank account the payment has to be deposited.
Amount	Integer	False		Amount paid in the respective payment.
BcyAmount	Integer	True		Balance amount
BankCharges	Integer	False		Bank Charges
CustomerId	String	False		Customer ID of the customer involved in the payment.
CustomerName	String	True		Name of the customer to whom the invoice is raised.
CurrencyId	String	True		ID of the currency used in the payment
CurrencyCode	String	True		Currency code in which the payment is made.
CurrencySymbol	String	True		Customer currency symbol.
Date	Date	False		Date on which payment is made. Date Format [yyyy-mm-dd]
Email	String	True		Email address of the customer involved in the payment.
Notes	String	True		Search payments by customer notes.
ExchangeRate	String	False		Exchange rate for the currency used in the invoices and customer currency.
Description	String	False		Description about the payment.
InvoiceNumber	String	True		Unique ID (starts with INV) of an invoice.
LastFourDigits	String	True		Mode through which payment is made.
PaymentMode	String	False		Mode through which payment is made. The allowed values are check, cash, creditcard, banktransfer, bankremittance, autotransaction, others.
PaymentNumber	String	True		Payment Number
ReferenceNumber	String	False		Search payments by reference number
TaxAmountWithheld	String	True		Amount withheld for tax.
UnusedAmount	Integer	True		Amount which is not used for invoice payment yet.
Status	Integer	True		Status of the payment
TaxAccountId	Integer	False		ID of the tax account.
TaxAccountName	Integer	True		Name of the tax account.
Invoices	String	False		Invoice related to a payment
CustomFields	String	False		Custom Fields related to a payment

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

PaymentsFilter

String

Filter invoices by any status or payment expected date.

The allowed values are PaymentMode.All, PaymentMode.Cash, PaymentMode.Check, PaymentMode.BankTransfer, PaymentMode.PayPal, PaymentMode.CreditCard, PaymentMode.GoogleCheckout, PaymentMode.Credit, PaymentMode.Authorizenet, PaymentMode.BankRemittance, PaymentMode.Payflowpro, PaymentMode.Stripe, PaymentMode.TwoCheckout, PaymentMode.Braintree, PaymentMode.Others.

Cmdlets for Zoho Inventory