CustomerPayments
Retrieves list of all the payments made by your customer.
Table Specific Information
Select
The add-in uses the Zoho Books API to process WHERE clause conditions built with the following columns and operators:
- PaymentMode supports the '=' comparison.
- Amount supports the '=,<,<=,>,>=' comparisons.
- CustomerName supports the '=' comparison.
- Date supports the '=' comparison.
- ReferenceNumber supports the '=' comparison.
- PaymentModeFilter supports the '=' comparison.
- Notes supports the '=' comparison.
The rest of the filter is executed client-side in the add-in.
For example:
SELECT * FROM CustomerPayments WHERE Amount < 900 AND Amount > 50 AND ReferenceNumber = '1894553000000079879'
SELECT * FROM CustomerPayments WHERE CustomerName = 'Harry'
SELECT * FROM CustomerPayments WHERE CONTAINS (ReferenceNumber, '455')
Columns
| Name | Type | References | SupportedOperators | Description |
| PaymentId [KEY] | String | Id of a payment. | ||
| AccountId | String |
BankAccounts.AccountId | Id of the Bank Account. | |
| PaymentMode | String | Mode through which payment is made. | ||
| PaymentNumber | String | Number through which payment is made. | ||
| PaymentType | String | Type of the payment. | ||
| AccountName | String | Name of the account. | ||
| Amount | Decimal | =,<,<=,>,>= | Amount of the customer payments. | |
| BcyAmount | Decimal | Amount applied for Base Currency. | ||
| BcyRefundedAmount | Decimal | Refunded amount from Base Currency. | ||
| BcyUnusedAmount | Decimal | Unused amount from Base Currency. | ||
| CreatedTime | Datetime | Time at which the customer payment was created. | ||
| CustomerId | String |
Contacts.ContactId | Id of the customer or vendor. | |
| CustomerName | String | Name of the customer or vendor. | ||
| Date | Date | Date of a customer payment. | ||
| GatewayTransactionId | String | Id of gateway transaction. | ||
| HasAttachment | Boolean | Check if the customer payment has an attachment. | ||
| LastModifiedTime | Datetime | The time of last modification of the customer payment. | ||
| ReferenceNumber | String | Reference number of a customer payment. | ||
| AppliedInvoices | String | List of invoices to which the payment is applied. | ||
| Description | String | Description of the payment. | ||
| Documents | String | Documents associated with the payment. | ||
| InvoiceNumbers | String | Numbers of the invoices. | ||
| LastFourDigits | Integer | Last four digits of the card number. | ||
| PaymentGateway | String | Payment gateway used. | ||
| PaymentStatus | String | Status of the payment. | ||
| ProductDescription | String | Description of the product. | ||
| SettlementStatus | String | Settlement status of the payment. | ||
| TaxAccountId | String | ID of the tax account. | ||
| TaxAccountName | String | Name of the tax account. | ||
| TaxAccountWithheld | Decimal | Amount withheld for tax account. | ||
| UnusedAmount | Decimal | Unused amount from the 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 | |
| PaymentModeFilter | String | Filter customer payments by payment mode.
The allowed values are 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, PaymentMode.Others. | |
| Notes | String | Notes of customer payments. |