JDBC Driver for Zoho Inventory

Build 24.0.9060

SalesOrders

Read, Insert,Update and Delete Sales Orders.

Table Specific Information

Select

The driver will use the Zoho Inventory API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the driver.

  • Id supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SalesOrders WHERE Id = '3350895000000089001'

Insert

Insert can be executed by specifying the CustomerId, SalesorderNumber and LineItems column. The columns that are not read-only can be inserted optionally. Following is an example of how to insert into this table.

INSERT INTO Salesorders (CustomerId, SalesorderNumber, LineItems) VALUES (3285934000000085043, 'SO-0001', '[{\"name\": \"OnePlus 8 pro\",\"description\":\"just a simple des\"}]')

Update

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE SalesOrders SET SalesorderNumber = 11, CustomerId = 111 WHERE Id = '3285934000000136008'

Delete

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

DELETE FROM SalesOrders WHERE Id = '3350895000000089001'

Columns

Name Type ReadOnly References Description
Id [KEY] Long True

Unique ID generated by the server for the Sales Order.

BcyTotal Integer True

Base Total.

CreatedTime Datetime True

Created Time.

CurrencyCode String True

Currency code.

CustomerId Long False

Contacts.Id

Unique ID generated for the customer.

PriceBookId Long False

Pricebooks.Id

Unique ID generated by the server for the Pricebook. This is used as an identifier.

SalespersonId Long False

Unique ID generated by the server for the sales person. This is used as an identifier.

TemplateId Long False

Unique ID generated by the server for the Template. This is used as an identifier.

CustomerName String True

Name of the customer.

Date Date False

The date for the Sales Order.

IsBackorder Boolean True

is backorder.

IsDropShipment Boolean True

is drop shipment.

IsDiscountBeforeTax Boolean False

Used to check whether the discount is applied before tax or after tax.

IsEmailed Boolean True

is emailed.

IsInclusiveTax Boolean False

Used to specify whether the line item rates are inclusive or exclusive of tax.

LastModifiedTime Datetime True

Time at which the sales order details were last modified.

LineItems String False

Each line item contains item_id,name,desc,rate,quantity,unit,tax_id,tax_name,tax_type,tax_percentage,item_total.

CustomFields String False

Custom Fields.

Notes String False

Notes for the Sales Order.

ExchangeRate Double False

Exchange rate of the currency, with respect to the base currency.

Adjustment Double False

Adjustment on the Sales Orde total.

AdjustmentDescription String False

Description for the adjustment.

Terms String False

Terms for the Sales Order.

Discount String False

The percentage of Discount applied.

DiscountType String False

Type of discount.

The allowed values are entity_level, item_level.

ShippingCharge Double False

Shipping charges that can be applied to the Sales Order.

DeliveryMethod String False

Delivery method of the shipment.

Quantity Integer True

Quantity of the line item.

QuantityInvoiced Integer True

Quantity Invoiced of the line item.

QuantityPacked Integer True

Quantity Packed of the line item.

QuAntityShipped Integer True

Quantity shipped of the line item.

ReferenceNumber String False

Reference number of the Sales Order.

SalesChannel String True

sales channel.

SalesorderNumber String False

The Sales Order number.

ShipmentDate Date False

Shipment date of the Sales Order.

ShipmentDays String True

Shipment days.

Status String True

The status for the Sales Order.

Total Integer True

Total amount of the Sales Order.

ShippingAddressId Long False

Customer shipping address.

BillingAddressId Long False

Customer billing address.

Taxes String True

Number of taxes applied on sales order.

Documents String True

Sales order can have files attached to them.

BillingAddressAddress String False

Name of the street of the customer shipping address.

BillingAddressCity String False

Name of the city of the customer shipping address.

BillingAddressCountry String False

Name of the country of the customer shipping address.

BillingAddressFax String False

Fax number of the customer shipping address.

BillingAddressState String False

Name of the state of the customer shipping address.

BillingAddressZip Integer False

Zip code of the customer shipping address.

ContactPersonsContactPersonId Long False

ContactPersons.Id

Unique ID generated by the server for the contact person.

ShippingAddressAddress String False

Name of the street of the customer shipping address.

ShippingAddressCity String False

Name of the city of the customer shipping address.

ShippingAddressCountry String False

Name of the country of the customer shipping address.

ShippingAddressFax String False

Fax number of the customer shipping address.

ShippingAddressState String False

Name of the state of the customer shipping address.

ShippingAddressZip Integer False

Zip code of the customer shipping address.

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