ServiceTitan Component
ServiceTitan is a comprehensive field service management solution that helps businesses manage their operations, workforce, and customer service.
Component key: servicetitan
Description
ServiceTitan is a comprehensive field service management solution that helps businesses manage their operations, workforce, and customer service.
Use the ServiceTitan component to manage Technicians, Jobs, Appointments, and more.
API Documentation: ServiceTitan API Reference
Connections
OAuth 2.0
To authenticate ServiceTitan integrations with OAuth 2.0 requires a developer account and the configuration of an application from the ServiceTitan Developer Portal.
To Create an app:
- Login to the Developer Portal
- Select My Apps at the top of the page
- Select + New App
- Fill all the required fields and scopes
- Under Client Credentials Management”, select I, the app developer, will configure the credentials on behalf of each tenant
- Click Create App
For Existing apps:
- Login to the Developer Portal
- Select My Apps at the top of the page
- Click Edit on your application
- Under Client Credentials Management”, select I, the app developer, will configure the credentials on behalf of each tenant
- Click Save
To obtain a Client Secret and Client ID:
If you haven’t done so already, please add the client’s Tenant ID to your application. Once the Tenant Admin has allowed access and connected to your application through their “API Application Access” settings, you can begin the process of obtaining the tenant’s client ID and client secret in your developer portal:
- Login to the Developer Portal
- Select My Apps at the top of the page
- Click View Connections for your app
- Click Generate under Client Secret to create a new Client Secret
- Reference the tenant’s Client ID on this page as well
| Input | Notes | Example |
|---|---|---|
| Application Key | The ID of the payment. | ak1.4adsy4lzgsd0b3cqh48zl5z3d7 |
| Authorize URL | The OAuth 2.0 Authorization URL for the API | |
| Client ID | Client Identifier of your app for the API | |
| Client Secret | Client Secret of your app for the API | |
| Environment | The environment to connect to | |
| Scopes | Space separated OAuth 2.0 permission scopes for the API | |
| Tenant | The client tenant. | 10978752986 |
| Token URL | The OAuth 2.0 Token URL for the API |
Data Sources
Select Appointment
Select an Appointment from a dropdown menu (up to 10,000 Appointments) | key: selectAppointment | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"key": "1",
"label": "#1 (ID: 1)"
}
]
}
Select Booking
Select a booking from a dropdown menu (up to 10,000 bookings) | key: selectBooking | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"key": "1",
"label": "Booking 1 (ID: 1)"
},
{
"key": "2",
"label": "Booking 2 (ID: 2)"
}
]
}
Select Customer
Select a customer from a dropdown menu (up to 10,000 customers) | key: selectCustomers | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"key": "1",
"label": "John Doe (ID: 1)"
},
{
"key": "2",
"label": "Jane Doe (ID: 2)"
}
]
}
Select Installed Equipment
Select an Installed Equipment from a dropdown menu (up to 10,000 Installed Equipments) | key: selectInstalledEquipment | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"key": "1",
"label": "Installed Equipment 1 (ID: 1)"
},
{
"key": "2",
"label": "Installed Equipment 2 (ID: 2)"
}
]
}
Select Invoice
Select an Invoice from a dropdown menu (up to 10,000 Invoices) | key: selectInvoice | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"key": "1",
"label": "#1234"
}
]
}
Select Job
Select a job from a dropdown menu (up to 10,000 jobs) | key: selectJob | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"key": "1",
"label": "#1"
},
{
"key": "2",
"label": "#2"
},
{
"key": "3",
"label": "#3"
}
]
}
Select Location
Select a Location from a dropdown menu (up to 10,000 Locations) | key: selectLocation | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"key": "1",
"label": "Location 1 (ID: 1)"
},
{
"key": "2",
"label": "Location 2 (ID: 2)"
},
{
"key": "3",
"label": "Location 3 (ID: 3)"
}
]
}
Select Project
Select a Project from a dropdown menu (up to 10,000 Projects) | key: selectProject | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"key": "1",
"label": "Project 1 (ID: 1)"
},
{
"key": "2",
"label": "Project 2 (ID: 2)"
}
]
}
Select Technician
Select a Technician from a dropdown menu (up to 10,000 Technicians) | key: selectTechnician | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"key": "1",
"label": "John Doe (ID: 1)"
},
{
"key": "2",
"label": "Jane Doe (ID: 2)"
}
]
}
Actions
Assign Technician to Appointment
Assigns the list of technicians to the appointment | key: assignTechnicians
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Job Appointment ID | ID of the job appointment | 1234567890 |
| Technician IDs | Assign these technicians to the appointment. | 1088 |
{
"data": {
"id": 0,
"jobId": 0,
"appointmentNumber": "string",
"start": "string",
"end": "string",
"arrivalWindowStart": "string",
"arrivalWindowEnd": "string",
"status": {},
"specialInstructions": "string",
"createdOn": "string",
"modifiedOn": "string"
}
}
Cancel Job
Cancels a Job | key: cancelJob
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Job ID | The job ID. | 10978752986 |
| Job Memo | Memo of job cancel reason | string |
| Reason ID | ID of job cancel reason | 1088 |
{
"data": {}
}
Create Appointment
Adds a new appointment to an existing job | key: createAppointment
| Input | Notes | Example |
|---|---|---|
| Arrival Window End | Arrival window end date/time (in UTC) | 2021-01-01T00:00:00Z |
| Arrival Window Start | Arrival window start date/time (in UTC) | 2021-01-01T00:00:00Z |
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| End | End date/time (in UTC) | 2021-01-01T00:00:00Z |
| Job ID | The job ID. | 10978752986 |
| Special Instructions | Special instructions associated to the appointment | Any special instructions |
| Start | Start date/time (in UTC) | 2021-01-01T00:00:00Z |
| Technician ID | The ID of the technician. | 10978752986 |
{
"data": {
"id": 0,
"jobId": 0,
"appointmentNumber": "string",
"start": "string",
"end": "string",
"arrivalWindowStart": "string",
"arrivalWindowEnd": "string",
"status": {},
"specialInstructions": "string",
"createdOn": "string",
"modifiedOn": "string",
"customerId": 0,
"unused": true
}
}
Create Booking by Provider
Create a booking | key: createBookingByProvider
| Input | Notes | Example |
|---|---|---|
| Address | Address of the booking | |
| Booking Provider | The ID of the booking provider. | 10978752986 |
| Business Unit ID | ID of the booking's business unit | 10978752986 |
| Campaign ID | ID of the booking's campaign | 10978752986 |
| Connection | ||
| Contacts | Contacts for the booking | |
| Customer Type | Type of the customer | |
| Debug Request | Enabling this flag will log out the current request. | false |
| External ID | External ID of booking | 10978752986 |
| Is First Time Client | True if first time client | |
| Send Confirmation Email | True if first time client | |
| Job Type ID | ID of the booking's job type | 10978752986 |
| Name | Booking name | Test Source |
| Priority | Booking priority | |
| Source | The source of the booking provider | Test Source |
| Start | Start date/time (in UTC) | 2021-01-01T00:00:00Z |
| Summary | Summary of the booking | A summary related to the invoice. |
| Uploaded Images | Uploaded images |
{
"data": {
"id": 0,
"source": "string",
"createdOn": "string",
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"customerType": {},
"start": "string",
"summary": "string",
"campaignId": 0,
"businessUnitId": 0,
"isFirstTimeClient": true,
"uploadedImages": [
"string"
],
"isSendConfirmationEmail": true,
"status": {},
"dismissingReasonId": 0,
"jobId": 0,
"externalId": "string",
"priority": {},
"jobTypeId": 0,
"bookingProviderId": 0,
"modifiedOn": "string"
}
}
Create Customer
Create a New Customer | key: createCustomer
| Input | Notes | Example |
|---|---|---|
| Address | Bill-To address of the customer record | |
| Connection | ||
| Contacts | Contacts for the booking | |
| Custom Fields | Custom fields for the request | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Do Not Mail | Customer has been flagged as “do not mail” | |
| Do Not Service | Customer has been flagged as “do not service” | |
| External Data | External data to attach to the request. | |
| Location | Locations for the customer | |
| Name | Name of the customer | Test Source |
| Tag Type IDs | A list of tags ID's | 123 |
| Customer Type | Type of the customer |
{
"data": {
"id": 0,
"active": true,
"name": "string",
"type": {},
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"balance": 0,
"tagTypeIds": [
0
],
"doNotMail": true,
"doNotService": true,
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"externalData": [
{
"key": "string",
"value": "string"
}
],
"locations": [
{
"taxZoneId": 0,
"id": 0,
"customerId": 0,
"active": true,
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"zoneId": 0,
"tagTypeIds": [
0
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"contacts": [
{
"id": 0,
"type": {},
"value": "string",
"memo": "string"
}
]
}
],
"contacts": [
{
"id": 0,
"type": {},
"value": "string",
"memo": "string"
}
]
}
}
Create Customer Contact
Create a contact for a customer | key: createCustomerContact
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Customer ID | The customer ID. | 10978752986 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Memo | Short description about this contact, for example, “work #” or “Owner’s daughter - Kelly” | Payment for services rendered. |
| Customer Contact Type | Type of the customer contact | |
| Customer Contact Type Value | The email, phone number, or fax number for the contact | 1234567890 |
{
"data": {
"id": 0,
"type": {},
"value": "string",
"memo": "string",
"modifiedOn": "string",
"phoneSettings": {
"phoneNumber": "string",
"doNotText": true
}
}
}
Create Installed Equipment
Create a new Installed equipment | key: createInstalledEquipment
| Input | Notes | Example |
|---|---|---|
| Attachments | List of attachments | |
| Connection | ||
| Cost | Cost of the installed equipment | 100.00 |
| Custom Fields | The custom fields of the installed equipment | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Installed On | The date the equipment was installed | 2021-01-01T00:00:00Z |
| Location ID | The location id of the installed equipment | 10978752986 |
| Manufacturer | Manufacturer of the installed equipment | Test Manufacturer |
| Manufacturer Warranty End | Manufacturer warranty end date | 2021-01-01T00:00:00Z |
| Manufacturer Warranty Start | Manufacturer warranty start date | 2021-01-01T00:00:00Z |
| Memo | The memo of the installed equipment | Payment for services rendered. |
| Model | Model of the installed equipment | Test Model |
| Name | The name of the installed equipment | Test Source |
| Serial Number | Serial number of the installed equipment | 1234567890 |
| Service Provider Warranty End | Service Provider Warranty End date | 2021-01-01T00:00:00Z |
| Service Provider Warranty Start | Service Provider Warranty Start date | 2021-01-01T00:00:00Z |
| Tag Type IDs | A list of tags ID's | 123 |
{
"data": {
"id": 0,
"equipmentId": 0,
"locationId": 0,
"customerId": 0,
"invoiceItemId": 0,
"name": "string",
"installedOn": "string",
"createdOn": "string",
"modifiedOn": "string",
"serialNumber": "string",
"memo": "string",
"manufacturer": "string",
"model": "string",
"cost": 0,
"manufacturerWarrantyStart": "string",
"manufacturerWarrantyEnd": "string",
"serviceProviderWarrantyStart": "string",
"serviceProviderWarrantyEnd": "string",
"tags": [
{
"id": 0,
"ownerId": 0,
"typeId": 0,
"typeName": "string",
"memo": "string",
"color": "string",
"textColor": "string",
"code": "string"
}
],
"customFields": [
{
"id": 0,
"typeId": 0,
"name": "string",
"value": "string"
}
],
"attachments": [
{
"alias": "string",
"fileName": "string",
"type": {},
"url": "string"
}
]
}
}
Create Installed Equipment Attachment
Create a new installed equipment attachment | key: createInstalledEquipmentAttachment
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Attachment File | Reference a file from another action. Must be a file type. | |
| File Name | Name of the file | Test File |
{
"data": {
"path": "InstalledEquipment/Documents/e2374d0c-16b8-4bb7-b3b5-1bd0ac1df1f4.csv"
}
}
Create Invoices
Create adjustment invoice | key: createInvoices
| Input | Notes | Example |
|---|---|---|
| Adjustment To ID | The ID of the invoice the adjustment is for. | 10978752986 |
| Assigned To ID | The ID of the user the invoice is assigned to. | 10978752986 |
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Export ID | Gets or sets the identifier when exported. | 6B29FC40-CA47-1067-B31D-00DD010662DA21323 |
| Invoiced On | The date the invoice was invoiced on. | 2021-01-01T00:00:00Z |
| Items | The items of the invoice. | |
| Number | The invoice number. | 10978752986 |
| Review Status | The review status of the invoice. | |
| Royalty Date | The royalty date of the invoice. | 2021-01-01T00:00:00Z |
| Royalty Memo | The royalty sent date of the invoice. | Payment for services rendered. |
| Royalty Sent On | The royalty sent date of the invoice. | 2021-01-01T00:00:00Z |
| Royalty Status | The royalty status of the invoice. | |
| Subtotal | The subtotal of the invoice. | 100.00 |
| Summary | The summary of the invoice. | A summary related to the invoice. |
| Tax | The tax of the invoice. | 100.00 |
| Type ID | The ID of the type of the payment. | 0 |
{
"data": {}
}
Create Job
Create a job | key: createJob
| Input | Notes | Example |
|---|---|---|
| Appointments | List of appointment information | |
| Business Unit ID | ID of the job's business unit | 10978752986 |
| Campaign ID | ID of the job's campaign | 10978752986 |
| Connection | ||
| Customer ID | The customer ID. | 10978752986 |
| Customer PO | Customer PO | |
| Custom Fields | Custom fields for the job | |
| Debug Request | Enabling this flag will log out the current request. | false |
| External Data | External data to attach to the request. | |
| Invoice Signature Is Required | Optional model that informs if invoice should requires a signature or not if not informed will follow the rules for location and job type | |
| Job Generated Lead Source | Object that contains: JobId: ID of the job from which this job was generated EmployeeId: ID of the office user or technician | |
| Job Type ID | ID of the job's type | 10978752986 |
| Location ID | The ID of the location. | 10978752986 |
| Priority | Priority of the job | |
| Project ID | ID of the job's project | 10978752986 |
| Summary | Job summary | A summary related to the invoice. |
| Tag Type IDs | Tag type IDs for the job | 123 |
{
"data": {
"id": 0,
"jobNumber": "string",
"projectId": 0,
"customerId": 0,
"locationId": 0,
"jobStatus": "string",
"completedOn": "string",
"businessUnitId": 0,
"jobTypeId": 0,
"priority": "string",
"campaignId": 0,
"summary": "string",
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"appointmentCount": 0,
"firstAppointmentId": 0,
"lastAppointmentId": 0,
"recallForId": 0,
"warrantyId": 0,
"jobGeneratedLeadSource": {
"jobId": 0,
"employeeId": 0
},
"noCharge": true,
"notificationsEnabled": true,
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"tagTypeIds": [
0
],
"leadCallId": 0,
"bookingId": 0,
"soldById": 0,
"externalData": [
{
"key": "string",
"value": "string"
}
],
"customerPo": "string"
}
}
Create Location
Creates a new location | key: createLocation
| Input | Notes | Example |
|---|---|---|
| Address | The address of the location | |
| Connection | ||
| Contacts | The contacts associated with the location | |
| Customer ID | The customer ID. | 10978752986 |
| Custom Fields | Custom fields for the request | |
| Debug Request | Enabling this flag will log out the current request. | false |
| External Data | External data to attach to the request. | |
| Name | The name of the location | Test Source |
| Tag Type IDs | A list of tags ID's | 123 |
{
"data": {
"id": 0,
"customerId": 0,
"active": true,
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"zoneId": 0,
"tagTypeIds": [
0
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"taxZoneId": 0,
"contacts": [
{
"id": 0,
"type": {},
"value": "string",
"memo": "string"
}
]
}
}
Create Payment
Create a payment in Service Titan | key: createPayment
| Input | Notes | Example |
|---|---|---|
| Auth Code | The authorization code for the payment. | 6B29FC40-CA47-1067-B31D-00DD010662DA21323 |
| Check Number | The check number for the payment. | 6B29FC40-CA47-1067-B31D-00DD010662DA21323 |
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Export ID | Gets or sets the identifier when exported. | 6B29FC40-CA47-1067-B31D-00DD010662DA21323 |
| Memo | The memo of the payment. | Payment for services rendered. |
| Paid On | The date the payment was paid on. | 2021-01-01T00:00:00Z |
| Splits | The splits of the payment. | |
| Status | The status of the payment. | |
| Type ID | The ID of the type of the payment. | 0 |
{
"data": {
"id": 0,
"typeId": 0,
"active": true,
"memo": "string",
"paidOn": "string",
"authCode": "string",
"checkNumber": "string",
"exportId": "string",
"transactionStatus": {},
"status": {},
"splits": [
{
"invoiceId": 0,
"amount": 0
}
]
}
}
Create Project
Create a new project | key: createProject
| Input | Notes | Example |
|---|---|---|
| Actual Completion Date | Actual completion date of the project | 2021-01-01T00:00:00Z |
| Connection | ||
| Customer ID | ID of the project's customer | 10978752986 |
| Custom Fields | Custom fields for the project | |
| Debug Request | Enabling this flag will log out the current request. | false |
| External Data | Optional model that contains a list of external data items that should be attached to this project. | |
| Location ID | The ID of the location. | 10978752986 |
| Name | Name of the project | Test Source |
| Project Manager IDs | IDs of the project's managers | 1088 |
| Start | Start date of the project | 2021-01-01T00:00:00Z |
| Status ID | Project status id | 1088 |
| Sub Status ID | Project sub status id | 1088 |
| Summary | Summary of the project | A summary related to the invoice. |
| Target Completion Date | Target completion date of the project | 2021-01-01T00:00:00Z |
{
"data": {
"id": 0,
"number": "string",
"name": "string",
"summary": "string",
"status": "string",
"statusId": 0,
"subStatus": "string",
"subStatusId": 0,
"customerId": 0,
"locationId": 0,
"projectManagerIds": [
0
],
"businessUnitIds": [
0
],
"startDate": "string",
"targetCompletionDate": "string",
"actualCompletionDate": "string",
"modifiedOn": "string",
"createdOn": "string",
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"jobIds": [
0
]
}
}
Create Technician
Create new technician | key: createTechnician
| Input | Notes | Example |
|---|---|---|
| Azure Active Directory User Id | Azure Active Directory User Id | 6B29FC40-CA47-1067-B31D-00DD010662DA |
| Account Creation Method | Account creation method | |
| Biography | Biography of the technician | Biography |
| Burden Rate | Burden rate (hourly) | 5.6 |
| Business Unit ID | The ID of the business unit to which the technician will be assigned | 10978752986 |
| Connection | ||
| Custom Fields | Custom fields for the technician | |
| Daily Goal | Daily revenue goal | 5.6 |
| Debug Request | Enabling this flag will log out the current request. | false |
Technician's email address | test@technician.us | |
| Address | The home address of the technician | |
| Job Filter | Upcoming appointment visibility | |
| Job History Date Filter | Appointment history visibility | |
| License Type | License type | |
| Login Username | Technician's username | technician_us |
| Memo | Memo for the technician | Payment for services rendered. |
| Name | The name of the technician | Test Source |
| Password | Technician's password | @an1pwd123 |
| Phone Number | Technician's phone number | 1234567890 |
| Positions | List of company positions | |
| Role ID | User role Id | 7 |
| Team | Team name | Test Team |
{
"data": {
"id": 0
}
}
Delete Appointment
Delete appointment by ID | key: deleteAppointment
| Input | Notes | Example |
|---|---|---|
| Appointment ID | The ID of the appointment. | 10978752986 |
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
{
"data": {}
}
Delete Customer Contact
Removes a contact from a customer | key: deletCustomersContact
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Customer Contact ID | The customer contact ID. | 10978752986 |
| Customer ID | The customer ID. | 10978752986 |
| Debug Request | Enabling this flag will log out the current request. | false |
{
"data": {}
}
Delete Invoice Item
Delete an invoice item | key: deleteInvoiceItem
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Invoice ID | The ID of the invoice. | 10978752986 |
| Item ID | The ID of the item. | 10978752986 |
{
"data": {}
}
Get Appointment
Retrieve an appointment by ID | key: getAppointment
| Input | Notes | Example |
|---|---|---|
| Appointment ID | The ID of the appointment. | 10978752986 |
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
{
"data": {
"id": 0,
"jobId": 0,
"appointmentNumber": "string",
"start": "string",
"end": "string",
"arrivalWindowStart": "string",
"arrivalWindowEnd": "string",
"status": {},
"specialInstructions": "string",
"createdOn": "string",
"modifiedOn": "string",
"customerId": 0,
"unused": true
}
}
Get Booking by Provider
Retrieve a booking by ID | key: getBookingByProvider
| Input | Notes | Example |
|---|---|---|
| Booking ID | The ID of the booking. | 10978752986 |
| Booking Provider | The ID of the booking provider. | 10978752986 |
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
{
"data": {
"id": 0,
"source": "string",
"createdOn": "string",
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"customerType": {},
"start": "string",
"summary": "string",
"campaignId": 0,
"businessUnitId": 0,
"isFirstTimeClient": true,
"uploadedImages": [
"string"
],
"isSendConfirmationEmail": true,
"status": {},
"dismissingReasonId": 0,
"jobId": 0,
"externalId": "string",
"priority": {},
"jobTypeId": 0,
"bookingProviderId": 0,
"modifiedOn": "string"
}
}
Get Booking by Tenant
Retrieve a booking by ID | key: getBookingByTenant
| Input | Notes | Example |
|---|---|---|
| Booking ID | The ID of the booking. | 10978752986 |
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
{
"data": {
"id": 0,
"source": "string",
"createdOn": "string",
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"customerType": {},
"start": "string",
"summary": "string",
"campaignId": 0,
"businessUnitId": 0,
"isFirstTimeClient": true,
"uploadedImages": [
"string"
],
"isSendConfirmationEmail": true,
"status": {},
"dismissingReasonId": 0,
"jobId": 0,
"externalId": "string",
"priority": {},
"jobTypeId": 0,
"bookingProviderId": 0,
"modifiedOn": "string"
}
}
Get Customer
Retrieve a Customer by ID | key: getCustomer
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Customer ID | The customer ID. | 10978752986 |
| Debug Request | Enabling this flag will log out the current request. | false |
{
"data": {
"id": 0,
"active": true,
"name": "string",
"type": {},
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"balance": 0,
"tagTypeIds": [
0
],
"doNotMail": true,
"doNotService": true,
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"externalData": [
{
"key": "string",
"value": "string"
}
]
}
}
Get Installed Equipment
Retrieve a Installed Equipment by ID | key: getInstalledEquipment
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Installed Equipment ID | ID of the installed equipment | 1234567890 |
{
"data": {
"id": 0,
"equipmentId": 0,
"locationId": 0,
"customerId": 0,
"invoiceItemId": 0,
"name": "string",
"installedOn": "string",
"createdOn": "string",
"modifiedOn": "string",
"serialNumber": "string",
"memo": "string",
"manufacturer": "string",
"model": "string",
"cost": 0,
"manufacturerWarrantyStart": "string",
"manufacturerWarrantyEnd": "string",
"serviceProviderWarrantyStart": "string",
"serviceProviderWarrantyEnd": "string",
"tags": [
{
"id": 0,
"ownerId": 0,
"typeId": 0,
"typeName": "string",
"memo": "string",
"color": "string",
"textColor": "string",
"code": "string"
}
],
"customFields": [
{
"id": 0,
"typeId": 0,
"name": "string",
"value": "string"
}
],
"attachments": [
{
"alias": "string",
"fileName": "string",
"type": {},
"url": "string"
}
]
}
}
Get Job
Retrieve a job by ID | key: getJob
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| External Data Application Guid | Format - guid. If this guid is provided, external data corresponding to this application guid will be returned. | 6B29FC40-CA47-1067-B31D-00DD010662DA |
| Job ID | The job ID. | 10978752986 |
{
"data": {
"id": 0,
"jobNumber": "string",
"projectId": 0,
"customerId": 0,
"locationId": 0,
"jobStatus": "string",
"completedOn": "string",
"businessUnitId": 0,
"jobTypeId": 0,
"priority": "string",
"campaignId": 0,
"summary": "string",
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"appointmentCount": 0,
"firstAppointmentId": 0,
"lastAppointmentId": 0,
"recallForId": 0,
"warrantyId": 0,
"jobGeneratedLeadSource": {
"jobId": 0,
"employeeId": 0
},
"noCharge": true,
"notificationsEnabled": true,
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"tagTypeIds": [
0
],
"leadCallId": 0,
"bookingId": 0,
"soldById": 0,
"externalData": [
{
"key": "string",
"value": "string"
}
],
"customerPo": "string"
}
}
Get Location
Retrieve a location by ID | key: getLocation
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Location ID | The ID of the location to retrieve | 10978752986 |
{
"data": {
"id": 0,
"customerId": 0,
"active": true,
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"zoneId": 0,
"tagTypeIds": [
0
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"taxZoneId": 0
}
}
Get Project
Retrieve a project by ID | key: getProject
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Project ID | The ID of the project to retrieve | 10978752986 |
{
"data": {
"id": 0,
"number": "string",
"name": "string",
"summary": "string",
"status": "string",
"statusId": 0,
"subStatus": "string",
"subStatusId": 0,
"customerId": 0,
"locationId": 0,
"projectManagerIds": [
0
],
"businessUnitIds": [
0
],
"startDate": "string",
"targetCompletionDate": "string",
"actualCompletionDate": "string",
"modifiedOn": "string",
"createdOn": "string",
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"jobIds": [
0
]
}
}
Get Technician
Retrieve a Technician by ID | key: getTechnician
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Technician ID | The ID of the Technician to retrieve | 10978752986 |
{
"data": {
"id": 0,
"userId": 0,
"name": "string",
"roleIds": [
0
],
"businessUnitId": 0,
"mainZoneId": 0,
"zoneIds": [
0
],
"createdOn": "string",
"modifiedOn": "string",
"email": "string",
"phoneNumber": "string",
"loginName": "string",
"home": {
"street": "string",
"unit": "string",
"country": "string",
"city": "string",
"state": "string",
"zip": "string",
"streetAddress": "string",
"latitude": 0,
"longitude": 0
},
"dailyGoal": 0,
"isManagedTech": true,
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"active": true,
"aadUserId": "string",
"burdenRate": 0,
"team": "string",
"jobFilter": {}
}
}
List Appointment Assignment
Retrieve a list of appointment assignments | key: listAppointmentsAssignment
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"technicianId": 0,
"technicianName": "string",
"assignedById": 0,
"assignedOn": "string",
"status": {},
"isPaused": true,
"jobId": 0,
"appointmentId": 0
}
]
}
}
List Appointments
Retrieve a list of appointments | key: listAppointments
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"jobId": 0,
"appointmentNumber": "string",
"start": "string",
"end": "string",
"arrivalWindowStart": "string",
"arrivalWindowEnd": "string",
"status": {},
"specialInstructions": "string",
"createdOn": "string",
"modifiedOn": "string",
"customerId": 0,
"unused": true
},
{
"id": 0,
"jobId": 0,
"appointmentNumber": "string",
"start": "string",
"end": "string",
"arrivalWindowStart": "string",
"arrivalWindowEnd": "string",
"status": {},
"specialInstructions": "string",
"createdOn": "string",
"modifiedOn": "string",
"customerId": 0,
"unused": true
}
]
}
}
List Bookings by Provider
Retrieves a list of bookings | key: listBookingByProvider
| Input | Notes | Example |
|---|---|---|
| Booking Provider | The ID of the booking provider. | 10978752986 |
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"source": "string",
"createdOn": "string",
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"customerType": {},
"start": "string",
"summary": "string",
"campaignId": 0,
"businessUnitId": 0,
"isFirstTimeClient": true,
"uploadedImages": [
"string"
],
"isSendConfirmationEmail": true,
"status": {},
"dismissingReasonId": 0,
"jobId": 0,
"externalId": "string",
"priority": {},
"jobTypeId": 0,
"bookingProviderId": 0,
"modifiedOn": "string"
},
{
"id": 0,
"source": "string",
"createdOn": "string",
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"customerType": {},
"start": "string",
"summary": "string",
"campaignId": 0,
"businessUnitId": 0,
"isFirstTimeClient": true,
"uploadedImages": [
"string"
],
"isSendConfirmationEmail": true,
"status": {},
"dismissingReasonId": 0,
"jobId": 0,
"externalId": "string",
"priority": {},
"jobTypeId": 0,
"bookingProviderId": 0,
"modifiedOn": "string"
}
]
}
}
List Bookings by Tenant
Retrieves a list of bookings | key: listBookingByTenant
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"source": "string",
"createdOn": "string",
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"customerType": {},
"start": "string",
"summary": "string",
"campaignId": 0,
"businessUnitId": 0,
"isFirstTimeClient": true,
"uploadedImages": [
"string"
],
"isSendConfirmationEmail": true,
"status": {},
"dismissingReasonId": 0,
"jobId": 0,
"externalId": "string",
"priority": {},
"jobTypeId": 0,
"bookingProviderId": 0,
"modifiedOn": "string"
},
{
"id": 0,
"source": "string",
"createdOn": "string",
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"customerType": {},
"start": "string",
"summary": "string",
"campaignId": 0,
"businessUnitId": 0,
"isFirstTimeClient": true,
"uploadedImages": [
"string"
],
"isSendConfirmationEmail": true,
"status": {},
"dismissingReasonId": 0,
"jobId": 0,
"externalId": "string",
"priority": {},
"jobTypeId": 0,
"bookingProviderId": 0,
"modifiedOn": "string"
}
]
}
}
List Business Units
Gets a list of business units | key: listBusinessUnits
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"active": true,
"name": "string",
"officialName": "string",
"email": "string",
"currency": "string",
"phoneNumber": "string",
"invoiceHeader": "string",
"invoiceMessage": "string",
"defaultTaxRate": 0,
"authorizationParagraph": "string",
"acknowledgementParagraph": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"materialSku": "string",
"quickbooksClass": "string",
"accountCode": "string",
"franchiseId": "string",
"conceptCode": "string",
"corporateContractNumber": "string",
"tenant": {
"id": 0,
"name": "string",
"accountCode": "string",
"franchiseId": "string",
"conceptCode": "string",
"modifiedOn": "string"
},
"createdOn": "string",
"modifiedOn": "string",
"externalData": [
{
"key": "string",
"value": "string"
}
]
}
]
}
}
List Customer Contacts
Gets a list of contacts for the specified customer | key: listCustomersContact
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Customer ID | The customer ID. | 10978752986 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Modified Before | Return items modified before certain date/time (in UTC) | 2021-01-01T00:00:00Z |
| Modified On Or After | Return items modified on or after certain date/time (in UTC) | 2021-01-01T00:00:00Z |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"type": {},
"value": "string",
"memo": "string",
"modifiedOn": "string",
"phoneSettings": {
"phoneNumber": "string",
"doNotText": true
}
},
{
"id": 0,
"type": {},
"value": "string",
"memo": "string",
"modifiedOn": "string",
"phoneSettings": {
"phoneNumber": "string",
"doNotText": true
}
}
]
}
}
List Customers
Retrieve a list of Customers | key: listCustomers
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"active": true,
"name": "string",
"type": {},
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"balance": 0,
"tagTypeIds": [
0
],
"doNotMail": true,
"doNotService": true,
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"externalData": [
{
"key": "string",
"value": "string"
}
]
},
{
"id": 0,
"active": true,
"name": "string",
"type": {},
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"balance": 0,
"tagTypeIds": [
0
],
"doNotMail": true,
"doNotService": true,
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"externalData": [
{
"key": "string",
"value": "string"
}
]
}
]
}
}
List Installed Equipment
Retrieve a list of installed equipment | key: listInstalledEquipment
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"equipmentId": 0,
"locationId": 0,
"customerId": 0,
"invoiceItemId": 0,
"name": "string",
"installedOn": "string",
"createdOn": "string",
"modifiedOn": "string",
"serialNumber": "string",
"memo": "string",
"manufacturer": "string",
"model": "string",
"cost": 0,
"manufacturerWarrantyStart": "string",
"manufacturerWarrantyEnd": "string",
"serviceProviderWarrantyStart": "string",
"serviceProviderWarrantyEnd": "string",
"tags": [
{
"id": 0,
"ownerId": 0,
"typeId": 0,
"typeName": "string",
"memo": "string",
"color": "string",
"textColor": "string",
"code": "string"
}
]
}
]
}
}
List Installed Equipment Attachments
Retrieve installed Equipment attachments | key: listInstalledEquipmentAttachments
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Path | Installed equipment attachment path | department |
{
"data": {
"type": "Buffer",
"data": [
69,
120,
97,
109,
112,
108,
101,
70,
105,
108,
101
]
}
}
List Invoices
Retrieves a list of invoices | key: listInvoices
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"syncStatus": "string",
"summary": "string",
"referenceNumber": "string",
"invoiceDate": "string",
"dueDate": "string",
"subTotal": "string",
"salesTax": "string",
"salesTaxCode": {
"id": 0,
"name": "string",
"taxRate": 0
},
"total": "string",
"balance": "string",
"invoiceType": {
"id": 0,
"name": "string"
},
"customer": {
"id": 0,
"name": "string"
},
"customerAddress": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"location": {
"id": 0,
"name": "string"
},
"locationAddress": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"businessUnit": {
"id": 0,
"name": "string"
},
"termName": "string",
"createdBy": "string",
"batch": {
"id": 0,
"number": "string",
"name": "string"
},
"depositedOn": "string",
"createdOn": "string",
"modifiedOn": "string",
"adjustmentToId": 0,
"job": {
"id": 0,
"number": "string",
"type": "string"
},
"projectId": 0,
"royalty": {
"status": "string",
"date": "string",
"sentOn": "string",
"memo": "string"
},
"employeeInfo": {
"id": 0,
"name": "string",
"modifiedOn": "string"
},
"commissionEligibilityDate": "string",
"sentStatus": "NotSent",
"reviewStatus": "NeedsReview",
"assignedTo": {
"id": 0,
"name": "string"
},
"items": [
{
"id": 0,
"description": "string",
"quantity": "string",
"cost": "string",
"totalCost": "string",
"inventoryLocation": "string",
"price": "string",
"type": "Service",
"skuName": "string",
"skuId": 0,
"total": "string",
"inventory": true,
"taxable": true,
"generalLedgerAccount": {
"id": 0,
"name": "string",
"number": "string",
"type": "string",
"detailType": "string"
},
"costOfSaleAccount": {
"id": 0,
"name": "string",
"number": "string",
"type": "string",
"detailType": "string"
},
"assetAccount": {
"id": 0,
"name": "string",
"number": "string",
"type": "string",
"detailType": "string"
},
"membershipTypeId": 0,
"itemGroup": {
"rootId": 0,
"name": "string"
},
"displayName": "string",
"soldHours": 0,
"modifiedOn": "string",
"serviceDate": "string",
"order": 0,
"businessUnit": {
"id": 0,
"name": "string"
}
}
],
"customFields": [
{
"name": "string",
"value": "string"
}
]
},
{
"id": 0,
"syncStatus": "string",
"summary": "string",
"referenceNumber": "string",
"invoiceDate": "string",
"dueDate": "string",
"subTotal": "string",
"salesTax": "string",
"salesTaxCode": {
"id": 0,
"name": "string",
"taxRate": 0
},
"total": "string",
"balance": "string",
"invoiceType": {
"id": 0,
"name": "string"
},
"customer": {
"id": 0,
"name": "string"
},
"customerAddress": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"location": {
"id": 0,
"name": "string"
},
"locationAddress": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"businessUnit": {
"id": 0,
"name": "string"
},
"termName": "string",
"createdBy": "string",
"batch": {
"id": 0,
"number": "string",
"name": "string"
},
"depositedOn": "string",
"createdOn": "string",
"modifiedOn": "string",
"adjustmentToId": 0,
"job": {
"id": 0,
"number": "string",
"type": "string"
},
"projectId": 0,
"royalty": {
"status": "string",
"date": "string",
"sentOn": "string",
"memo": "string"
},
"employeeInfo": {
"id": 0,
"name": "string",
"modifiedOn": "string"
},
"commissionEligibilityDate": "string",
"sentStatus": "NotSent",
"reviewStatus": "NeedsReview",
"assignedTo": {
"id": 0,
"name": "string"
},
"items": [
{
"id": 0,
"description": "string",
"quantity": "string",
"cost": "string",
"totalCost": "string",
"inventoryLocation": "string",
"price": "string",
"type": "Service",
"skuName": "string",
"skuId": 0,
"total": "string",
"inventory": true,
"taxable": true,
"generalLedgerAccount": {
"id": 0,
"name": "string",
"number": "string",
"type": "string",
"detailType": "string"
},
"costOfSaleAccount": {
"id": 0,
"name": "string",
"number": "string",
"type": "string",
"detailType": "string"
},
"assetAccount": {
"id": 0,
"name": "string",
"number": "string",
"type": "string",
"detailType": "string"
},
"membershipTypeId": 0,
"itemGroup": {
"rootId": 0,
"name": "string"
},
"displayName": "string",
"soldHours": 0,
"modifiedOn": "string",
"serviceDate": "string",
"order": 0,
"businessUnit": {
"id": 0,
"name": "string"
}
}
],
"customFields": [
{
"name": "string",
"value": "string"
}
]
}
]
}
}
List Job Cancel Reasons
Retrieve a list of job cancel reasons | key: listJobCancelReasons
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"name": "string",
"active": true,
"createdOn": "string",
"modifiedOn": "string"
}
]
}
}
List Jobs
Retrieve a list of jobs | key: listJobs
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"jobNumber": "string",
"projectId": 0,
"customerId": 0,
"locationId": 0,
"jobStatus": "string",
"completedOn": "string",
"businessUnitId": 0,
"jobTypeId": 0,
"priority": "string",
"campaignId": 0,
"summary": "string",
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"appointmentCount": 0,
"firstAppointmentId": 0,
"lastAppointmentId": 0,
"recallForId": 0,
"warrantyId": 0,
"jobGeneratedLeadSource": {
"jobId": 0,
"employeeId": 0
},
"noCharge": true,
"notificationsEnabled": true,
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"tagTypeIds": [
0
],
"leadCallId": 0,
"bookingId": 0,
"soldById": 0,
"externalData": [
{
"key": "string",
"value": "string"
}
],
"customerPo": "string"
},
{
"id": 0,
"jobNumber": "string",
"projectId": 0,
"customerId": 0,
"locationId": 0,
"jobStatus": "string",
"completedOn": "string",
"businessUnitId": 0,
"jobTypeId": 0,
"priority": "string",
"campaignId": 0,
"summary": "string",
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"appointmentCount": 0,
"firstAppointmentId": 0,
"lastAppointmentId": 0,
"recallForId": 0,
"warrantyId": 0,
"jobGeneratedLeadSource": {
"jobId": 0,
"employeeId": 0
},
"noCharge": true,
"notificationsEnabled": true,
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"tagTypeIds": [
0
],
"leadCallId": 0,
"bookingId": 0,
"soldById": 0,
"externalData": [
{
"key": "string",
"value": "string"
}
],
"customerPo": "string"
}
]
}
}
List Locations
Retrieve a list of Locations | key: listLocations
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"customerId": 0,
"active": true,
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"zoneId": 0,
"tagTypeIds": [
0
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"taxZoneId": 0
},
{
"id": 0,
"customerId": 0,
"active": true,
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"zoneId": 0,
"tagTypeIds": [
0
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"taxZoneId": 0
}
]
}
}
List Payments
Retrieve a list of payments | key: listPayments
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"syncStatus": "string",
"referenceNumber": "string",
"date": "string",
"type": "string",
"typeId": "string",
"total": "string",
"unappliedAmount": "string",
"memo": "string",
"customer": {
"id": 0,
"name": "string"
},
"businessUnit": {
"id": 0,
"name": "string"
},
"batch": {
"id": 0,
"number": "string",
"name": "string"
},
"createdBy": "string",
"generalLedgerAccount": {
"id": 0,
"name": "string",
"number": "string",
"type": "string",
"detailType": "string"
},
"appliedTo": [
{
"appliedId": 0,
"appliedTo": 0,
"appliedAmount": "string",
"appliedOn": "string",
"appliedBy": "string",
"appliedToReferenceNumber": "string"
}
],
"customFields": [
{
"name": "string",
"value": "string"
}
],
"authCode": "string",
"checkNumber": "string",
"modifiedOn": "string",
"createdOn": "string"
}
]
}
}
List Projects
Retrieve a list of Projects | key: listProjects
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"number": "string",
"name": "string",
"summary": "string",
"status": "string",
"statusId": 0,
"subStatus": "string",
"subStatusId": 0,
"customerId": 0,
"locationId": 0,
"projectManagerIds": [
0
],
"businessUnitIds": [
0
],
"startDate": "string",
"targetCompletionDate": "string",
"actualCompletionDate": "string",
"modifiedOn": "string",
"createdOn": "string",
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"jobIds": [
0
]
},
{
"id": 0,
"number": "string",
"name": "string",
"summary": "string",
"status": "string",
"statusId": 0,
"subStatus": "string",
"subStatusId": 0,
"customerId": 0,
"locationId": 0,
"projectManagerIds": [
0
],
"businessUnitIds": [
0
],
"startDate": "string",
"targetCompletionDate": "string",
"actualCompletionDate": "string",
"modifiedOn": "string",
"createdOn": "string",
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"jobIds": [
0
]
}
]
}
}
List Technicians
Retrieve a list of technicians | key: listTechnicians
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"userId": 0,
"name": "string",
"roleIds": [
0
],
"businessUnitId": 0,
"mainZoneId": 0,
"zoneIds": [
0
],
"createdOn": "string",
"modifiedOn": "string",
"email": "string",
"phoneNumber": "string",
"loginName": "string",
"home": {
"street": "string",
"unit": "string",
"country": "string",
"city": "string",
"state": "string",
"zip": "string",
"streetAddress": "string",
"latitude": 0,
"longitude": 0
},
"dailyGoal": 0,
"isManagedTech": true,
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"active": true,
"aadUserId": "string",
"burdenRate": 0,
"team": "string",
"jobFilter": {}
},
{
"id": 0,
"userId": 0,
"name": "string",
"roleIds": [
0
],
"businessUnitId": 0,
"mainZoneId": 0,
"zoneIds": [
0
],
"createdOn": "string",
"modifiedOn": "string",
"email": "string",
"phoneNumber": "string",
"loginName": "string",
"home": {
"street": "string",
"unit": "string",
"country": "string",
"city": "string",
"state": "string",
"zip": "string",
"streetAddress": "string",
"latitude": 0,
"longitude": 0
},
"dailyGoal": 0,
"isManagedTech": true,
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"active": true,
"aadUserId": "string",
"burdenRate": 0,
"team": "string",
"jobFilter": {}
}
]
}
}
List User Roles
Gets a list of user roles | key: listUserRoles
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Custom Query Params | Custom fields filter | key1=value1 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | If true, fetch all records, if false, will use the pageSize and page parameters | false |
| Include Total | Include total count of records. If fetchAll is true, this will be ignored. | false |
| Page | The page number to filter by | 1 |
| Page Size | How many records to return (50 by default) | 50 |
| Sort | Applies sorting by the specified field:'?sort=+FieldName' for ascending order,'?sort=-FieldName' for descending order. | +FieldName |
{
"data": {
"page": 0,
"pageSize": 0,
"hasMore": true,
"totalCount": 0,
"data": [
{
"id": 0,
"active": true,
"name": "string",
"createdOn": "string",
"employeeType": "Employee"
}
]
}
}
Raw Request
Send raw HTTP request to ServiceDesk Plus | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enable this to log the request and response | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/jobs), The base URL is already included (https://api.servicetitan.io/jpm/v2/{YOUR-TENANT}/). For example, to connect to https://api.servicetitan.io/jpm/v2/{YOUR-TENANT}/jobs, only /jobs is entered in this field. e.g. /jobs | /jobs |
| URL Type | The URL type to connect to. For example, jpm, crm, accounting, etc. | jpm |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Unassign Technician to Appointment
Un-assigns the list of technicians from the appointment | key: unassignTechnicians
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Job Appointment ID | ID of the job appointment | 1234567890 |
| Technician IDs | Unassign these technicians to the appointment. | 1088 |
{
"data": {
"id": 0,
"jobId": 0,
"appointmentNumber": "string",
"start": "string",
"end": "string",
"arrivalWindowStart": "string",
"arrivalWindowEnd": "string",
"status": {},
"specialInstructions": "string",
"createdOn": "string",
"modifiedOn": "string"
}
}
Update Booking
Update a booking | key: updateBooking
| Input | Notes | Example |
|---|---|---|
| Address | Address of the booking | |
| Booking ID | The ID of the booking. | 10978752986 |
| Booking Provider | The ID of the booking provider. | 10978752986 |
| Business Unit ID | ID of the booking's business unit | 10978752986 |
| Campaign ID | ID of the booking's campaign | 10978752986 |
| Connection | ||
| Customer Type | Type of the customer | |
| Debug Request | Enabling this flag will log out the current request. | false |
| External ID | External ID of booking | 10978752986 |
| Is First Time Client | True if first time client | |
| Job Type ID | ID of the booking's job type | 10978752986 |
| Name | Name of the customer | Test Source |
| Priority | Booking priority | |
| Source | The source of the booking provider | Test Source |
| Start | Start date/time (in UTC) | 2021-01-01T00:00:00Z |
| Summary | Summary of the booking | A summary related to the invoice. |
| Uploaded Images | Uploaded images |
{
"data": {
"id": 0,
"source": "string",
"createdOn": "string",
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"customerType": {},
"start": "string",
"summary": "string",
"campaignId": 0,
"businessUnitId": 0,
"isFirstTimeClient": true,
"uploadedImages": [
"string"
],
"isSendConfirmationEmail": true,
"status": {},
"dismissingReasonId": 0,
"jobId": 0,
"externalId": "string",
"priority": {},
"jobTypeId": 0,
"bookingProviderId": 0,
"modifiedOn": "string"
}
}
Update Customer
Update a customer | key: updateCustomer
| Input | Notes | Example |
|---|---|---|
| Active | Whether the customer is active | |
| Address | Address of the booking | |
| Connection | ||
| Customer ID | The customer ID. | 10978752986 |
| Custom Fields | Custom fields for the request | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Do Not Mail | Customer has been flagged as “do not mail” | |
| Do Not Service | Customer has been flagged as “do not service” | |
| External Data | External data to attach to the request. | |
| Name | Name of the customer | Test Source |
| Tag Type IDs | A list of tags ID's | 123 |
| Customer Type | Type of the customer |
{
"data": {
"id": 0,
"active": true,
"name": "string",
"type": {},
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"balance": 0,
"tagTypeIds": [
0
],
"doNotMail": true,
"doNotService": true,
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"externalData": [
{
"key": "string",
"value": "string"
}
],
"locations": [
{
"taxZoneId": 0,
"id": 0,
"customerId": 0,
"active": true,
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"zoneId": 0,
"tagTypeIds": [
0
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"contacts": [
{
"id": 0,
"type": {},
"value": "string",
"memo": "string"
}
]
}
],
"contacts": [
{
"id": 0,
"type": {},
"value": "string",
"memo": "string"
}
]
}
}
Update Customer Contact
Updates a contact on the customers | key: updateCustomerContact
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Customer Contact ID | The customer contact ID. | 10978752986 |
| Customer ID | The customer ID. | 10978752986 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Memo | Short description about this contact, for example, “work #” or “Owner’s daughter - Kelly” | Payment for services rendered. |
| Customer Contact Type | Type of the customer contact | |
| Customer Contact Type Value | The email, phone number, or fax number for the contact | 1234567890 |
{
"data": {
"id": 0,
"type": {},
"value": "string",
"memo": "string",
"modifiedOn": "string",
"phoneSettings": {
"phoneNumber": "string",
"doNotText": true
}
}
}
Update Installed Equipment
Update installed equipment by ID | key: updateInstalledEquipment
| Input | Notes | Example |
|---|---|---|
| Attachments | List of attachments | |
| Connection | ||
| Cost | Cost of the installed equipment | 100.00 |
| Custom Fields | The custom fields of the installed equipment | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Installed Equipment ID | ID of the installed equipment | 1234567890 |
| Installed On | The date the equipment was installed | 2021-01-01T00:00:00Z |
| Manufacturer | Manufacturer of the installed equipment | Test Manufacturer |
| Manufacturer Warranty End | Manufacturer warranty end date | 2021-01-01T00:00:00Z |
| Manufacturer Warranty Start | Manufacturer warranty start date | 2021-01-01T00:00:00Z |
| Memo | The memo of the installed equipment | Payment for services rendered. |
| Model | Model of the installed equipment | Test Model |
| Name | The name of the installed equipment | Test Source |
| Serial Number | Serial number of the installed equipment | 1234567890 |
| Service Provider Warranty End | Service Provider Warranty End date | 2021-01-01T00:00:00Z |
| Service Provider Warranty Start | Service Provider Warranty Start date | 2021-01-01T00:00:00Z |
| Tag Type IDs | A list of tags ID's | 123 |
{
"data": {
"id": 0,
"equipmentId": 0,
"locationId": 0,
"customerId": 0,
"invoiceItemId": 0,
"name": "string",
"installedOn": "string",
"createdOn": "string",
"modifiedOn": "string",
"serialNumber": "string",
"memo": "string",
"manufacturer": "string",
"model": "string",
"cost": 0,
"manufacturerWarrantyStart": "string",
"manufacturerWarrantyEnd": "string",
"serviceProviderWarrantyStart": "string",
"serviceProviderWarrantyEnd": "string",
"tags": [
{
"id": 0,
"ownerId": 0,
"typeId": 0,
"typeName": "string",
"memo": "string",
"color": "string",
"textColor": "string",
"code": "string"
}
],
"customFields": [
{
"id": 0,
"typeId": 0,
"name": "string",
"value": "string"
}
],
"attachments": [
{
"alias": "string",
"fileName": "string",
"type": {},
"url": "string"
}
]
}
}
Update Invoice
Update Invoice | key: updateInvoice
| Input | Notes | Example |
|---|---|---|
| Assigned To ID | The ID of the user the invoice is assigned to. | 10978752986 |
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Export ID | Gets or sets the identifier when exported. | 6B29FC40-CA47-1067-B31D-00DD010662DA21323 |
| Invoiced On | The date the invoice was invoiced on. | 2021-01-01T00:00:00Z |
| Invoice ID | The ID of the invoice. | 10978752986 |
| Items | The items of the invoice. | |
| Number | The invoice number. | 10978752986 |
| Payments | The payments of the invoice. | |
| Review Status | The review status of the invoice. | |
| Royalty Date | The royalty date of the invoice. | 2021-01-01T00:00:00Z |
| Royalty Memo | The royalty sent date of the invoice. | Payment for services rendered. |
| Royalty Sent On | The royalty sent date of the invoice. | 2021-01-01T00:00:00Z |
| Royalty Status | The royalty status of the invoice. | |
| Subtotal | The subtotal of the invoice. | 100.00 |
| Summary | The summary of the invoice. | A summary related to the invoice. |
| Tax | The tax of the invoice. | 100.00 |
| Type ID | The ID of the type of the payment. | 0 |
{
"data": {}
}
Update Invoice Custom Fields
Update custom fields for specified Invoices | key: updateInvoiceCustomFields
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Operations | The operations to perform on the invoice. |
{
"data": {}
}
Update Invoice Items
Update invoice items | key: updateInvoiceItems
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Cost | The cost of the SKU. | 2.0 |
| Debug Request | Enabling this flag will log out the current request. | false |
| Description | The description of the SKU. | A test SKU |
| Duration Billing ID | The duration billing ID of the SKU. | 10978752986 |
| ID | The ID. | 10978752986 |
| Installed On | The date the SKU was installed on. | 2021-01-01T00:00:00Z |
| Inventory Location ID | The inventory location ID of the SKU. | 10978752986 |
| Inventory Warehouse Name | The inventory warehouse name of the SKU. | Warehouse |
| Invoice ID | The ID of the invoice. | 10978752986 |
| Is Add On | Is the SKU an add on. | |
| Item Group Name | The item group name of the SKU. | Test Group |
| Item Group Root ID | The item group root ID of the SKU. | 10978752986 |
| Quantity | The quantity of the SKU. | 2 |
| Signature | The signature of the SKU. | An example signature. |
| Skip Updating Membership Prices | Skip updating membership prices. | |
| SKU ID | The ID of the SKU. | 10978752986 |
| SKU Name | The name of the SKU. | Test SKU |
| Technician Acknowledgement Signature | The technician acknowledgement signature of the SKU. | Test Signature |
| Technician ID | The ID of the technician. | 10978752986 |
| Unit Price | The unit price of the SKU. | 2.0 |
{
"data": {}
}
Update Job
Update a job | key: updateJob
| Input | Notes | Example |
|---|---|---|
| Business Unit ID | ID of the job's business unit | 10978752986 |
| Campaign ID | ID of the job's campaign | 10978752986 |
| Connection | ||
| Customer ID | The customer ID. | 10978752986 |
| Customer PO | Customer PO | |
| Custom Fields | Custom fields for the job | |
| Debug Request | Enabling this flag will log out the current request. | false |
| External Data | External data to attach to the request. | |
| Job Generated Lead Source | Object that contains: JobId: ID of the job from which this job was generated EmployeeId: ID of the office user or technician | |
| Job ID | The job ID. | 10978752986 |
| Job Type ID | ID of the job's type | 10978752986 |
| Location ID | The ID of the location. | 10978752986 |
| Priority | Priority of the job | |
| Should Update Invoice Items | If set to true, update the business unit of invoice items on job's invoice | |
| Summary | Job summary | A summary related to the invoice. |
| Tag Type IDs | Tag type IDs for the job | 123 |
{
"data": {
"id": 0,
"jobNumber": "string",
"projectId": 0,
"customerId": 0,
"locationId": 0,
"jobStatus": "string",
"completedOn": "string",
"businessUnitId": 0,
"jobTypeId": 0,
"priority": "string",
"campaignId": 0,
"summary": "string",
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"appointmentCount": 0,
"firstAppointmentId": 0,
"lastAppointmentId": 0,
"recallForId": 0,
"warrantyId": 0,
"jobGeneratedLeadSource": {
"jobId": 0,
"employeeId": 0
},
"noCharge": true,
"notificationsEnabled": true,
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"tagTypeIds": [
0
],
"leadCallId": 0,
"bookingId": 0,
"soldById": 0,
"externalData": [
{
"key": "string",
"value": "string"
}
],
"customerPo": "string"
}
}
Update Location
Update a location | key: updateLocation
| Input | Notes | Example |
|---|---|---|
| Active | If false, the location will be marked as inactive | |
| Address | The address of the location | |
| Connection | ||
| Customer ID | The customer ID associated with the location | 10978752986 |
| Custom Fields | Custom fields for the request | |
| Debug Request | Enabling this flag will log out the current request. | false |
| External Data | External data to attach to the request. | |
| Location ID | The ID of the location. | 10978752986 |
| Name | The name of the location | Test Source |
| Tag Type IDs | A list of tags ID's | 123 |
| Tax Zone ID | ID of the location tax zone | 1088 |
{
"data": {
"id": 0,
"customerId": 0,
"active": true,
"name": "string",
"address": {
"street": "string",
"unit": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"createdOn": "string",
"createdById": 0,
"modifiedOn": "string",
"mergedToId": 0,
"zoneId": 0,
"tagTypeIds": [
0
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"taxZoneId": 0
}
}
Update Payment
Update a specified payment | key: updatePayment
| Input | Notes | Example |
|---|---|---|
| Auth Code | The authorization code for the payment. | 6B29FC40-CA47-1067-B31D-00DD010662DA21323 |
| Check Number | The check number for the payment. | 6B29FC40-CA47-1067-B31D-00DD010662DA21323 |
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Export ID | Gets or sets the identifier when exported. | 6B29FC40-CA47-1067-B31D-00DD010662DA21323 |
| Memo | The memo of the payment. | Payment for services rendered. |
| Paid On | The date the payment was paid on. | 2021-01-01T00:00:00Z |
| Payment ID | The ID of the payment. | 10978752986 |
| Splits | The splits of the payment. | |
| Status | The status of the payment. | |
| Type ID | The ID of the type of the payment. | 0 |
{
"data": {
"id": 0,
"typeId": 0,
"active": true,
"memo": "string",
"paidOn": "string",
"authCode": "string",
"checkNumber": "string",
"exportId": "string",
"transactionStatus": {},
"status": {},
"splits": [
{
"invoiceId": 0,
"amount": 0
}
]
}
}
Update Payment Custom Fields
Update custom fields for specified payments | key: updatePaymentCustomFields
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Operations | The operations to perform on the payment. |
{
"data": {}
}
Update Project
Update a project | key: updateProject
| Input | Notes | Example |
|---|---|---|
| Actual Completion Date | Actual completion date of the project | 2021-01-01T00:00:00Z |
| Connection | ||
| Custom Fields | Custom fields for the project | |
| Debug Request | Enabling this flag will log out the current request. | false |
| External Data | Optional model that contains a list of external data items that should be attached to this project. | |
| Jobs IDs | IDs of the project's jobs | 1088 |
| Name | Name of the project | Test Source |
| Project ID | ID of the project to update | 10978752986 |
| Project Manager IDs | IDs of the project's managers | 1088 |
| Start | Start date of the project | 2021-01-01T00:00:00Z |
| Status ID | Project status id | 1088 |
| Sub Status ID | Project sub status id | 1088 |
| Summary | Summary of the project | A summary related to the invoice. |
| Target Completion Date | Target completion date of the project | 2021-01-01T00:00:00Z |
{
"data": {
"id": 0,
"number": "string",
"name": "string",
"summary": "string",
"status": "string",
"statusId": 0,
"subStatus": "string",
"subStatusId": 0,
"customerId": 0,
"locationId": 0,
"projectManagerIds": [
0
],
"businessUnitIds": [
0
],
"startDate": "string",
"targetCompletionDate": "string",
"actualCompletionDate": "string",
"modifiedOn": "string",
"createdOn": "string",
"customFields": [
{
"typeId": 0,
"name": "string",
"value": "string"
}
],
"externalData": [
{
"key": "string",
"value": "string"
}
],
"jobIds": [
0
]
}
}
Update Technician
Update a technician | key: updateTechnician
| Input | Notes | Example |
|---|---|---|
| Azure Active Directory User Id | Azure Active Directory User Id | 6B29FC40-CA47-1067-B31D-00DD010662DA |
| Biography | Biography of the technician | Biography |
| Burden Rate | Burden rate (hourly) | 5.6 |
| Business Unit ID | The ID of the business unit to which the technician will be assigned | 10978752986 |
| Connection | ||
| Custom Fields | Custom fields for the technician | |
| Daily Goal | Daily revenue goal | 5.6 |
| Debug Request | Enabling this flag will log out the current request. | false |
Technician's email address | test@technician.us | |
| Address | The home address of the technician | |
| Job Filter | Upcoming appointment visibility | |
| Job History Date Filter | Appointment history visibility | |
| License Type | License type | |
| Login Username | Technician's username | technician_us |
| Memo | Memo for the technician | Payment for services rendered. |
| Name | The name of the technician | Test Source |
| Phone Number | Technician's phone number | 1234567890 |
| Positions | List of company positions | |
| Role ID | User role Id | 7 |
| Team | Team name | Test Team |
| Technician ID | The ID of the technician to update | 10978752986 |
{
"data": {
"id": 0
}
}