Cmdlets for Zoho Books

Build 24.0.9060

VendorPaymentsRefund

Read, Insert and Update Vendor Credit Refunds.

Table Specific Information

Select

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

  • VendorPaymentId supports the '=' comparison.
  • VendorPaymentRefundId supports the '=' comparison.

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

For example, the following queries are processed server-side:

SELECT * FROM VendorPaymentsRefund WHERE VendorPaymentId = '3285934000000429001'

SELECT * FROM VendorPaymentsRefund WHERE VendorPaymentRefundId = '3285934000000429017'

Insert

INSERT can be executed by specifying the Amount, Date, ToAccountId, and VendorCreditId columns. The columns that are not read-only can be inserted optionally. The following is an example of how to insert into this table.

INSERT INTO VendorPaymentsRefund (Date, Amount, ToAccountId, VendorPaymentId) VALUES ('2023-02-27', '1200', 3285934000000259036, 3285934000000429001)

Update

UPDATE can be executed by specifying the Amount, Date and AccountId columns in the WHERE Clause. The columns that are not read-only can be updated. For example:

UPDATE VendorPaymentsRefund SET Description = 'test2' WHERE vendorpaymentrefundid = 3285934000000437017 AND VendorPaymentId = 3285934000000429001

Delete

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

DELETE FROM VendorPaymentsRefund WHERE VendorPaymentId = 3285934000000429001 AND vendorpaymentrefundid = 3285934000000437017

Columns

Name Type ReadOnly References SupportedOperators Description
VendorPaymentId [KEY] String True

Vendor Payment Id.

VendorPaymentRefundId [KEY] String True

Vendor Payment Refund Id.

ToAccountId String False

To Account Id.

ToAccountName String False

To Account Name.

Amount Integer False

Amount.

AmountBcy Integer False

Amount BCY.

AmountFcy Integer False

Amount FCY.

CustomFields String True

Custom Fields.

CustomerName String False

Customer Name.

Date Date False

Date.

Description String False

Description.

ReferenceNumber String False

Reference Number.

RefundMode String False

Refund Mode.

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