Basic Object Types

Basic Object Types

ValidationResult

PropertyData TypeDescription
ProperyNameStringThe name of the property that was not valid
MessageStringThe error message
ValueStringThe value of the property used in the request

EntityRef

PropertyData TypeRequired
IdInt32False
NameStringFalse

You must provide either the Id or Name.

ListInfo

PropertyData TypeDescription
TypeRecordTypeEnumRequired
FiltersFilterField [ ]Optional - An Array of FilterField Objects
SortationSortFieldOptional (Default is Id or DocNo)
PageNumberInt32Optional - Default is 1
NumberOfRecordsInt32Optional - Default is 100, Max is 1000
IncludeLineItemsBooleanApplies to Tranactions only
IncludeLineItemDetailsBooleanApplies to Tranactions only

FilterField

PropertyData TypeDescription
PropertyNameStringRequired
FilterValueArrayStringRequired unless DataType is Date or DateTime and DataMacro is used OR the operator is Null or Not Null. 
OperatorFilterOpEnumOptional - default is Equals
DateMacroEnumDateMacroRequired if DataType is Date or DateTime
FieldType
DataTypeEnum
Default is String

SortField

PropertyData TypeDescription
PropertyNameStringRequired
Direction
SortDirEnum
Default is Asc

CustomFieldData

PropertyData TypeRequired
NameStringFalse
ValueAnyFalse

Person

PropertyCaptionData TypeRequired
SalutationMr./Ms./...String (15)False
FirstNameFirst NameString (50)False
MiddleNameM.I.String (5)False
LastNameLast NameString (50)False

Address

PropertyCaptionData TypeRequired
Addr1Name/CompanyString (50)False
Addr2StreetString (50)False
Addr3Floor/SuiteString (50)False
Addr4Care ofString (50)False
AltContactAlt. ContactString (50)False
AltPhoneAlt. PhoneString (50)False
CityCityString (50)False
ContactContactString (50)False
CountryCountryString (50)False
FaxFaxString (50)False
PhonePhoneString (50)False
StateState/Prov./Reg.String (50)False
WebsiteWebsiteString (50)False
ZipZip/Postal codeString (50)False
EmailEmailString (1023)False

Doc

PropertyCaptionData TypeRequired
DocNoNo.Int32False
DateDateInt32False
TranTypeTran TypeRecordTypeEnumFalse
MemoMemoString (4000)False
RevisionRevisionInt16False
CustomFieldsCustom FieldsArray of CustomFieldDataFalse
StatusRefStatusEntityRefFalse

LineItem

PropertyCaptionData TypeRequired
IdIdInt32False
LineNoLine NoInt32False
ItemRefItemEntityRefTrue
DescriptionDescriptionString (4000)False
QuantityQuantityDecimalTrue
CustomFieldsCustom FieldsArray of CustomFieldDataFalse