ODBC Driver for Zoho Books

Build 24.0.9060

Journals

List, add, update and delete journals.

Table Specific Information

Select

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

  • EntryNumber supports the '=' comparison.
  • Notes supports the '=' comparison.
  • ReferenceNumber supports the '=' comparison.
  • Total supports the '=,<,<=,>,>=' comparisons.
  • Date supports the '=,<,>' comparisons.
  • VendorId supports the '=' comparison.
  • JournalFilter supports the '=' comparison.
  • CustomerId supports the '=' comparison.
  • LastModifiedTime supports the '=' comparison.

By default, the response shows the journals of the current month only.

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

For example:

    SELECT * FROM Journals WHERE Total < 1000 AND Total >= 119

    SELECT * FROM Journals WHERE JournalFilter = 'JournalDate.All'

Columns

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

Id of a journal.

JournalType String False

Type of a journal.

JournalDate Date False

Date of a journal.

BcyTotal Decimal True

Total Base Currency.

CurrencyId String False

Currencies.CurrencyId

Currency Id of the customer's currency.

CustomFields String False

Custom Fields defined for Journal.

EntityType String True

Entity type of a journal.

EntryNumber String True

Entry number of the journal.

IncludeInVatReturn String False

VAT treatment for the estimates.

IsBasAdjustment Boolean False

Check if Journal is created for BAS Adjustment.

Notes String False

Notes of the journal.

ReferenceNumber String False

Reference number of the journal.

Status String False

Status of the journal.

Total Decimal True =,<,<=,>,>=

Total of journals. Search by journal total. This field will be populated with a value only when the Journal Id is specified.

JournalNumberPrefix String True

Prefix for journal number. This field will be populated with a value only when the Journal Id is specified.

JournalNumberSuffix String True

Suffix for journal number. This field will be populated with a value only when the Journal Id is specified.

CreatedTime Datetime True

Time at which the journal was created. This field will be populated with a value only when the Journal Id is specified.

CurrencyCode String True

Currency code of the customer's currency. This field will be populated with a value only when the Journal Id is specified.

CurrencySymbol String True

Currency symbol of the customer's currency. This field will be populated with a value only when the Journal Id is specified.

ExchangeRate Decimal True

Exchange rate of the currency. This field will be populated with a value only when the Journal Id is specified.

LastModifiedTime Datetime True

Last Modified Time of a journal. This field will be populated with a value only when the Journal Id is specified.

LineItemTotal Decimal True

Total number of line items included in a journal. This field will be populated with a value only when the Journal Id is specified.

PricePrecision Integer True

The precision for the price This field will be populated with a value only when the Journal Id is specified.

ProjectId String True

Projects.ProjectId

Id of a project. This field will be populated with a value only when the Journal Id is specified.

ProjectName String True

Name of a project. This field will be populated with a value only when the Journal Id is specified.

ProductType String False

Type of the journal. This denotes whether the journal is to be treated as goods or service.

VatTreatment String False

VAT treatment for the estimates.

LineItems String False

Line items of an estimate.

TaxExemptionCode String False

Code of a tax exemption.

TaxExemptionType String False

Type of the Tax Exemption.

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
Date Date

Date of a journal.

VendorId String

Vendor Id of a journal.

JournalFilter String

Filter journals by journal date.

The allowed values are JournalDate.All, JournalDate.Today, JournalDate.ThisWeek, JournalDate.ThisMonth, JournalDate.ThisQuarter, JournalDate.ThisYear.

CustomerId String

Id of a customer.

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