Settings API

Get settings
URL /Settings
Method GET
Body  
Response
{
   "AddressTypeModels":[
      {
         "Id":1,
         "IsBilling":true,
         "IsEditable":true,
         "MasterId":null,
         "Name":"Billing",
         "Position":1
      }
   ],
   "AdvancedFeatures":{
      "IsAttachmentsFeatureEnabled":false,
      "IsCustomerSpecificFeatureEnabled":false,
      "IsExpandedCustomerRecordsFeatureEnabled":false,
      "IsGoogleCalendarIntegrationEnabled":false,
      "IsMergeInvoiceEnabled":false,
      "IsMobileInvoicingEnabled":false,
      "IsNotesCustomerFeatureEnabled":false,
      "IsNotesServiceRequestFeatureEnabled":false,
      "IsNotesTaskFeatureEnabled":false,
      "IsNotificationsFeatureEnabled":true,
      "IsMobileQuotingEnabled":false,
      "IsRecurrentServiceRequestEnabled":true,
      "IsServiceFormsFeatureEnabled":true,
      "IsServiceItemsFeatureEnabled":false,
      "IsTieredPricingEnabled":false,
      "IsTimeBasedServiceItemsFeatureEnabled":false,
      "IsTimeCardReportingEnabled":false,
      "IsWorkOrderCustomStatusesEnabled":false
   },
   "AttachmentTypes":[
      {
         "Id":1,
         "Name":"Invoice"
      }
   ],
   "Carriers":[
      {
         "Gateway":"txt.att.net",
         "Id":3,
         "IsNational":true,
         "Name":"AT&T",
         "Sort":1
      }
   ],
   "ContactTypeModels":[
      {
         "Id":1,
         "IsBilling":true,
         "IsEditable":true,
         "MasterId":null,
         "Name":"Billing",
         "Position":1
      }
   ],
   "CurrentTimeZone":"Eastern Standard Time",
   "CurrentTimeZoneOffset":"-5:0",
   "CustomerTypeModels":[
      {
         "Id":1,
         "IsEditable":true,
         "MasterId":null,
         "Name":"Residential",
         "Position":1
      }
   ],
   "DefaultDurationOfWorkOrder":"01:00:00",
   "GlobalTaxRate":0,
   "Holidays":[
      {
         "EndTime":"\/Date(1346687100000)\/",
         "Id":1,
         "IsAllDay":false,
         "Name":"test",
         "StartTime":"\/Date(1346677200000)\/"
      }
   ],
   "InoiceTo":"Excel",
   "InvoicingSettings":{ 
      "IsExportingAddressesAsSubCustomersEnabled":true,
      "IsExportingServiceRequestsAsJobsEnabled":false
   },
   "Locations":[
      {
         "CityStateZIP":"234",
         "Id":1,
         "Lat":60.0929642,
         "Lng":19.985157,
         "Phone":"2341231334",
         "StreetAddress":"234",
         "Title":"234"
      }
   ],
   "OrgDetails":{
      "AddressLine1":"234",
      "AddressLine2":"234",
      "CompanyName":"234",
      "Email":"234@234.3",
      "FullName":"234",
      "Phone":"(234) 122-2222",
      "PortalId":"1",
      "PortalName":null
   },
   "OrgSchedule":{
      "FridayEnd":"05:00 PM",
      "FridayIsWorkingDay":true,
      "FridayStart":"09:00 AM",
      "MondayEnd":"05:00 PM",
      "MondayIsWorkingDay":true,
      "MondayStart":"09:00 AM",
      "SaturdayEnd":"05:00 PM",
      "SaturdayIsWorkingDay":false,
      "SaturdayStart":"09:00 AM",
      "SundayEnd":"05:00 PM",
      "SundayIsWorkingDay":false,
      "SundayStart":"09:00 AM",
      "ThursdayEnd":"05:00 PM",
      "ThursdayIsWorkingDay":false,
      "ThursdayStart":"09:00 AM",
      "TuesdayEnd":"05:00 PM",
      "TuesdayIsWorkingDay":true,
      "TuesdayStart":"09:00 AM",
      "WednesdayEnd":"05:00 PM",
      "WednesdayIsWorkingDay":true,
      "WednesdayStart":"09:00 AM"
   },
   "PhoneTemplate":"(999) 999-9999",
   "PortalVersion":"4.6.9",
 

"SalespersonModels": [
{
"Id": 1,
"IsDefault": null,
"IsEditable": true,
"MasterId": null,
"Name": "New Type1",
"Position": 1
}
],


   "ServiceRequestStatuses":[
      {
         "Id":1,
         "Name":"Complete"
      }
   ],
   "TerminologyList":[
      {
         "Key":"Service Request",
         "Value":"Service Request"
      }
   ],
   "Users":[
      {
         "CarrierId":null,
         "Color":"7fc1d4",
         "EMail":"clevou@gmail.com1",
         "FirstName":"Firstname",
         "HideTimelineMap":false,
         "Id":1,
         "IsActive":true,
         "LastName":"Kamiak",
         "Login":"admin",
         "MobilePhone":"76754395",
         "NotifyViaEmail":false,
         "NotifyViaSms":false,
         "Phone":"0076754395",
         "RoleId":0,
         "RoleName":"Admin",
         "Schedule":{
            "FridayEnd":"05:00 PM",
            "FridayIsWorkingDay":true,
            "FridayStart":"09:00 AM",
            "MondayEnd":"05:00 PM",
            "MondayIsWorkingDay":true,
            "MondayStart":"09:00 AM",
            "SaturdayEnd":"05:00 PM",
            "SaturdayIsWorkingDay":false,
            "SaturdayStart":"09:00 AM",
            "SundayEnd":"05:00 PM",
            "SundayIsWorkingDay":false,
            "SundayStart":"09:00 AM",
            "ThursdayEnd":"05:00 PM",
            "ThursdayIsWorkingDay":false,
            "ThursdayStart":"09:00 AM",
            "TuesdayEnd":"05:00 PM",
            "TuesdayIsWorkingDay":true,
            "TuesdayStart":"09:00 AM",
            "WednesdayEnd":"05:00 PM",
            "WednesdayIsWorkingDay":true,
            "WednesdayStart":"09:00 AM"
         }
      }
   ],
   "WorkOrderCustomStatuses":[
      {
         "Id":1,
         "IsCanInvoiced":false,
         "LastChangeDate":"\/Date(1384943609293)\/",
         "Name":"Incomplete",
         "Position":1,
         "WorkOrderStatusTypeId":1,
  "Color":"e8e475"
      }
   ],
   "WorkOrderStatusTypes":[
      {

"CustomColor": "e8e475",
"DefaultColor": "e8e475",
"Id": 1,
"Position": 1,

"Name":"TestType"

      }
   ],
   "WorkflowSettings":{
      "IsUsersCanSeeMainEntitiesOfColleagues":true,
      "IsAbleChangeWorkOrderStatusFromComplete":true,
      "IsAbleCompleteWorkOrderWithoutFillingForm":true,
      "IsInvoicingWorkOrdersWithZeroServiceItemsAllowed":true
   }
}
Comments

IsUsersCanSeeMainEntitiesOfColleagues connected with Customers,Service Requests, Work Orders and User Location 

  Get invoicing settings                                                                                                                                 
URL /InvoicingSettings
Method GET
Body  

Response

{

  "Destinations": [
    {
      "Disabled": false,
      "Group": null,
      "Selected": false,
      "Text": "QuickBooks Online",
      "Value": "QuickBooks_Online"
    },
    {
      "Disabled": false,
      "Group": null,
      "Selected": false,
      "Text": "Excel / PDF",
      "Value": "Excel"
    }
  ],
  "SelectedDestination": "QuickBooks_Online",
  "GlobalTaxRate": ".00000",
  "ToBeEmailed": false,
  "ToBePrinted": false,
  "WorkOrderNumberAsInvoiceNumber": true,
  "ExportPaymentNumberToQuickBooks": true,
  "PaymentMethod": null,
  "GlobalTaxNameId": "",
  "TaxNames": [
    {
      "Disabled": false,
      "Group": null,
      "Selected": false,
      "Text": "California - 8.000%",
      "Value": "1019"
    },
    {
      "Disabled": false,
      "Group": null,
      "Selected": false,
      "Text": "Tucson - 9.100%",
      "Value": "1021"
    }
  ],
  "AddressParts": {
    "BillingLine1": 2,
    "BillingLine2": 10,
    "BillingLine3": 3,
    "BillingLine4": 4,
    "BillingLine5": null,
    "ServiceLine1": 2,
    "ServiceLine2": 16,
    "ServiceLine3": 8,
    "ServiceLine4": 9,
    "ServiceLine5": null,
    "UseBillToFroServiceTo": false,
    "PossibleAddressParts": [
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Service Request Summary",
        "Value": "0"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Billing Address Name",
        "Value": "17"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Service Address Name",
        "Value": "1"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Company Name",
        "Value": "2"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Billing Address: Street",
        "Value": "3"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Billing Address: City/State/ZIP",
        "Value": "4"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "(Parsed) City",
        "Value": "5"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "(Parsed) State",
        "Value": "6"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "(Parsed) ZIP",
        "Value": "7"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Service Address: Street",
        "Value": "8"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Service Address: City/State/ZIP",
        "Value": "9"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Billing Contact of the Service Address",
        "Value": "10"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Service Contact of the Service Address",
        "Value": "16"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Billing Contact",
        "Value": "11"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Primary Contact",
        "Value": "12"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Secondary Contact",
        "Value": "13"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Billing Address Description",
        "Value": "14"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Service Address Description",
        "Value": "15"
      },
      {
        "Disabled": false,
        "Group": null,
        "Selected": false,
        "Text": "Display Name",
        "Value": "18"
      }
    ]
  },
  "IsExportingServiceRequestsAsJobsEnabled": false,
  "IsExportingAddressesAsSubCustomersEnabled": true,
  "InvoiceDueDateRangeDays": 30,
  "ARAccountName": "Accounts Receivable",
  "UndepositedFundsName": "Undeposited Funds",
  "DefaultClassName": null,
  "DefaultTaxCodeId": "",
  "TaxCodes": [
    {
      "Disabled": false,
      "Group": null,
      "Selected": false,
      "Text": "Tax - Taxable Sales",
      "Value": "1"
    },
    {
      "Disabled": false,
      "Group": null,
      "Selected": false,
      "Text": "Non - Non-Taxable Sales",
      "Value": "2"
    }
  ],
  "InvoicingMemoOptions": false
}

Comments