Explore the simPRO data model

See how the various simPRO endpoints relate to each other, using our handy Entity Relationship Diagram.

Pulling data from simPRO is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only pull your simPRO endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

Company

Documentation: https://developer.simprogroup.com/apidoc/?page=edefbda3a2bdd979e42d8944b7325b79

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
TenantID string - -
Phone string - -
Fax string - -
Email string - -
AddressLine1 string - -
AddressLine2 string - -
BillingAddressLine1 string - -
BillingAddressLine2 string - -
EIN string - -
CompanyNo string - -
Licence string - -
Website string - -
BankingBank string - -
BankingBranchCode string - -
BankingAccountNumber string - -
BankingRoutingNo string - -
BankingAccountNo string - -
BankingIBAN string - -
BankingSwiftCode string - -
CISCertNo string - -
EmployerTaxRefNo string - -
Timezone string - -
TimezoneOffset string - -
DefaultLanguage string - -
Template boolean - -
MultiCompanyLabel string - -
MultiCompanyColor string - -
Currency string - -
Country string - -
TaxName string - -
UIDateFormat string - -
UITimeFormat string - -
ScheduleFormat int - -
SingleCostCenterMode boolean - -
LaborRateOverhead decimal - -
DefaultCostCenterID int CostCenter → ID -
DateModified datetime - -

CustomerAsset

Documentation: https://developer.simprogroup.com/apidoc/?page=3352d5e59a4d8d5e7d3888ebd86c8064

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
AssetTypeID int AssetType → ID -
DisplayOrder int - -
CurrentCustomerContractID int - -
StartDate datetime - -
LastTestResult string - -
LastTestDate datetime - -
LastTestServiceLevelID int - -
LastTestServiceLevelName string - -
ParentID int - -
SiteID int Site → ID -
Archived boolean - -
DateModified datetime - -

CustomerAssetCustomField

Column Type Relates to Notes
RemoteID string - -
CustomerAssetRemoteID string CustomerAsset → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerAssetID int CustomerAsset → ID -
AssetTypeCustomFieldID int AssetTypeCustomField → ID -
Value string - -

Employee

Documentation: https://developer.simprogroup.com/apidoc/?page=eb626c94531ec554f93b2b78a77c8b1b

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Position string - -
AddressAddress string - -
AddressCity string - -
AddressState string - -
AddressPostalCode string - -
AddressCountry string - -
DateOfHire datetime - -
DateOfBirth datetime - -
PrimaryContactEmail string - -
PrimaryContactSecondaryEmail string - -
PrimaryContactWorkPhone string - -
PrimaryContactExtension string - -
PrimaryContactCellPhone string - -
PrimaryContactFax string - -
PrimaryContactPreferredNotificationMethod string - -
EmergencyContactName string - -
EmergencyContactRelationship string - -
EmergencyContactWorkPhone string - -
EmergencyContactCellPhone string - -
EmergencyContactAltPhone string - -
EmergencyContactAddress string - -
AccountSetupUserName string - -
AccountSetupIsMobility boolean - -
UserProfileIsSalesperson boolean - -
UserProfileIsProjectManager boolean - -
UserProfilePreferredLanguage string - -
DateCreated datetime - -
DefaultZoneID int - -
DefaultZoneName string - -
DefaultCompanyID int - -
DefaultCompanyName string - -
MaskedSSN string - -
BankingAccountName string - -
BankingRoutingNo string - -
BankingAccountNo string - -
PayRatesPayRate decimal - -
PayRatetCost decimal - -
PayRateOverhead decimal - -
Archived boolean - -
DateModified datetime - -

Site

Documentation: https://developer.simprogroup.com/apidoc/?page=3faa64303d5f5bcd043bb88f6768e603

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
SiteAddressAddress string - -
SiteAddressCity string - -
SiteAddressState string - -
SiteAddressPostalCode string - -
SiteAddressCountry string - -
BillingAddressAddress string - -
BillingAddressCity string - -
BillingAddressState string - -
BillingAddressPostalCode string - -
BillingContact string -
  • 24 Mar 2021 This is actually described as 'Postal Contact' in the simPRO application. It is a free-text string.
PrimaryContactID int Contact → ID -
PublicNotes string - -
PrivateNotes string - -
SiteZoneID int - -
STCZone int - -
VEECZone string - -
Archived boolean - -
DateModified datetime - -

SiteCustomer

Column Type Relates to Notes
RemoteID string - -
SiteRemoteID string Site → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
CompanyName string - -
GivenName string - -
FamilyName string - -
IndividualCustomerID int IndividualCustomer → ID -
CompanyCustomerID int CompanyCustomer → ID -
SiteID int Site → ID -

SitePreferredTechnician

Column Type Relates to Notes
RemoteID string - -
SiteRemoteID string Site → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
StaffID int - -
StaffName string - -
StaffType string - -
StaffTypeID int - -
AssetTypeID int - -
AssetTypeName string - -
ServiceLevelID int - -
ServiceLevelName string - -
SiteID int Site → ID -

SiteCustomField

Column Type Relates to Notes
RemoteID string - -
SiteRemoteID string Site → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
SiteID int Site → ID -
CustomFieldID int CustomField → ID -
Value string - -

EmployeeAssignedCostCenter

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CostCenterID int CostCenter → ID -
EmployeeID int Employee → ID -

EmployeeZone

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
EmployeeID int Employee → ID -

EmployeeCustomField

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
EmployeeID int Employee → ID -
CustomFieldID int CustomField → ID -
Value string - -

Contact

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Title string - -
GivenName string - -
FamilyName string - -
Email string - -
WorkPhone string - -
Fax string - -
CellPhone string - -
AltPhone string - -
Department string - -
Position string - -
Notes string - -
DateModified datetime - -

ContactCustomField

Column Type Relates to Notes
RemoteID string - -
ContactRemoteID string Contact → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContactID int Contact → ID -
CustomFieldID int CustomField → ID -
Value string - -

CustomField

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Type string - -
IsMandatory boolean - -
Order int - -
Archived boolean - -
EntityType string - -

AssetType

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
ReferenceSection string - -
ReferenceStandard string - -
RegType decimal - -
Archived boolean - -

AssetTypeCustomField

Documentation: https://developer.simprogroup.com/apidoc/?page=3352d5e59a4d8d5e7d3888ebd86c8064

Column Type Relates to Notes
RemoteID string - -
AssetTypeRemoteID string AssetType → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
AssetTypeID int AssetType → ID -
Type string - -
Order int - -
IsMandatory boolean - -
Archived boolean - -

Contractor

Documentation: https://developer.simprogroup.com/apidoc/?page=0f475af584faa19c9b62d780d7199320

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Position string - -
AddressAddress string - -
AddressCity string - -
AddressState string - -
AddressPostalCode string - -
AddressCountry string - -
DateOfHire datetime - -
DateOfBirth datetime - -
ContractorEmail string - -
ContractorSecondaryEmail string - -
ContractorWorkPhone string - -
ContractorExtension string - -
ContractorCellPhone string - -
ContractorFax string - -
ContractorPreferredNotificationMethod string - -
EmergencyContactName string - -
EmergencyContactRelationship string - -
EmergencyContactWorkPhone string - -
EmergencyContactCellPhone string - -
EmergencyContactAltPhone string - -
EmergencyContactAddress string - -
AccountSetupUsername string - -
AccountSetupIsMobility boolean - -
AccountSetupSecurityGroupID int - -
AccountSetupSecurityGroupName string - -
UserProfileIsSalesperson boolean - -
UserProfileIsProjectManager boolean - -
UserProfileStorageServiceID int - -
UserProfileStorageServiceName string - -
UserProfilePreferredLanguage string - -
DateCreated datetime - -
Archived boolean - -
DefaultZoneID int - -
DefaultZoneName string - -
DefaultCompanyID int Company → ID -
DefaultCompanyName string - -
EIN string - -
MaskedSSN string - -
CompanyNumber string - -
ContactName string - -
Currency string - -
BankingAccountName string - -
BankingRoutingNo string - -
BankingAccountNo string - -
BankingPaymentTermsDays int - -
BankingPaymentTermsType string - -
RatesTaxCodeID int - -
RatesTaxCodeCode string - -
RatesTaxCodeType string - -
RatesTaxCodeRate int - -
DisplayOrder int - -
DateModified datetime - -

ContractorCustomField

Column Type Relates to Notes
RemoteID string - -
ContractorRemoteID string Contractor → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContractorID int Contractor → ID -
CustomFieldID int CustomField → ID -
Value string - -

ContractorInvoice

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
ContractorID int Contractor → ID -
InvoiceNo string - -
Notes string - -
DateIssued datetime - -
DueDate datetime - -
DatePaid datetime - -
Currency string - -
ExchangeRate decimal - -
CategoryID int - -
CategoryName string - -
DateModified datetime - -

ContractorInvoiceContractorJob

Column Type Relates to Notes
RemoteID string - -
ContractorInvoiceRemoteID string ContractorInvoice → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContractorJobID int - -
ContractorInvoiceID int ContractorInvoice → ID -

ContractorInvoiceCostCenter

Column Type Relates to Notes
RemoteID string - -
ContractorInvoiceRemoteID string ContractorInvoice → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Description string - -
ContractorJob int - -
ContractorInvoiceID int ContractorInvoice → ID -
CostCenterID int CostCenter → ID -
CostCenterName string - -
CostCenterExpenseAccountNo string - -
JobNo int - -
LineTotalExTax decimal - -
LineTotalIncTax decimal - -
TotalExTax decimal - -
TotalIncTax decimal - -
InvoicedExTax decimal - -
InvoicedIncTax decimal - -
Complete boolean - -
TaxCodeID int - -
TaxCodeCode string - -
TaxCodeRate int - -
BusinessGroupID int - -
BusinessGroupName string - -

ContractorInvoiceRetention

Column Type Relates to Notes
RemoteID string - -
ContractorInvoiceRemoteID string ContractorInvoice → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContractorJob int - -
ContractorInvoiceID int ContractorInvoice → ID -
LineTotalExTax decimal - -
LineTotalIncTax decimal - -
TaxCodeID int - -
TaxCodeCode string - -
TaxCodeRate decimal - -

ContractorInvoiceVariance

Column Type Relates to Notes
RemoteID string - -
ContractorInvoiceRemoteID string ContractorInvoice → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContractorInvoiceID int ContractorInvoice → ID -
CostCenterID int CostCenter → ID -
CostCenterName string - -
CostCenterExpenseAccountNo string - -
LineTotalExTax decimal - -
LineTotalIncTax decimal - -
TaxCodeID int - -
TaxCodeCode string - -
TaxCodeRate decimal - -
BusinessGroupID int - -
BusinessGroupName string - -

IndividualCustomer

Documentation: https://developer.simprogroup.com/apidoc/?page=e6d0e1c8fc6a4fcf47869df87e04cd88

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Title string - -
GivenName string - -
FamilyName string - -
CellPhone string - -
Phone string - -
DoNotCall boolean - -
AltPhone string - -
AddressAddress string - -
AddressCity string - -
AddressState string - -
AddressPostalCode string - -
AddressCountry string - -
BillingAddressAddress string - -
BillingAddressCity string - -
BillingAddressState string - -
BillingAddressPostalCode string - -
BillingAddressCountry string - -
CustomerType string - -
RatesPartTaxCodeID int - -
RatesPartTaxCodeCode string - -
RatesPartTaxCodeType string - -
RatesPartTaxCodeRate decimal - -
RatesLabourTaxCodeID int - -
RatesLabourTaxCodeCode string - -
RatesLabourTaxCodeType string - -
RatesLabourTaxCodeRate decimal - -
RatesDiscountFee string - -
RatesServiceFeeID int - -
RatesServiceFeeName string - -
RatesMaterialPricingTierID int - -
RatesMaterialPricingTierName string - -
RatesMaterialPricingTierDefaultMarkup decimal - -
DatesMaterialMarkup decimal - -
ProfileNotes string - -
ProfileCustomerProfileID int - -
ProfileCustomerProfileName string - -
ProfileCustomerGroupID int - -
ProfileCustomerGroupName string - -
ProfileAccountManagerID int - -
ProfileAccountMangerName string - -
ProfileCurrencyID string - -
ProfileCurrencyName string - -
ProfileCurrencyVisible boolean - -
ProfileServiceJobCostCenterID int CostCenter → ID -
ProfileServiceJobCostCenterName string - -
BankingAccountName string - -
BankingRoutingNo string - -
BankingAccountNo string - -
BankingPaymentMethodID int - -
BankingPaymentMethodName string - -
BankingPaymentTermsDays int - -
BankingPaymentTermsType string - -
BankingCreditLimit decimal - -
BankingOnStop boolean - -
BankingVendorOrderNotRequired boolean - -
Archived boolean - -
Email string - -
DateCreated datetime - -
DateModified datetime - -

IndividualCustomerPreferredTech

Column Type Relates to Notes
RemoteID string - -
IndividualCustomerRemoteID string IndividualCustomer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CustomerID int IndividualCustomer → ID -
Type string - -
TypeID int - -

IndividualCustomerSite

Column Type Relates to Notes
RemoteID string - -
IndividualCustomerRemoteID string IndividualCustomer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CustomerID int IndividualCustomer → ID -

IndividualCustomerContract

Column Type Relates to Notes
RemoteID string - -
IndividualCustomerRemoteID string IndividualCustomer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CustomerID int IndividualCustomer → ID -
StartDate datetime - -
EndDate datetime - -
ContractNo string - -
Value decimal - -
Notes string - -
Email string - -
Archived boolean - -
Expired boolean - -
Markup decimal - -

IndividualCustomerCustomFiled

Column Type Relates to Notes
RemoteID string - -
IndividualCustomerRemoteID string IndividualCustomer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerID int IndividualCustomer → ID -
CustomFieldID int CustomField → ID -
Value string - -

CompanyCustomer

Documentation: https://developer.simprogroup.com/apidoc/?page=e6d0e1c8fc6a4fcf47869df87e04cd88

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
CompanyName string - -
EIN string - -
Website string - -
Fax string - -
CompanyNumber string - -
Phone string - -
DoNotCall boolean - -
AltPhone string - -
AddressAddress string - -
AddressCity string - -
AddressState string - -
AddressPostalCode string - -
AddressCountry string - -
BillingAddressAddress string - -
BillingAddressCity string - -
BillingAddressState string - -
BillingAddressPostalCode string - -
BillingAddressCountry string - -
CustomerType string - -
RatesPartTaxCodeID int - -
RatesPartTaxCodeCode string - -
RatesPartTaxCodeType string - -
RatesPartTaxCodeRate decimal - -
RatesLabourTaxCodeID int - -
RatesLabourTaxCodeCode string - -
RatesLabourTaxCodeType string - -
RatesLabourTaxCodeRate decimal - -
RatesDiscountFee string - -
RatesServiceFeeID int - -
RatesServiceFeeName string - -
RatesMaterialPricingTierID int - -
RatesMaterialPricingTierName string - -
RatesMaterialPricingTierDefaultMarkup decimal - -
DatesMaterialMarkup decimal - -
ProfileNotes string - -
ProfileCustomerProfileID int - -
ProfileCustomerProfileName string - -
ProfileCustomerGroupID int - -
ProfileCustomerGroupName string - -
ProfileAccountManagerID int - -
ProfileAccountMangerName string - -
ProfileCurrencyID string - -
ProfileCurrencyName string - -
ProfileCurrencyVisible boolean - -
ProfileServiceJobCostCenterID int CostCenter → ID -
ProfileServiceJobCostCenterName string - -
BankingAccountName string - -
BankingRoutingNo string - -
BankingAccountNo string - -
BankingPaymentMethodID int - -
BankingPaymentMethodName string - -
BankingPaymentTermsDays int - -
BankingPaymentTermsType string - -
BankingCreditLimit decimal - -
BankingOnStop boolean - -
BankingVendorOrderNotRequired boolean - -
Archived boolean - -
Email string - -
DateCreated datetime - -
DateModified datetime - -

CompanyCustomerPreferredTech

Column Type Relates to Notes
RemoteID string - -
CompanyCustomerRemoteID string CompanyCustomer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CustomerID int CompanyCustomer → ID -
Type string - -
TypeID int - -

CompanyCustomerSite

Column Type Relates to Notes
RemoteID string - -
CompanyCustomerRemoteID string CompanyCustomer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CustomerID int CompanyCustomer → ID -

CompanyCustomerContract

Column Type Relates to Notes
RemoteID string - -
CompanyCustomerRemoteID string CompanyCustomer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CustomerID int CompanyCustomer → ID -
StartDate datetime - -
EndDate datetime - -
ContractNo string - -
Value decimal - -
Notes string - -
Email string - -
Archived boolean - -
Expired boolean - -
Markup decimal - -

CompanyCustomerCustomFiled

Column Type Relates to Notes
RemoteID string - -
CompanyCustomerRemoteID string CompanyCustomer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerID int CompanyCustomer → ID -
CustomFieldID int CustomField → ID -
Value string - -

PurchaseOrder

Documentation: https://developer.simprogroup.com/apidoc/?page=1ce5d9607216ee37fb61fe793d38e2c3#tag/Vendor-Orders

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Type string - -
StorageDeviceID int StorageDevice → ID -
AssignedToID int - -
AssignedToCostCenterID int CostCenter → ID -
AssignedToName string - -
AssignedToJob int - -
AssignedToSection int - -
Stage string - -
StatusID int - -
StatusName string - -
StatusAutoAdjust boolean - -
DateIssued datetime - -
VendorID int - -
VendorName string - -
QuoteNo string - -
Reference string - -
DueDate datetime - -
VendorQuote int - -
VendorNotes string - -
PrivateNotes string - -
CreatedByID int - -
Archived boolean - -
Currency string - -
ExchangeRate decimal - -
TotalsExTax decimal - -
TotalsIncTax decimal - -
DateModified datetime - -

PurchaseOrderCustomField

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderRemoteID string PurchaseOrder → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PurchaseOrderID int PurchaseOrder → ID -
CustomFieldID int CustomField → ID -
Value string - -

AssetTypeAssetTestReading

Column Type Relates to Notes
RemoteID string - -
AssetTypeRemoteID string AssetType → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
AssetTypeID int AssetType → ID -
Type string - -
IsMandatory boolean - -
Order int - -
Archived boolean - -

AdvancedCommission

Documentation: https://developer.simprogroup.com/apidoc/?page=62cc48113b97b0cb4e5f9ad4adbe4c58#operation/7e1741155126f40dc7c9989d945bd54d

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Type string - -
DisplayOrder int - -
ComponentsCatalog decimal - -
ComponentsPrebuild decimal - -
ComponentsOneOffs decimal - -
ComponentsLabor decimal - -
ComponentsServiceFee decimal - -
ComponentsAdjustment decimal - -
Trigger string - -

BasicCommission

Documentation: https://developer.simprogroup.com/apidoc/?page=62cc48113b97b0cb4e5f9ad4adbe4c58#operation/611610ae9385e6cd37554660bdf71f40

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Type string - -
DisplayOrder int - -
Rule string - -
Rate decimal - -
Trigger string - -

Job

Documentation: https://developer.simprogroup.com/apidoc/?page=12ceff2290bb9039beaa8f36d5dec226

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
Type string - -
IndividualCustomerID int IndividualCustomer → ID -
CompanyCustomerID int CompanyCustomer → ID -
CustomerContactID int Contact → ID -
SiteID int Site → ID -
SiteName string - -
SiteContactID int Contact → ID -
OrderNo string - -
RequestNo string - -
Notes string - -
DateIssued datetime - -
DueDate datetime - -
DueTime string - -
SalesPersonEmployeeID int Employee → ID -
ProjectManagerEmployeeID int Employee → ID -
PrimaryTechnicianEmployeeID int Employee → ID -
StatusID int - -
StatusName string - -
ResponseTimeID int - -
IsVariation boolean - -
ConvertedFromQuoteID int Quote → ID -
AutoAdjustStatus boolean - -
TotalExTax decimal - -
TotalTax decimal - -
TotalIncTax decimal - -
TotalsMaterialsCostActual decimal - -
TotalsMaterialsCostCommitted decimal - -
TotalsMaterialsCostEstimate decimal - -
TotalsMaterialsCostRevised decimal - -
TotalsResourcesCostTotalActual decimal - -
TotalsResourcesCostTotalCommitted decimal - -
TotalsResourcesCostTotalEstimate decimal - -
TotalsResourcesCostTotalRevised decimal - -
TotalsResourcesCostLaborActual decimal - -
TotalsResourcesCostLaborCommitted decimal - -
TotalsResourcesCostLaborEstimate decimal - -
TotalsResourcesCostLaborRevised decimal - -
TotalsResourcesCostLaborHoursActual decimal - -
TotalsResourcesCostLaborHoursCommitted decimal - -
TotalsResourcesCostLaborHoursEstimate decimal - -
TotalsResourcesCostLaborHoursRevised decimal - -
TotalsResourcesCostPlantAndEquipmentActual decimal - -
TotalsResourcesCostPlantAndEquipmentCommitted decimal - -
TotalsResourcesCostPlantAndEquipmentEstimate decimal - -
TotalsResourcesCostPlantAndEquipmentRevised decimal - -
TotalsResourcesCostPlantAndEquipmentHoursActual decimal - -
TotalsResourcesCostPlantAndEquipmentHoursCommitted decimal - -
TotalsResourcesCostPlantAndEquipmentHoursEstimate decimal - -
TotalsResourcesCostPlantAndEquipmentHoursRevised decimal - -
TotalsResourcesCostOverheadActual decimal - -
TotalsResourcesCostOverheadCommitted decimal - -
TotalsResourcesCostOverheadEstimate decimal - -
TotalsResourcesCostOverheadRevised decimal - -
TotalsMaterialsMarkupActual decimal - -
TotalsMaterialsMarkupEstimate decimal - -
TotalsMaterialsMarkupRevised decimal - -
TotalsResourcesMarkupTotalActual decimal - -
TotalsResourcesMarkupTotalEstimate decimal - -
TotalsResourcesMarkupTotalRevised decimal - -
TotalsResourcesMarkupLaborActual decimal - -
TotalsResourcesMarkupLaborEstimate decimal - -
TotalsResourcesMarkupLaborRevised decimal - -
TotalsResourcesMarkupPlantAndEquipmentActual decimal - -
TotalsResourcesMarkupPlantAndEquipmentCommitted decimal - -
TotalsResourcesMarkupPlantAndEquipmentEstimate decimal - -
TotalsResourcesMarkupPlantAndEquipmentRevised decimal - -
TotalsAdjustedActual decimal - -
TotalsAdjustedEstimate decimal - -
TotalsAdjustedRevised decimal - -
TotalsMembershipDiscount decimal - -
TotalsDiscount decimal - -
TotalsSTCs decimal - -
TotalsVEECs decimal - -
TotalsGrossProfitLossActual decimal - -
TotalsGrossProfitLossEstimate decimal - -
TotalsGrossProfitLossRevised decimal - -
TotalsGrossMarginActual decimal - -
TotalsGrossMarginEstimate decimal - -
TotalsGrossMarginRevised decimal - -
TotalsNettProfitLossActual decimal - -
TotalsNettProfitLossEstimate decimal - -
TotalsNettProfitLossRevised decimal - -
TotalsNettMarginActual decimal - -
TotalsNettMarginEstimate decimal - -
TotalsNettMarginRevised decimal - -
TotalsInvoicedValue decimal - -
TotalsInvoicePercentage decimal - -
STCSTCsEligible boolean - -
STCVEECsEligible boolean - -
STCSTCValue decimal - -
STCVEECValue decimal - -
CompletedDate datetime - -
DateModified datetime - -

JobCustomField

Column Type Relates to Notes
RemoteID string - -
JobRemoteID string Job → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
JobID int Job → ID -
CustomFieldID int CustomField → ID -
Value string - -

JobAdditionalContact

Column Type Relates to Notes
RemoteID string - -
JobRemoteID string Job → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
GivenName string - -
FamilyName string - -
JobID int Job → ID -

JobTag

Column Type Relates to Notes
RemoteID string - -
JobRemoteID string Job → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
JobID int Job → ID -

JobTechnician

Column Type Relates to Notes
RemoteID string - -
JobRemoteID string Job → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Type string - -
TypeID int - -
JobID int Job → ID -

JobLinkedVariation

Column Type Relates to Notes
RemoteID string - -
JobRemoteID string Job → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
TotalExTax decimal - -
TotalTax decimal - -
TotalIncTax decimal - -
JobID int Job → ID -

JobSection

Column Type Relates to Notes
RemoteID string - -
JobRemoteID string Job → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
DateModified datetime - -
IsVariation boolean - -
IsVariationRetention boolean - -
DisplayOrder int - -
JobID int Job → ID -

Vendor

Documentation: https://developer.simprogroup.com/apidoc/?page=be3439768cb74608cedb2e37a74820d7

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
EIN string - -
CompanyNo string - -
Website string - -
Email string - -
Phone string - -
Fax string - -
AddressAddress string - -
AddressCity string - -
AddressState string - -
AddressPostalCode string - -
AddressCountry string - -
BillingAddressAddress string - -
BillingAddressCity string - -
BillingAddressState string - -
BillingAddressPostalCode string - -
BillingAddressCountry string - -
BankingAccountName string - -
BankingRoutingNo string - -
BankingAccountNo string - -
PrivateNotes string - -
ProfileAccount string - -
ProfilePreferredNotificationMethod string - -
DateCreated datetime - -
Archived boolean - -
DateModified datetime - -

VendorCustomField

Column Type Relates to Notes
RemoteID string - -
VendorRemoteID string Vendor → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
VendorID int Vendor → ID -
CustomFieldID int CustomField → ID -
Value string - -

VendorContact

Column Type Relates to Notes
RemoteID string - -
VendorRemoteID string Vendor → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
VendorID int Vendor → ID -
ContactID int Contact → ID -

CompanyCustomerContact

Column Type Relates to Notes
RemoteID string - -
CompanyCustomerRemoteID string CompanyCustomer → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
CompanyCustomerID int CompanyCustomer → ID -
ContactID int Contact → ID -

SiteContact

Column Type Relates to Notes
RemoteID string - -
SiteRemoteID string Site → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
SiteID int Site → ID -
ContactID int Contact → ID -

JobSectionCostCenter

Documentation: https://developer.simprogroup.com/apidoc/?page=e20580fa653ea5969f97040b4eb3c8db

Column Type Relates to Notes
RemoteID string - -
JobSectionRemoteID string JobSection → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int -
  • 5 May 2021 This is the ID of the relationship between JobSection and CostCenter
Name string - -
JobSectionID int JobSection → ID -
JobID int Job → ID -
CostCenterID int CostCenter → ID -
ExTax decimal - -
Tax decimal - -
IncTax decimal - -
TaxCodeID int - -
ClaimedToDatePercent decimal - -
ClaimedToDateExTax decimal - -
ClaimedToDateIncTax decimal - -
ClaimedRemainingPercent decimal - -
ClaimedRemainingExTax decimal - -
ClaimedRemainingIncTax decimal - -
Stage string -
  • 5 May 2021 For example, 'Pending', 'Complete'
StartDate datetime - -
EndDate datetime - -
AutoAdjustDates boolean - -
Variation boolean - -
VariationApprovalDate datetime - -
DateModified datetime - -
PercentComplete decimal -
  • 5 May 2021 The PercentComplete comes down as an empty string if no values is specified, otherwise a numeric

JobCard

Documentation: https://developer.simprogroup.com/apidoc/?page=401740175cb9b4b5190e6d44cc5478bd#operation/97fc2be4fc45f535f32c847c95c9a62a

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterRemoteID string JobSectionCostCenter → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
EmployeeID int Employee → ID -
JobSectionCostCenterID int JobSectionCostCenter → ID -
JobSectionID int JobSection → ID -
JobID int Job → ID -
WorkOrderDate string -
  • 10 May 2021 Format is yyyy-MM-dd
DescriptionNotes string -
  • 10 May 2021 Can include HTML
MaterialNotes string - -
Approved boolean - -
DateModified datetime - -

JobCardBlock

Column Type Relates to Notes
RemoteID string - -
JobCardRemoteID string JobCard → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
BlockNumber int - -
JobCardID int JobCard → ID -
Hrs decimal - -
StartTime string -
  • 10 May 2021 The time component of the start of this block, for example '8:00'
EndTime string -
  • 10 May 2021 The time component of the end of this block, for example '13:00'
ISO8601StartTime datetime - -
ISO8601EndTime datetime - -
ScheduleRateID int - -

JobCardAsset

Column Type Relates to Notes
RemoteID string - -
JobCardRemoteID string JobCard → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AssetID int - -
JobCardID int JobCard → ID -
Result string -
  • 10 May 2021 For example, 'Pass'

CostCenter

Documentation: https://developer.simprogroup.com/apidoc/?page=9b945efebb006547a94415eadaa12921#operation/45f7d7f4767de4368c59a1873bf67360

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
IncomeAccountNo string - -
ExpenseAccountNo string - -
MonthlySalesBudget decimal - -
MonthlyExpenditureBudget decimal - -
Archived boolean - -
IsMembershipCostCenter boolean - -

RecurringInvoice

Documentation: https://developer.simprogroup.com/apidoc/?page=a028944d25abee97a013c7f3f0090254

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
Type string - -
IndividualCustomerID int IndividualCustomer → ID -
CompanyCustomerID int CompanyCustomer → ID -
RequestNo string - -
OrderNo string - -
Notes string - -
RecurringStartDate datetime - -
NextRecurringDate datetime - -
RecurringQuantity decimal - -
RecurringFrequency string - -
Removed boolean - -
SiteID int Site → ID -
ProjectManagerID int Employee → ID -
SalesPersonID int Employee → ID -
PaymentTermsType string - -
PaymentTermsDays decimal - -
TotalExTax decimal - -
TotalTax decimal - -
TotalIncTax decimal - -
TotalMaterialsCostEstimate decimal - -
TotalMaterialsCostRevized decimal - -
TotalResourcesCostTotalEstimate decimal - -
TotalResourcesCostTotalRevized decimal - -
TotalResourcesCostLaborEstimate decimal - -
TotalResourcesCostLaborRevized decimal - -
TotalResourcesCostLaborHoursEstimate decimal - -
TotalResourcesCostLaborHoursRevized decimal - -
TotalResourcesCostOverheadEstimate decimal - -
TotalResourcesCostOverheadRevized decimal - -
TotalMaterialsMarkupEstimate decimal - -
TotalMaterialsMarkupRevized decimal - -
TotalResourcesMarkupTotalEstimate decimal - -
TotalResourcesMarkupTotalRevized decimal - -
TotalResourcesMarkupLaborEstimate decimal - -
TotalResourcesMarkupLaborRevized decimal - -
TotalDiscount decimal - -
TotalGrossProfitLossEstimate decimal - -
TotalGrossProfitLossRevized decimal - -
TotalGrossMarginEstimate decimal - -
TotalGrossMarginRevized decimal - -
TotalNetProfitLossEstimate decimal - -
TotalNetProfitLossRevized decimal - -
TotalNetMarginEstimate decimal - -
TotalNetMarginRevized decimal - -
DateModified datetime - -

ContractorJob

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
Status string - -
DateIssued datetime - -
ContractorSupplyMaterials boolean - -
Materials decimal - -
Currency string - -
ExchangeRate decimal - -
Labor decimal - -
JobID int Job → ID
  • 9 Jul 2021 The Job ID can be parsed out of the _href property
ContractorID int Contractor → ID -
TaxCodeID int - -
TaxCodeCode string - -
TaxCodeType string - -
TaxCodeRate decimal - -
RetentionAmount decimal - -
RetentionPerClaim decimal - -
RetentionPeriodMonths int - -
TotalExTax decimal - -
TotalIncTax decimal - -
DateModified datetime - -

LaborRate

Documentation: https://developer.simprogroup.com/apidoc/?page=9d590cb9ad8969796f67b63a2f94f1a7#tag/Labor-Rates

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CostRate decimal - -
Markup decimal - -
Multiplier decimal - -
IsDefault boolean - -
IncOverhead boolean - -
Archived boolean - -
TaxCodeID int - -
TaxCodeCode string - -
TaxCodeType string - -
TaxCodeRate decimal - -
PlantID int - -
PlantName string - -

ScheduleRate

Documentation: https://developer.simprogroup.com/apidoc/?page=9d590cb9ad8969796f67b63a2f94f1a7#tag/Schedule-Rates

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Multiplier decimal - -
ShowInMobile boolean - -
ShowInConnect boolean - -
IncOverhead boolean - -
ActivityOnly boolean - -
ScheduleColor string - -
DisplayOrder int - -
Archived boolean - -
HourlyAllowance decimal - -
PayRateOverride decimal - -

PurchaseOrderReceipt

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderRemoteID string PurchaseOrder → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
PurchaseOrderID int PurchaseOrder → ID -
VendorInvoiceNo string - -
DateIssued string - -
DueDate string - -
PackingSlipNo string - -
Notes string - -
Currency string - -
ExchangeRate decimal - -
DateCreated datetime - -
TaxAdjustment decimal - -
FreightTaxID int - -
FreightTaxRate decimal - -
FreightIncTax decimal - -
FreightExTax decimal - -
TotalIncTax decimal - -
TotalExTax decimal - -
ItemsReceived boolean - -
ItemsReceivedDate datetime - -
DateModified datetime - -

Invoice

Documentation: https://developer.simprogroup.com/apidoc/?page=fce9a6a1bd2a2050eb86d33103f46fd3#operation/4ae796284a1a689da2c02021725e0474

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
CustomerID int - -
StartDate datetime - -
EndDate datetime - -
RecurringInvoiceID int RecurringInvoice → ID -
PaymentTermsDays decimal - -
PaymentTermsType string - -
PaymentTermsDueDate datetime - -
AccountingCategoryID int - -
StatusID int -
  • 11 May 2022 Note that a VOIDed invoice in simPRO may still render as active here. This is because the user may have loaded a 'VOID Invoice' Credit Note against this invoice. You can check the types of the associated credit notes via the /invoice/{id}/creditNotes endpoint
DateIssued datetime - -
ProgressClaimNumber string - -
Type string - -
Stage string - -
PerItem boolean - -
LatePaymentFee boolean - -
CISDeductionRate decimal - -
ExchangeRate decimal - -
ExTax decimal - -
IncTax decimal - -
AutoAdjustStatus boolean - -
Notes string - -
IsRetainage boolean - -
IsPaid boolean - -
DatePaid datetime - -
DateModified datetime - -

InvoiceJob

Column Type Relates to Notes
RemoteID string - -
InvoiceRemoteID string Invoice → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int Job → ID -
InvoiceID int Invoice → ID -
ExTax decimal - -
IncTax decimal - -

InvoiceRetainage

Column Type Relates to Notes
RemoteID string - -
InvoiceRemoteID string Invoice → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
InvoiceID int Invoice → ID -
JobID int Job → ID -
ExTax decimal - -
IncTax decimal - -

InvoiceCostCenter

Column Type Relates to Notes
RemoteID string - -
InvoiceRemoteID string Invoice → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
InvoiceID int Invoice → ID -
CostCenterID int CostCenter → ID -
RecurringInvoiceID int RecurringInvoice → ID -
JobID int Job → ID
  • 7 Jul 2022
ClaimExTax decimal - -
ClaimPercent decimal - -
ClaimIncTax decimal - -
ExTax decimal - -
IncTax decimal - -

InvoiceItem

Column Type Relates to Notes
RemoteID string - -
InvoiceCostCenterRemoteID string InvoiceCostCenter → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
InvoiceID int Invoice → ID -
CostCenterID int CostCenter → ID -
ItemID int - -
QuantityTotal decimal - -
QuantityRemaining decimal - -
QuantityClaimed decimal - -
UnitPriceExTax decimal - -
UnitPriceIncTax decimal - -
TotalExTax decimal - -
TotalIncTax decimal - -

Quote

Documentation: https://developer.simprogroup.com/apidoc/?page=c9a28e7f0dbc3ed20a161351c4f29a7b#tag/Quotes

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
IndividualCustomerID int IndividualCustomer → ID -
CompanyCustomerID int CompanyCustomer → ID -
StatusID int - -
StatusName string - -
CustomerContactID int Contact → ID -
SiteID int Site → ID -
SiteContactID int Contact → ID -
SalesPersonEmployeeID int Employee → ID -
SalesPersonContractorID int Contractor → ID -
ProjectManagerEmployeeID int Employee → ID -
ProjectManagerContractorID int Contractor → ID -
ConvertedFromLeadID int Lead → ID -
ForecastYear decimal - -
ForecastMonth decimal - -
ForecastPercent decimal - -
TotalExTax decimal - -
TotalTax decimal - -
TotalIncTax decimal - -
Notes string - -
Type string - -
DateIssued datetime - -
DueDate datetime - -
ValidityDays decimal - -
OrderNo string - -
RequestNo string - -
IsClosed boolean - -
Stage string - -
CustomerStage string - -
JobNo int Job → ID -
IsVariation boolean - -
AutoAdjustStatus boolean - -
TotalsMaterialsCostEstimate decimal - -
TotalsMaterialsCostRevised decimal - -
TotalsResourcesCostTotalEstimate decimal - -
TotalsResourcesCostTotalRevised decimal - -
TotalsResourcesCostLaborEstimate decimal - -
TotalsResourcesCostLaborRevised decimal - -
TotalsResourcesCostLaborHoursEstimate decimal - -
TotalsResourcesCostLaborHoursRevised decimal - -
TotalsResourcesCostPlantAndEquipmentEstimate decimal - -
TotalsResourcesCostPlantAndEquipmentRevised decimal - -
TotalsResourcesCostPlantAndEquipmentHoursEstimate decimal - -
TotalsResourcesCostPlantAndEquipmentHoursRevised decimal - -
TotalsResourcesCostOverheadEstimate decimal - -
TotalsResourcesCostOverheadRevised decimal - -
TotalsMaterialsMarkupEstimate decimal - -
TotalsMaterialsMarkupRevised decimal - -
TotalsResourcesMarkupTotalEstimate decimal - -
TotalsResourcesMarkupTotalRevised decimal - -
TotalsResourcesMarkupLaborEstimate decimal - -
TotalsResourcesMarkupLaborRevised decimal - -
TotalsResourcesMarkupPlantAndEquipmentEstimate decimal - -
TotalsResourcesMarkupPlantAndEquipmentRevised decimal - -
TotalsAdjustedEstimate decimal - -
TotalsAdjustedRevised decimal - -
TotalsMembershipDiscount decimal - -
TotalsDiscount decimal - -
TotalsSTCs decimal - -
TotalsVEECs decimal - -
TotalsGrossProfitLossEstimate decimal - -
TotalsGrossProfitLossRevised decimal - -
TotalsGrossMarginEstimate decimal - -
TotalsGrossMarginRevised decimal - -
TotalsNettProfitLossEstimate decimal - -
TotalsNettProfitLossRevised decimal - -
TotalsNettMarginEstimate decimal - -
TotalsNettMarginRevised decimal - -
TotalsInvoicedValue decimal - -
TotalsInvoicePercentage decimal - -
STCSTCsEligible boolean - -
STCVEECsEligible boolean - -
STCSTCValue decimal - -
STCVEECValue decimal - -
DateModified datetime - -

QuoteTechnician

Column Type Relates to Notes
RemoteID string - -
QuoteRemoteID string Quote → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
QuoteID int Quote → ID -
EmployeeID int Employee → ID -
ContractorID int Contractor → ID -

Lead

Documentation: https://developer.simprogroup.com/apidoc/?page=c9a28e7f0dbc3ed20a161351c4f29a7b#tag/Leads

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
LeadName string - -
AutoAdjustStatus boolean - -
Stage string - -
FollowUpDate string - -
DateCreated string - -
Notes string - -
IndividualCustomerID int IndividualCustomer → ID -
CompanyCustomerID int CompanyCustomer → ID -
SiteID int Site → ID -
SiteContactID int Contact → ID -
CustomerContactID int Contact → ID -
CostCenterID int CostCenter → ID -
SalesPersonEmployeeID int Employee → ID -
SalesPersonContractorID int Contractor → ID -
ProjectManagerEmployeeID int Employee → ID -
ProjectManagerContractorID int Contractor → ID -
ForecastEstimatedPrice decimal - -
ForecastProbability decimal - -
ForecastExpectedYear decimal - -
ForecastExpectedMonth decimal - -
DateModified datetime - -

Asset

Column Type Relates to Notes
RemoteID string - -
SiteRemoteID string Site → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
SiteID int Site → ID -
AssetTypeID int AssetType → ID -
DisplayOrder decimal - -
StartDate datetime - -
Archived boolean - -
LastTestDate datetime - -
LastTestResult string - -
CustomerContractID int -
  • 7 Jul 2022
DateModified datetime - -

AssetTestResult

Column Type Relates to Notes
RemoteID string - -
AssetRemoteID string Asset → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AssetID int Asset → ID -
EmployeeID int Employee → ID -
JobID int Job → ID -
QuoteID int Quote → ID -
ServiceLevelID int - -
Date datetime - -
Notes string - -
Result string - -

AssetCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
AssetRemoteID string Asset → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AssetID int Asset → ID -
CustomFieldID int AssetTypeCustomField → ID
  • 7 Jul 2022
Value string - -

AssetTestResultReading

Column Type Relates to Notes
RemoteID string - -
AssetTestResultRemoteID string AssetTestResult → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Value string - -

Timesheet

Column Type Relates to Notes
RemoteID string -
  • 9 Mar 2022 simPRO have advised that there is no uniquely identifying field (or composite fields) on this record. We use the employee/date/time combo, but this means that if the user changes their time, the prior version gets orphaned. simPRO have advised 'A timesheet is a collection of schedules so it won't have an ID on its own. Column _href in the response can be used to identify the schedule which can give you how many blocks of schedule it has for the schedule type for that day', but this doesn't really help our issue unfortunately.
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
EmployeeID int Employee → ID -
ScheduleType string - -
Reference string - -
Date datetime - -
StartTime string - -
EndTime string - -
TotalHrs decimal - -
Cost decimal - -
JobID int Job → ID -
CostCenterID int CostCenter → ID -

Task

Documentation: https://developer.simprogroup.com/apidoc/?page=ef615563c8e8ea902c7fcac3cd2c4246#tag/Tasks

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
CreatedByEmployeeID int Employee → ID -
CompletedByEmployeeID int Employee → ID -
JobID int Job → ID -
CostCenterID int CostCenter → ID -
QuoteID int Quote → ID -
ContactID int Contact → ID -
SiteID int Site → ID -
IndividualCustomerID int IndividualCustomer → ID -
CompanyCustomerID int CompanyCustomer → ID -
EstimatedHours decimal - -
EstimatedMinutes decimal - -
EstimatedSeconds decimal - -
ActualHours decimal - -
ActualMinutes decimal - -
ActualSeconds decimal - -
CategoryID int - -
ParentTaskID int Task → ID -
Subject string - -
AssignedToCustomer boolean - -
IsBillable boolean - -
ShowOnWorkOrder boolean - -
StartDate datetime - -
DueDate datetime - -
CompletedDate datetime - -
Notes string - -
Status string - -
Priority string - -
PercentComplete decimal - -
DateModified datetime - -

TaskAssignee

Column Type Relates to Notes
RemoteID string - -
TaskRemoteID string Task → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TaskID int Task → ID -
EmployeeID int Employee → ID -
ContractorID int Contractor → ID -

TaskCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
TaskRemoteID string Task → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TaskID int Task → ID -
CustomFieldID int CustomField → ID -
Value string - -

Catalog

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
IsFavorite boolean - -
IsInventory boolean - -
UPC string - -
Manufacturer string - -
CountryOfOrigin string - -
EstimatedTime decimal - -
TradeSplitQty decimal - -
MinPackQty decimal - -
PurchasingStageID int - -
Markup decimal - -
BasePrice decimal - -
SellPrice decimal - -
StorageLocation string - -
SearchTerm string - -
Notes string - -
UOMID int - -
PurchaseTaxCodeID int - -
SalesTaxCodeID int - -
GroupID int - -
DisplayOrder decimal - -
DateModified datetime - -
Archived boolean - -
VendorQuantity decimal - -
VendorDescription string - -
PartNo string - -
TradePrice decimal - -
TradePriceEx decimal - -
TradePriceInc decimal - -
SplitPrice decimal - -
SplitPriceEx decimal - -
SplitPriceInc decimal - -

CatalogVendor

Column Type Relates to Notes
RemoteID string - -
CatalogRemoteID string Catalog → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
VendorID int Vendor → ID -
VendorPartNo string - -
Default boolean - -
NettPrice decimal - -
Discount decimal - -
CatalogID int Catalog → ID -

LinkedCatalog

Column Type Relates to Notes
RemoteID string - -
CatalogRemoteID string Catalog → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ToCatalogID int Catalog → ID -
FromCatalogID int Catalog → ID -

Schedule

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Type string - -
Reference string - -
TotalHours decimal - -
JobID int Job → ID -
EmployeeID int Employee → ID -
ContractorID int Contractor → ID -
Date string - -
DateModified datetime - -

ScheduleBlock

Column Type Relates to Notes
RemoteID string - -
ScheduleRemoteID string Schedule → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ScheduleID int Schedule → ID -
Hrs decimal - -
StartTime string - -
ISO8601StartTime datetime - -
EndTime string - -
ISO8601EndTime datetime - -
ScheduleRateID int ScheduleRate → ID -

CatalogCustomField

Column Type Relates to Notes
RemoteID string - -
CatalogRemoteID string Catalog → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CatalogID int Catalog → ID -
CustomFieldID int CustomField → ID -
Value string - -

CreditNote

Documentation: https://developer.simprogroup.com/apidoc/?page=bd16af1838f0dd73a528391790db0115#operation/eb06ee3cbad06670495ff8030caeecad

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
CustomerID int - -
StartDate datetime - -
EndDate datetime - -
IncomeAccountID int - -
CategoryID int - -
StatusID int - -
DateIssued datetime - -
Type string - -
Stage string - -
OrderNo string - -
InvoiceID int Invoice → ID -
InvoiceNo int - -
AutoAdjustStatus boolean - -
ExTax decimal - -
IncTax decimal - -
Notes string - -
DateModified datetime - -

CreditNoteJob

Column Type Relates to Notes
RemoteID string - -
CreditNoteRemoteID string CreditNote → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int Job → ID -
CreditNoteID int CreditNote → ID -
ExTax decimal - -
IncTax decimal - -

CreditNoteCostCenter

Column Type Relates to Notes
RemoteID string - -
CreditNoteRemoteID string CreditNote → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CreditNoteID int CreditNote → ID -
CostCenterID int CostCenter → ID -
ClaimExTax decimal - -
ClaimIncTax decimal - -
TotalExTax decimal - -
TotalIncTax decimal - -

CreditNoteCustomField

Column Type Relates to Notes
RemoteID string - -
CreditNoteRemoteID string CreditNote → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CreditNoteID int CreditNote → ID -
CustomFieldID int CustomField → ID -
Value string - -

InvoiceCustomField

Column Type Relates to Notes
RemoteID string - -
InvoiceRemoteID string Invoice → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
InvoiceID int Invoice → ID -
CustomFieldID int CustomField → ID -
Value string - -

StorageDevice

Documentation: https://developer.simprogroup.com/apidoc/?page=567bb087576e68109daf1d04361ff0d6#operation/a2df290f8fbeca8d5e7749c3dccc8d32

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -

StorageDeviceStockItem

Column Type Relates to Notes
RemoteID string - -
StorageDeviceRemoteID string StorageDevice → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CatalogID int Catalog → ID -
StorageDeviceID int StorageDevice → ID -
InventoryCount decimal - -
StorageLocation string -
  • 14 May 2022 The docs indicate that StorageLocation is a decimal, but in fact we see string values, such as 'Auckland' returning here
InventoryValue decimal - -

JobSectionCostCenterStock

Documentation: https://developer.simprogroup.com/apidoc/?page=e20580fa653ea5969f97040b4eb3c8db#operation/b14ed922edaeaad3946e795348de4a0d

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterRemoteID string JobSectionCostCenter → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CatalogID int Catalog → ID -
Required decimal - -
Assigned decimal - -
JobSectionID int JobSection → ID -
JobID int Job → ID -
JobSectionCostCenterID int JobSectionCostCenter → ID -

JobSectionCostCenterStockStorage

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterStockRemoteID string JobSectionCostCenterStock → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Quantity decimal - -
StorageID int StorageDevice → ID -

EmployeeLicence

Documentation: https://developer.simprogroup.com/apidoc/?page=eb626c94531ec554f93b2b78a77c8b1b#tag/Employee-Licences

Column Type Relates to Notes
RemoteID string -
  • 20 Jun 2022 The ID field actually uniquely identifies these records, however we prefix the EmployeeID so that we may use it to find the dedicated API endpoint later, if required
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
ExpiryAlertQuantity int - -
ExpiryAlertFrequency string - -
Critical boolean - -
Ref string - -
ExpiryDate datetime - -
EmployeeID int Employee → ID -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.