Logo
Submit a request
Follow

Updating From API v1.0 to v2.0

Summary

Upgrading your code to the BlueFolder API v2.0 should be trivial. The main changes you'll need to make are (but not limited to):

  • Changing endpoint URLs from .../api/1.0/... to .../api/2.0/...
  • Modifying code to use new XML node names (mostly changing "ID" to "Id")
  • Making any necessary changes to account for the new way assignments are handled in the new BlueFolder
  • Making sure your code complies with the new API limits (100 calls per minute maximum)

 

Endpoint URL

The default endpoint URL for the API v2.0 is:

          https://app.bluefolder.com/api/2.0/...

Renamed XML Nodes

The BlueFolder API v2.0 works by accepting XML input and returning XML output. During the upgrade from v1.0 to v2.0 certain XML nodes were renamed. The following nodes were renamed across the entire API:

API v1.0 API v2.0
accountManagerID accountManagerId
apptID apptId
billingContractID billingContractId
billToAddressID billToAddressId
billToCustomerID billToCustomerId
billToID billToId
commentID commentId
contractID contractId
createdByUserID createdByUserId
customerContactID customerContactId
customerID customerId
customerLocationID customerLocationId
defaultLaborRateID defaultLaborRateId
defaultRateTypeID defaultRateTypeId
defaultTaxCodeID defaultTaxCodeId
expenseID expenseId
externalID externalId
itemID itemId
laborID laborId
locationID locationId
materialID materialId
serviceContractID serviceContractId
serviceManagerID serviceManagerId
serviceRequestFileID serviceRequestFileId
serviceRequestID serviceRequestId
serviceRequestSignedDocumentID serviceRequestSignedDocumentId
taxCodeID taxCodeId
technicianID technicianId
userID userId

 

Changes to Appointments

Appointments are no longer used to assign users to a Service Request. Instead, Service Requests can have multiple Service Request Assignments to associate users to a Service Request.

Removal of Tasks

Service Request tasks have been replaced by Service Request Assignments.

Changes to Equipment

Equipment in BlueFolder has been changed so that the resources are accessed via the /equipment path rather than through the /customers path.

Moved Resources

API v1.0 API v2.0
/customer/addEquipment.aspx /equipment/add.aspx
/customer/editEquipment.aspx /equipment/edit.aspx
/customer/listEquipment.aspx /equipment/list.aspx
/customer/getEquipment.aspx /equipment/get.aspx

Changes to Portal Users

The /customers/get.aspx resource will now output information about a customer contact’s portal user account.

Changes to Comments

Service Request, Status Change, and Item (labor, material, and expense) comments have been modified, You can no longer pass a private comment along with a public comment in the same call. You may now only pass a public OR private comment.

Changes to adding Items (labor, material, and expense) to a Service Request

In addition to the changes in the comments noted above the valid value for billingStatus for non-billable items has been changed from “notBillable” to “non-billable”.

Changes to Service Requests

Service Requests priority values are now numeric. You may no longer pass a string representing a priority value. You must pass an integer value (1 - 4) that corresponds to the priority that you wish to assign in the order defined for your account.

References to the following Service Request nodes have been renamed

API v1.0 API v2.0
notes detailedDescription
category type

 

API Limits

API usage is limited to 100 calls per minute. This is a company-wide limit and is enforced across access by all users within the account to prevent abuse. When an account reaches the 100 call per minute limit the server will return a '429 Too Many Requests’ response. This response will include a ‘Retry-After' header that will indicate when (in seconds) the application may retry. 

Resources Added in 2.0

  • /equipment/getCustomFields.aspx
  • /servicerequests/addAssignment.aspx
  • /servicerequests/completeAssignment.aspx
  • /servicerequests/deleteAssignment.aspx
  • /servicerequests/editAssignment.aspx
  • /servicerequests/getAssignmentList.aspx
  • /servicerequests/getAssignment.aspx
  • /servicerequests/getCustomFields.aspx
  • /servicerequests/removeCompletionAssignment.aspx
  • /users/add.aspx
  • /users/edit.aspx
  • /users/get.aspx

 

Detailed API Changes

Appointments

appointments/add

Input
Nodes Added
  • notifyCustomer (boolean – indicating whether or not the system will send a notification to a customer when adding an appointment)
Nodes Removed
  • serviceRequestID (you can no longer associate appointments to a service request – you should use Service Request Assignments instead)
Nodes Changed
API v1.0 API v2.0
assignedTo/userID assignedTo/userId
customerID customerId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
apptID apptId

appointments/edit

Input
Nodes Added
  • notifyCustomer (boolean – indicating whether or not the system will send a notification to a customer when adding an appointment)
Nodes Removed
  • serviceRequestID (you can no longer associate appointments to a service request – you should use Service Request Assignments instead)
Nodes Changed
API v1.0 API v2.0
apptID apptId
assignedTo/userID assignedTo/userId
customerID customerId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
apptID apptId

appointments/get

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
apptID apptId
Output
Nodes Added
  • None
Nodes Removed
  • serviceRequestID (you can no longer associate appointments to a service request – you should use Service Request Assignments instead)
Nodes Changed
API v1.0 API v2.0
assignedTo/userID assignedTo/userId
customerID customerId
createdByUserID createdByUserId
dateTime dateTimeStart

appointments/list

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
userID userId
Output
Nodes Added
  • None
Nodes Removed
  • serviceRequestID (you can no longer associate appointments to a service request – you should use Service Request Assignments instead)
  • taskID (tasks have been removed)
Nodes Changed
API v1.0 API v2.0
assignedTo/userID assignedTo/userId
customerID customerId
createdByUserID createdByUserId

Contracts

contracts/get

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
contractID contractId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
contractID contractId
billToAddressID billToAddressId
billToID billToId
createdByUserID createdByUserId
customerContactID contractId
customerID customerId
taxCodeID taxCodeId
Empty Nodes

The following nodes are output as empty nodes rather than self-closing tags in v2.0 when there is no inner text:

  • billToCity
  • billToCountry
  • billToPostalCode
  • billToState
  • billToStreetAddress
  • contractDescription
  • contractNotes
  • contractTerms
  • contractType

contracts/list

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
contractID contractId
customerID customerId
customerContactID customerContactId
Empty Nodes

The following nodes are output as empty nodes rather than self-closing tags in v2.0 when there is no inner text:

  • contractDateEnd
  • contractType

Customers

customers/add

Input
Nodes Added
  • billToAddressId
  • billToAddressName
  • billToCity
  • billToCountry
  • billToPostalCode
  • billToState
  • billToStreetAddress
  • billToType
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
defaultLaborRateID defaultLaborRateId
defaultTaxCodeID defaultTaxCodeId
primaryLocation/serviceManagerID primaryLocation/serviceManagerId
primaryLocation/technicianID primaryLocation/technicianId
accountManagerID accountManagerId
serviceManagerID serviceManagerId
technicianID technicianId
externalID externalId (required to be unique)
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId

customers/addComment

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId
userID userId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
commentID commentId

customers/addContact

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerContactID customerContactId

customers/addLocation

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId
serviceManagerID serviceManagerId
technicianID technicianId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerLocationID customerLocationId

customers/deleteContact

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
  • None
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
contactID contactId

customers/deleteLocation

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
  • None
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
locationID locationId

customers/delete

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
  • None
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId

customers/editContact

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerContactID customerContactId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerContactID customerContactId

customers/editLocation

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerLocationID customerLocationId
serviceManagerID serviceManagerId
technicianID technicianId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerLocationID customerLocationId

customers/edit

Input
Nodes Added
  • billToAddressId
  • billToAddressName
  • billToCity
  • billToCountry
  • billToPostalCode
  • billToState
  • billToStreetAddress
  • billToType
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId
defaultLaborRateID defaultLaborRateId
defaultTaxCodeID defaultTaxCodeId
accountManagerID accountManagerId
serviceManagerID serviceManagerId
technicianID technicianId
externalID externalId (required to be unique)
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId
externalID externalId
Empty Nodes

The following nodes are output as empty nodes rather than self-closing tags in v2.0 when there is no inner text:

  • externalID

customers/get

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId
externalID externalId
Output
Nodes Added
  • contacts/contact/u
  • contacts/contact/portalUserId
Nodes Removed
  • contacts/contact/portalAccessGranted
  • contacts/contact/portalLoginCount
  • contacts/contact/portalUsername
Nodes Changed
API v1.0 API v2.0
accountManagerID accountManagerId
billToAddressID billToAddressId
billToCustomerID billToCustomerId
createdByUserID createdByUserId
customerID customerId
defaultLaborTypeID defaultLaborRateId
defaultTaxCodeID defaultTaxCodeId
serviceManagerID serviceManagerId
technicianID technicianId
externalID externalId
contacts/contact/customerID contacts/contact/customerId
contacts/contact/contactID contacts/contact/contactId
contacts/contact/createdByUserID contacts/contact/createdByUserId
contacts/contact/locationID contacts/contact/locationId
locations/location/createdByUserID locations/location/createdByUserId
locations/location/customerID locations/location/customerId
locations/location/locationID locations/location/locationId
locations/location/serviceManagerID locations/location/serviceManagerId
locations/location/technicianID locations/location/technicianId
Empty Nodes

The following nodes are output as empty nodes rather than self-closing tags in v2.0 when there is no inner text:

  • externalID

customers/list

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
  • None
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId
externalID externalId
Empty Nodes

The following nodes are output as empty nodes rather than self-closing tags in v2.0 when there is no inner text:

  • externalID

Equipment

equipment/add

Input
Nodes Added
  • None
Nodes Removed
  • createdByUserID
Nodes Changed
API v1.0 API v2.0
/customerAddEquipment /equipmentAdd
customerID customerId
locationID locationId (required)
externalID externalId (required to be unique)
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
equipmentItemID equipmentId
externalID externalId

equipment/edit

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
/customerEditEquipment /equipmentEdit
equipmentItemID equipmentId
customerID customerId
locationID locationId
externalID externalId (required to be unique)
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
equipmentItemID equipmentId
externalID externalId
Empty Nodes

The following nodes are output as empty nodes rather than self-closing tags in v2.0 when there is no inner text:

  • externalID

equipment/get

Input
Nodes Added
  • externalId
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
itemID equipmentId
Output
Nodes Added
  1. externalID
  2. inactive
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
ID equipmentId
createdByUserID createdByUserId
customerID customerId
locationID locationId
Empty Nodes

The following nodes are output as empty nodes rather than self-closing tags in v2.0 when there is no inner text:

  • equipType
  • mfrName
  • modelNo
  • serialNo

equipment/list

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId
customerExternalID customerExternalId
listType listType (required)
Output
Nodes Added
  • inactive
Nodes Removed
  • externalID
Nodes Changed
API v1.0 API v2.0
ID equipmentId
createdByUserID createdByUserId
customerID customerId
locationID locationId

Items

items/add

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
  • None
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
itemID itemId

items/edit

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
itemID itemId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
itemID itemId

items/delete

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
itemID itemId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
itemID itemId

items/get

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
itemID itemId
Output
Nodes Added
  • accountName
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
createdByUserID createdByUserId

items/list

  • No Changes

Service Requests

servicerequests/addComment

Input
Nodes Added
  • comment
  • commentIsPublic
  • notifyCustomer
Nodes Removed
  • commentPrivate
  • commentPublic
Nodes Changed
API v1.0 API v2.0
serviceRequestID serviceRequestId
userID userId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
commentID commentId

servicerequests/addExpense

Input
Nodes Added
  • comment
  • commentIsPublic
Nodes Removed
  • publicNotes
Nodes Changed
API v1.0 API v2.0
serviceRequestID serviceRequestId
userID userId
billingContractID billingContractId
billingStatus billingStatus (valid values changed from “notBillable” to “non-billable”)
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
expenseID expenseId

servicerequests/addLabor

Input
Nodes Added
  • comment
  • commentIsPublic
Nodes Removed
  • privateNotes
  • publicNotes
Nodes Changed
API v1.0 API v2.0
serviceRequestID serviceRequestId
userID userId
billingContractID billingContractId
billingStatus billingStatus (valid values changed from “notBillable” to “non-billable”)
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
laborID laborId

servicerequests/addMaterial

Input
Nodes Added
  • comment
  • commentIsPublic
Nodes Removed
  • publicNotes
Nodes Changed
API v1.0 API v2.0
serviceRequestID serviceRequestId
billingContractID billingContractId
billingStatus (valid values changed from “notBillable” to “non-billable”)
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
materialID materialId

servicerequests/add

Input
Nodes Added
  • accountManagerId
  • detailedDescription
  • linkedToServiceRequestId
  • sourceId
  • sourceName
  • taxCodeID
  • type
  • notifyCustomer
Nodes Removed
  • category
Nodes Changed
API v1.0 API v2.0
assignedTo/userID node assignedTo/userId
customerContactID customerContactId
customerID customerId
customerLocationID customerLocationId
externalID externalId
serviceManagerID serviceManagerId
equipmentToService/equipID equipmentToService/equipmentId
priority priority (changed from a string to an integer representing one of the 4 priorities selected)
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
serviceRequestID serviceRequestId

servicerequests/delete

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
  • None
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
serviceRequestID serviceRequestId

servicerequests/editExpense

Input
Nodes Added
  • comment
  • commentIsPublic
Nodes Removed
  • publicNotes
Nodes Changed
API v1.0 API v2.0
expenseID expenseId
userID userId
billingContractID billingContractId
billingStatus (valid values changed from “notBillable” to “non-billable”)
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
expenseID expenseId

servicerequests/editLabor

Input
Nodes Added
  • comment
  • commentIsPublic
Nodes Removed
  • privateNotes
  • publicNotes
Nodes Changed
API v1.0 API v2.0
laborID laborId
userID userId
billingContractID billingContractId
billingStatus (valid values changed from “notBillable” to “non-billable”)
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
laborID laborId

servicerequests/editMaterial

Input
Nodes Added
  • comment
  • commentIsPublic
Nodes Removed
  • publicNotes
Nodes Changed
API v1.0 API v2.0
materialID materialId
billingContractID billingContractId
billingStatus (valid values changed from “notBillable” to “non-billable”)
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
materialID materialId

servicerequests/edit

Input
Nodes Added
  • accountManagerId
  • detailedDescription
  • linkedToServiceRequestId
  • notifyCustomer (you can now control whether or not the system will send a notification to a customer when editing a Service Request)
  • taxCodeID
  • type (category was renamed to type)
  • statusChanged/comment
  • statusChanged/commentIsPublic
Nodes Removed
  • assignedTo/userID (Service Request can no longer be assigned directly to a user, for assignment information see Service Request Assignments)
  • category (category was renamed to type)
  • statusChanged/commentPrivate
  • statusChanged/commentPublic
  • statusChanged/notifyCustomer (you can now control whether or not the system will send a notification to a customer when changing the status of a Service Request)
Nodes Changed
API v1.0 API v2.0
customerContactID customerContactId
customerID customerId
customerLocationID customerLocationId
externalID externalId
serviceManagerID serviceManagerId
serviceRequestID serviceRequestId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
serviceRequestID serviceRequestId
externalID externalId

servicerequests/getFiles

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
serviceRequestID serviceRequestId
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
serviceRequestFileID serviceRequestFileId
serviceRequestSignedDocumentID serviceRequestSignedDocumentId
isexternal isExternalLink
issigneddocument isSignedDocument
fileURL linkUrl

servicerequests/getHistory

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
serviceRequestID serviceRequestId
externalID externalId
Output
Nodes Added
  • CommentIsPublic
  • comment
Nodes Removed
  • commentPrivate
  • commentPublic
Nodes Changed
API v1.0 API v2.0
ID Id
serviceRequestID serviceRequestId

servicerequests/get

Input
Nodes Added
  • groupItemsByType (you can now group the items listed together so that all the types are grouped by their type)
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
serviceRequestID serviceRequestId
externalID externalId
Output
Nodes Added
  • accountManagerId (used to identify the salesperson associated with the work order)
  • customerContactFirstName
  • customerContactLastName
  • customerName
  • dateTimeClosed
  • dateTimeExportedForBilling
  • linkedToServiceRequestId
  • detailedDescription
  • serviceContractId
  • serviceRequestToken
  • sourceId
  • sourceName
  • statusLastUpdated
  • statusAge_hours
  • type (category was renamed to type)
  • comment
  • commentIsPublic
  • labor/laborItem/comment
  • labor/laborItem/commentIsPublic
  • materials/materialsItem/comment
  • materials/materialsItem/commentIsPublic
  • expenses/expensesItem/comment
  • expenses/expensesItem/commentIsPublic
Nodes Removed
  • assignedToUser (Service Request can no longer be assigned directly to a user, for assignment information see Service Request Assignments)
  • assignedToUserID
  • category (category was renamed to type)
  • closingComments (Service Request closing comments have been removed)
  • closingReason (Service Request closing reason has been removed)
  • createdByUser
  • notes
  • serviceManager
  • comment_private
  • comment_public
  • labor/laborItem/notes
  • labor/laborItem/notesPrivate
  • labor/laborItem/taskID
  • materials/materialsItem/notes
  • materials/materialsItem/taskID
  • expenses/expensesItem/notes
  • expenses/expensesItem/taskID
  • log/logEntry/comment_private
  • log/logEntry/comment_public
  • tasks (tasks are no longer valid in BlueFolder, use Service Request Assignments instead)
Nodes Changed
API v1.0 API v2.0
billToAddressID billToAddressId
billToID billToId
createdByUserID createdByUserId
customerContactID customerContactId
customerID customerId
customerLocationID customerLocationId
externalID externalId
serviceManagerID serviceManagerId
serviceRequestID serviceRequestId
taxCodeID taxCodeId
createdByUserID createdByUserId
requestType sourceType
serviceRequestID serviceRequestId
labor/laborItem/apptID labor/laborItem/apptId
labor/laborItem/billingContractID labor/laborItem/billingContractId
labor/laborItem/createdByUserID labor/laborItem/createdByUserId
labor/laborItem/ID labor/laborItem/id
labor/laborItem/itemID labor/laborItem/itemId
labor/laborItem/serviceRequestID labor/laborItem/serviceRequestId
labor/laborItem/userID labor/laborItem/userId
materials/materialsItem/apptID materials/materialsItem/apptId
materials/materialsItem/billingContractID materials/materialsItem/billingContractId
materials/materialsItem/createdByUserID materials/materialsItem/createdByUserId
materials/materialsItem/ID materials/materialsItem/id
materials/materialsItem/itemID materials/materialsItem/itemId
materials/materialsItem/serviceRequestID materials/materialsItem/serviceRequestId
expenses/expensesItem/apptID expenses/expensesItem/apptId
expenses/expensesItem/billingContractID expenses/expensesItem/billingContractId
expenses/expensesItem/createdByUserID expenses/expensesItem/createdByUserId
expenses/expensesItem/ID expenses/expensesItem/id
expenses/expensesItem/itemID expenses/expensesItem/itemId
expenses/expensesItem/serviceRequestID expenses/expensesItem/serviceRequestId
expenses/expensesItem/userID expenses/expensesItem/userId
log/logEntry/createdByUserID log/logEntry/createdByUserId
log/logEntry/ID log/logEntry/Id
log/logEntry/serviceRequestID log/logEntry/serviceRequestId
equipmentToService/equipmentItem/id equipmentToService/equipmentItem/equipmentId
equipmentToService/equipmentItem/externalID equipmentToService/equipmentItem/externalId
Empty Nodes

The following nodes are output as empty nodes rather than self-closing tags in v2.0 when there is no inner text:

  • priority
  • requestDetails

servicerequests/list

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
customerID customerId
Output
Nodes Added
  • accountManagerId (used to identify the salesperson associated with the work order)
  • billable
  • billableTotal
  • dateTimeClosed
  • detailedDescription
  • dueDate
  • linkedToServiceRequestId
  • sourceId
  • sourceName
  • taxCodeId
  • priorityLabel
  • type (category was renamed to type)
Nodes Removed
  • assignedToUser (Service Request can no longer be assigned directly to a user, for assignment information see Service Request Assignments)
  • assignedToUserID
  • category (category was renamed to type)
  • externalID
  • notes
  • serviceManager
Nodes Changed
API v1.0 API v2.0
customerContactID customerContactId
customerID customerId
customerLocationID customerLocationId
serviceManagerID serviceManagerId
serviceRequestID serviceRequestId
timeOpen node timeOpen_hours
priority priority (changed from a string to an integer representing one of the 4 priorities selected)
Empty Nodes

The following nodes are output as empty nodes rather than self-closing tags in v2.0 when there is no inner text:

  • customerContactPhone
  • customerContactPhoneMobile
  • customerLocationCity
  • customerLocationCountry
  • customerLocationPostalCode
  • customerLocationState
  • customerLocationStreetAddress

Tax Codes

taxcodes/add

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
  • None
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
taxCodeID taxCodeId

taxcodes/edit

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
  • None
Output
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
taxCodeID taxCodeId

Users

users/list

Input
Nodes Added
  • None
Nodes Removed
  • None
Nodes Changed
  • None
Output
Nodes Added
  • link1Name
  • link1Url
  • link2Name
  • link2Url
  • roles
Nodes Removed
  • None
Nodes Changed
API v1.0 API v2.0
userID userId
defaultLaborTypeID defaultRateTypeId
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request