Cmdlets for Zoho Books

Build 24.0.9060

RecurringBillDetails

List, add, update and delete details of a bill.

git ad

Table Specific Information

Select

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

  • RecurringBillId supports the '=' comparison.

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

For example:

    SELECT * FROM RecurringBillDetails WHERE RecurringBillId = '3255827000000084031'

Insert

INSERT can be executed by specifying the StartDate, RecurrenceName, RecurrenceFrequency, VendorID, and LineItems 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 RecurringBillLineItems#TEMP (Name, itemid) VALUES ('rubberband', '3255827000000081058') 

INSERT INTO RecurringBillDetails (vendorid, startdate, recurrencename, lineitems, recurrencefrequency) VALUES ('3255827000000081003', '2023-03-01', 'recurring7', RecurringBillLineItems#TEMP, 'days')

INSERT can also be executed by specifying the LineItems column as a JSON array. The following is an example of how to insert using JSON array into this table.

INSERT INTO RecurringBillDetails (VendorId, StartDate, RecurrenceName, RecurrenceFrequency, LineItems) VALUES ('3255827000000081003', '2023-03-01', 'recurring7', 'days', '[{"Name":"Cloth-Jeans3", "ItemId":"3285934000000104097"}]')

Update

UPDATE can be executed by specifying the RecurringBillId in the WHERE Clause. The columns that are not read-only can be updated. For example:

UPDATE RecurringBillDetails SET RecurrenceName = 'recurrence3' WHERE RecurringBillId = '3255827000000084031'

Delete

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

DELETE FROM RecurringBillDetails WHERE BillId = '3255827000000084031'

Columns

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

Id of a Recurring Bill.

Adjustment Integer False

Adjustment.

AdjustmentDescription String True

Status of the bill.

ContactCategory String True

ContactCategory.

CreatedById String True

Created By Id.

CreatedTime Datetime True

Created Time.

CurrencyId String False

Currencies.CurrencyId

Currency Id of the customer's currency.

CurrencyCode String True

Currency code of the customer's currency.

CustomFields String False

Custom fields of the items.

Discount String False

Discount of recurring bills.

DiscountAccountId String True

Account Id of discount.

DiscountAmount Integer True

Discount amount.

DiscountAppliedOnAmount String True

Discount applied on amount.

DiscountSetting String True

Discount setting.

DiscountType String True

Discount type.

EndDate Date False

Date when the payment is expected.

ExchangeRate Integer False

Exchange Rate.

IsDiscountBeforeTax Boolean False

Check if discount should be applied before tax.

IsInclusiveTax Boolean False

Check if the tax is inclusive in the bill.

IsItemLevelTax Boolean True

Item Level Tax.

IsPreGST Boolean True

Is Pre GST.

IsTDSAmountInPercent Boolean True

Is TDS Amount In Percent.

LastModifiedById String True

Last Modified By Id.

LastModifiedTime Datetime True

The time of last modification of the bill.

LastSentDate Date True

Date when recurring bill was last sent.

LineItems String False

Line items of an recurring bill.

NextBillDate Date True

Date when bill will be sent next.

Notes String False

Notes of the bill.

PaymentTerms Integer False

Net payment term for the customer.

PaymentTermsLabel String False

Label for the paymet due details.

RecurrenceFrequency String False

Frequency at which recurring bill will be sent.

The allowed values are days, weeks, months, years.

RecurrenceName String False

Search recurring bills by recurrence number.

VendorId String False

Id of the vendor the bill has been made.

VendorName String True

Name of the vendor the bill has been made.

Total Integer True

Total of the bill.

ReferenceId String False

Reference Id.

RepeatEvery Integer False

Integer value denoting the frequency of bill.

StartDate Date False

Date when bill was created.

Status String True

Status of the bill.

The allowed values are active, stopped, expired.

SubTotal Integer True

Sub total of the bill.

SubjectContent String True

SubjectContent.

TaxAccountId String True

Tax Account Id.

TaxRounding String False

Tax Rounding.

TaxTotal String True

Tax Total.

TdsTaxId String False

Tax Id of TDS.

TdsTaxName String True

Tds tax name.

TdsAmount Integer True

TDS Amount.

TdsPercent Decimal True

TDS Percent.

TrackDiscountInAccount Boolean True

Track Discount In Account.

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