- Overview
- Account Settings
- Assets
- Connectors Framework
- Customer Portal
- Customers
- Dashboards
- Devices
- Dispatching
- Forms
- Inventory
- Invoices & Billing
- Locations
- Payments
- Parts
- Projects
- Quotes
- Recurrent Routes
- Recurrent Services
- Reports
- Sales Orders
- Schedule
- Services
- Tasks
- Text Messaging
- Time Tracking
- Users
- Work Orders
Overview
All the API methods available for recurrent service
All the API methods available for recurrent service
Table of Contents
Parameters
Allows the API to create and update your recurrent services. You can retrieve individual recurrent services as well.
Allows the API to create and update your recurrent services. You can retrieve individual recurrent services as well.
recurrentServiceId required |
Long A unique ID representing a recurrent service |
customerId required |
Long A unique ID representing the customer for the recurrent service |
customer optional |
String Name of customer |
locationId required |
Long A unique ID representing the customer's location |
location optional |
String The customer's location |
description required |
String Description of the recurrent service |
frequencyTypeId required |
Integer An ID that represents the recurrent service's frequency type. 1- Every X Days (see intervalDays attribute), 2- Weekly, 3- Biweekly, 4- Monthly, 5- Bimonthly, 6- Quarterly, 7- Every 4 Months, 8- Semiannually, 9- Annually, 12- Every 4 Weeks, 13- Every 3 Weeks, 14- Every 8 Weeks, 15- Every 5 Weeks, 16- Every 2 Years, 17- Every 3 Years |
frequencyType optional |
String The name of the frequency type |
workOrderTypeId required |
Long A unique ID representing the work order type |
workOrderType optional |
String The name of the work order type |
intervalDays required |
Integer Only used if 'Every X Days' frequency is used. Defines how often the service occurs. If frequencyTypeId = 1, intervalDays must be > 0 . Otherwise, intervalDays must = 0. |
warnDays optional |
Integer Number of days before warning |
tardyDays optional |
Integer Number of days before recurrent service is tardy |
lastServiceDate required |
Date Last date that the recurrent service occurred |
nextServiceDate optional |
Date Next date that the recurrent service will occur |
assignedTo optional |
String Name of user that recurrent service is assigned to |
asset optional |
Asset Object An asset that is associated with the recurrent service |
serviceItem optional |
Product Object A product/service that is associated with the recurrent service |
Example
<recurrentService>
<recurrentServiceId>501266</recurrentServiceId>
<customerId>3178692</customerId>
<customer>CustomerName</customer>
<locationId>4373022</locationId>
<location>Street, City State Zip</location>
<description>Test Recurrent Service</description>
<frequencyTypeId>15</frequencyTypeId>
<frequencyType>EVERY_5_WEEKS</frequencyType>
<workOrderTypeId>25121</workOrderTypeId>
<workOrderType>testworkordertype</workOrderTypeId>
<intervalDays>0</intervalDays>
<warnDays>2</warnDays>
<tardyDays>3</tardyDays>
<lastServiceDate>2020/12/01</lastServiceDate>
<nextServiceDate>2021/01/05</nextServiceDate>
<assignedTo>Test User,</assignedTo>
<assetList>
<asset>
<id>512704</id>
<name>asset1</name>
<serialNumber>111</serialNumber>
<assetTag>tag1</assetTag>
</asset>
<asset>
<id>512705</id>
<name>asset2</name>
<serialNumber>222</serialNumber>
<assetTag>tag2</assetTag>
</asset>
</assetList>
<serviceList>
<serviceItem>
<id>3875858</id>
<productId>1399162</productId>
<name>test product</name>
<desc>test description</desc>
<qty>1.0</qty>
<price>4.0</price>
</serviceItem>
<serviceItem>
<id>3875859</id>
<productId>1399163</productId>
<name>test service</name>
<desc>test description</desc>
<qty>2.0</qty>
<price>12.0</price>
</serviceItem>
</serviceList>
</recurrentService>
<recurrentService>
<recurrentServiceId>501266</recurrentServiceId>
<customerId>3178692</customerId>
<customer>CustomerName</customer>
<locationId>4373022</locationId>
<location>Street, City State Zip</location>
<description>Test Recurrent Service</description>
<frequencyTypeId>15</frequencyTypeId>
<frequencyType>EVERY_5_WEEKS</frequencyType>
<workOrderTypeId>25121</workOrderTypeId>
<workOrderType>testworkordertype</workOrderTypeId>
<intervalDays>0</intervalDays>
<warnDays>2</warnDays>
<tardyDays>3</tardyDays>
<lastServiceDate>2020/12/01</lastServiceDate>
<nextServiceDate>2021/01/05</nextServiceDate>
<assignedTo>Test User,</assignedTo>
<assetList>
<asset>
<id>512704</id>
<name>asset1</name>
<serialNumber>111</serialNumber>
<assetTag>tag1</assetTag>
</asset>
<asset>
<id>512705</id>
<name>asset2</name>
<serialNumber>222</serialNumber>
<assetTag>tag2</assetTag>
</asset>
</assetList>
<serviceList>
<serviceItem>
<id>3875858</id>
<productId>1399162</productId>
<name>test product</name>
<desc>test description</desc>
<qty>1.0</qty>
<price>4.0</price>
</serviceItem>
<serviceItem>
<id>3875859</id>
<productId>1399163</productId>
<name>test service</name>
<desc>test description</desc>
<qty>2.0</qty>
<price>12.0</price>
</serviceItem>
</serviceList>
</recurrentService>