Cmdlets for Zoho Books

Build 24.0.9060

VendorPayments

Retrieves list of all the payments made to your vendor.

Table Specific Information

Select

The cmdlet uses the Zoho Books API to process WHERE clause conditions built with the following columns and operators:

  • VendorId supports the '=' comparison.
  • VendorName supports the '=' comparison.
  • Amount supports the '=,<,<=,>,>=' comparisons.
  • Date supports the '=,<,>' comparisons.
  • Description supports the '=' comparison.
  • LastModifiedTime supports the '=' comparison.
  • PaymentMode supports the '=' comparison.
  • PaymentNumber supports the '=' comparison.
  • ReferenceNumber supports the '=' comparison.
  • VendorPaymentFilter supports the '=' comparison.
  • Notes supports the '=' comparison.

The rest of the filter is executed client-side in the cmdlet.

For example:

    SELECT * FROM VendorPayments WHERE Amount >= 98 AND Date < '2019-07-07'

    SELECT * FROM VendorPayments WHERE PaymentNumber = 1;

    SELECT * FROM VendorPayments WHERE CONTAINS (PaymentMode, 'sh')

Columns

Name Type References SupportedOperators Description
PaymentId [KEY] String Id of a payment.
VendorId String Id of the vendor the vendor payment has been made. Search payments by vendor id.
VendorName String Name of the vendor the vendor payment has been made. Search payments by vendor name.
AchGwTransactionId String Id of a ACH GW Transaction.
Amount Decimal =,<,<=,>,>= Payment amount made to the vendor. Search payments by payment amount.
Balance Decimal Balance of vendor payment.
BcyAmount Decimal Amount of Base Currency.
BcyBalance Decimal Balance of Base Currency.
CheckDetailsCheckId String Id of a check.
CheckDetailsCheckNumber String Number of a check.
Date Date =,<,> Date the payment is made. Search payments by payment made date.
Description String Description of a vendor payment.
HasAttachment Boolean Check if a vendor payment has attachment.
LastModifiedTime Datetime Last Modified Time of the Vendor Payment.
PaymentMode String Mode through which payment is made. Search payments by payment mode.
PaymentNumber String Number through which payment is made. Search with Payment Number.
ReferenceNumber String Reference number of a a bill.

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
VendorPaymentFilter String Filter payments by 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.Others..

Notes String Notes of vendor payments..

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060