2024 is the year of the connector - vote here

Explore the simPRO API data model

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

Try our interactive ERD Or, browse below

Pulling data from the simPRO API 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 sync your simPRO API 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

Activity

Documentation: https://developer.simprogroup.com/apidoc/?page=d78ed35383108fb6c04c16d0a11b20fe#operation/d6f8643f50d427781b9be54c3bd70c76

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

ActivitySchedule

Documentation: https://developer.simprogroup.com/apidoc/?page=ccdb7bf9d93e5652b57cabcc8c41e061#tag/Activity-Schedules

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DateModified datetime - -
TotalHours decimal - -
Notes string - -
IsLocked boolean - -
RecurringScheduleID int -
  • 3 Oct 2022 Have not confirmed if this is an FK to a Schedule or if simPRO have a RecurringSchedule entity/concept
Date datetime - -
StaffID int Employee → ID -
ActivityID int Activity → ID -

AdvancedCommission

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

Asset

Documentation: https://developer.simprogroup.com/apidoc/?page=3352d5e59a4d8d5e7d3888ebd86c8064#operation/7b8d23d03848151ad0b6a757cebd001d

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

AssetAttachmentFile

Column Type Relates to Notes
RemoteID string - -
AssetRemoteID string Asset → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
AssetID int Asset → ID -
DateAdded datetime - -
Filename string - -
MimeType string - -
FileSizeBytes long - -
FolderID long AssetAttachmentFolder → ID -

AssetAttachmentFolder

Column Type Relates to Notes
RemoteID string - -
AssetRemoteID string Asset → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
AssetID int Asset → ID -

AssetServiceLevel

Documentation: https://developer.simprogroup.com/apidoc/?page=dd530f67a3c5c4f3768841df8f40fb0f#operation/74c8f5ddeccdd4cac3b3c130c6b9e196

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

AssetType

Documentation: https://developer.simprogroup.com/apidoc/?page=dd530f67a3c5c4f3768841df8f40fb0f#tag/Asset-Types

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

AssetTypeAssetTestReading

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

AssetTypeCustomField

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

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

BasicCommission

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

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

Catalog

Documentation: https://developer.simprogroup.com/apidoc/?page=5408c752aea14ba352fc3dad16b268d8#tag/Catalogs

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -
Archived boolean - -
VendorQuantity decimal - -
VendorDescription string - -
PartNo string - -
TradePrice decimal - -
TradePriceEx decimal - -
TradePriceInc decimal - -
SplitPrice decimal - -
SplitPriceEx decimal - -
SplitPriceInc decimal - -
DateModified datetime - -

CatalogGroup

Documentation: https://developer.simprogroup.com/apidoc/?page=5408c752aea14ba352fc3dad16b268d8#tag/Catalog-Groups

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
DateCreated datetime - -
Archived boolean - -
DisplayOrder int - -
IsThirdPartyGroup boolean - -
ParentGroupID int CatalogGroup → ID -

Company

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

CompanyRecurringJob

Documentation: https://developer.simprogroup.com/apidoc/?page=47d1b3eff79ecdfc51222ea2d777571f#operation/a6f9b203694baadbf5d4b2cc4fb03bdc

Column Type Relates to Notes
RemoteID string - -
CompanyRemoteID string Company → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long -
  • 19 Apr 2023 Although nested under a 'Company', this ID field is globally unique
Name string - -
Description string - -
CompanyID int Company → ID -
TotalExTax decimal - -
TotalTax decimal - -
TotalIncTax decimal - -
Type string - -
OrderNo string - -
Notes string - -
DateModified datetime - -
RecurringStartDate datetime - -
NextRecurringDate datetime - -
RecurringFrequency string - -
LaborOverhead decimal - -
MaterialMarkup decimal - -
CustomerID int - -
IndividualCustomerID int IndividualCustomer → ID -
CompanyCustomerID int CompanyCustomer → ID -
SiteID int Site → ID -
CustomerContactID int Contact → ID -
SiteContactID int Contact → ID -
SalesPersonID int Employee → ID -
ProjectManagerID int Employee → ID -
PricingTierID long -
  • 17 Apr 2023 Foreign Key - Refers to `Pricing Tier` (not implemented).
LaborTypeID long - -
LaborFitTimeID long -
  • 17 Apr 2023 Foreign Key - Refers to `Fit Times` (not implemented).
LaborTaxCodeID long -
  • 17 Apr 2023 Foreign Key - Refers to `Tax Codes` (not implemented).
TotalMaterialsCostEstimate decimal - -
TotalMaterialsCostRevized decimal - -
TotalResourcesCostTotalEstimate decimal - -
TotalResourcesCostTotalRevized decimal - -
TotalResourcesCostLaborEstimate decimal - -
TotalResourcesCostLaborRevized decimal - -
TotalResourcesCostLaborHoursEstimate decimal - -
TotalResourcesCostLaborHoursRevized decimal - -
TotalResourcesCostPlantAndEquipmentEstimate decimal - -
TotalResourcesCostPlantAndEquipmentRevized decimal - -
TotalResourcesCostPlantAndEquipmentHoursEstimate decimal - -
TotalResourcesCostPlantAndEquipmentHoursRevized decimal - -
TotalResourcesCostOverheadEstimate decimal - -
TotalResourcesCostOverheadRevized decimal - -
TotalMaterialsMarkupEstimate decimal - -
TotalMaterialsMarkupRevized decimal - -
TotalResourcesMarkupTotalEstimate decimal - -
TotalResourcesMarkupTotalRevized decimal - -
TotalResourcesMarkupLaborEstimate decimal - -
TotalResourcesMarkupLaborRevized decimal - -
TotalResourcesMarkupPlantAndEquipmentEstimate decimal - -
TotalResourcesMarkupPlantAndEquipmentRevized decimal - -
TotalAdjustedEstimate decimal - -
TotalAdjustedRevized decimal - -
TotalDiscount decimal - -
TotalGrossProfitLossEstimate decimal - -
TotalGrossProfitLossRevized decimal - -
TotalGrossMarginEstimate decimal - -
TotalGrossMarginRevized decimal - -
TotalNettProfitLossEstimate decimal - -
TotalNettProfitLossRevized decimal - -
TotalNettMarginEstimate decimal - -
TotalNettMarginRevized decimal - -

Contact

Documentation: https://developer.simprogroup.com/apidoc/?page=9aa698f602b1e5694855cee73a683488#tag/Contacts

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

ContactLog

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DateLogged datetime - -
Message string - -
ContactID int Contact → ID -
StaffID int Employee → ID -

Contractor

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 decimal - -
DisplayOrder int - -
DateModified datetime - -

ContractorInvoice

Documentation: https://developer.simprogroup.com/apidoc/?page=4a13b7d6ede54db66195b81af6c4b0d1#tag/Contractor-Invoices

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

ContractorJob

Documentation: https://developer.simprogroup.com/apidoc/?page=e2a18aeb5468c988d1400f8de506746b#tag/Contractor-Jobs

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

ContractorJobLog

Documentation: https://developer.simprogroup.com/apidoc/?page=b2d37ae1cedf42ff874289b721860af2#operation/d1cc2a852efa99956399576f3895f1ee

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DateLogged datetime - -
Message string - -
ContractorJobID int ContractorJob → ID -
StaffID int Employee → ID -

ContractorTimesheet

Documentation: https://developer.simprogroup.com/apidoc/?page=0f475af584faa19c9b62d780d7199320#tag/Contractor-Timesheets

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.
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContractorID int Contractor → ID -
ScheduleType string - -
Reference string - -
Date datetime - -
StartTime string - -
EndTime string - -
TotalHrs decimal - -
Cost decimal - -
JobID int Job → ID -
ActivityID int Activity → ID -
CostCenterID int CostCenter → ID -

CostCenter

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

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

CreditNote

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

IndividualCustomer

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

CompanyCustomer

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

CustomerAsset

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

InvoiceLog

Documentation: https://developer.simprogroup.com/apidoc/?page=b2d37ae1cedf42ff874289b721860af2#tag/Customer-Invoice-Logs

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DateLogged datetime - -
Message string - -
InvoiceID int Invoice → ID -
StaffID int Employee → ID -

CustomerLog

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DateLogged datetime - -
Message string - -
CustomerID int - -
StaffID int Employee → ID -

CustomerPayment

Documentation: https://developer.simprogroup.com/apidoc/?page=166bb94a7df2dd7995b3aca6254e02f0#operation/87058d78ae39e56f120e0116333ead43

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
PaymentMethodID int - -
DepositAccount string - -
Date datetime - -
FinanceCharge decimal - -
CheckNo string - -
Details string - -
Notes string - -
DateModified datetime - -

CustomerTag

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

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

CustomField

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

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

Employee

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

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 -
WhenUpsertedIntoDataStore datetime - -
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 -

Invoice

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
CustomerID int - -
StartDate datetime - -
EndDate datetime - -
IsFinalClaim boolean - -
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 - -
DateCreated datetime - -
ExTax decimal - -
Tax decimal - -
AmountApplied decimal - -
BalanceDue decimal - -
ReverseChargeTax decimal - -
IncTax decimal - -
AutoAdjustStatus boolean - -
Notes string - -
IsRetainage boolean - -
IsPaid boolean - -
DatePaid datetime - -
DateModified datetime - -

Job

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
DateModified datetime - -
Type string - -
IndividualCustomerID int IndividualCustomer → ID -
CompanyCustomerID int CompanyCustomer → ID -
CustomerContactID int Contact → ID -
SiteID int Site → ID -
IndividualCustomerContractID int IndividualCustomerContract → ID -
CompanyCustomerContractID int CompanyCustomerContract → ID -
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 -
Stage string - -
StatusID int - -
StatusName string - -
ResponseTimeID int - -
IsVariation boolean - -
ConvertedFromQuoteID int Quote → ID -
ConvertedFromRecurringJobID long CompanyRecurringJob → 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 - -

JobAttachmentFile

Documentation: https://developer.simprogroup.com/apidoc/?page=12ceff2290bb9039beaa8f36d5dec226#tag/Job-Attachments

Column Type Relates to Notes
RemoteID string - -
JobRemoteID string Job → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
DateAdded datetime - -
JobID int Job → ID -
Public boolean - -
Email boolean - -
MimeType string - -
FileSizeBytes long - -
FolderID long JobAttachmentFolder → ID -

JobAttachmentFolder

Documentation: https://developer.simprogroup.com/apidoc/?page=12ceff2290bb9039beaa8f36d5dec226#tag/Job-Attachments

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

JobCard

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

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterRemoteID string JobSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int -
  • 6 May 2024 We have observed that the IDs of deleted JobCards are re-used, meaning that they are not truly unique.
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 - -

JobLog

Documentation: https://developer.simprogroup.com/apidoc/?page=b2d37ae1cedf42ff874289b721860af2#tag/Job-Logs

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DateLogged datetime - -
Message string - -
JobID int Job → ID -
StaffID int Employee → ID -

JobSection

Column Type Relates to Notes
RemoteID string - -
JobRemoteID string Job → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -

JobSectionCostCenter

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

Column Type Relates to Notes
RemoteID string - -
JobSectionRemoteID string JobSection → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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
TotalMaterialsCostEstimate decimal - -
TotalMaterialsCostRevized decimal - -
TotalMaterialsCostActual decimal - -
TotalMaterialsCostCommitted decimal - -
TotalResourcesCostTotalActual decimal - -
TotalResourcesCostTotalEstimate decimal - -
TotalResourcesCostTotalRevized decimal - -
TotalResourcesCostLaborActual decimal - -
TotalResourcesCostLaborCommitted decimal - -
TotalResourcesCostLaborEstimate decimal - -
TotalResourcesCostLaborRevized decimal - -
TotalResourcesCostLaborHoursActual decimal - -
TotalResourcesCostLaborHoursCommitted decimal - -
TotalResourcesCostLaborHoursEstimate decimal - -
TotalResourcesCostLaborHoursRevized decimal - -
TotalResourcesCostPlantAndEquipmentActual decimal - -
TotalResourcesCostPlantAndEquipmentEstimate decimal - -
TotalResourcesCostPlantAndEquipmentRevized decimal - -
TotalResourcesCostPlantAndEquipmentHoursActual decimal - -
TotalResourcesCostPlantAndEquipmentHoursEstimate decimal - -
TotalResourcesCostPlantAndEquipmentHoursRevised decimal -
  • 17 May 2023 The API states that this should be depreciated and using 'Revised' like the others (with the exception of Commission) instead but in testing this is not the case and 'Revised' is still in use
TotalResourcesCostCommissionActual decimal - -
TotalResourcesCostCommissionEstimate decimal - -
TotalResourcesCostCommissionRevised decimal -
  • 17 May 2023 Confirmed in testing the API still uses this instead of 'Revized'
TotalResourcesCostOverheadActual decimal - -
TotalResourcesCostOverheadEstimate decimal - -
TotalResourcesCostOverheadRevized decimal - -
TotalMaterialsMarkupActual decimal - -
TotalMaterialsMarkupEstimate decimal - -
TotalMaterialsMarkupRevized decimal - -
TotalResourcesMarkupTotalActual decimal - -
TotalResourcesMarkupTotalEstimate decimal - -
TotalResourcesMarkupTotalRevized decimal - -
TotalResourcesMarkupLaborActual decimal - -
TotalResourcesMarkupLaborEstimate decimal - -
TotalResourcesMarkupLaborRevized decimal - -
TotalResourcesMarkupPlantAndEquipmentActual decimal - -
TotalResourcesMarkupPlantAndEquipmentEstimate decimal - -
TotalResourcesMarkupPlantAndEquipmentRevised decimal - -
TotalAdjustedActual decimal - -
TotalAdjustedEstimate decimal - -
TotalAdjustedRevized decimal - -
TotalGrossProfitLossActual decimal - -
TotalGrossProfitLossEstimate decimal - -
TotalGrossProfitLossRevized decimal - -
TotalGrossMarginEstimate decimal - -
TotalGrossMarginActual decimal - -
TotalGrossMarginRevized decimal - -
TotalNettProfitLossActual decimal - -
TotalNettProfitLossEstimate decimal - -
TotalNettProfitLossRevized decimal - -
TotalNettMarginActual decimal - -
TotalNettMarginEstimate decimal - -
TotalNettMarginRevized decimal - -
TotalMembershipDiscount decimal - -
TotalDiscount decimal - -
TotalSTCs decimal - -
TotalVEECs decimal - -

JobSectionCostCenterAsset

Documentation: https://developer.simprogroup.com/apidoc/?page=e20580fa653ea5969f97040b4eb3c8db#tag/Job-Cost-Center-Assets

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterRemoteID string JobSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
JobID int Job → ID -
JobSectionID int JobSection → ID -
JobSectionCostCenterID int JobSectionCostCenter → ID -
AssetID int CustomerAsset → ID -

JobSectionCostCenterCatalog

Documentation: https://developer.simprogroup.com/apidoc/?page=e20580fa653ea5969f97040b4eb3c8db#tag/Job-Cost-Center-Catalog-Items

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterRemoteID string JobSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
JobID int Job → ID -
JobSectionID int JobSection → ID -
JobSectionCostCenterID int JobSectionCostCenter → ID -
DateModified datetime - -
BillableItem boolean - -
BillableStatus string - -
EstimatedTime decimal - -
LaborCost decimal - -
BasePrice decimal - -
Markup decimal - -
DisplayOrder int - -
CatalogID int Catalog → ID -
FitTimeID int -
  • 15 May 2023 Foreign Key - Refers to `Fit Times` (not implemented).
FitTimeName string - -
FitTimeMultiplier decimal - -
SalesTaxCodeID int -
  • 15 May 2023 Foreign Key - Refers to `Tax Codes` (not implemented).
SalesTaxCodeCode string - -
SalesTaxCodeType string - -
SalesTaxCodeRate decimal - -
TotalPriceEx decimal - -
TotalPriceInc decimal - -
TotalEstimatedTime decimal - -
SellPriceExTax decimal - -
SellPriceIncTax decimal - -
TotalQty decimal - -
TotalAmountExTax decimal - -
TotalAmountIncTax decimal - -
ClaimedToDateQty decimal - -
ClaimedToDateAmountExTax decimal - -
ClaimedToDateAmountIncTax decimal - -
ClaimedRemainingQty decimal - -
ClaimedRemainingAmountExTax decimal - -
ClaimedRemainingAmountIncTax decimal - -
IncomeAccountID int -
  • 15 May 2023 Foreign Key - Refers to `Chart of Accounts` (not implemented).
IncomeAccountName string - -
IncomeAccountNumber string - -

JobSectionCostCenterContractorJob

Documentation: https://developer.simprogroup.com/apidoc/?page=e2a18aeb5468c988d1400f8de506746b#operation/6636a9b28a4604c1a0816222bd3cba33

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterRemoteID string JobSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
JobSectionID int JobSection → ID -
JobID int Job → ID -
JobSectionCostCenterID int JobSectionCostCenter → ID -
ContractorID int Contractor → ID -
TaxCodeID int - -
RetentionAmount decimal - -
RetentionPerClaim decimal - -
RetentionPeriodMonths decimal - -
TotalExTax decimal - -
TotalIncTax decimal - -
ProjectType string - -
Status string - -
DateIssued datetime - -
DueDate datetime - -
ContractorSupplyMaterials boolean - -
Materials decimal - -
Currency string - -
ExchangeRate decimal - -
Labor decimal - -
DateModified datetime - -

JobSectionCostCenterLabor

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

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterRemoteID string JobSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
LaborRateID int LaborRate → ID -
SellPriceExTax decimal - -
SellPriceIncTax decimal - -
TotalQuantity decimal - -
TotalExTax decimal - -
TotalIncTax decimal - -
ClaimedQuantityToDate decimal - -
ClaimedAmountToDateExTax decimal - -
ClaimedAmountToDateIncTax decimal - -
ClaimedQuantityRemaining decimal - -
ClaimedAmountRemainingExTax decimal - -
ClaimedAmountRemainingIncTax decimal - -
JobSectionID int JobSection → ID -
JobID int Job → ID -
JobSectionCostCenterID int JobSectionCostCenter → ID -

JobSectionCostCenterOneOff

Documentation: https://developer.simprogroup.com/apidoc/?page=e20580fa653ea5969f97040b4eb3c8db#tag/Job-Cost-Center-One-off-Items

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterRemoteID string JobSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
JobID int Job → ID -
JobSectionID int JobSection → ID -
JobSectionCostCenterID int JobSectionCostCenter → ID -
DateModified datetime - -
Type string - -
Billable boolean - -
BillableStatus string - -
InventoryItem int - -
EstimatedCost decimal - -
Markup decimal - -
LaborCost decimal - -
EstimatedTime decimal - -
ActualCost decimal - -
ActualCostDate datetime - -
DisplayOrder int - -
SalesTaxCodeID int -
  • 15 May 2023 Foreign Key - Refers to `Tax Codes` (not implemented).
SalesTaxCodeCode string - -
SalesTaxCodeType string - -
SalesTaxCodeRate decimal - -
SellPriceExTax decimal - -
SellPriceIncTax decimal - -
TotalQty decimal - -
TotalAmountExTax decimal - -
TotalAmountIncTax decimal - -
ClaimedToDateQty decimal - -
ClaimedToDateAmountExTax decimal - -
ClaimedToDateAmountIncTax decimal - -
ClaimedRemainingQty decimal - -
ClaimedRemainingAmountExTax decimal - -
ClaimedRemainingAmountIncTax decimal - -
IncomeAccountID int -
  • 15 May 2023 Foreign Key - Refers to `Chart of Accounts` (not implemented).
IncomeAccountName string - -
IncomeAccountNumber string - -

JobSectionCostCenterPrebuild

Documentation: https://developer.simprogroup.com/apidoc/?page=e20580fa653ea5969f97040b4eb3c8db#tag/Job-Cost-Center-Prebuild-Items

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterRemoteID string JobSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
JobID int Job → ID -
JobSectionID int JobSection → ID -
JobSectionCostCenterID int JobSectionCostCenter → ID -
DateModified datetime - -
BillableItem boolean - -
BillableStatus string - -
EstimatedTime decimal - -
BasePrice decimal - -
Markup decimal - -
LaborCost decimal - -
DisplayOrder int - -
PrebuildID int -
  • 15 May 2023 Foreign Key - Refers to either 'Standard Price Prebuild' or 'Set Price Prebuild', unable to determine from API call alone
PrebuildPartNo string - -
PrebuildName string - -
FitTimeID int -
  • 15 May 2023 Foreign Key - Refers to `Fit Times` (not implemented).
FitTimeName string - -
FitTimeMultiplier decimal - -
SalesTaxCodeID int -
  • 15 May 2023 Foreign Key - Refers to `Tax Codes` (not implemented).
SalesTaxCodeCode string - -
SalesTaxCodeType string - -
SalesTaxCodeRate decimal - -
TotalPriceEx decimal - -
TotalPriceInc decimal - -
TotalEstimatedTime decimal - -
SellPriceExTax decimal - -
SellPriceIncTax decimal - -
TotalQty decimal - -
TotalAmountExTax decimal - -
TotalAmountIncTax decimal - -
ClaimedToDateQty decimal - -
ClaimedToDateAmountExTax decimal - -
ClaimedToDateAmountIncTax decimal - -
ClaimedRemainingQty decimal - -
ClaimedRemainingAmountExTax decimal - -
ClaimedRemainingAmountIncTax decimal - -
IncomeAccountID int -
  • 15 May 2023 Foreign Key - Refers to `Chart of Accounts` (not implemented).
IncomeAccountName string - -
IncomeAccountNumber string - -

JobSectionCostCenterServiceFee

Documentation: https://developer.simprogroup.com/apidoc/?page=e20580fa653ea5969f97040b4eb3c8db#tag/Job-Cost-Center-Service-Fees

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterRemoteID string JobSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
JobID int Job → ID -
JobSectionID int JobSection → ID -
JobSectionCostCenterID int JobSectionCostCenter → ID -
DateModified datetime - -
BillableItem boolean - -
BillableStatus string - -
BasePrice decimal - -
Markup decimal - -
LaborCost decimal - -
DisplayOrder int - -
ServiceFeeID int -
  • 16 May 2023 Foreign Key - Refers to `Service Fees` (not implemented).
ServiceFeeName string - -
FitTimeID int -
  • 15 May 2023 Foreign Key - Refers to `Fit Times` (not implemented).
FitTimeName string - -
FitTimeMultiplier decimal - -
SalesTaxCodeID int -
  • 15 May 2023 Foreign Key - Refers to `Tax Codes` (not implemented).
SalesTaxCodeCode string - -
SalesTaxCodeType string - -
SalesTaxCodeRate decimal - -
TotalPriceEx decimal - -
TotalPriceInc decimal - -
TotalEstimatedTime decimal - -
SellPriceExTax decimal - -
SellPriceIncTax decimal - -
TotalQty decimal - -
TotalAmountExTax decimal - -
TotalAmountIncTax decimal - -
ClaimedToDateQty decimal - -
ClaimedToDateAmountExTax decimal - -
ClaimedToDateAmountIncTax decimal - -
ClaimedRemainingQty decimal - -
ClaimedRemainingAmountExTax decimal - -
ClaimedRemainingAmountIncTax decimal - -
IncomeAccountID int -
  • 15 May 2023 Foreign Key - Refers to `Chart of Accounts` (not implemented).
IncomeAccountName string - -
IncomeAccountNumber string - -

JobSectionCostCenterStock

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

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterRemoteID string JobSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -

LaborRate

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

Lead

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 -
StatusID int - -
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 - -

MobileStatusLog

Documentation: https://developer.simprogroup.com/apidoc/?page=b2d37ae1cedf42ff874289b721860af2#tag/Mobile-Status-Logs

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DateLogged datetime - -
Latitude decimal - -
Longitude decimal - -
StaffID int Employee → ID -
WorkOrderID int -
  • 19 May 2023 Foreign Key - Refers to `Job Section Cost Center Workorders` (not implemented).
StatusID int - -

PlantAndEquipment

Documentation: https://developer.simprogroup.com/apidoc/?page=7356d7d84d7b589fc626e1ef374440c2#tag/Plant-And-Equipment

Column Type Relates to Notes
RemoteID string - -
PlantTypeRemoteID string PlantType → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
PlantTypeID int PlantType → ID -
EnableServicing boolean - -
Billable boolean - -
Archived boolean - -
ServiceFeeID int -
  • 24 Oct 2023 Foreign Key - Refers to 'ServiceFees' (not implemented)
CheckedOutByID int - -
CheckedOutByType string - -
CheckedOutByEmployeeID int Employee → ID -
CheckedOutByContractorID int Contractor → ID -
ServicingFrequency int - -
ServicingFrequencyType string - -
ServicingStartDate datetime - -
ServicingNextServiceDate datetime - -
ServicingNextServiceHours decimal - -
BillingCostRate string - -
BillingOverheadRate string - -
BillingSellRate decimal - -
BillingTaxCodeID decimal -
  • 24 Oct 2023 Foreign Key - Refers to `Tax Codes` (not implemented).

PlantType

Documentation: https://developer.simprogroup.com/apidoc/?page=7356d7d84d7b589fc626e1ef374440c2#tag/Plant-Types

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Frequency string - -
Qty decimal - -
Archived boolean - -

PreBuildGroup

Documentation: https://developer.simprogroup.com/apidoc/?page=128c7259ed396d9691286cc1ddcbc541#tag/Prebuild-Groups

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
ParentGroupID int PreBuildGroup → ID -
DisplayOrder int - -
DateCreated datetime - -
IsThirdPartyGroup boolean - -
Archived boolean - -

ProjectTag

Documentation: https://developer.simprogroup.com/apidoc/?page=189f63f277cd73395561651753563065#operation/8394c2de9db06eacd4bdaea43eb0779b

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

PurchaseOrder

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Type string - -
StorageDeviceID int StorageDevice → ID -
AssignedToID int JobSectionCostCenter → ID -
AssignedToCostCenterID int CostCenter → ID -
AssignedToName string - -
AssignedToJob int - -
AssignedToSection int - -
Stage string - -
StatusID int PurchaseOrderStatusCode → ID -
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 - -

PurchaseOrderItem

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderRemoteID string PurchaseOrder → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PurchaseOrderID int PurchaseOrder → ID -
CatalogID int Catalog → ID -
Price decimal - -
DisplayOrder decimal - -

PurchaseOrderLog

Documentation: https://developer.simprogroup.com/apidoc/?page=b2d37ae1cedf42ff874289b721860af2#tag/Vendor-Order-Logs

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DateLogged datetime - -
Message string - -
StaffID int Employee → ID -
VendorOrderID int PurchaseOrder → ID -
CatalogID int Catalog → ID -
Type string - -

PurchaseOrderReceipt

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderRemoteID string PurchaseOrder → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 - -

PurchaseOrderReceiptCatalog

Documentation: https://developer.simprogroup.com/apidoc/?page=a8231ece0d8c47b8bf1875242406c189#tag/Vendor-Receipt-Items

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderReceiptRemoteID string PurchaseOrderReceipt → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int Catalog → ID -
PurchaseOrderID int PurchaseOrder → ID -
PurchaseOrderReceiptID int PurchaseOrderReceipt → ID -
Qty decimal - -
UnitPriceExTax decimal - -
UnitPriceIncTax decimal - -
TotalExTax decimal - -
TotalIncTax decimal - -

PurchaseOrderReceiptCredit

Documentation: https://developer.simprogroup.com/apidoc/?page=69cae2bceec138665128e23a470a6e5e#tag/Vendor-Receipt-Credits

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderReceiptRemoteID string PurchaseOrderReceipt → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
PurchaseOrderID int PurchaseOrder → ID -
PurchaseOrderReceiptID int PurchaseOrderReceipt → ID -
Type string - -
VendorCreditNo string - -
DateIssued datetime - -
DateCreated datetime - -
DateModified datetime - -
Notes string - -
Currency string - -
ExchangeRate decimal - -
TaxRounding decimal - -
AccountingCategoryID int -
  • 29 Jun 2023 Foreign Key: Refers to `AccountingCategory` (not implemented).
FreightExTax decimal - -
FreightIncTax decimal - -
FreightTaxCodeID int -
  • 29 Jun 2023 Foreign Key: Refers to `TaxCode` (not implemented).
RestockingFeeExTax decimal - -
RestockingFeeIncTax decimal - -
RestockingFeeTaxCodeID int -
  • 29 Jun 2023 Foreign Key: Refers to `TaxCode` (not implemented).
TotalExTax decimal - -
TotalIncTax decimal - -

Quote

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
IndividualCustomerID int IndividualCustomer → ID -
CompanyCustomerID int CompanyCustomer → ID -
ArchiveReasonDescription string - -
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 - -

QuoteAttachmentFile

Column Type Relates to Notes
RemoteID string - -
QuoteRemoteID string Quote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
DateAdded datetime - -
QuoteID int Quote → ID -
Public boolean - -
Email boolean - -
MimeType string - -
FileSizeBytes long - -
FolderID long QuoteAttachmentFolder → ID -

QuoteAttachmentFolder

Column Type Relates to Notes
RemoteID string - -
QuoteRemoteID string Quote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
QuoteID int Quote → ID -
ParentFolderID long QuoteAttachmentFolder → ID -

QuoteLog

Documentation: https://developer.simprogroup.com/apidoc/?page=b2d37ae1cedf42ff874289b721860af2#tag/Quote-Logs

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DateLogged datetime - -
Message string - -
QuoteID int Quote → ID -
StaffID int Employee → ID -

QuoteSection

Column Type Relates to Notes
RemoteID string - -
QuoteRemoteID string Quote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
QuoteID int Quote → ID -
DisplayOrder int - -

QuoteSectionCostCenter

Documentation: https://developer.simprogroup.com/apidoc/?page=fb78ee4e3878df89f4c9876b104c8798#operation/7d452e9556e404b0b15ebb63cef18543

Column Type Relates to Notes
RemoteID string - -
QuoteSectionRemoteID string QuoteSection → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
CostCenterID int CostCenter → ID -
QuoteID int Quote → ID -
QuoteSectionID int QuoteSection → ID -
Header string - -
Stage string - -
Notes string - -
OrderNo string - -
SiteID int Site → ID -
StartDate datetime - -
EndDate datetime - -
DateModified datetime - -
AutoAdjustDates boolean - -
Variation boolean - -
OptionalDepartment boolean - -
Billable boolean - -
ItemsLocked boolean - -
DisplayOrder int - -
TotalExTax decimal - -
TotalTax decimal - -
TotalIncTax decimal - -
TotalTaxCodeID int - -
MaterialsCostEstimate decimal - -
MaterialsCostRevised decimal - -
ResourcesCostTotalEstimate decimal - -
ResourcesCostTotalRevised decimal - -
ResourcesCostLaborEstimate decimal - -
ResourcesCostLaborRevised decimal - -
ResourcesCostLaborHoursEstimate decimal - -
ResourcesCostLaborHoursRevised decimal - -
ResourcesCostOverheadEstimate decimal - -
ResourcesCostOverheadRevised decimal - -
ResourcesCostOverheadHoursEstimate decimal - -
ResourcesCostOverheadHoursRevised decimal - -
ResourcesCostCommissionEstimate decimal - -
ResourcesCostCommissionRevised decimal - -
MaterialsMarkupEstimate decimal - -
MaterialsMarkupRevised decimal - -
ResourcesMarkupOverheadEstimate decimal - -
ResourcesMarkupOverheadRevised decimal - -
ResourcesMarkupTotalEstimate decimal - -
ResourcesMarkupTotalRevised decimal - -
ResourcesMarkupLaborEstimate decimal - -
ResourcesMarkupLaborRevised decimal - -
AdjustedEstimate decimal - -
AdjustedRevised decimal - -
MembershipDiscount decimal - -
Discount decimal - -
STCs decimal - -
VEECs decimal - -
GrossProfitLossEstimate decimal - -
GrossProfitLossRevised decimal - -
GrossMarginEstimate decimal - -
GrossMarginRevised decimal - -
NettProfitLossEstimate decimal - -
NettProfitLossRevised decimal - -
NettMarginEstimate decimal - -
NettMarginRevised decimal - -

QuoteSectionCostCenterAsset

Documentation: https://developer.simprogroup.com/apidoc/?page=fb78ee4e3878df89f4c9876b104c8798#tag/Quote-Cost-Center-Assets

Column Type Relates to Notes
RemoteID string - -
QuoteSectionCostCenterRemoteID string QuoteSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
QuoteID int Quote → ID -
QuoteSectionID int QuoteSection → ID -
QuoteSectionCostCenterID int QuoteSectionCostCenter → ID -
AssetID int CustomerAsset → ID -

QuoteSectionCostCenterCatalog

Documentation: https://developer.simprogroup.com/apidoc/?page=fb78ee4e3878df89f4c9876b104c8798#operation/d9e1a48b6ec15c49618bc6aa2f5d12b5

Column Type Relates to Notes
RemoteID string - -
QuoteSectionCostCenterRemoteID string QuoteSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
QuoteID int Quote → ID -
QuoteSectionID int QuoteSection → ID -
QuoteSectionCostCenterID int QuoteSectionCostCenter → ID -
DateModified datetime - -
BillableItem boolean - -
BillableStatus string - -
EstimatedTime decimal - -
LaborCost decimal - -
BasePrice decimal - -
Markup decimal - -
DisplayOrder int - -
CatalogID int Catalog → ID -
FitTimeID int -
  • 15 May 2023 Foreign Key - Refers to `Fit Times` (not implemented).
SalesTaxCodeID int -
  • 15 May 2023 Foreign Key - Refers to `Tax Codes` (not implemented).
TotalPriceEx decimal - -
TotalEstimatedTime decimal - -
TotalPriceInc decimal - -
SellPriceExTax decimal - -
SellPriceIncTax decimal - -
TotalQty decimal - -
TotalAmountExTax decimal - -
TotalAmountIncTax decimal - -
IncomeAccountID int -
  • 15 May 2023 Foreign Key - Refers to `Chart of Accounts` (not implemented).

QuoteSectionCostCenterContractorJob

Documentation: https://developer.simprogroup.com/apidoc/?page=e2a18aeb5468c988d1400f8de506746b#tag/Quote-Contractor-Jobs

Column Type Relates to Notes
RemoteID string - -
QuoteSectionCostCenterRemoteID string QuoteSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int ContractorJob → ID -
QuoteID int Quote → ID -
QuoteSectionID int QuoteSection → ID -
QuoteSectionCostCenterID int QuoteSectionCostCenter → ID -

QuoteSectionCostCenterLabour

Documentation: https://developer.simprogroup.com/apidoc/?page=fb78ee4e3878df89f4c9876b104c8798#tag/Quote-Cost-Center-Labor-Items

Column Type Relates to Notes
RemoteID string - -
QuoteSectionCostCenterRemoteID string QuoteSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
QuoteID int Quote → ID -
QuoteSectionID int QuoteSection → ID -
QuoteSectionCostCenterID int QuoteSectionCostCenter → ID -
DateModified datetime - -
LaborRate decimal - -
LaborMarkup decimal - -
Ticked boolean - -
LabourTypeID int -
  • 15 May 2023 Foreign Key - Refers to `Labor Rates` (not implemented).
LabourTypeName string - -
SalesTaxCodeID int -
  • 15 May 2023 Foreign Key - Refers to `Tax Codes` (not implemented).
SalesTaxCodeCode string - -
SalesTaxCodeType string - -
SalesTaxCodeRate decimal - -
SellPriceExTax decimal - -
SellPriceIncTax decimal - -
TotalQty decimal - -
TotalAmountExTax decimal - -
TotalAmountIncTax decimal - -
IncomeAccountID int -
  • 15 May 2023 Foreign Key - Refers to `Chart of Accounts` (not implemented).
IncomeAccountName string - -
IncomeAccountNumber string - -

QuoteSectionCostCenterOneOff

Documentation: https://developer.simprogroup.com/apidoc/?page=fb78ee4e3878df89f4c9876b104c8798#tag/Quote-Cost-Center-One-off-Items

Column Type Relates to Notes
RemoteID string - -
QuoteSectionCostCenterRemoteID string QuoteSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
QuoteID int Quote → ID -
QuoteSectionID int QuoteSection → ID -
QuoteSectionCostCenterID int QuoteSectionCostCenter → ID -
DateModified datetime - -
Type string - -
Billable boolean - -
BillableStatus string - -
InventoryItem int - -
EstimatedCost decimal - -
Markup decimal - -
LaborCost decimal - -
EstimatedTime decimal - -
ActualCost decimal - -
ActualCostDate datetime - -
DisplayOrder int - -
SalesTaxCodeID int -
  • 15 May 2023 Foreign Key - Refers to `Tax Codes` (not implemented).
SalesTaxCodeCode string - -
SalesTaxCodeType string - -
SalesTaxCodeRate decimal - -
SellPriceExTax decimal - -
SellPriceIncTax decimal - -
TotalQty decimal - -
TotalAmountExTax decimal - -
TotalAmountIncTax decimal - -
IncomeAccountID int -
  • 15 May 2023 Foreign Key - Refers to `Chart of Accounts` (not implemented).
IncomeAccountName string - -
IncomeAccountNumber string - -

QuoteSectionCostCenterPrebuild

Documentation: https://developer.simprogroup.com/apidoc/?page=fb78ee4e3878df89f4c9876b104c8798#tag/Quote-Cost-Center-Prebuild-Items

Column Type Relates to Notes
RemoteID string - -
QuoteSectionCostCenterRemoteID string QuoteSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
QuoteID int Quote → ID -
QuoteSectionID int QuoteSection → ID -
QuoteSectionCostCenterID int QuoteSectionCostCenter → ID -
DateModified datetime - -
BillableItem boolean - -
BillableStatus string - -
EstimatedTime decimal - -
BasePrice decimal - -
Markup decimal - -
LaborCost decimal - -
DisplayOrder int - -
PrebuildID int -
  • 15 May 2023 Foreign Key - Refers to either 'Standard Price Prebuild' or 'Set Price Prebuild', unable to determine from API call alone
PrebuildPartNo string -
  • 22 Nov 2024 I changed this to type string because we saw a similar requirement in JobSectionCostCenterPreBuild.PrebuildPartNo
PrebuildName string - -
FitTimeID int -
  • 15 May 2023 Foreign Key - Refers to `Fit Times` (not implemented).
FitTimeName string - -
FitTimeMultiplier decimal - -
SalesTaxCodeID int -
  • 15 May 2023 Foreign Key - Refers to `Tax Codes` (not implemented).
SalesTaxCodeCode string - -
SalesTaxCodeType string - -
SalesTaxCodeRate decimal - -
TotalPriceEx decimal - -
TotalPriceInc decimal - -
TotalEstimatedTime decimal - -
SellPriceExTax decimal - -
SellPriceIncTax decimal - -
TotalQty decimal - -
TotalAmountExTax decimal - -
TotalAmountIncTax decimal - -
IncomeAccountID int -
  • 15 May 2023 Foreign Key - Refers to `Chart of Accounts` (not implemented).
IncomeAccountName string - -
IncomeAccountNumber string - -

QuoteSectionCostCenterServiceFee

Documentation: https://developer.simprogroup.com/apidoc/?page=fb78ee4e3878df89f4c9876b104c8798#tag/Quote-Cost-Center-Service-Fees

Column Type Relates to Notes
RemoteID string - -
QuoteSectionCostCenterRemoteID string QuoteSectionCostCenter → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
QuoteID int Quote → ID -
QuoteSectionID int QuoteSection → ID -
QuoteSectionCostCenterID int QuoteSectionCostCenter → ID -
DateModified datetime - -
BillableItem boolean - -
BillableStatus string - -
BasePrice decimal - -
Markup decimal - -
LaborCost decimal - -
DisplayOrder int - -
ServiceFeeID int -
  • 16 May 2023 Foreign Key - Refers to `Service Fees` (not implemented).
ServiceFeeName string - -
FitTimeID int -
  • 15 May 2023 Foreign Key - Refers to `Fit Times` (not implemented).
FitTimeName string - -
FitTimeMultiplier decimal - -
SalesTaxCodeID int -
  • 15 May 2023 Foreign Key - Refers to `Tax Codes` (not implemented).
SalesTaxCodeCode string - -
SalesTaxCodeType string - -
SalesTaxCodeRate decimal - -
TotalPriceEx decimal - -
TotalPriceInc decimal - -
TotalEstimatedTime decimal - -
SellPriceExTax decimal - -
SellPriceIncTax decimal - -
TotalQty decimal - -
TotalAmountExTax decimal - -
TotalAmountIncTax decimal - -
IncomeAccountID int -
  • 15 May 2023 Foreign Key - Refers to `Chart of Accounts` (not implemented).
IncomeAccountName string - -
IncomeAccountNumber string - -

RecurringInvoice

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
DateModified datetime - -
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 - -

RecurringInvoiceLog

Documentation: https://developer.simprogroup.com/apidoc/?page=b2d37ae1cedf42ff874289b721860af2#tag/Recurring-Invoice-Logs

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DateLogged datetime - -
Message string - -
StaffID int Employee → ID -
RecurringInvoiceID int RecurringInvoice → ID -

ResponseTime

Documentation: https://developer.simprogroup.com/apidoc/?page=f1771907f4365e2f876df28d5a471371#tag/Response-Times

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Archived boolean - -
Days int - -
Hours int - -
Minutes int - -

Schedule

Documentation: https://developer.simprogroup.com/apidoc/?page=ccdb7bf9d93e5652b57cabcc8c41e061#tag/Schedules

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

ScheduleLog

Documentation: https://developer.simprogroup.com/apidoc/?page=b2d37ae1cedf42ff874289b721860af2#tag/Schedule-Logs

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
DateLogged datetime - -
Message string - -
Type string - -
ScheduleID int Schedule → ID -
StaffID int Employee → ID -
ScheduleEmployeeID int Employee → ID -

ScheduleRate

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

SetPricePreBuild

Documentation: https://developer.simprogroup.com/apidoc/?page=128c7259ed396d9691286cc1ddcbc541#operation/487377fc49c02a88ccd268e1b20a8f0b

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
GroupID int PreBuildGroup → ID -
SalesTaxCodeID int - -
AddOnPriceExTax decimal - -
AddOnPriceTax decimal - -
AddOnPriceIncTax decimal - -
IsFavorite boolean - -
PartNo string - -
Notes string - -
LaborTime decimal - -
LaborTimeBasedOnBuild decimal - -
TotalEx decimal - -
AddOnEnabled boolean - -
DisplayOrder int - -
Archived boolean - -
STCsEnabled boolean - -
DateModified datetime - -

Site

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
DateModified datetime - -
Archived boolean - -
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 - -
STCZone int - -
VEECZone string - -
SiteZoneID int - -

StandardPricePreBuild

Documentation: https://developer.simprogroup.com/apidoc/?page=128c7259ed396d9691286cc1ddcbc541#operation/9ebc4024dd58ea034bfc45def3ee79e5

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
Description string - -
GroupID int PreBuildGroup → ID -
SalesTaxCodeID int - -
AddOnPriceExTax decimal - -
AddOnPriceTax decimal - -
AddOnPriceIncTax decimal - -
IsFavorite boolean - -
PartNo string - -
Notes string - -
LaborTime decimal - -
LaborTimeBasedOnBuild decimal - -
TotalEx decimal - -
AddOnEnabled boolean - -
DisplayOrder int - -
Archived boolean - -
STCsEnabled boolean - -
DateModified datetime - -

CustomerInvoiceStatusCode

Documentation: https://developer.simprogroup.com/apidoc/?page=8a6a14b567ca5591a91d9a164088812b#tag/Customer-Invoice-Status-Codes

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

ProjectStatusCode

Documentation: https://developer.simprogroup.com/apidoc/?page=8a6a14b567ca5591a91d9a164088812b#tag/Project-Status-Codes

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

PurchaseOrderStatusCode

Documentation: https://developer.simprogroup.com/apidoc/?page=8a6a14b567ca5591a91d9a164088812b#tag/Vendor-Order-Status-Codes

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

StorageDevice

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

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

Task

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

Timesheet

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

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.
WhenUpsertedIntoDataStore datetime - -
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 -
ActivityID int Activity → ID -
CostCenterID int CostCenter → ID -

Vendor

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

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

AssetServiceDate

Documentation: https://developer.simprogroup.com/apidoc/?page=dd530f67a3c5c4f3768841df8f40fb0f#tag/Service-Levels

Column Type Relates to Notes
RemoteID string - -
AssetRemoteID string Asset → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AssetID int Asset → ID -
ServiceLevelID int AssetServiceLevel → ID -
ServiceDate datetime - -

AssetTestResult

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

Column Type Relates to Notes
RemoteID string - -
AssetRemoteID string Asset → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AssetID int Asset → ID -
CustomFieldID int AssetTypeCustomField → ID
  • 22 Nov 2024
Value string - -

CatalogCustomField

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

LinkedCatalog

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

CatalogVendor

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

CompanyRecurringJobAdditionalContact

Column Type Relates to Notes
RemoteID string - -
CompanyRecurringJobRemoteID string CompanyRecurringJob → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyRecurringJobID long CompanyRecurringJob → ID -
ContactID int Contact → ID -

CompanyRecurringJobTechnician

Column Type Relates to Notes
RemoteID string - -
CompanyRecurringJobRemoteID string CompanyRecurringJob → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyRecurringJobID long CompanyRecurringJob → ID -
EmployeeID int Employee → ID -

CompanyRecurringJobTag

Column Type Relates to Notes
RemoteID string - -
CompanyRecurringJobRemoteID string CompanyRecurringJob → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyRecurringJobID long CompanyRecurringJob → ID -
ProjectTagID long ProjectTag → ID -

CompanyRecurringJobCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
CompanyRecurringJobRemoteID string CompanyRecurringJob → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CompanyRecurringJobID long CompanyRecurringJob → ID -
CustomFieldID int CustomField → ID -
Value string - -

ContactCustomField

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

ContractorCustomField

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

ContractorInvoiceContractorJob

Column Type Relates to Notes
RemoteID string - -
ContractorInvoiceRemoteID string ContractorInvoice → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 decimal - -
BusinessGroupID int - -
BusinessGroupName string - -

ContractorInvoiceRetention

Column Type Relates to Notes
RemoteID string - -
ContractorInvoiceRemoteID string ContractorInvoice → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 - -

ContractorJobCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
ContractorJobRemoteID string ContractorJob → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ContractorJobID int ContractorJob → ID -
CustomFieldID int CustomField → ID -
Value string - -

CreditNoteCustomField

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

CreditNoteJob

Column Type Relates to Notes
RemoteID string - -
CreditNoteRemoteID string CreditNote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
CreditNoteID int CreditNote → ID -
CostCenterID int CostCenter → ID -
ClaimExTax decimal - -
ClaimIncTax decimal - -
TotalExTax decimal - -
TotalIncTax decimal - -

IndividualCustomerPreferredTech

Column Type Relates to Notes
RemoteID string - -
IndividualCustomerRemoteID string IndividualCustomer → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 - -
PricingTierID int - -
PricingTierName string - -
PricingTierDefaultMarkup decimal - -
Markup decimal - -
RateServiceFeeID int - -
RateServiceFeeName string - -

IndividualCustomerCustomFiled

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

IndividualCustomerTag

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

CompanyCustomerContact

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

CompanyCustomerPreferredTech

Column Type Relates to Notes
RemoteID string - -
CompanyCustomerRemoteID string CompanyCustomer → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 - -
PricingTierID int - -
PricingTierName string - -
PricingTierDefaultMarkup decimal - -
Markup decimal - -
RateServiceFeeID int - -
RateServiceFeeName string - -

CompanyCustomerCustomFiled

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

CompanyCustomerTag

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

CustomerAssetCustomField

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

CustomerPaymentInvoice

Column Type Relates to Notes
RemoteID string - -
CustomerPaymentRemoteID string CustomerPayment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
InvoiceID int Invoice → ID -
CustomerPaymentID int CustomerPayment → ID -
Amount decimal - -

EmployeeAssignedCostCenter

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
EmployeeID int Employee → ID -
CustomFieldID int CustomField → ID -
Value string - -

InvoiceCustomField

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

InvoiceJob

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

InvoiceItem

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

InvoiceCostCenter

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

InvoiceRetainage

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

JobCustomField

Column Type Relates to Notes
RemoteID string - -
JobRemoteID string Job → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Description string - -
TotalExTax decimal - -
TotalTax decimal - -
TotalIncTax decimal - -
JobID int Job → ID -

JobCardAsset

Column Type Relates to Notes
RemoteID string - -
JobCardRemoteID string JobCard → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AssetID int - -
JobCardID int -
  • 6 May 2024 We have observed that the IDs of deleted JobCards are re-used, meaning that they are not truly unique. We recommend using the JobCardRemoteID reference instead
Result string -
  • 10 May 2021 For example, 'Pass'

JobCardBlock

Column Type Relates to Notes
RemoteID string - -
JobCardRemoteID string JobCard → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
BlockNumber int - -
JobCardID int -
  • 6 May 2024 We have observed that the IDs of deleted JobCards are re-used, meaning that they are not truly unique. We recommend using the JobCardRemoteID reference instead
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 - -

JobCardCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
JobCardRemoteID string JobCard → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
JobCardID int JobCard → ID -
CustomFieldID int CustomField → ID -
Value string - -

JobSectionCostCenterContractorJobCatalog

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterContractorJobRemoteID string JobSectionCostCenterContractorJob → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CatalogID int Catalog → ID -
PriceLabor decimal - -
PriceMaterial decimal - -
QtyAssigned decimal - -
QtyRemaining decimal - -

JobSectionCostCenterContractorJobPreBuild

Column Type Relates to Notes
RemoteID string - -
JobSectionCostCenterContractorJobRemoteID string JobSectionCostCenterContractorJob → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
PreBuildID int - -
PriceLabor decimal - -
PriceMaterial decimal - -
QtyAssigned decimal - -
QtyRemaining decimal - -

JobSectionCostCenterStockStorage

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

LeadTag

Column Type Relates to Notes
RemoteID string - -
LeadRemoteID string Lead → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
LeadID int Lead → ID -

LeadAdditionalCustomer

Column Type Relates to Notes
RemoteID string - -
LeadRemoteID string Lead → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
LeadID int Lead → ID -
IndividualCustomerID int IndividualCustomer → ID -
CompanyCustomerID int CompanyCustomer → ID -

LeadAdditionalContact

Column Type Relates to Notes
RemoteID string - -
LeadRemoteID string Lead → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int Contact → ID -
LeadID int Lead → ID -

LeadCustomField

Column Type Relates to Notes
RemoteID string - -
LeadRemoteID string Lead → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int CustomField → ID -
LeadID int Lead → ID -
Value string - -

PlantAndEquipmentCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
PlantAndEquipmentRemoteID string PlantAndEquipment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomFieldID int PlantTypeCustomField → ID -
Value string - -

PlantAndEquipmentJob

Column Type Relates to Notes
RemoteID string - -
PlantAndEquipmentRemoteID string PlantAndEquipment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
JobNo int Job → ID -
CustomerID int -
  • 24 Oct 2023 Foreign Key - Refers to either IndividualCustomer or CompanyCustomer
SiteID int Site → ID -
StartDate datetime - -
EndDate datetime - -
Total decimal - -

PlantTypeCustomField

Column Type Relates to Notes
RemoteID string - -
PlantTypeRemoteID string PlantType → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
PlantTypeID int PlantType → ID -
Type string - -
Order int - -
Archived boolean - -
Locked boolean - -

PurchaseOrderCustomField

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

PurchaseOrderItemAllocation

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderItemRemoteID string PurchaseOrderItem → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Notes string - -
DueDate datetime - -
StorageDeviceID int StorageDevice → ID -
Total decimal - -
QuantityReceived decimal - -
QuantityTotal decimal - -
CostCenterID int CostCenter → ID -

PurchaseOrderReceiptCatalogAllocation

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderReceiptCatalogRemoteID string PurchaseOrderReceiptCatalog → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
LineNumber int - -
Quantity decimal - -
StorageDeviceID int StorageDevice → ID -
AssignedToJobSectionCostCenterID int JobSectionCostCenter → ID
  • 16 May 2024 Reminder that these do actually have their own separate ID which is the ID of the relationship between JobSection and CostCenter
ExpenseCostCenterID int CostCenter → ID
  • 16 May 2024 After scouring through live data I have discovered that this and the above AssignedToCostCenterID can indeed be different (although rarely) so I'm including both

PurchaseOrderReceiptCreditItem

Column Type Relates to Notes
RemoteID string - -
PurchaseOrderReceiptCreditRemoteID string PurchaseOrderReceiptCredit → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CatalogID int Catalog → ID -
Received string - -
UnitPrice decimal - -
CreditAmount decimal - -
Total decimal - -

QuoteCustomField

Column Type Relates to Notes
RemoteID string - -
QuoteRemoteID string Quote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
QuoteID int Quote → ID -
CustomFieldID int CustomField → ID -
Value string - -

QuoteTechnician

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

QuoteAdditionalContact

Column Type Relates to Notes
RemoteID string - -
QuoteRemoteID string Quote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int Contact → ID -
QuoteID int Quote → ID -

QuoteAdditionalCustomer

Column Type Relates to Notes
RemoteID string - -
QuoteRemoteID string Quote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
QuoteID int Quote → ID -
IndividualCustomerID int IndividualCustomer → ID -
CompanyCustomerID int CompanyCustomer → ID -

QuoteTag

Column Type Relates to Notes
RemoteID string - -
QuoteRemoteID string Quote → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
QuoteID int Quote → ID -

QuoteSectionCostCenterContractorJobCatalog

Column Type Relates to Notes
RemoteID string - -
QuoteSectionCostCenterContractorJobRemoteID string QuoteSectionCostCenterContractorJob → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
ContractorJobID int QuoteSectionCostCenterContractorJob → ID -
CatalogID int Catalog → ID -
LaborPrice decimal - -
MaterialPrice decimal - -
QuantityAssigned decimal - -
QuantityRemaining decimal - -

QuoteSectionCostCenterContractorJobPrebuild

Column Type Relates to Notes
RemoteID string - -
QuoteSectionCostCenterContractorJobRemoteID string QuoteSectionCostCenterContractorJob → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
ContractorJobID int QuoteSectionCostCenterContractorJob → ID -
PrebuildID int - -
LaborPrice decimal - -
MaterialPrice decimal - -
QuantityAssigned decimal - -
QuantityRemaining decimal - -

QuoteSectionCostCenterContractorJobAttachmentFile

Column Type Relates to Notes
RemoteID string - -
QuoteSectionCostCenterContractorJobRemoteID string QuoteSectionCostCenterContractorJob → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
QuoteSectionCostCenterContractorJobID int QuoteSectionCostCenterContractorJob → ID -
DateAdded datetime - -
Filename string - -
MimeType string - -
FileSizeBytes long - -
FolderID long QuoteSectionCostCenterContractorJobAttachmentFolder → ID -

QuoteSectionCostCenterContractorJobAttachmentFolder

Column Type Relates to Notes
RemoteID string - -
QuoteSectionCostCenterContractorJobRemoteID string QuoteSectionCostCenterContractorJob → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
QuoteSectionCostCenterContractorJobID int QuoteSectionCostCenterContractorJob → ID -
ParentID long QuoteSectionCostCenterContractorJobAttachmentFolder → ID -

ScheduleBlock

Column Type Relates to Notes
RemoteID string - -
ScheduleRemoteID string Schedule → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -

SetPricePreBuildCatalog

Column Type Relates to Notes
RemoteID string - -
SetPricePreBuildRemoteID string SetPricePreBuild → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PrebuildID int SetPricePreBuild → ID -
CatalogID int Catalog → ID -
Quantity decimal - -
Cost decimal - -
LaborTime decimal - -
DisplayOrder int - -
FitTimeID int -
  • 19 May 2023 Foreign Key - Refers to `Fit Times` (not implemented).
FitTimeName int - -
FitTimeMultiplier int - -
TotalCost decimal - -
TotalLaborTime decimal - -

SetPricePreBuildCustomField

Documentation: https://developer.simprogroup.com/apidoc/?page=128c7259ed396d9691286cc1ddcbc541#operation/3564ae15d11d67a463d0d5b72efe5a2f

Column Type Relates to Notes
RemoteID string - -
SetPricePreBuildRemoteID string SetPricePreBuild → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PreBuildID int SetPricePreBuild → ID -
CustomFieldID int CustomField → ID -
Value string - -

SiteContact

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

SiteCustomer

Column Type Relates to Notes
RemoteID string - -
SiteRemoteID string Site → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
StaffID int - -
StaffType string - -
EmployeeID int Employee → ID -
ContractorID int - -
AssetTypeID int AssetType → ID -
ServiceLevelID int AssetServiceLevel → ID -
SiteID int Site → ID -

SiteCustomField

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

StandardPricePreBuildCatalog

Column Type Relates to Notes
RemoteID string - -
StandardPricePreBuildRemoteID string StandardPricePreBuild → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PrebuildID int StandardPricePreBuild → ID -
CatalogID int Catalog → ID -
Quantity decimal - -
Cost decimal - -
LaborTime decimal - -
DisplayOrder int - -
FitTimeID int -
  • 19 May 2023 Foreign Key - Refers to `Fit Times` (not implemented).
FitTimeName int - -
FitTimeMultiplier int - -
TotalCost decimal - -
TotalLaborTime decimal - -

StandardPricePreBuildCustomField

Documentation: https://developer.simprogroup.com/apidoc/?page=128c7259ed396d9691286cc1ddcbc541#operation/3564ae15d11d67a463d0d5b72efe5a2f

Column Type Relates to Notes
RemoteID string - -
StandardPricePreBuildRemoteID string StandardPricePreBuild → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PreBuildID int StandardPricePreBuild → ID -
CustomFieldID int CustomField → ID -
Value string - -

StorageDeviceStockItem

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

Column Type Relates to Notes
RemoteID string - -
StorageDeviceRemoteID string StorageDevice → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CatalogID int Catalog → ID -
StorageDeviceID int StorageDevice → ID -
InventoryCount decimal - -
AssignedToJobs decimal - -
AssignedValue decimal - -
OnOrder decimal - -
OrderValue decimal - -
InTransit decimal - -
OnOrderAssigned decimal - -
TransitInventoryValue decimal - -
OrderAssignedValue decimal - -
Total decimal - -
TotalValue decimal - -
DaysInInventory decimal - -
MinimumLevel decimal - -
RestockLevel 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 - -

TaskAssignee

Column Type Relates to Notes
RemoteID string - -
TaskRemoteID string Task → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TaskID int Task → ID -
CustomFieldID int CustomField → ID -
Value string - -

VendorContact

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

VendorCustomField

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

AssetTestResultReading

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

IndividualCustomerContractCustomField

Column Type Relates to Notes
RemoteID string - -
IndividualCustomerContractRemoteID string IndividualCustomerContract → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerContractID int IndividualCustomerContract → ID -
CustomFieldID int CustomField → ID -
Value string - -

IndividualCustomerContractServiceLevel

Column Type Relates to Notes
RemoteID string - -
IndividualCustomerContractRemoteID string IndividualCustomerContract → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CustomerContractID int IndividualCustomerContract → ID -
PrebuildID int - -
PrebuildName string - -
Time decimal - -
ChargeRate decimal - -
AssetTypeID int AssetType → ID -

CompanyCustomerContractCustomField

Column Type Relates to Notes
RemoteID string - -
CompanyCustomerContractRemoteID string CompanyCustomerContract → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerContractID int CompanyCustomerContract → ID -
CustomFieldID int CustomField → ID -
Value string - -

CompanyCustomerContractServiceLevel

Column Type Relates to Notes
RemoteID string - -
CompanyCustomerContractRemoteID string CompanyCustomerContract → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID int - -
Name string - -
CustomerContractID int CompanyCustomerContract → ID -
PrebuildID int - -
PrebuildName string - -
Time decimal - -
ChargeRate decimal - -
AssetTypeID int AssetType → ID -

Need more?

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

Connect your own simPRO data Querying simPRO using regular SQL