Object Basics
Generally speaking, API objects represent database tables that contain your organization's information. For example, the central object in the Facility Source (FS) data model represents accounts - companies and organizations involved with your business, such as customers, partners, and competitors. The term “record” describes a particular occurrence of an object. A record is analogous to a row in a database table.
Objects can be standard objects, custom objects and external objects.
Applications work with only the objects that you are authorized to access. Programmatic access to objects are determined by the objects defined in your organization, your organization configuration, your user permissions and access settings (which are configured by your organization’s system administrator), your data sharing model, and other factors related specifically to the object.
Primitive Data Types
The API uses the following primitive data types:
| Value |
Details |
| Base64 |
Base 64-encoded binary data. Fields of this type are used for storing binary files in Attachment records, Document records, and Scontrol records. |
| boolean |
Boolean fields have one of these values: true (or 1), or false (or 0). |
| Byte |
A set of bits. |
| Date |
Fields of this type contain date values, such as ActivityDate in the Event object. |
| DateTime |
Fields of this type handle date/time values (timestamps), such as ActivityDateTime in the Event object or the CreatedDate, LastModifiedDate, or SystemModstamp in many objects. |
| Double |
Fields of this type can contain fractional portions (digits to the right of the decimal place), such as ConversionRate in CurrencyType.
Scale: Maximum number of digits to the right of the decimal place.
Precision: Total number of digits, including those to the left and the right of the decimal place.
|
| int |
Fields of this type contain numbers with no fractional portion. |
| string |
Fields that are of data type string contain text and some have length restrictions depending on the data being stored. The MailingStreet is 255 characters. |
| time |
Fields of this type handle time values, such as FridayEndTime in the BusinessHours object.
Development tools differ in the way that they handle time data.
|
External Information
List of ExternalAttachment
| Name |
Type |
| WorkOrderNumber |
string
|
| Id |
integer
|
| InvoiceId |
integer
|
| QuoteId |
integer
|
| Name |
string
|
| Path |
string
|
| URL |
string
|
| Username |
string
|
| CreatedDate |
date
|
| FormattedCreatedDate |
string
|
| SizeString |
string
|
| Latitude |
string
|
| Longitude |
string
|
Quote Information
List of QuoteFragment
| Name |
Type |
| Order |
integer
|
| SubmittedDate |
date
|
| RejectedDate |
date
|
| ApprovedDate |
date
|
| IncurredLaborCost |
decimal number
|
| IncurredPartsCost |
decimal number
|
| IncurredMaterialCost |
decimal number
|
| IncurredPartsAndOtherCost |
decimal number
|
| IncurredTotal |
decimal number
|
| EstimatedLaborCost |
decimal number
|
| EstimatedPartsCost |
decimal number
|
| EstimatedMaterialCost |
decimal number
|
| EstimatedPartsAndOtherCost |
decimal number
|
| EstimatedTotal |
decimal number
|
| SubTotal |
decimal number
|
| SalesTax |
decimal number
|
| VendorTotalTax |
decimal number
|
| Total |
decimal number
|
| TotalCost |
decimal number
|
| TotalLaborCost |
decimal number
|
| TotalPartsAndOtherCost |
decimal number
|
| TotalFreightCost |
decimal number
|
| TotalHandlingCost |
decimal number
|
| TotalMaterialCost |
decimal number
|
| TotalPartsCost |
decimal number
|
| TotalShippingCost |
decimal number
|
| Tax1ID |
integer
|
| Tax1Name |
string
|
| Tax1Value |
decimal number
|
| Tax2ID |
integer
|
| Tax2Name |
string
|
| Tax2Value |
decimal number
|
| Tax3ID |
integer
|
| Tax3Name |
string
|
| Tax3Value |
decimal number
|
| Tax4ID |
integer
|
| Tax4Name |
string
|
| Tax4Value |
decimal number
|
| Tax5ID |
integer
|
| Tax5Name |
string
|
| Tax5Value |
decimal number
|
| Id |
integer
|
| CreateDateTime |
date
|
| CreateUser |
string
|
| Description |
string
|
| LocationNumber |
string
|
| VendorCompanyName |
string
|
| VendorCode |
string
|
WorkUserViewModel
List of WorkUserViewModel
| Name | Type |
|---|
| Id |
integer
|
| Name |
string
|
| Description |
string
|
| Exclude |
boolean
|
| TimeZoneRule |
boolean
|
| HoldOnTimeMinutes |
integer
|
| HoldOnTime |
time interval
|
| UserId |
integer
|
| UserName |
string
|
| FirstName |
string
|
| LastName |
string
|
| Role |
string
|
| RoleId |
integer
|
| IsPublished |
boolean
|
| RefreshPage |
boolean
|
WorkUserListitem
List of WorkUserListitem
| Name | Type |
|---|
| Id |
integer
|
| Name |
string
|
| Description |
string
|
| UserId |
integer
|
| UserName |
string
|
| FirstName |
string
|
| LastName |
string
|
| FullName |
string
|
| RoleId |
integer
|
| LastUpdated |
date
|
| IsPublished |
boolean
|
| Role |
string
|