Overview
Configuration is provided for establishing connections with ServiceTitan service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to ServiceTitan REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select ServiceTitan.
Step 3. Set [Environment] to the desired environment in the Server host parameter. For more details about Environment visit https://developer.servicetitan.io/docs/get-going-environments/. Then provide client_id, client_secret, tenant and ST_APP_Key in the grid below for the client_id, client_secret, tenant and ST APP Key parameters parameters
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your ServiceTitan instance.
In this guide, we will show how to read data from the ServiceTitan service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select ServiceTitan connection from the combo. Select from available ServiceTitan resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select ServiceTitan resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from ServiceTitan service.
In this guide, we will show how to write data to the ServiceTitan service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select ServiceTitan connection from the combo. Also, select resource action and ServiceTitan resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the ServiceTitan resource.
Configuration
Base URL address: https://api.servicetitan.io.
- Auth
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client_id.
- client_secret: Required. Specify client_secret.
- tenant: Required. Specify tenant.
- ST_APP_Key: Required. Specify ST-App-Key.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}} -
ST-App-Key:
{{=connection.user.ST_APP_Key}}
Documentation: https://developer.servicetitan.io/docs/get-going-first-api-call/.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/invoices.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=Invoices_GetList.
- [Create] action
-
Endpoint URL address:
/invoices.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=Invoices_CreateAdjustmentInvoice.
- [Update] action
-
Endpoint URL address:
/invoices/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=Invoices_UpdateInvoice.
- id
A key field. Data type: DT_I8
- syncStatus
Template: ShortText.
- summary
Template: ShortText.
- referenceNumber
Template: ShortText.
- number
Template: ShortText.
- invoiceDate
Template: DateTime.
- invoicedOn
Template: DateTime.
- dueDate
Template: DateTime.
- royaltyMemo
Template: ShortText.
- royaltySentOn
Template: DateTime.
- royaltyDate
Template: DateTime.
- subTotal
Data type: DT_R8
- salesTax
Data type: DT_R8
- salesTaxCode
Template: ShortText.
- exportId
Data type: DT_I8
- total
Data type: DT_R8
- balance
Data type: DT_R8
- customer
Template: basicInfoT.
- customerAddress
Template: addressT.
- locationAddress
Template: addressT.
- businessUnit
Template: basicInfoT.
- termName
Template: ShortText.
- createdBy
Template: ShortText.
- batch
Template: basicInfoT.
- modifiedOn
Template: DateTime.
- adjustmentToId
Data type: DT_I8
- job
Field components:
-
Uses template:
ShortText. - Contains the following components: id, number, type.
-
Uses template:
- projectId
Data type: DT_I8
- royalty
Field components:
-
Uses template:
ShortText. - Contains the following components: status, date, sentOn, memo.
-
Uses template:
- employeeInfo
Template: ShortText.
- commissionEligibilityDate
Template: DateTime.
- items
Field components:
- An array.
-
Uses template:
itemT.
- payments
Field components:
- An array.
- Contains the following components: id, settlementStatus, settlementDate.
- royaltyStatus
Template: ShortText.
- [External]
-
The external fields URL address:
/invoices. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression. The value is sent to/invoices/custom-fieldsaddress.
Based on resource template Accounting.
- [Create] action
-
Endpoint URL address:
/invoices/markasexported.
The result is extracted from:{{=undefined}}.The following request parameters will be automatically processed:
-
application/json:
{{=batch}}
-
application/json:
- invoiceId
Data type: DT_I8
- externalId
Data type: DT_I8
- externalMessage
Template: LongText.
Based on resource template Accounting.
- [Update] action
-
Endpoint URL address:
/invoices/{{=item.invoiceId}}/items.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=Invoices_UpdateInvoiceItems.
- [Delete] action
-
Endpoint URL address:
/invoices/{{=item.invoiceId}}/items/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=Invoices_DeleteInvoiceItem.
The resource includes the fields from the itemT template.
- invoiceId
A key field. Data type: DT_I8
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/inventory-bills.
The result is extracted from:{{=response}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=InventoryBills_GetList.
- id
A key field. Data type: DT_I8
- purchaseOrderId
Data type: DT_I8
- syncStatus
Template: ShortText.
- referenceNumber
Template: ShortText.
- vendorNumber
Template: ShortText.
- summary
Template: ShortText.
- billDate
Template: DateTime.
- billAmount
Template: ShortText.
- taxAmount
Data type: DT_R8
- shippingAmount
Data type: DT_R8
- createdBy
Template: ShortText.
- createdOn
Template: DateTime.
- termName
Template: ShortText.
- dueDate
Template: DateTime.
- shipToDescription
Template: ShortText.
- batch
Template: basicInfoT.
- businessUnit
Template: basicInfoT.
- vendor
Template: basicInfoT.
- shipTo
Template: addressT.
- items
Field components:
- An array.
-
Uses template:
itemT.
- jobId
Template: ShortText.
- jobNumber
Template: ShortText.
- [External]
-
The external fields URL address:
/inventory-bills. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression. The value is sent to/inventory-bills/custom-fieldsaddress.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/payments.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=Payments_GetList.
- [Create] action
-
Endpoint URL address:
/payments.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=Payments_Create.
- [Update] action
-
Endpoint URL address:
/payments/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=Payments_Update.
- id
A key field. Data type: DT_I8
- syncStatus
Template: ShortText.
- referenceNumber
Template: ShortText.
- date
Template: DateTime.
- paidOn
Template: DateTime.
- type
Template: ShortText.
- typeId
Data type: DT_I8
- exportId
Data type: DT_I8
- total
Data type: DT_R8
- unappliedAmount
Data type: DT_R8
- memo
Template: ShortText.
- transactionStatus
Template: ShortText.
- customer
Template: basicInfoT.
- batch
Template: basicInfoT.
- createdBy
Template: ShortText.
- generalLedgerAccount
Template: generalAccountT.
- appliedTo
Field components:
- An array.
- Contains the following components: appliedTo, appliedAmount, appliedOn, appliedBy.
- splits
Field components:
- An array.
- Contains the following components: invoiceId, amount.
- authCode
Template: ShortText.
- checkNumber
Template: ShortText.
- status
Template: ShortText. The value is sent to
/payments/statusaddress.
- [External]
-
The external fields URL address:
/payments. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression. The value is sent to/payments/custom-fieldsaddress.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/payment-terms/{{=parameters.paymentTermId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- paymentTermId: Required. Please specify the payment term identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=PaymentTerms_GetPaymentTermModel.
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- dueDayType
Template: ShortText.
- dueDay
Template: ShortText.
- isCustomerDefault
Data type: DT_BOOL
- isVendorDefault
Data type: DT_BOOL
- active
Data type: DT_BOOL
- inUse
Data type: DT_BOOL
- paymentTermPenaltyModel
Template: paymentTermPenaltyModelT.
- paymentTermDiscountModel
Template: paymentTermDiscountModelT.
- interestSettings
Template: interestSettingsT.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/payment-types.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=PaymentTypes_GetList.
- [Read single] action
-
Endpoint URL address:
/payment-types/{{=parameters.id}}.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- id: Required. Please specify the payment type identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=PaymentTypes_Get.
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- modifiedOn
Template: DateTime. A read-only field.
Based on resource template Accounting.
- [Read] action
-
Endpoint URL address:
/tax-zones.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-accounting-v2&operation=TaxZones_GetList.
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- color
Data type: DT_I4
- isTaxRateSeparated
Data type: DT_BOOL
- isMultipleTaxZone
Data type: DT_BOOL
- rates
Field components:
- An array.
- Contains the following components: id, taxName, taxBaseType, taxRate, salesTaxItem.
- createdOn
Template: DateTime.
- active
Data type: DT_BOOL
Based on resource template CRM.
- [Read] action
-
Endpoint URL address:
{{=parameters.get('booking_provider') ? '/booking-provider/' + parameters.booking_provider : ''}}/bookings.The action has the following user-defined parameters:
- booking_provider: Please specify the booking provider identifier. Optional.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Bookings_GetList2.
- [Read single] action
-
Endpoint URL address:
{{=parameters.get('booking_provider') ? '/booking-provider/' + parameters.booking_provider : ''}}/bookings/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- booking_provider: Please specify the booking provider identifier. Optional.
- id: Required. Please specify the booking identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Bookings_GetForProvider.
- [Create] action
-
Endpoint URL address:
/booking-provider/{{=parameters.booking_provider}}/bookings.The action has the following user-defined parameters:
- booking_provider: Required. Please specify the booking provider identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2.
- [Update] action
-
Endpoint URL address:
/booking-provider/{{=parameters.booking_provider}}/bookings/{{=item.id}}.The action has the following user-defined parameters:
- booking_provider: Required. Please specify the booking provider identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2.
- id
A key field. Data type: DT_I8
- source
Template: ShortText.
- createdOn
Template: DateTime.
- name
Template: ShortText.
- address
Template: addressT.
- customerType
Template: ShortText.
- start
Template: ShortText.
- summary
Template: ShortText.
- campaignId
Data type: DT_I8
- businessUnitId
Data type: DT_I8
- isFirstTimeClient
Data type: DT_BOOL
- uploadedImages
Template: LongText. A composite field.
- isSendConfirmationEmail
Data type: DT_BOOL
- status
Template: ShortText.
- dismissingReasonId
Data type: DT_I8
- jobId
Data type: DT_I8
- externalId
Data type: DT_I8
- priority
Template: ShortText.
- jobTypeId
Data type: DT_I8
- bookingProviderId
Data type: DT_I8
- modifiedOn
Template: DateTime.
- contacts
The value is gathered from
{{=parameters.get('booking_provider') ? '/booking-provider/' + parameters.booking_provider : ''}}/bookings/{{=item.id}}/contactsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
contactT.
Based on resource template CRM.
- [Read] action
-
Endpoint URL address:
/booking-provider/{{=parameters.booking_provider}}/bookings/{{=parameters.booking_id}}/contacts.The action has the following user-defined parameters:
- booking_provider: Required. Please specify the booking provider identifier
- booking_id: Required. Please specify the booking identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Bookings_GetContactList2.
- [Create] action
-
Endpoint URL address:
/booking-provider/{{=parameters.booking_provider}}/bookings/{{=parameters.booking_id}}/contacts.The action has the following user-defined parameters:
- booking_provider: Required. Please specify the booking provider identifier
- booking_id: Required. Please specify the booking identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Bookings_CreateContact.
- [Update] action
-
Endpoint URL address:
/booking-provider/{{=parameters.booking_provider}}/bookings/{{=parameters.booking_id}}/contacts/{{=item.id}}.The action has the following user-defined parameters:
- booking_provider: Required. Please specify the booking provider identifier
- booking_id: Required. Please specify the booking identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Bookings_UpdateBookingContact.
- [Delete] action
-
Endpoint URL address:
/booking-provider/{{=parameters.booking_provider}}/bookings/{{=parameters.booking_id}}/contacts/{{=item.id}}.The action has the following user-defined parameters:
- booking_provider: Required. Please specify the booking provider identifier
- booking_id: Required. Please specify the booking identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Bookings_DeleteContact.
The resource includes the fields from the contactT template.
Based on resource template CRM.
- [Update] action
-
Endpoint URL address:
/tags.
The action uses PUT method.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=BulkTags_AddTags.
- [Delete] action
-
Endpoint URL address:
/tags.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=BulkTags_RemoveTags.
- customerIds
Template: LongText. Before setting, the value is processed with
{{=value.split(',')}}expression.- tagTypeIds
Template: LongText. Before setting, the value is processed with
{{=value.split(',')}}expression.
Based on resource template CRM.
- [Read] action
-
Endpoint URL address:
/customers.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Customers_GetList.
- [Create] action
-
Endpoint URL address:
/customers.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Customers_Create.
- [Update] action
-
Endpoint URL address:
/customers/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Customers_Update.
- id
A key field. Data type: DT_I8
- active
Data type: DT_BOOL
- name
Template: ShortText.
- type
Template: LongText. A composite field.
- balance
Data type: DT_R8
- doNotMail
Data type: DT_BOOL
- doNotService
Data type: DT_BOOL
- createdOn
Template: DateTime.
- createdById
Data type: DT_I8
- modifiedOn
Template: DateTime.
- mergedToId
Data type: DT_I8
- locations
Field components:
- An array.
- Contains the following components: name, address, contacts, customFields.
- address
Template: addressT.
- contacts
The value is gathered from
/customers/{{=item.id}}/contactsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
contactT.
- notes
The value is gathered from
/customers/{{=item.id}}/notesaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
noteT.
- [External]
-
The external fields URL address:
/customers. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression.
Based on resource template CRM.
- [Read] action
-
Endpoint URL address:
/customers/contacts.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Customers_GetModifiedContactsList.
- [Read single] action
-
Endpoint URL address:
/customers/{{=parameters.customer_id}}/contacts.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- customer_id: Required. Please specify the customer identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Customers_GetContactList.
- [Create] action
-
Endpoint URL address:
/customers/{{=parameters.customer_id}}/contacts.The action has the following user-defined parameters:
- customer_id: Required. Please specify the customer identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Customers_CreateContact.
- [Update] action
-
Endpoint URL address:
/customers/{{=parameters.customer_id}}/contacts/{{=item.id}}.The action has the following user-defined parameters:
- customer_id: Required. Please specify the customer identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Customers_UpdateContact.
- [Delete] action
-
Endpoint URL address:
/customers/{{=parameters.customer_id}}/contacts/{{=item.id}}.The action has the following user-defined parameters:
- customer_id: Required. Please specify the customer identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Customers_DeleteContact.
The resource includes the fields from the contactT template.
Based on resource template CRM.
- [Read] action
-
Endpoint URL address:
/customers/{{=parameters.customer_id}}/notes.The action has the following user-defined parameters:
- customer_id: Required. Please specify the customer identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Customers_GetNotes.
- [Create] action
-
Endpoint URL address:
/customers/{{=parameters.customer_id}}/notes.The action has the following user-defined parameters:
- customer_id: Required. Please specify the customer identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Customers_CreateNote.
The resource includes the fields from the noteT template.
Based on resource template CRM.
- [Read] action
-
Endpoint URL address:
/leads.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Leads_GetList.
- [Read single] action
-
Endpoint URL address:
/leads/{{=parameters.lead_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- lead_id: Required. Please specify the lead identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Leads_Get.
- [Create] action
-
Endpoint URL address:
/leads.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Leads_Create.
- [Update] action
-
Endpoint URL address:
/leads/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Leads_Update.
- id
A key field. Data type: DT_I8
- status
Template: ShortText.
- customerId
Data type: DT_I8
- locationId
Data type: DT_I8
- businessUnitId
Data type: DT_I4
- jobTypeId
Data type: DT_I8
- priority
Template: ShortText.
- campaignId
Data type: DT_I8
- summary
Template: ShortText.
- callReasonId
Data type: DT_I8
- followUpDate
Template: DateTime.
- createdOn
Template: DateTime. A read-only field.
- createdById
Data type: DT_I8
- modifiedOn
Template: ShortText.
- tagTypeIds
Template: LongText. A composite field.
- notes
The value is gathered from
/leads/{{=item.id}}/notesaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
noteT.
Based on resource template CRM.
- [Read] action
-
Endpoint URL address:
/leads/{{=parameters.lead_id}}/notes.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- lead_id: Required. Please specify the lead identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Leads_GetNotes.
- [Create] action
-
Endpoint URL address:
/leads/{{=parameters.lead_id}}/notes.The action has the following user-defined parameters:
- lead_id: Required. Please specify the lead identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Leads_CreateNote.
The resource includes the fields from the noteT template.
Based on resource template CRM.
- [Read] action
-
Endpoint URL address:
/locations.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Locations_GetList.
- [Read single] action
-
Endpoint URL address:
/locations/{{=parameters.location_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- location_id: Required. Please specify the location identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Locations_Get.
- [Create] action
-
Endpoint URL address:
/locations.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Locations_Create.
- [Update] action
-
Endpoint URL address:
/locations/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Locations_Update.
- id
A key field. Data type: DT_I8
- customerId
Data type: DT_I8
- active
Data type: DT_BOOL
- name
Template: ShortText.
- address
Template: addressT.
- createdOn
Template: ShortText.
- createdById
Data type: DT_I8
- modifiedOn
Template: ShortText.
- mergedToId
Data type: DT_I8
- taxZoneId
Data type: DT_I8
- contacts
The value is gathered from
/locations/{{=item.id}}/contactsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
contactT.
- notes
The value is gathered from
/locations/{{=item.id}}/notesaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
noteT.
- [External]
-
The external fields URL address:
/locations. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression.
Based on resource template CRM.
- [Read] action
-
Endpoint URL address:
/locations/contacts.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Locations_GetLocationsContactsList.
- [Read single] action
-
Endpoint URL address:
/locations/{{=parameters.location_id}}/contacts.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- location_id: Required. Please specify the location identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Locations_GetContactList.
- [Create] action
-
Endpoint URL address:
/locations/{{=parameters.location_id}}/contacts.The action has the following user-defined parameters:
- location_id: Required. Please specify the location identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Locations_CreateContact.
- [Update] action
-
Endpoint URL address:
/locations/{{=parameters.location_id}}/contacts/{{=item.id}}.The action has the following user-defined parameters:
- location_id: Required. Please specify the location identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Locations_UpdateContact.
- [Delete] action
-
Endpoint URL address:
/locations/{{=parameters.location_id}}/contacts/{{=item.id}}.The action has the following user-defined parameters:
- location_id: Required. Please specify the location identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Locations_DeleteContact.
The resource includes the fields from the contactT template.
Based on resource template CRM.
- [Read] action
-
Endpoint URL address:
/locations/{{=parameters.location_id}}/notes.The action has the following user-defined parameters:
- location_id: Required. Please specify the location identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Locations_GetNotes.
- [Create] action
-
Endpoint URL address:
/locations/{{=parameters.location_id}}/notes.The action has the following user-defined parameters:
- location_id: Required. Please specify the location identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-crm-v2&operation=Locations_CreateNote.
The resource includes the fields from the noteT template.
Based on resource template Dispatcher.
- [Read] action
-
Endpoint URL address:
/appointment-assignments.
- id
A key field. Data type: DT_I8
- technicianId
Data type: DT_I8
- technicianName
Template: ShortText.
- assignedById
Data type: DT_I8
- assignedOn
Template: DateTime. A read-only field.
- status
Template: ShortText.
- isPaused
Data type: DT_BOOL
- jobId
Data type: DT_I8
- appointmentId
Data type: DT_I8
Based on resource template Dispatcher.
- [Update] action
-
Endpoint URL address:
/appointment-assignments/{{=parameters.action}}.
The action uses POST method.The action has the following user-defined parameters:
- action: Required. Specify the desired action.
- id
A key field. Data type: DT_I8
- jobAppointmentId
Data type: DT_I8
- technicianIds
Template: LongText. A composite field.
- jobId
Data type: DT_I8
- appointmentId
Data type: DT_I8
Based on resource template Dispatcher.
- [Create] action
-
Endpoint URL address:
/gps-provider/{{=parameters.gps_provider}}/gps-pings.The action has the following user-defined parameters:
- gps_provider: Required. Please specify the gps provider identifier
- unitId
Data type: DT_I8
- unitName
Template: ShortText.
- eventTime
Template: ShortText.
- latitude
Data type: DT_R8
- longitude
Data type: DT_R8
- speed
Data type: DT_I4
- street
Template: ShortText.
- city
Template: ShortText.
- region
Template: ShortText.
- postalCode
Template: ShortText.
- message
Template: ShortText.
- externalId
Data type: DT_I8
- isNew
Data type: DT_BOOL
- statusMessage
Template: ShortText.
Based on resource template Dispatcher.
- [Read] action
-
Endpoint URL address:
/non-job-appointments.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-dispatch-v2&operation=NonJobAppointments_GetList.
- [Read single] action
-
Endpoint URL address:
/non-job-appointments/{{=parameters.nja_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- nja_id: Required. Please specify the non-job-appointments identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-dispatch-v2&operation=NonJobAppointments_Get.
- [Create] action
-
Endpoint URL address:
/non-job-appointments.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-dispatch-v2&operation=NonJobAppointments_Create.
- [Update] action
-
Endpoint URL address:
/non-job-appointments/{{=item.id}}.
The action uses PUT method.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-dispatch-v2&operation=NonJobAppointments_Update.
- id
A key field. Data type: DT_I8
- technicianId
Data type: DT_I4
- start
Template: ShortText.
- name
Template: ShortText.
- duration
Template: ShortText.
- timesheetCodeId
Data type: DT_I8
- summary
Template: ShortText.
- clearDispatchBoard
Data type: DT_BOOL
- clearTechnicianView
Data type: DT_BOOL
- removeTechnicianFromCapacityPlanning
Data type: DT_BOOL
- allDay
Data type: DT_BOOL
- active
Data type: DT_BOOL
- createdOn
Template: DateTime. A read-only field.
- createdById
Data type: DT_I8
Based on resource template Dispatcher.
- [Read] action
-
Endpoint URL address:
/technician-shifts.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-dispatch-v2&operation=TechnicianShifts_GetList.
- [Read single] action
-
Endpoint URL address:
/technician-shifts/{{=parameters.technician_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- technician_id: Required. Please specify the technician shift identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-dispatch-v2&operation=TechnicianShifts_Get.
- id
Data type: DT_I8
- shiftType
Template: ShortText.
- title
Template: ShortText.
- note
Template: LongText.
- active
Data type: DT_BOOL
- technicianId
Data type: DT_I4
- start
Template: DateTime.
- end
Template: DateTime.
Based on resource template Dispatcher.
- [Read] action
-
Endpoint URL address:
/zones.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-dispatch-v2&operation=Zone_GetList.
- [Read single] action
-
Endpoint URL address:
/zones/{{=parameters.zone_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- zone_id: Required. Please specify the zone identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-dispatch-v2&operation=Zone_Get.
- id
A key field. Data type: DT_I8
- active
Data type: DT_BOOL
- name
Template: ShortText.
- zips
Template: LongText. A composite field.
- cities
Template: LongText. A composite field.
- territoryNumbers
Template: LongText. A composite field.
- locnNumbers
Template: LongText. A composite field.
- createdBy
Data type: DT_I4
- createdOn
Template: DateTime. A read-only field.
- modifiedOn
Data type: DT_I8
- serviceDaysEnabled
Data type: DT_BOOL
- serviceDays
Template: LongText. A composite field.
- businessUnits
Template: LongText. A composite field.
Based on resource template Equipment.
- [Read] action
-
Endpoint URL address:
/installed-equipment.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-equipment-systems-v2&operation=InstalledEquipment_GetList.
- [Read single] action
-
Endpoint URL address:
/installed-equipment/{{=equipment_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- equipment_id: Required. Please specify the installed equipment identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-equipment-systems-v2&operation=InstalledEquipment_Get.
- [Create] action
-
Endpoint URL address:
/installed-equipment.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-equipment-systems-v2&operation=InstalledEquipment_Create.
- [Update] action
-
Endpoint URL address:
/installed-equipment/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-equipment-systems-v2&operation=InstalledEquipment_Update.
- id
Data type: DT_I8
- locationId
Data type: DT_I8
- customerId
Data type: DT_I8
- name
Template: ShortText.
- installedOn
Template: ShortText.
- serialNumber
Template: ShortText.
- memo
Template: ShortText.
- manufacturer
Template: ShortText.
- model
Template: ShortText.
- cost
Data type: DT_R8
- manufacturerWarrantyStart
Template: DateTime.
- manufacturerWarrantyEnd
Template: DateTime.
- serviceProviderWarrantyStart
Template: DateTime.
- serviceProviderWarrantyEnd
Template: DateTime.
- [External]
-
The external fields URL address:
/installed-equipment. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression.
Based on resource template Setting.
- [Read] action
-
Endpoint URL address:
/business-units.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-settings-v2&operation=BusinessUnits_GetList.
- [Read single] action
-
Endpoint URL address:
/business-units/{{=parameters.businessunit_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- businessunit_id: Required. Please specify the business unit identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-settings-v2&operation=BusinessUnits_Get.
- [Update] action
-
Endpoint URL address:
/business-units/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ externalData : item } }}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-settings-v2&operation=BusinessUnits_Update.
-
application/json:
The resource includes the fields from the businessUnitT template.
Based on resource template Setting.
- [Read] action
-
Endpoint URL address:
/employees.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-settings-v2&operation=Employees_GetList.
- [Read single] action
-
Endpoint URL address:
/employees/{{=parameters.employee_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- employee_id: Required. Please specify the employee identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-settings-v2&operation=Employees_Get.
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- role
Template: ShortText.
- businessUnitId
Data type: DT_I8
- createdOn
Template: DateTime. A read-only field.
- modifiedOn
Template: DateTime. A read-only field.
Template: ShortText.
- phoneNumber
Template: ShortText.
- loginName
Template: ShortText.
- active
Data type: DT_BOOL
- [External]
-
The external fields URL address:
/employees. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText.
Based on resource template Setting.
- [Read] action
-
Endpoint URL address:
/technicians.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-settings-v2&operation=Technicians_GetList.
- [Read] action
-
Endpoint URL address:
/technicians/{{=parameters.technician_id}}.The action has the following user-defined parameters:
- technician_id: Required. Please specify the technician identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-settings-v2&operation=Technicians_Get.
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- businessUnitId
Data type: DT_I8
- createdOn
Template: DateTime. A read-only field.
- modifiedOn
Template: DateTime. A read-only field.
Template: ShortText.
- phoneNumber
Template: ShortText.
- loginName
Template: ShortText.
- home
Template: addressT.
- dailyGoal
Data type: DT_I4
- isManagedTech
Data type: DT_BOOL
- active
Data type: DT_BOOL
- [External]
-
The external fields URL address:
/tag-types?pageSize=1. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText.
Based on resource template Telecom.
- [Read] action
-
Endpoint URL address:
/calls.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-telecom-v2&operation=Calls_GetCalls.
- [Read single] action
-
Endpoint URL address:
/calls/{{=parameters.call_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- call_id: Required. Please specify the call identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-telecom-v2&operation=Calls_GetDetails.
- [Update] action
-
Endpoint URL address:
/calls/{{=item.id}}.
The action uses PUT method.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-telecom-v2&operation=Calls_Update.
- id
A key field. Data type: DT_I8
- jobNumber
Template: ShortText.
- projectId
Data type: DT_I8
- callId
Data type: DT_I8
- campaignId
Data type: DT_I8
- jobId
Data type: DT_I8
- agentId
Data type: DT_I8
- callType
Template: ShortText.
- excuseMemo
Template: ShortText.
- reason
Template: reasonT.
- customer
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, address, contacts.
-
Uses template:
- location
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, address, contacts.
-
Uses template:
- businessUnit
Template: businessUnitT.
- type
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, modifiedOn.
-
Uses template:
- leadCall
A read-only field. Field components:
-
Uses template:
DateTime. - Contains the following components: id, receivedOn, duration, from, to, direction, callType, reason, recordingUrl, voiceMailUrl, createdBy, customer, campaign, modifiedOn, agent.
-
Uses template:
- recording
Data type: DT_IMAGE The value is gathered from
/calls/{{=item.id}}/recordingaddress.- voicemail
Data type: DT_IMAGE The value is gathered from
/calls/{{=item.id}}/voicemailaddress.
Based on resource template TaskManagement.
- [Read] action
-
Endpoint URL address:
/data.
- employees
Field components:
- An array.
-
Uses template:
generalActiveT.
- businessUnits
Template: csDataT.
- taskPriorities
Template: csDataT.
- taskResolutionTypes
Template: csDataT.
- taskStatuses
Template: csDataT.
- taskTypes
Field components:
- An array.
-
Uses template:
generalActiveT.
- taskSources
Field components:
- An array.
-
Uses template:
generalActiveT.
- taskResolutions
Field components:
- An array.
-
Uses template:
generalActiveT. - Contains the following components: type, excludedTaskTypeIds.
Based on resource template TaskManagement.
- [Create] action
-
Endpoint URL address:
/tasks.
- reportedById
Data type: DT_I8
- assignedToId
Data type: DT_I8
- isClosed
Data type: DT_BOOL
- name
Template: ShortText.
- businessUnitId
Data type: DT_I8
- employeeTaskTypeId
Data type: DT_I8
- employeeTaskSourceId
Data type: DT_I8
- employeeTaskResolutionId
Data type: DT_I8
- reportedDate
Template: DateTime.
- completeBy
Template: DateTime.
- involvedEmployeeIdList
Template: LongText. A composite field.
- customerId
Data type: DT_I8
- jobId
Data type: DT_I8
- description
Template: ShortText.
- priority
Template: ShortText.
Based on resource template TaskManagement.
- [Create] action
-
Endpoint URL address:
/tasks/{{=item.taskId}}/subtasks.
- taskId
Data type: DT_I8
- isClosed
Data type: DT_BOOL
- name
Template: ShortText.
- assignedToId
Data type: DT_I8
- dueDateTime
Template: DateTime.
Based on resource template Pricebook.
- [Read] action
-
Endpoint URL address:
/categories.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Categories_GetList.
- [Read single] action
-
Endpoint URL address:
/categories/{{=parameters.category_id}}.The action has the following user-defined parameters:
- category_id: Required. Please specify the category identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Categories_Get.
- [Create] action
-
Endpoint URL address:
/categories.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Categories_Create.
- [Update] action
-
Endpoint URL address:
/categories/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Categories_Update.
- [Delete] action
-
Endpoint URL address:
/categories/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Categories_Delete.
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- active
Data type: DT_BOOL
- description
Template: LongText.
- image
Template: ShortText.
- parentId
Data type: DT_I8
- position
Data type: DT_I4
- categoryType
Template: ShortText.
- businessUnitIds
Template: LongText. A composite field.
- skuImages
Template: LongText. A composite field.
- skuVideos
Template: LongText. A composite field.
- source
Template: ShortText.
- externalId
Template: ShortText.
- subcategories
Field components:
- An array.
- Contains the following components: id, name, active, description, image, parentId, position, categoryType, businessUnitIds, skuImages, skuVideos, source, externalId.
Based on resource template Pricebook.
- [Read] action
-
Endpoint URL address:
/discounts-and-fees.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=DiscountAndFees_GetList.
- [Read single] action
-
Endpoint URL address:
/discounts-and-fees/{{=parameters.discountfee_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- discountfee_id: Required. Please specify the discount and fee identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=DiscountAndFees_Get.
- [Create] action
-
Endpoint URL address:
/discounts-and-fees.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=DiscountAndFees_Create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/discounts-and-fees/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=DiscountAndFees_Update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/discounts-and-fees/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=DiscountAndFees_Delete.
The resource includes the fields from the discountFeeT template.
Based on resource template Pricebook.
- [Read] action
-
Endpoint URL address:
/equipment.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Equipment_GetList.
- [Read single] action
-
Endpoint URL address:
/equipment/{{=parameters.equipment_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- equipment_id: Required. Please specify the equipment identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Equipment_Get.
- [Create] action
-
Endpoint URL address:
/equipment.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Equipment_Create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/equipment/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Equipment_Update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/equipment/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Equipment_Delete.
The resource includes the fields from the equipmentT template.
Based on resource template Pricebook.
- [Read] action
-
Endpoint URL address:
/materials.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Materials_GetList.
- [Read single] action
-
Endpoint URL address:
/materials/{{=parameters.material_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- material_id: Required. Please specify the material identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Materials_Get.
- [Create] action
-
Endpoint URL address:
/materials.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Materials_Create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/materials/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Materials_Update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/materials/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Materials_Delete.
The resource includes the fields from the materialT template.
Based on resource template Pricebook.
- [Create] action
-
Endpoint URL address:
/pricebook.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=PricebookBulk_Create.
- [Update] action
-
Endpoint URL address:
/pricebook.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=PricebookBulk_Update.
- services
Field components:
- An array.
-
Uses template:
serviceT.
- equipment
Field components:
- An array.
-
Uses template:
equipmentT.
- materials
Field components:
- An array.
-
Uses template:
materialT.
- discountAndFees
Field components:
- An array.
-
Uses template:
discountFeeT.
Based on resource template Pricebook.
- [Read] action
-
Endpoint URL address:
/services.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Services_GetList.
- [Read single] action
-
Endpoint URL address:
/services/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. Please specify the service identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Services_Get.
- [Create] action
-
Endpoint URL address:
/services.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Services_Create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/services/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Services_Update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/services/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-pricebook-v2&operation=Services_Delete.
The resource includes the fields from the serviceT template.
Based on resource template Sale.
- [Read] action
-
Endpoint URL address:
/estimates.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-salestech-v2&operation=Estimates_GetList.
- [Read single] action
-
Endpoint URL address:
/estimates/{{=parameters.estimate_id}}.The action has the following user-defined parameters:
- estimate_id: Required. Please specify the estimate identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-salestech-v2.
- [Create] action
-
Endpoint URL address:
/estimates.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-salestech-v2&operation=Estimates_Create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/estimates/{{=item.id}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-salestech-v2&operation=Estimates_Update.
-
application/json:
- id
A key field. Data type: DT_I8
- jobId
Data type: DT_I8
- projectId
Data type: DT_I8
- name
Template: ShortText.
- jobNumber
Template: ShortText.
- status
Field components:
-
Uses template:
ShortText. - Contains the following components: value, name.
-
Uses template:
- summary
Template: ShortText.
- modifiedOn
Template: DateTime. A read-only field.
- soldOn
Template: DateTime. A read-only field.
- soldBy
Data type: DT_I4
- active
Data type: DT_BOOL
- items
Field components:
- An array.
-
Uses template:
estimateItemT.
- externalLinks
Field components:
- An array.
- Contains the following components: name, url.
Based on resource template Sale.
- [Read] action
-
Endpoint URL address:
/estimates/items.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-salestech-v2.
- [Update] action
-
Endpoint URL address:
/estimates/{{=parameters.estimate_id}}/items.
The action uses PUT method.The action has the following user-defined parameters:
- estimate_id: Required. Please specify the estimate identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-salestech-v2&operation=Estimates_PutItem.
- [Delete] action
-
Endpoint URL address:
/estimates/{{=parameters.estimate_id}}/items/{{=item.id}}.The action has the following user-defined parameters:
- estimate_id: Required. Please specify the estimate identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-salestech-v2&operation=Estimates_DeleteItem.
The resource includes the fields from the estimateItemT template.
Based on resource template Sale.
- [Update] action
-
Endpoint URL address:
/estimates/{{=item.id}}/{{=parameters.action}}.The action has the following user-defined parameters:
- action: Required. Specify the desired action sell or unsell.
- id
A key field. Data type: DT_I8
- soldBy
Data type: DT_I8
Based on resource template JobBooking.
- [Read] action
-
Endpoint URL address:
/call-reasons.
- id
Data type: DT_I8
- name
Template: ShortText.
- isLead
Data type: DT_BOOL
- active
Data type: DT_BOOL
Based on resource template Payroll.
- [Read] action
-
Endpoint URL address:
/activity-codes.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=ActivityCodes_GetList.
- [Read single] action
-
Endpoint URL address:
/activity-codes/{{=parameters.code_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- code_id: Required. Please specify the activity code identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=ActivityCodes_Get.
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- code
Template: ShortText.
- earningCategory
Template: ShortText.
Based on resource template Payroll.
- [Read] action
-
Endpoint URL address:
/gross-pay-items.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=GrossPayItems_GetList.
- [Create] action
-
Endpoint URL address:
/gross-pay-items.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=GrossPayItems_Create.
- [Update] action
-
Endpoint URL address:
/gross-pay-items/{{=item.id}}.
The action uses PUT method.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=GrossPayItems_Update.
- [Delete] action
-
Endpoint URL address:
/gross-pay-items/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=GrossPayItems_Delete.
- id
A key field. Data type: DT_I8
- employeeId
Data type: DT_I8
- employeeType
Template: ShortText.
- businessUnitName
Template: ShortText.
- payrollId
Data type: DT_I8
- employeePayrollId
Template: ShortText.
- date
Template: DateTime.
- activity
Template: ShortText.
- activityCodeId
Data type: DT_I8
- activityCode
Template: ShortText.
- amount
Data type: DT_R8
- amountAdjustment
Data type: DT_R8
- payoutBusinessUnitName
Template: ShortText.
- grossPayItemType
Template: ShortText.
- startedOn
Template: DateTime.
- endedOn
Template: DateTime.
- paidDurationHours
Data type: DT_R8
- paidTimeType
Template: ShortText.
- jobId
Data type: DT_I8
- jobNumber
Template: ShortText.
- jobTypeName
Template: ShortText.
- projectNumber
Template: ShortText.
- projectId
Data type: DT_I8
- invoiceId
Data type: DT_I8
- invoiceNumber
Template: ShortText.
- invoiceItemId
Data type: DT_I8
- customerId
Data type: DT_I8
- customerName
Template: ShortText.
- locationId
Data type: DT_I8
- locationName
Template: ShortText.
- locationAddress
Template: ShortText.
- locationZip
Template: ShortText.
- zoneName
Template: ShortText.
- taxZoneName
Template: ShortText.
- laborTypeId
Data type: DT_I8
- laborTypeCode
Template: ShortText.
- isPrevailingWageJob
Data type: DT_BOOL
Based on resource template Payroll.
- [Read] action
-
Endpoint URL address:
/jobs/{{=parameters.job}}/splits.The action has the following user-defined parameters:
- job: Required. Please specify the job.
- jobId
A key field. Data type: DT_I8
- technicianId
Data type: DT_I4
- split
Data type: DT_I4
- createdOn
Template: DateTime. A read-only field.
- modifiedOn
Template: DateTime.
Based on resource template Payroll.
- [Read] action
-
Endpoint URL address:
/payroll-adjustments.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=PayrollAdjustments_GetList.
- [Read single] action
-
Endpoint URL address:
/payroll-adjustments/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the payroll adjustment identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=PayrollAdjustments_Get.
- [Create] action
-
Endpoint URL address:
/payroll-adjustments.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=PayrollAdjustments_Create.
- id
A key field. Data type: DT_I8
- employeeType
Template: ShortText.
- employeeId
Data type: DT_I8
- postedOn
Template: ShortText.
- amount
Data type: DT_R8
- memo
Template: ShortText.
- activityCodeId
Data type: DT_I4
- hours
Data type: DT_R8
- rate
Data type: DT_R8
Based on resource template Payroll.
- [Read] action
-
Endpoint URL address:
/payrolls.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=Payrolls_GetList.
- [Read employee] action
-
Endpoint URL address:
/employees/{{=parameters.employee_id}}/payrolls.The action has the following user-defined parameters:
- employee_id: Required. Please specify the employee identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=Payrolls_GetEmployeePayrolls.
- [Read technician] action
-
Endpoint URL address:
/technicians/{{=parameters.technician_id}}/payrolls.The action has the following user-defined parameters:
- technician_id: Required. Please specify the technician identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=Payrolls_GetTechnicianPayrolls.
- id
A key field. Data type: DT_I8
- startedOn
Template: DateTime.
- endedOn
Template: DateTime.
- employeeId
Data type: DT_I8
- employeeType
Template: ShortText.
- status
Template: ShortText.
Based on resource template Payroll.
- [Read] action
-
Endpoint URL address:
/jobs/{{=parameters.job}}/timesheets.The action has the following user-defined parameters:
- job: Required. Please specify the job.
- id
A key field. Data type: DT_I8
- jobId
Data type: DT_I8
- appointmentId
Data type: DT_I8
- technicianId
Data type: DT_I8
- dispatchedOn
Template: DateTime. A read-only field.
- arrivedOn
Template: DateTime. A read-only field.
- canceledOn
Template: DateTime. A read-only field.
- doneOn
Template: DateTime. A read-only field.
Based on resource template Payroll.
- [Read] action
-
Endpoint URL address:
/timesheet-codes.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=TimesheetCodes_GetList.
- [Read single] action
-
Endpoint URL address:
/timesheet-codes/{{=parameters.code_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- code_id: Required. Please specify the timesheet code identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-payroll-v2&operation=TimesheetCodes_Get.
- id
A key field. Data type: DT_I8
- code
Template: ShortText.
- description
Template: ShortText.
- type
Template: ShortText.
- applicableEmployeeType
Template: ShortText.
- rateInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: hourlyRate, customHourlyRate, rateMultiplier.
-
Uses template:
Based on resource template JobManagement.
- [Read] action
-
Endpoint URL address:
/appointments.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Appointments_GetList.
- [Read single] action
-
Endpoint URL address:
/appointments/{{=parameters.appointment_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- appointment_id: Required. Please specify the appointment identifier
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Appointments_Get.
- [Create] action
-
Endpoint URL address:
/appointments.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Appointments_Add.
- [Delete] action
-
Endpoint URL address:
/appointments/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Appointments_Delete.
- id
A key field. Data type: DT_I8
- jobId
Data type: DT_I8
- appointmentNumber
Template: ShortText.
- start
Template: DateTime.
- end
Template: DateTime.
- arrivalWindowStart
Template: DateTime.
- arrivalWindowEnd
Template: DateTime.
- status
Template: ShortText.
- specialInstructions
Template: ShortText.
- createdOn
Template: DateTime.
- modifiedOn
Template: DateTime.
Based on resource template JobManagement.
- [Update] action
-
Endpoint URL address:
/appointments/{{=item.id}}/hold.
The action uses PUT method.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Appointments_Hold.
- [Delete] action
-
Endpoint URL address:
/appointments/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Appointments_RemoveHold.
- id
A key field. Data type: DT_I8
- reasonId
Data type: DT_I8
- memo
Template: ShortText.
Based on resource template JobManagement.
- [Update] action
-
Endpoint URL address:
/appointments/{{=item.id}}/special-instructions.
The action uses PUT method.
- id
A key field. Data type: DT_I8
- specialInstructions
Template: LongText.
Based on resource template JobManagement.
- [Update] action
-
Endpoint URL address:
/appointments/{{=item.id}}/reschedule.
- id
A key field. Data type: DT_I8
- start
Template: DateTime.
- end
Template: DateTime.
- arrivalWindowStart
Template: DateTime.
- arrivalWindowEnd
Template: DateTime.
Based on resource template JobManagement.
- [Read] action
-
Endpoint URL address:
/jobs.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Jobs_GetList.
- [Create] action
-
Endpoint URL address:
/jobs.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Jobs_Create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/jobs/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Jobs_Update.
-
application/json:
- id
A key field. Data type: DT_I8
- jobNumber
Template: ShortText.
- customerId
Data type: DT_I8
- locationId
Data type: DT_I8
- jobStatus
Template: ShortText.
- completedOn
Template: DateTime. A read-only field.
- businessUnitId
Data type: DT_I8
- jobTypeId
Data type: DT_I8
- priority
Template: ShortText.
- campaignId
Data type: DT_I8
- summary
Template: ShortText.
- appointmentCount
Data type: DT_I4
- firstAppointmentId
Data type: DT_I8
- lastAppointmentId
Data type: DT_I8
- recallForId
Data type: DT_I8
- warrantyId
Data type: DT_I8
- jobGeneratedLeadSource
Field components:
- Contains the following components: jobId, employeeId.
- noCharge
Data type: DT_BOOL
- notificationsEnabled
Data type: DT_BOOL
- createdOn
Template: DateTime. A read-only field.
- createdById
Data type: DT_I8
- modifiedOn
Template: DateTime. A read-only field.
- tagTypeIds
Template: LongText. A composite field.
- leadCallId
Data type: DT_I8
- bookingId
Data type: DT_I8
- soldById
Data type: DT_I8
- applicationGuid
Template: ShortText.
- externalData
Field components:
- An array.
-
Uses template:
externalDataT.
- history
The value is gathered from
/jobs/{{=item.id}}/historyaddress. The gathered value is processed with{{=response.history}}expression. Field components:- An array.
- Contains the following components: id, employeeId, eventType, date, usedSchedulingTool.
- notes
The value is gathered from
/jobs/{{=item.id}}/notesaddress. The gathered value is processed with{{=response.history}}expression. Field components:- An array.
-
Uses template:
noteT.
- [External]
-
The external fields URL address:
/jobs. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression.
Based on resource template JobManagement.
- [Read] action
-
Endpoint URL address:
/jobs/{{=parameters.job_id}}/notes.The action has the following user-defined parameters:
- job_id: Required. Please specify the job identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Jobs_GetNotes.
- [Create] action
-
Endpoint URL address:
/jobs/{{=item.jobId}}/notes.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Jobs_CreateNote.
The resource includes the fields from the noteT template.
- jobId
Data type: DT_I8
Based on resource template JobManagement.
- [Read] action
-
Endpoint URL address:
/job-types.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=JobTypes_GetList.
- [Read single] action
-
Endpoint URL address:
/job-types/{{=parameters.type_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- type_id: Required. Please specify the job type identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=JobTypes_Get.
- [Create] action
-
Endpoint URL address:
/job-types.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=JobTypes_Create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/job-types/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=JobTypes_Update.
-
application/json:
- id
A key field. Data type: DT_I8
- modifiedOn
Template: DateTime. A read-only field.
- applicationGuid
Template: ShortText.
- name
Template: ShortText.
- externalData
Field components:
- An array.
-
Uses template:
externalDataT.
Based on resource template JobManagement.
- [Read] action
-
Endpoint URL address:
/projects.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Projects_GetList.
- [Read single] action
-
Endpoint URL address:
/projects/{{=parameters.project_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- project_id: Required. Please specify the project identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-jpm-v2&operation=Projects_Get.
- id
A key field. Data type: DT_I8
- number
Template: ShortText.
- name
Template: ShortText.
- summary
Template: ShortText.
- status
Template: ShortText.
- customerId
Data type: DT_I8
- locationId
Data type: DT_I8
- startDate
Template: DateTime. A read-only field.
- targetCompletionDate
Template: DateTime. A read-only field.
- actualCompletionDate
Template: DateTime. A read-only field.
- modifiedOn
Template: DateTime. A read-only field.
- [External]
-
The external fields URL address:
/projects. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression.
Based on resource template MarketingAds.
- [Create] action
-
Endpoint URL address:
/external-call-attributions.
- externalCallData
Field components:
-
Uses template:
ShortText. - Contains the following components: customerPhoneNumber, forwardingPhoneNumber, trackingPhoneNumber, callStartedOnUtc.
-
Uses template:
- webSessionData
Template: sessionDataT.
Based on resource template MarketingAds.
- [Create] action
-
Endpoint URL address:
/web-booking-attributions.
- bookingId
Data type: DT_I8
- webSessionData
Template: sessionDataT.
Based on resource template Membership.
- [Read] action
-
Endpoint URL address:
/memberships.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=CustomerMemberships_GetList.
- [Read single] action
-
Endpoint URL address:
/memberships/{{=parameters.membership_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- membership_id: Required. Please specify the membership identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=CustomerMemberships_Get.
- [Update] action
-
Endpoint URL address:
/memberships/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=CustomerMemberships_Update.
- id
A key field. Data type: DT_I8
- createdOn
Template: DateTime. A read-only field.
- createdById
Data type: DT_I8
- modifiedOn
Template: DateTime. A read-only field.
- followUpOn
Template: DateTime.
- cancellationDate
Template: DateTime.
- from
Template: DateTime.
- nextScheduledBillDate
Template: DateTime.
- to
Template: DateTime.
- billingFrequency
Template: LongText. A composite field.
- renewalBillingFrequency
Template: LongText. A composite field.
- status
Template: LongText. A composite field.
- followUpStatus
Template: LongText. A composite field.
- active
Data type: DT_BOOL
- initialDeferredRevenue
Data type: DT_R8
- duration
Data type: DT_I4
- renewalDuration
Data type: DT_I4
- businessUnitId
Data type: DT_I8
- customerId
Data type: DT_I8
- membershipTypeId
Data type: DT_I8
- activatedById
Data type: DT_I8
- activatedFromId
Data type: DT_I8
- billingTemplateId
Data type: DT_I8
- cancellationBalanceInvoiceId
Data type: DT_I8
- cancellationInvoiceId
Data type: DT_I8
- followUpCustomStatusId
Data type: DT_I8
- locationId
Data type: DT_I8
- paymentMethodId
Data type: DT_I8
- paymentTypeId
Data type: DT_I8
- recurringLocationId
Data type: DT_I8
- renewalMembershipTaskId
Data type: DT_I8
- renewedById
Data type: DT_I8
- soldById
Data type: DT_I8
- customerPo
Template: ShortText.
- importId
Template: ShortText.
- memo
Template: ShortText.
Based on resource template Membership.
- [Create] action
-
Endpoint URL address:
/memberships/sale.
- customerId
Data type: DT_I8
- businessUnitId
Data type: DT_I8
- saleTaskId
Data type: DT_I8
- durationBillingId
Data type: DT_I8
- locationId
Data type: DT_I8
- recurringServiceAction
Template: ShortText.
- recurringLocationId
Data type: DT_I8
Based on resource template Membership.
- [Read] action
-
Endpoint URL address:
/invoice-templates.The action has the following user-defined parameters:
- ids: Required. Please specify the ids of the record.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=InvoiceTemplates_GetList.
- [Create] action
-
Endpoint URL address:
/invoice-templates.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=InvoiceTemplates_Create.
- [Update] action
-
Endpoint URL address:
/memberships/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=InvoiceTemplates_Update.
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- createdOn
Template: DateTime. A read-only field.
- createdById
Data type: DT_I8
- active
Data type: DT_BOOL
- total
Data type: DT_R8
- isSettingsTemplate
Data type: DT_BOOL
- importId
Template: ShortText.
- items
Field components:
- An array.
-
Uses template:
itemT.
Based on resource template Membership.
- [Read] action
-
Endpoint URL address:
/recurring-services.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=LocationRecurringServices_GetList.
- [Read single] action
-
Endpoint URL address:
/recurring-services/{{=parameters.service_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- service_id: Required. Specify the recurring service identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=LocationRecurringServices_Get.
- [Update] action
-
Endpoint URL address:
/recurring-services/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=LocationRecurringServices_Update.
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- active
Data type: DT_BOOL
- createdOn
Template: DateTime. A read-only field.
- createdById
Data type: DT_I8
- modifiedOn
Template: DateTime. A read-only field.
- importId
Template: ShortText.
- membershipId
Data type: DT_I8
- locationId
Data type: DT_I8
- recurringServiceTypeId
Data type: DT_I8
- durationType
Template: ShortText.
- durationLength
Data type: DT_I4
- from
Template: DateTime.
- to
Template: DateTime.
- memo
Template: ShortText.
- invoiceTemplateId
Template: ShortText.
- invoiceTemplateForFollowingYearsId
Template: ShortText.
- firstVisitComplete
Data type: DT_BOOL
- activatedFromId
Template: ShortText.
- allocation
Data type: DT_R8
- businessUnitId
Data type: DT_I8
- jobTypeId
Data type: DT_I8
- campaignId
Data type: DT_I8
- priority
Template: LongText. A composite field.
- jobSummary
Template: ShortText.
- recurrenceType
Template: LongText. A composite field.
- recurrenceInterval
Data type: DT_I4
- recurrenceMonths
Template: LongText. A composite field.
- recurrenceDaysOfWeek
Template: LongText. A composite field.
- recurrenceWeek
Template: LongText. A composite field.
- recurrenceDayOfNthWeek
Template: LongText. A composite field.
- recurrenceDaysOfMonth
Template: LongText. A composite field.
- jobStartTime
Template: ShortText.
- estimatedPayrollCost
Data type: DT_R8
Based on resource template Membership.
- [Read] action
-
Endpoint URL address:
/recurring-service-events.
- id
A key field. Data type: DT_I8
- locationRecurringServiceId
Data type: DT_I8
- locationRecurringServiceName
Template: ShortText.
- membershipId
Data type: DT_I8
- membershipName
Template: ShortText.
- status
Template: LongText. A composite field.
- date
Template: ShortText.
- createdOn
Template: DateTime. A read-only field.
- createdById
Data type: DT_I8
Based on resource template Membership.
- [Create] action
-
Endpoint URL address:
/recurring-service-events/{{=parameters.action}}.The action has the following user-defined parameters:
- action: Required. Specify the desired action complete or incomplete.
- id
Data type: DT_I8
- locationRecurringServiceId
Data type: DT_I8
- locationRecurringServiceName
Template: ShortText.
- membershipId
Data type: DT_I8
- membershipName
Template: ShortText.
- status
Template: LongText. A composite field.
- date
Template: ShortText.
- createdOn
Template: DateTime. A read-only field.
- createdById
Data type: DT_I8
Based on resource template Membership.
- [Read] action
-
Endpoint URL address:
/membership-types.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=MembershipTypes_GetList.
- [Read single] action
-
Endpoint URL address:
/membership-types/{{=parameters.type_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- type_id: Required. Specify the membership type identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=MembershipTypes_Get.
- name
Template: ShortText.
- active
Data type: DT_BOOL
- discountMode
Template: LongText. A composite field.
- locationTarget
Template: LongText. A composite field.
- revenueRecognitionMode
Template: LongText. A composite field.
- autoCalculateInvoiceTemplates
Data type: DT_BOOL
- useMembershipPricingTable
Data type: DT_BOOL
- showMembershipSavings
Data type: DT_BOOL
- id
A key field. Data type: DT_I8
- createdOn
Template: DateTime. A read-only field.
- createdById
Data type: DT_I4
- modifiedOn
Template: DateTime. A read-only field.
- importId
Template: ShortText.
- billingTemplateId
Data type: DT_I8
- discount
The value is gathered from
/membership-types/{{=item.id}}/discountsaddress. The gathered value is processed with{{=response}}expression. Field components:- An array.
- Contains the following components: id, targetId, discount, createdOn, createdById.
- duration_billing_item
The value is gathered from
/membership-types/{{=item.id}}/duration-billing-itemsaddress. The gathered value is processed with{{=response}}expression. Field components:- An array.
- Contains the following components: id, duration, billingFrequency, salePrice, billingPrice, renewalPrice, importId, active, createdOn, createdById.
- recurring_service_item
The value is gathered from
/membership-types/{{=item.id}}/recurring-service-itemsaddress. The gathered value is processed with{{=response}}expression. Field components:- An array.
- Contains the following components: id, membershipTypeId, recurringServiceTypeId, offset, offsetType, allocation, importId, createdOn, createdById.
Based on resource template Membership.
- [Read] action
-
Endpoint URL address:
/recurring-service-types.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=RecurringServiceTypes_GetList.
- [Read single] action
-
Endpoint URL address:
/recurring-service-types/{{=parameters.type_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- type_id: Required. Specify recurring service type identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-memberships-v2&operation=RecurringServiceTypes_Get.
- id
A key field. Data type: DT_I8
- createdOn
Template: DateTime. A read-only field.
- createdById
Data type: DT_I8
- modifiedOn
Template: DateTime. A read-only field.
- active
Data type: DT_BOOL
- recurrenceType
Template: ShortText.
- recurrenceInterval
Data type: DT_I4
- recurrenceMonths
Template: LongText. A composite field.
- durationType
Template: ShortText.
- durationLength
Data type: DT_I4
- invoiceTemplateId
Data type: DT_I8
- businessUnitId
Data type: DT_I8
- jobTypeId
Data type: DT_I8
- priority
Template: ShortText.
- campaignId
Data type: DT_I8
- jobSummary
Template: ShortText.
- name
Template: ShortText.
- importId
Template: ShortText.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/campaigns.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-marketing-v2&operation=Campaigns_GetList.
- [Read] action
-
Endpoint URL address:
/campaigns/{{=parameters.campaign_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- campaign_id: Required. Specify the campaign identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-marketing-v2&operation=Campaigns_Get.
- [Create] action
-
Endpoint URL address:
/campaigns.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-marketing-v2&operation=Campaigns_Create.
- [Update] action
-
Endpoint URL address:
/campaigns/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-marketing-v2&operation=Campaigns_Update.
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- modifiedOn
Template: DateTime. A read-only field.
- active
Data type: DT_BOOL
- category
Template: generalActiveT.
- cost
The value is gathered from
campaigns/{{=item.id}}/costsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: id, year, month, dailyCost.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/categories.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-marketing-v2&operation=CampaignCategories_GetList.
- [Read single] action
-
Endpoint URL address:
/categories/{{=parameters.category_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- category_id: Required. Specify the category identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-marketing-v2&operation=CampaignCategories_Get.
- [Create] action
-
Endpoint URL address:
/categories.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-marketing-v2&operation=CampaignCategories_Create.
- [Update] action
-
Endpoint URL address:
/categories/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-marketing-v2&operation=CampaignCategories_Update.
The resource includes the fields from the generalActiveT template.
- type
Template: ShortText.
Based on resource template Marketing.
- [Read] action
-
Endpoint URL address:
/costs/{{=parameters.cost_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- cost_id: Required. Specify the cost identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-marketing-v2&operation=CampaignCosts_Get.
- [Create] action
-
Endpoint URL address:
/costs.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-marketing-v2&operation=CampaignCosts_Create.
- [Update] action
-
Endpoint URL address:
/costs/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-marketing-v2&operation=CampaignCosts_Update.
- id
A key field. Data type: DT_I8
- year
Data type: DT_I4
- month
Data type: DT_I4
- dailyCost
Data type: DT_R8
Based on resource template Inventory.
- [Read] action
-
Endpoint URL address:
/adjustments.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Adjustments_Get.
- [Update] action
-
Endpoint URL address:
/adjustments/custom-fields.The following request parameters will be automatically processed:
-
application/json:
{{={ operations : [item] } }}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Adjustments_UpdateCustomFields.
-
application/json:
- id
A key field. Data type: DT_I8
- active
Data type: DT_BOOL
- number
Template: ShortText.
- referenceNumber
Template: ShortText.
- type
Template: ShortText.
- inventoryLocationId
Data type: DT_I8
- businessUnitId
Data type: DT_I8
- createdById
Data type: DT_I8
- memo
Template: ShortText.
- date
Template: DateTime.
- createdOn
Template: DateTime. A read-only field.
- modifiedOn
Template: DateTime. A read-only field.
- batchId
Data type: DT_I8
- syncStatus
Template: ShortText.
- objectId
Data type: DT_I8
- items
Field components:
- An array.
-
Uses template:
itemT.
- [External]
-
The external fields URL address:
/adjustments. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression.
Based on resource template Inventory.
- [Read] action
-
Endpoint URL address:
/purchase-orders.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=PurchaseOrders_GetList.
- [Read] action
-
Endpoint URL address:
/purchase-orders/{{=parameters.order_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- order_id: Required. Specify the purchase order identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=PurchaseOrders_GetById.
- [Create] action
-
Endpoint URL address:
/purchase-orders.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=PurchaseOrders_Create.
- [Update] action
-
Endpoint URL address:
/purchase-orders/{{=item.id}}.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=PurchaseOrders_Update.
- id
A key field. Data type: DT_I8
- number
Template: ShortText.
- invoiceId
Data type: DT_I8
- jobId
Data type: DT_I8
- projectId
Data type: DT_I8
- status
Template: ShortText.
- typeId
Data type: DT_I8
- vendorId
Data type: DT_I8
- technicianId
Data type: DT_I8
- shipTo
Template: addressT. Field components:
-
Uses template:
LongText. - Contains the following components: description, address.
-
Uses template:
- businessUnitId
Data type: DT_I8
- inventoryLocationId
Data type: DT_I8
- batchId
Data type: DT_I8
- vendorDocumentNumber
Template: ShortText.
- date
Template: ShortText.
- requiredOn
Template: ShortText.
- sentOn
Template: ShortText.
- receivedOn
Template: ShortText.
- createdOn
Template: ShortText.
- modifiedOn
Template: ShortText.
- total
Data type: DT_R8
- tax
Data type: DT_R8
- shipping
Data type: DT_R8
- summary
Template: ShortText.
- items
Field components:
- An array.
-
Uses template:
itemT.
- [External]
-
The external fields URL address:
/purchase-orders. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText.
Based on resource template Inventory.
- [Read] action
-
Endpoint URL address:
/purchase-order-types.
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- active
Data type: DT_BOOL
- automaticallyReceive
Data type: DT_BOOL
- displayToTechnician
Data type: DT_BOOL
- impactToTechnicianPayroll
Data type: DT_BOOL
- allowTechniciansToSendPo
Data type: DT_BOOL
- defaultRequiredDateDaysOffset
Data type: DT_I4
- skipWeekends
Data type: DT_BOOL
- excludeTaxFromJobCosting
Data type: DT_BOOL
Based on resource template Inventory.
- [Read] action
-
Endpoint URL address:
/receipts.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Receipts_Get.
- [Update] action
-
Endpoint URL address:
/receipts/custom-fields.The following request parameters will be automatically processed:
-
application/json:
{{={ operations : [item] } }}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Receipts_UpdateCustomFields.
-
application/json:
- id
A key field. Data type: DT_I8
- active
Data type: DT_BOOL
- number
Template: ShortText.
- vendorInvoiceNumber
Template: ShortText.
- createdById
Data type: DT_I8
- memo
Template: ShortText.
- purchaseOrderId
Data type: DT_I8
- billId
Data type: DT_I8
- jobId
Data type: DT_I8
- businessUnitId
Data type: DT_I8
- vendorId
Data type: DT_I8
- technicianId
Data type: DT_I8
- inventoryLocationId
Data type: DT_I8
- objectId
Data type: DT_I8
- shipTo
Template: addressT.
- shipToDescription
Template: ShortText.
- receiptAmount
Data type: DT_R8
- taxAmount
Data type: DT_R8
- shippingAmount
Data type: DT_R8
- receivedOn
Template: DateTime. A read-only field.
- createdOn
Template: DateTime. A read-only field.
- modifiedOn
Template: DateTime. A read-only field.
- batchId
Data type: DT_I8
- syncStatus
Template: LongText. A composite field.
- items
Field components:
- An array.
-
Uses template:
itemT.
- [External]
-
The external fields URL address:
/receipts. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression.
Based on resource template Inventory.
- [Read] action
-
Endpoint URL address:
/returns.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Returns_Get.
- [Update] action
-
Endpoint URL address:
/returns/custom-fields.The following request parameters will be automatically processed:
-
application/json:
{{={ operations : [item] } }}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Returns_UpdateCustomFields.
-
application/json:
- id
A key field. Data type: DT_I8
- active
Data type: DT_BOOL
- number
Template: ShortText.
- referenceNumber
Template: ShortText.
- vendorId
Data type: DT_I8
- purchaseOrderId
Data type: DT_I8
- jobId
Data type: DT_I8
- businessUnitId
Data type: DT_I8
- inventoryLocationId
Data type: DT_I8
- createdById
Data type: DT_I8
- memo
Template: ShortText.
- returnAmount
Data type: DT_R8
- taxAmount
Data type: DT_R8
- shippingAmount
Data type: DT_R8
- returnDate
Template: ShortText.
- createdOn
Template: ShortText.
- modifiedOn
A key field. Template: DateTime.
- batchId
Data type: DT_I8
- syncStatus
Template: LongText. A composite field.
- objectId
Data type: DT_I8
- items
Field components:
- An array.
-
Uses template:
itemT.
- [External]
-
The external fields URL address:
/returns. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression.
Based on resource template Inventory.
- [Read] action
-
Endpoint URL address:
/transfers.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Transfers_Get.
- [Update] action
-
Endpoint URL address:
/transfers/custom-fields.The following request parameters will be automatically processed:
-
application/json:
{{={ operations : [item] } }}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Transfers_UpdateCustomFields.
-
application/json:
- id
A key field. Data type: DT_I8
- transferType
Template: ShortText.
- status
Template: ShortText.
- number
Template: ShortText.
- referenceNumber
Template: ShortText.
- fromLocationId
Data type: DT_I8
- toLocationId
Data type: DT_I8
- createdById
Data type: DT_I8
- memo
Template: ShortText.
- date
Template: DateTime.
- pickedDate
Template: DateTime.
- receivedDate
Template: DateTime.
- createdOn
Template: DateTime. A read-only field.
- modifiedOn
Template: DateTime. A read-only field.
- batchId
Data type: DT_I8
- syncStatus
Template: LongText. A composite field.
- items
Field components:
- An array.
-
Uses template:
itemT.
- [External]
-
The external fields URL address:
/transfers. The external fields list is extracted from:{{=ServiceTitan.getFieldResponse(response.data)}}.- custom.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=ServiceTitan.getFieldValue(field, value)}}expression.
Based on resource template JobManagement.
- [Read] action
-
Endpoint URL address:
/vendors.Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Vendors_GetList.
- [Read single] action
-
Endpoint URL address:
/vendors/{{=parameters.vendor_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- vendor_id: Required. Please specify the vendor identifier.
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Vendors_GetById.
- [Create] action
-
Endpoint URL address:
/vendors.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Vendors_Create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/vendors/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=ServiceTitan.getExternalData(item)}}
Documentation: https://developer.servicetitan.io/api-details/#api=tenant-inventory-v2&operation=Vendors_Update.
-
application/json:
- id
A key field. Data type: DT_I8
- name
Template: ShortText.
- active
Data type: DT_BOOL
- isTruckReplenishment
Data type: DT_BOOL
- isMobileCreationRestricted
Data type: DT_BOOL
- memo
Template: ShortText.
- deliveryOption
Template: ShortText.
- defaultTaxRate
Data type: DT_R8
- tags
Field components:
- An array.
- vendorContacts
Field components:
- An array.
- Contains the following components: id, name, email.
- contactInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: firstName, lastName, phone, email, fax.
-
Uses template:
- address
Template: addressT.
- createdOn
Template: DateTime. A read-only field.
- modifiedOn
Template: ShortText.
- applicationGuid
Template: ShortText.
- externalData
Field components:
- An array.
- Contains the following components: key, value.
- [Read] action
-
The result is extracted from:{{=response.data}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
pageSize:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- basicInfoT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, number.
-
Uses template:
- generalAccountT
Field components:
-
Uses template:
ShortText. - Contains the following components: name, number, type, detailType.
-
Uses template:
- itemT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, description, quantity, cost, totalCost, skipUpdatingMembershipPrices, inventoryLocation, inventoryWarehouseName, skuType, itemGroupName, serialNumber, price, unitPrice, type, skuName, signature, importId, name, code, technicianAcknowledgementSignature, skuId, total, inventory, isAddOn, workflowActionItemId, taxable, generalLedgerAccount, costOfSaleAccount, assetAccount, membershipTypeId, typeId, technicianId, itemGroup, displayName, soldHours, modifiedOn, installedOn, serviceDate, order, skuCode, vendorPartNumber, quantityReceived, serialNumbers, status, chargeable.
-
Uses template:
- addressT
Field components:
-
Uses template:
ShortText. - Contains the following components: street, unit, city, state, zip, country, latitude, longitude, streetAddress.
-
Uses template:
- noteT
Field components:
-
Uses template:
ShortText. - Contains the following components: text, isPinned, pinToTop, addToLocations, addToCustomer, createdById, createdOn, modifiedOn.
-
Uses template:
- phoneSettingT
Field components:
-
Uses template:
ShortText. - Contains the following components: phoneNumber, doNotText.
-
Uses template:
- contactT
Field components:
-
Uses template:
DateTime. - Contains the following components: modifiedOn, phoneSettings, id, type, value, memo, customerId.
-
Uses template:
- paymentTermPenaltyModelT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, penaltyApplyTo, penalty, penaltyType, maxPenaltyAmount, penaltyFrequency, serviceTaskId.
-
Uses template:
- paymentTermDiscountModelT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, discountApplyTo, discount, discountType, account, applyBy, applyByValue.
-
Uses template:
- interestSettingsT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, rateType, flatRateValue, percentageRateValue, chargeMethod, frequency, gracePeriod, targetInvoices, taskId, taskDisplayName.
-
Uses template:
- tenantT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, quickbooksClass, accountCode, franchiseId, conceptCode, modifiedOn.
-
Uses template:
- assetT
Field components:
-
Uses template:
ShortText. - Contains the following components: alias, fileName, type, url.
-
Uses template:
- externalDataT
Field components:
-
Uses template:
ShortText. - Contains the following components: key, value.
-
Uses template:
- generalAccountT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, cost, accountName.
-
Uses template:
- recommendationT
Field components:
-
Uses template:
ShortText. - Contains the following components: skuId, type.
-
Uses template:
- vendorT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, vendorName, vendorId, memo, vendorPart, cost, active, primarySubAccount, otherSubAccounts.
-
Uses template:
- generalServiceMaterialT
Field components:
- Contains the following components: skuId, quantity.
- generalWarrantyT
Field components:
-
Uses template:
ShortText. - Contains the following components: duration, description.
-
Uses template:
- serviceT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, code, displayName, description, warranty, categories, price, memberPrice, addOnPrice, addOnMemberPrice, taxable, account, hours, isLabor, recommendations, upgrades, assets, serviceMaterials, serviceEquipment, active, crossSaleGroup, paysCommission, modifiedOn, source, externalId, applicationGuid, externalData.
-
Uses template:
- materialT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, code, displayName, description, cost, active, price, memberPrice, addOnPrice, addOnMemberPrice, hours, commissionBonus, paysCommission, deductAsJobCost, unitOfMeasure, isInventory, account, costOfSaleAccount, assetAccount, taxable, primaryVendor, otherVendors, categories, assets, modifiedOn, source, externalId, applicationGuid, externalData.
-
Uses template:
- equipmentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, code, displayName, description, active, price, memberPrice, addOnPrice, addOnMemberPrice, manufacturer, model, manufacturerWarranty, serviceProviderWarranty, categories, assets, recommendations, upgrades, equipmentMaterials, primaryVendor, otherVendors, account, costOfSaleAccount, assetAccount, crossSaleGroup, paysCommission, commissionBonus, hours, taxable, cost, unitOfMeasure, isInventory, modifiedOn, source, externalId, applicationGuid, externalData.
-
Uses template:
- discountFeeT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, type, code, displayName, description, amountType, amount, limit, taxable, categories, hours, assets, account, crossSaleGroup, active, bonus, commissionBonus, paysCommission, excludeFromPayroll, applicationGuid, externalData.
-
Uses template:
- estimateItemT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, sku, skuAccount, description, qty, unitRate, total, itemGroupName, itemGroupRootId, modifiedOn.
-
Uses template:
- sessionDataT
Field components:
-
Uses template:
ShortText. - Contains the following components: landingPageUrl, referrerUrl, gclid, fbclid, msclkid, utmSource, utmMedium, utmCampaign, utmAdgroup, utmTerm, utmContent, googleAnalyticsClientId.
-
Uses template:
- businessUnitT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, active, name, officialName, email, currency, phoneNumber, invoiceHeader, invoiceMessage, defaultTaxRate, authorizationParagraph, acknowledgementParagraph, address, materialSku, quickbooksClass, accountCode, franchiseId, conceptCode, corporateContractNumber, tenant, createdOn, modifiedOn, externalData.
-
Uses template:
- reasonT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, lead, active.
-
Uses template:
- generalActiveT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, active.
-
Uses template:
- csDataT
Field components:
- An array.
- Contains the following components: name, value.
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.