Basic Object Types
Last Modified on 06/20/2025 11:21 am EDT
Basic Object Types
ValidationResult
| Property | Data Type | Description |
| ProperyName | String | The name of the property that was not valid |
| Message | String | The error message |
| Value | String | The value of the property used in the request |
EntityRef
| Property | Data Type | Required |
| Id | Int32 | False |
| Name | String | False |
You must provide either the Id or Name.
ListInfo
| Property | Data Type | Description |
| Type | RecordTypeEnum | Required |
| Filters | FilterField [ ] | Optional - An Array of FilterField Objects |
| Sortation | SortField | Optional (Default is Id or DocNo) |
| PageNumber | Int32 | Optional - Default is 1 |
| NumberOfRecords | Int32 | Optional - Default is 100, Max is 1000 |
| IncludeLineItems | Boolean | Applies to Transactions only |
IncludeLineItemDetails
| Boolean | Applies to Transactions only AND IncludeLineItems is true
|
FilterField
| Property | Data Type | Description |
| PropertyName | String | Required |
| FilterValueArray | String | Required unless DataType is Date or DateTime and DataMacro is used OR the operator is Null or Not Null. |
| Operator | FilterOpEnum | Optional - default is Equals |
| DateMacroEnum | DateMacro | Required if DataType is Date or DateTime |
FieldType
| DataTypeEnum
| Default is String |
SortField
| Property | Data Type | Description |
| PropertyName | String | Required |
Direction
| SortDirEnum
| Default is Asc |
CustomFieldData
| Property | Data Type | Required |
| Name | String | False |
| Value | Any | False |
Person
| Property | Caption | Data Type | Required |
| Salutation | Mr./Ms./... | String (15) | False |
| FirstName | First Name | String (50) | False |
| MiddleName | M.I. | String (5) | False |
| LastName | Last Name | String (50) | False |
Address
| Property | Caption | Data Type | Required |
| Addr1 | Name/Company | String (50) | False |
| Addr2 | Street | String (50) | False |
| Addr3 | Floor/Suite | String (50) | False |
| Addr4 | Care of | String (50) | False |
| AltContact | Alt. Contact | String (50) | False |
| AltPhone | Alt. Phone | String (50) | False |
| City | City | String (50) | False |
| Contact | Contact | String (50) | False |
| Country | Country | String (50) | False |
| Fax | Fax | String (50) | False |
| Phone | Phone | String (50) | False |
| State | State/Prov./Reg. | String (50) | False |
| Website | Website | String (50) | False |
| Zip | Zip/Postal code | String (50) | False |
| Email | Email | String (1023) | False |
Doc
| Property | Caption | Data Type | Required |
| DocNo | No. | Int32 | False |
| Date | Date | Int32 | False |
| TranType | Tran Type | RecordTypeEnum | False |
| Memo | Memo | String (4000) | False |
| Revision | Revision | Int16 | False |
| CustomFields | Custom Fields | Array of CustomFieldData | False |
| StatusRef | Status | EntityRef | False |
LineItem
| Property | Caption | Data Type | Required |
| Id | Id | Int32 | False |
| LineNo | Line No | Int32 | False |
| ItemRef | Item | EntityRef | True |
| Description | Description | String (4000) | False |
| Quantity | Quantity | Decimal | True |
| CustomFields | Custom Fields | Array of CustomFieldData | False |
