Type Reference

See also

Please see the official Zoho API References for the purpose and semantics of each object.

• Books API

• Inventory API

• Invoice API

Alphabetic

This is an alphabetic list of all the Zoho Object types we support, and the APIs which include them.

We note which additional methods each object type includes, if any.

Account

Available In

Books, Inventory

Bill

Available In

Inventory

Additional methods

• GetCustomField()

• SetCustomField()

Brand

Available In

Inventory

Bundle

Available In

Inventory

CreditNote

Available In

Inventory

Additional methods

• GetCustomField()

• SetCustomField()

CompositeItem

Available In

Inventory

Additional methods

• Activate()

• Deactivate()

• GetCustomField()

• MakeBundle()

• SetCustomField()

Contact

Available In

Inventory

Additional methods

• Activate()

• Deactivate()

• GetCustomField()

• SetCustomField()

• UpdateBilling()

• UpdateShipping()

CustomerPayment

Available In

Inventory

Currency

Available In

Inventory

Document

Available In

Books, Inventory

Retrieving a List-of Document objects will get your the typical List-of. Getting a particular Document (by ID, or iterating over the list) will get you object(s) with two fields:

• content is the raw, binary version of the document;

• content_type is the MIME-type of the content;

Warning

The document content could be very large, and will be loaded into memory. Use with care.

Invoice

Available In

Books, Inventory

Item

Available In

Books, Inventory

Additional methods

• Activate()

• AddImage()

• Deactivate()

• DeleteImage()

• GetCustomField()

• SetCustomField()

ItemAdjustment

Available In

Inventory

ItemGroup

Available In

Inventory

Additional methods

• Activate()

• Deactivate()

Organization

Available In

Books, Inventory

Package

Available In

Inventory

PriceList

Available In

Inventory

PurchaseOrder

Available In

Books, Inventory

PurchaseReceive

Available In

Inventory

RetainerInvoice

Available In

Books, Inventory

SalesOrder

Available In

Books, Inventory

Additional methods

• Confirm()

• GetCustomField()

• SetCustomField()

• Void()

SalesPerson

Available In

Books, Inventory

Additional methods

You can only get the list of all Sales Persons from the API. No other operations work.

SalesReturn

Available In

Inventory

ShipmentOrder

Available In

Inventory

Additional methods

• Delivered()

• GetCustomField()

• SetCustomField()

Tax

Available In

Inventory

TaxAuthority

Available In

Inventory (US Edition Only)

TaxExemption

Available In

Inventory (US Edition Only)

TaxGroup

Available In

Inventory (Non-US Edition Only)

TransferOrder

Available In

Inventory

User

Available In

Books, Inventory

Additional methods

• Activate()

• Deactivate()

• GetCustomField()

• SetCustomField()

Warehouse

Available In

Inventory

Warning

Warehouse does not support Get-By-ID semantics. Always use .Iter(raw=True) when walking the list of warehouses.

This also means ANY operation which returns or acts on an existing warehouse is not currently supported.

By Product

Zoho Books

• Account

• CompositeItem

• Contact

• CustomerPayment

• Document

• Invoice

• Item

• ItemGroup

• Organization

• PurchaseOrder

• SalesOrder

• SalesPerson

• User

Zoho Checkout

Todo

Planned for a future release.

Zoho Expense

Todo

Planned for a future release.

Zoho Inventory

• Account

• Bundle

• CompositeItem

• Contact

• ContactPerson (TODO)

• CustomerPayment

• Currency

• Document

• Invoice

• Item

• ItemAdjustment

• ItemGroup

• Organization

• Package

• PriceList

• PurchaseOrder

• PurchaseReceive

• RetainerInvoice

• SalesOrder

• SalesPerson

• SalesReturn

• ShipmentOrder

• Tax

• TaxAuthority

• TaxExemption

• TaxGroup

• TransferOrder

• User

• VendorCredit (TODO)

• Warehouse

Zoho Invoice

Todo

Planned for a future release.

Zoho Subscriptions

Todo

Planned for a future release.