Package veryfi.models

Class UpdateLineItem

java.lang.Object

veryfi.models.SharedLineItem

veryfi.models.UpdateLineItem

public class UpdateLineItem
extends SharedLineItem

Model class for updating line items in documents.

This class extends SharedLineItem and provides the necessary fields for updating existing line items in Veryfi documents. Unlike AddLineItem, all fields in this class are optional since updates may only modify specific fields.

See Also:

• SharedLineItem
• AddLineItem
• NotValidModelException

Field Summary

Fields

Modifier and Type	Field	Description
String	description	The description or name of the line item.
Integer	order	The order/position of the line item in the document.
Float	total	The total amount for this line item.

Fields inherited from class veryfi.models.SharedLineItem

category, discountRate, endDate, hsn, price, quantity, section, sku, startDate, tax, taxRate, unitOfMeasure, upc, weight

Constructor Summary

Constructors

Constructor	Description
UpdateLineItem()

Method Summary

Modifier and Type	Method	Description
final org.json.JSONObject	toJsonObject()	Convert current object to a Json

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

order

public Integer order

The order/position of the line item in the document. Optional field that can be null.

description

public String description

The description or name of the line item. Optional field that can be null.

total

public Float total

The total amount for this line item. Optional field that can be null.

Constructor Details

UpdateLineItem

public UpdateLineItem()

Method Details

toJsonObject

public final org.json.JSONObject toJsonObject()
                                       throws NotValidModelException

Convert current object to a Json

Returns:

Json object

Throws:

NotValidModelException - throws when the model is not valid.