Package veryfi.models

Class AddLineItem

java.lang.Object

veryfi.models.SharedLineItem

veryfi.models.AddLineItem

public class AddLineItem
extends SharedLineItem

Model class for adding line items to documents.

This class extends SharedLineItem and provides the necessary fields for creating new line items in Veryfi documents. The required fields are order, description, and total, while all other fields are optional.

See Also:

• SharedLineItem
• UpdateLineItem
• 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
AddLineItem(Integer order, String description, Float total)	Creates a new AddLineItem with the required fields.

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. This field is required and cannot be null.

description

public String description

The description or name of the line item. This field is required and cannot be null.

total

public Float total

The total amount for this line item. This field is required and cannot be null.

Constructor Details

AddLineItem

public AddLineItem(Integer order,
 String description,
 Float total)

Creates a new AddLineItem with the required fields.

Parameters:

order - The order/position of the line item

description - The description or name of the line item

total - The total amount for this line item

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.