Skimmer.PublicApi.Host | v1

Schemas

Billing.Chemical

idstring · required
Record identifier
descriptionstring · required
The chemical description.

Billing.Customer

idstring · required
Record identifier

firstNamestring | null
The customer's first name.
lastNamestring | null
The customer's last name.
companyNamestring | null
The customer's company name if specified.
mobilePhonestring | null
Mobile phone
homePhonestring | null
Home phone
workPhonestring | null
Work phone
primaryEmailstring | null
Primary email address
secondaryEmailstring | null
Secondary email address
billingAddressstring | null
Billing street address
billingCitystring | null
Billing city
billingStatestring | null
Billing state
billingZipstring | null
Billing postal code
serviceLocationsobject[]
The customer's service locations that included billable activity.

Billing.Dosage

idstring · required
Record identifier
dosageTypeIdstring · required
The type of the applied dosage.

quantitynumber · double
The unit of measure quantity dosed.

Billing.InstalledItem

idstring · required
Record identifier

itemTypestring · enum
The installed item type. This will indicate as to if the installed item's reference ID references a part, product or chemical.
Enum values:
Part
Chemical
Other
Product
descriptionstring | null
A description of the installed item.
quantitynumber · double
Number of units installed.
pricenumber · double
The unit price.
partobject
A part installed as part of a work order or route stop.
chemicalobject
A chemical installed as part of a work order or route stop. Unrelated to dosages. This typically represents chemical inventory left at the service site rather than those added to the body of water.
productIdstring | null
The product (if any) referenced by the installed item.

Billing.Part

categorystring · required
The category of the installed item part.
makestring · required
The make of the installed item part.
modelstring · required
The model of the installed item part.

Billing.Response

serviceActivityobject[]
Customers' billable service activity.
taxGroupsobject[]
Tax groups referenced by included activity.
workOrderTypesobject[]
Work order types referenced by included activity.
dosageTypesobject[]
Dosage types referenced by the included activity.
productsobject[]
Products referenced by the included activity.

Billing.RouteStop

idstring · required
Record identifier

serviceDatestring · date
The service date of the route stop.
completeTimestring · date-time
The time at which the route stop was completed. Currently reported in UTC only but this may change at a future date.
bodiesOfWaterobject[]
Bodies of water that included billable activity.

Billing.RouteStopBodyOfWater

idstring · required
Record identifier

namestring | null
The body of water name.
dosagesarray
Dosages applied to the body of water.
installedItemsarray
Items installed as part of completing a route stop.

Billing.ServiceLocation

idstring · required
Record identifier

addressstring | null
Street address
citystring | null
City
statestring | null
State
zipstring | null
Postal code
ratenumber · double
The service rate.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
taxGroupIdstring | null
The tax group assigned to the service location.
workOrdersobject[]
Work orders completed at the service location.
routeStopsobject[]
Route stops completed at the service location.

Billing.ShoppingListItemType

string · enum

Enum values:

Part

Chemical

Other

Product

The installed item type. This will indicate as to if the installed item's reference ID references a part, product or chemical.

Billing.WorkOrder

idstring · required
Record identifier
workOrderTypeIdstring · required
The type of the work order.

serviceDatestring · date
The service date of the work order.
completeTimestring · date-time
The time at which the work order was completed. Currently reported in UTC only but this may change at a future date.
pricenumber · double
The price of the work order. Independent of installed items or dosages.
workPerformedstring | null
A description of work performed as part of service.
bodiesOfWaterobject[]
Bodies of water that included billable activity.
installedItemsobject[]
Items installed as part of completing a work order.

Billing.WorkOrderBodyOfWater

idstring · required
Record identifier

namestring | null
The body of water name
dosagesobject[]
Dosages applied to the body of water.

BodiesOfWater.BodyOfWater

namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

BodiesOfWater.BodyOfWater.Create

serviceLocationIdstring · required
The Service Location ID this pool belongs to.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

BodiesOfWater.BodyOfWater.Update

idstring | null · required
The unique identifier for the pool.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

BodiesOfWater.BodyOfWaterListItem

namestring | null · required
Name of the pool.

idstring | null
The unique identifier for the pool.
serviceLocationIdstring | null
The Service Location ID this pool belongs to.
deletedboolean
Indicates whether the pool has been marked as deleted.
gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

BodiesOfWater.BodyOfWaterRead

namestring | null · required
Name of the pool.

idstring | null
The unique identifier for the pool.
serviceLocationIdstring | null
The Service Location ID this pool belongs to.
deletedboolean
Indicates whether the pool has been marked as deleted.
gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Customers.CustomerListItem

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Customers.CustomerRead

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

serviceLocationsarray | null
Service locations related to the customer.
accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Customers.Writes.Customer.Create

serviceLocationsarray | null · required
Service locations related to the customer
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Customers.Writes.Customer.Update

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Customers.Writes.CustomersDeactivate

idsstring[] · required
The list of customer IDs to deactivate.

deleteRouteAssignmentsboolean | null
If true, route assignments related to the customers will be deleted.
deleteWorkOrdersboolean | null
If true, work orders associated with the customers will be deleted.
deleteWorkOrderRemindersboolean | null
If true, work order reminders associated with the customers will be deleted.
deleteTagsboolean | null
If true, tags associated with the customers will be deleted.
deleteRepeatingWorkOrdersboolean | null

Customers.Writes.MultiStatus

resultsobject[]

Customers.Writes.MultiStatusItem

idstring
statusstring

DosageTypes.DosageType

idstring · required
The unique identifier for the dosage.

deletedboolean
Indicates whether the dosage is deleted.
descriptionstring | null
A description of the dosage.
unitOfMeasurestring | null
The unit of measure for the dosage.
costnumber · double
The cost of the dosage.
pricenumber · double
The price of the dosage.

ErrorLevel

string · enum

Enum values:

Error

Warning

Info

ErrorResponse

messagestring | null
errorCodestring | null
errorLevelstring · enum
Enum values:
Error
Warning
Info
validationErrorsobject | null
dataobject | null

Invoices.Invoice

idstring · required
The invoice identifier.
customerIdstring · required
The customer identifier.
statusstring · required
The current status of this invoice.
subtotalnumber · double · required
The total before taxes.
taxAmountnumber · double · required
Sales taxes owed on this invoice.
totalnumber · double · required
Total amount with taxes.
amountDuenumber · double · required
Amount due from the customer.
invoiceDatestring · date-time · required
The date this invoice was created.
dueDatestring · date-time · required
The due date for this invoice.

customerFirstNamestring | null
The customer's first name.
customerLastNamestring | null
The customer's last name.
billingAddressstring | null
The customer's address.
billingCitystring | null
The city for the customer's address.
billingStatestring | null
The state for the customer's address.
billingZipstring | null
The zip code for the customer's address.

Invoices.InvoiceDetail

idstring · required
The invoice identifier.
customerIdstring · required
The customer identifier.
statusstring · required
The current status of this invoice.
subtotalnumber · double · required
The total before taxes.
taxAmountnumber · double · required
Sales taxes owed on this invoice.
totalnumber · double · required
Total amount with taxes.
amountDuenumber · double · required
Amount due from the customer.
invoiceDatestring · date-time · required
The date this invoice was created.
dueDatestring · date-time · required
The due date for this invoice.

paymentsobject[]
The list of payments associated with this invoice.
serviceLocationsobject[]
Service locations associated with this invoice.
customerFirstNamestring | null
The customer's first name.
customerLastNamestring | null
The customer's last name.
billingAddressstring | null
The customer's address.
billingCitystring | null
The city for the customer's address.
billingStatestring | null
The state for the customer's address.
billingZipstring | null
The zip code for the customer's address.

Invoices.InvoiceItem

itemstring · required
The name of the line item.
quantitynumber · double · required
The quantity to multiply the cost and rates by to get the subtotals.
ratenumber · double · required
This is the unit rate for this item.
isTaxableboolean · required
True when the item is subject to sales tax.
amountnumber · double · required
The total amount for this item.

descriptionstring | null
The item description.
costnumber | null · double
The unit cost for this item.

Invoices.InvoiceLocation

serviceLocationAddressstring · required
The address of the service location.

serviceLocationCitystring | null
The city of the service location.
serviceLocationStatestring | null
The state of the service location.
serviceLocationZipstring | null
The zip code of the service location.
invoiceItemsobject[]
The line items for this service location.

Invoices.Payment

amountnumber · double · required
The payment amount.
paymentMethodstring · required
The method of payment.

paymentDatestring | null · date-time
Date the payment was made.
statusMessagestring | null
A note recorded with the payment for clarification.

ProblemDetails

typestring | null
titlestring | null
statusinteger | null · int32
detailstring | null
instancestring | null

ProductCategories.ProductCategory

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

deletedboolean
Indicates as to if the product category is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.

ProductCategories.ProductCategory.Create

descriptionstring · required

ProductCategories.ProductCategory.Update

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

Products.PriceUpdate

idstring · required
The product ID.

defaultPricenumber | null · double
The default price applied when the product is added to a quote or invoice.

Products.Product

idstring · required
The product identifier.
isTaxableboolean · required
Indicates that a resulting invoice line item will default to be taxable.
namestring · required
The product name.

deletedboolean
Indicates as to if the product is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
costnumber · double
The cost to the pool pro for the product.
defaultPricenumber · double
The default price applied when the product is added to a quote or invoice.
categoryobject
A category for the grouping of products
defaultDescriptionstring | null
The default description applied when the product is added to a quote or invoice.
productCategoryIdstring | null
The product category identifier.

Products.Product.Create

isTaxableboolean | null · required
Indicates that a resulting invoice line item will default to be taxable.
namestring · required
The product name.

costnumber | null · double
The cost to the pool pro for the product.
defaultPricenumber | null · double
The default price applied when the product is added to a quote or invoice.
defaultDescriptionstring | null
The default description applied when the product is added to a quote or invoice.
productCategoryIdstring | null
The product category identifier.

Products.Product.Update

idstring · required
The product identifier.
isTaxableboolean | null · required
Indicates that a resulting invoice line item will default to be taxable.
namestring · required
The product name.

costnumber | null · double
The cost to the pool pro for the product.
defaultPricenumber | null · double
The default price applied when the product is added to a quote or invoice.
defaultDescriptionstring | null
The default description applied when the product is added to a quote or invoice.
productCategoryIdstring | null
The product category identifier.

ServiceLocations.LaborCostType

string · enum

Enum values:

None

PerStop

PerMonth

The type of labor cost applied.

ServiceLocations.RateType

string · enum

Enum values:

None

PerStopIncludingChemicals

PerStopPlusChemicals

FlatMonthlyRateIncludingChemicals

FlatMonthlyRatePlusChemicals

The type of rate applied to the service.

ServiceLocations.ServiceLocationListItem

customerIdstring · required
The unique identifier of the customer associated with this service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

idstring | null
The unique identifier for the service location.
ratenumber · double
The service rate charged at this location.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
laborCostnumber · double
The labor cost associated with servicing this location.
laborCostTypestring · enum
The type of labor cost applied.
Enum values:
None
PerStop
PerMonth
deletedboolean
Indicates whether the service location has been marked as deleted.
taxGroupobject
The tax group.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

ServiceLocations.ServiceLocationRead

customerIdstring · required
The unique identifier of the customer associated with this service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

bodiesOfWaterobject[]
Bodies of water associated with the service location.
idstring | null
The unique identifier for the service location.
ratenumber · double
The service rate charged at this location.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
laborCostnumber · double
The labor cost associated with servicing this location.
laborCostTypestring · enum
The type of labor cost applied.
Enum values:
None
PerStop
PerMonth
deletedboolean
Indicates whether the service location has been marked as deleted.
taxGroupobject
The tax group.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

ServiceLocations.TaxGroup

idstring · required
The unique identifier for the tax group.
namestring · required
The name of the tax group.

deletedboolean
Indicates whether the tax group has been marked as deleted.
isActiveboolean
Indicates whether the tax group is currently active and available for use.

ServiceLocations.Writes.LaborCost

costnumber · double · required
The labor cost.
typestring · enum · required
The type of labor cost applied.
Enum values:
PerStop
PerMonth

ServiceLocations.Writes.LaborCostType

string · enum

Enum values:

PerStop

PerMonth

The type of labor cost applied.

ServiceLocations.Writes.RateType

string · enum

Enum values:

PerStopIncludingChemicals

PerStopPlusChemicals

FlatMonthlyRateIncludingChemicals

FlatMonthlyRatePlusChemicals

The type of rate applied to the service.

ServiceLocations.Writes.ServiceLocation.Create

customerIdstring · required
The unique identifier of the customer associated with this service location.
bodiesOfWaterobject[] · required
Bodies of water associated with the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

ServiceLocations.Writes.ServiceLocation.Update

idstring | null · required
The unique identifier for the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

ServiceLocations.Writes.ServiceLocationCreateDtoBase

bodiesOfWaterobject[] · required
Bodies of water associated with the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

ServiceLocations.Writes.ServiceRate

costnumber · double · required
The service rate cost.
typestring · enum · required
The type of rate applied to the service.
Enum values:
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals

Tags.Name

namestring · required
Name of the tag.

Tags.Tag

namestring · required
Name of the tag.

idstring | null
The unique identifier for the tag.
deletedboolean
Indicates whether the tag has been marked as deleted.

WorkOrders.WorkOrderType

idstring · required
The unique identifier for the work order type.

descriptionstring | null
The work order type name/description.
defaultPricenumber · double
The default price used when creating a work order.
priceIsTaxableboolean
Indicates that the work order price is taxable.
deletedboolean
Indicates whether the work order type has been marked as deleted.

Skimmer.PublicApi.Host | v1

Schemas

Billing.Chemical

idstring · required
Record identifier
descriptionstring · required
The chemical description.

Billing.Customer

idstring · required
Record identifier

firstNamestring | null
The customer's first name.
lastNamestring | null
The customer's last name.
companyNamestring | null
The customer's company name if specified.
mobilePhonestring | null
Mobile phone
homePhonestring | null
Home phone
workPhonestring | null
Work phone
primaryEmailstring | null
Primary email address
secondaryEmailstring | null
Secondary email address
billingAddressstring | null
Billing street address
billingCitystring | null
Billing city
billingStatestring | null
Billing state
billingZipstring | null
Billing postal code
serviceLocationsobject[]
The customer's service locations that included billable activity.

Billing.Dosage

idstring · required
Record identifier
dosageTypeIdstring · required
The type of the applied dosage.

quantitynumber · double
The unit of measure quantity dosed.

Billing.InstalledItem

idstring · required
Record identifier

itemTypestring · enum
The installed item type. This will indicate as to if the installed item's reference ID references a part, product or chemical.
Enum values:
Part
Chemical
Other
Product
descriptionstring | null
A description of the installed item.
quantitynumber · double
Number of units installed.
pricenumber · double
The unit price.
partobject
A part installed as part of a work order or route stop.
chemicalobject
A chemical installed as part of a work order or route stop. Unrelated to dosages. This typically represents chemical inventory left at the service site rather than those added to the body of water.
productIdstring | null
The product (if any) referenced by the installed item.

Billing.Part

categorystring · required
The category of the installed item part.
makestring · required
The make of the installed item part.
modelstring · required
The model of the installed item part.

Billing.Response

serviceActivityobject[]
Customers' billable service activity.
taxGroupsobject[]
Tax groups referenced by included activity.
workOrderTypesobject[]
Work order types referenced by included activity.
dosageTypesobject[]
Dosage types referenced by the included activity.
productsobject[]
Products referenced by the included activity.

Billing.RouteStop

idstring · required
Record identifier

serviceDatestring · date
The service date of the route stop.
completeTimestring · date-time
The time at which the route stop was completed. Currently reported in UTC only but this may change at a future date.
bodiesOfWaterobject[]
Bodies of water that included billable activity.

Billing.RouteStopBodyOfWater

idstring · required
Record identifier

namestring | null
The body of water name.
dosagesarray
Dosages applied to the body of water.
installedItemsarray
Items installed as part of completing a route stop.

Billing.ServiceLocation

idstring · required
Record identifier

addressstring | null
Street address
citystring | null
City
statestring | null
State
zipstring | null
Postal code
ratenumber · double
The service rate.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
taxGroupIdstring | null
The tax group assigned to the service location.
workOrdersobject[]
Work orders completed at the service location.
routeStopsobject[]
Route stops completed at the service location.

Billing.ShoppingListItemType

string · enum

Enum values:

Part

Chemical

Other

Product

The installed item type. This will indicate as to if the installed item's reference ID references a part, product or chemical.

Billing.WorkOrder

idstring · required
Record identifier
workOrderTypeIdstring · required
The type of the work order.

serviceDatestring · date
The service date of the work order.
completeTimestring · date-time
The time at which the work order was completed. Currently reported in UTC only but this may change at a future date.
pricenumber · double
The price of the work order. Independent of installed items or dosages.
workPerformedstring | null
A description of work performed as part of service.
bodiesOfWaterobject[]
Bodies of water that included billable activity.
installedItemsobject[]
Items installed as part of completing a work order.

Billing.WorkOrderBodyOfWater

idstring · required
Record identifier

namestring | null
The body of water name
dosagesobject[]
Dosages applied to the body of water.

BodiesOfWater.BodyOfWater

namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

BodiesOfWater.BodyOfWater.Create

serviceLocationIdstring · required
The Service Location ID this pool belongs to.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

BodiesOfWater.BodyOfWater.Update

idstring | null · required
The unique identifier for the pool.
namestring | null · required
Name of the pool.

gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

BodiesOfWater.BodyOfWaterListItem

namestring | null · required
Name of the pool.

idstring | null
The unique identifier for the pool.
serviceLocationIdstring | null
The Service Location ID this pool belongs to.
deletedboolean
Indicates whether the pool has been marked as deleted.
gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

BodiesOfWater.BodyOfWaterRead

namestring | null · required
Name of the pool.

idstring | null
The unique identifier for the pool.
serviceLocationIdstring | null
The Service Location ID this pool belongs to.
deletedboolean
Indicates whether the pool has been marked as deleted.
gallonsinteger · int64
The volume of water in the pool, measured in gallons.
baselineFilterPressurenumber · double
The baseline pressure reading of the pool's filter system, measured in PSI.
notesstring | null
Additional notes or comments about the pool.

Customers.CustomerListItem

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Customers.CustomerRead

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

serviceLocationsarray | null
Service locations related to the customer.
accountCreditnumber · double
The customer's available account credit balance.
isInactiveboolean
Indicates as to if the customer is not active.
deletedboolean
Indicates as to if the customer is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Customers.Writes.Customer.Create

serviceLocationsarray | null · required
Service locations related to the customer
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Customers.Writes.Customer.Update

idstring · required
The customer identifier.
billingAddressstring | null · required
Billing street address.
billingCitystring | null · required
Billing city
billingStatestring | null · required
Billing state code
billingZipstring | null · required
Billing postal code

tagsarray | null
A list of tags associated with the customer.
firstNamestring | null
First name of the customer.
lastNamestring | null
Last name of the customer.
companyNamestring | null
Company name of the customer.
mobilePhonestring | null
Mobile phone number of the customer.
mobileLabel1string | null
Type of phone number in the MobilePhone.
mobilePhone2string | null
Additional mobile phone number of the customer.
mobileLabel2string | null
Type of phone number in the MobilePhone2.
homePhonestring | null
Home phone number of the customer.
workPhonestring | null
Work phone number of the customer.
primaryEmailstring | null
The primary email address of the customer.
secondaryEmailstring | null
The secondary email address of the customer.
email3string | null
Additional email address of the customer.
email4string | null
Additional email address of the customer.
notesstring | null
Notes about the customer.
customerCodestring | null
The unique code assigned to the customer.
displayAsCompanyboolean
Indicates as to if the customer should be displayed as a company.
primaryEmailIsBillingboolean
Indicates whether the primary email address is used for billing.
secondaryEmailIsBillingboolean
Indicates whether the secondary email address is used for billing.
email3IsBillingboolean
Indicates whether the third email address is used for billing.
email4IsBillingboolean
Indicates whether the fourth email address is used for billing.
mobilePhoneSendServiceTextsboolean
Specifies whether service-related text messages should be sent to the customer's mobile phone.

Customers.Writes.CustomersDeactivate

idsstring[] · required
The list of customer IDs to deactivate.

deleteRouteAssignmentsboolean | null
If true, route assignments related to the customers will be deleted.
deleteWorkOrdersboolean | null
If true, work orders associated with the customers will be deleted.
deleteWorkOrderRemindersboolean | null
If true, work order reminders associated with the customers will be deleted.
deleteTagsboolean | null
If true, tags associated with the customers will be deleted.
deleteRepeatingWorkOrdersboolean | null

Customers.Writes.MultiStatus

resultsobject[]

Customers.Writes.MultiStatusItem

idstring
statusstring

DosageTypes.DosageType

idstring · required
The unique identifier for the dosage.

deletedboolean
Indicates whether the dosage is deleted.
descriptionstring | null
A description of the dosage.
unitOfMeasurestring | null
The unit of measure for the dosage.
costnumber · double
The cost of the dosage.
pricenumber · double
The price of the dosage.

ErrorLevel

string · enum

Enum values:

Error

Warning

Info

ErrorResponse

messagestring | null
errorCodestring | null
errorLevelstring · enum
Enum values:
Error
Warning
Info
validationErrorsobject | null
dataobject | null

Invoices.Invoice

idstring · required
The invoice identifier.
customerIdstring · required
The customer identifier.
statusstring · required
The current status of this invoice.
subtotalnumber · double · required
The total before taxes.
taxAmountnumber · double · required
Sales taxes owed on this invoice.
totalnumber · double · required
Total amount with taxes.
amountDuenumber · double · required
Amount due from the customer.
invoiceDatestring · date-time · required
The date this invoice was created.
dueDatestring · date-time · required
The due date for this invoice.

customerFirstNamestring | null
The customer's first name.
customerLastNamestring | null
The customer's last name.
billingAddressstring | null
The customer's address.
billingCitystring | null
The city for the customer's address.
billingStatestring | null
The state for the customer's address.
billingZipstring | null
The zip code for the customer's address.

Invoices.InvoiceDetail

idstring · required
The invoice identifier.
customerIdstring · required
The customer identifier.
statusstring · required
The current status of this invoice.
subtotalnumber · double · required
The total before taxes.
taxAmountnumber · double · required
Sales taxes owed on this invoice.
totalnumber · double · required
Total amount with taxes.
amountDuenumber · double · required
Amount due from the customer.
invoiceDatestring · date-time · required
The date this invoice was created.
dueDatestring · date-time · required
The due date for this invoice.

paymentsobject[]
The list of payments associated with this invoice.
serviceLocationsobject[]
Service locations associated with this invoice.
customerFirstNamestring | null
The customer's first name.
customerLastNamestring | null
The customer's last name.
billingAddressstring | null
The customer's address.
billingCitystring | null
The city for the customer's address.
billingStatestring | null
The state for the customer's address.
billingZipstring | null
The zip code for the customer's address.

Invoices.InvoiceItem

itemstring · required
The name of the line item.
quantitynumber · double · required
The quantity to multiply the cost and rates by to get the subtotals.
ratenumber · double · required
This is the unit rate for this item.
isTaxableboolean · required
True when the item is subject to sales tax.
amountnumber · double · required
The total amount for this item.

descriptionstring | null
The item description.
costnumber | null · double
The unit cost for this item.

Invoices.InvoiceLocation

serviceLocationAddressstring · required
The address of the service location.

serviceLocationCitystring | null
The city of the service location.
serviceLocationStatestring | null
The state of the service location.
serviceLocationZipstring | null
The zip code of the service location.
invoiceItemsobject[]
The line items for this service location.

Invoices.Payment

amountnumber · double · required
The payment amount.
paymentMethodstring · required
The method of payment.

paymentDatestring | null · date-time
Date the payment was made.
statusMessagestring | null
A note recorded with the payment for clarification.

ProblemDetails

typestring | null
titlestring | null
statusinteger | null · int32
detailstring | null
instancestring | null

ProductCategories.ProductCategory

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

deletedboolean
Indicates as to if the product category is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.

ProductCategories.ProductCategory.Create

descriptionstring · required

ProductCategories.ProductCategory.Update

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

Products.PriceUpdate

idstring · required
The product ID.

defaultPricenumber | null · double
The default price applied when the product is added to a quote or invoice.

Products.Product

idstring · required
The product identifier.
isTaxableboolean · required
Indicates that a resulting invoice line item will default to be taxable.
namestring · required
The product name.

deletedboolean
Indicates as to if the product is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.
costnumber · double
The cost to the pool pro for the product.
defaultPricenumber · double
The default price applied when the product is added to a quote or invoice.
categoryobject
A category for the grouping of products
defaultDescriptionstring | null
The default description applied when the product is added to a quote or invoice.
productCategoryIdstring | null
The product category identifier.

Products.Product.Create

isTaxableboolean | null · required
Indicates that a resulting invoice line item will default to be taxable.
namestring · required
The product name.

costnumber | null · double
The cost to the pool pro for the product.
defaultPricenumber | null · double
The default price applied when the product is added to a quote or invoice.
defaultDescriptionstring | null
The default description applied when the product is added to a quote or invoice.
productCategoryIdstring | null
The product category identifier.

Products.Product.Update

idstring · required
The product identifier.
isTaxableboolean | null · required
Indicates that a resulting invoice line item will default to be taxable.
namestring · required
The product name.

costnumber | null · double
The cost to the pool pro for the product.
defaultPricenumber | null · double
The default price applied when the product is added to a quote or invoice.
defaultDescriptionstring | null
The default description applied when the product is added to a quote or invoice.
productCategoryIdstring | null
The product category identifier.

ServiceLocations.LaborCostType

string · enum

Enum values:

None

PerStop

PerMonth

The type of labor cost applied.

ServiceLocations.RateType

string · enum

Enum values:

None

PerStopIncludingChemicals

PerStopPlusChemicals

FlatMonthlyRateIncludingChemicals

FlatMonthlyRatePlusChemicals

The type of rate applied to the service.

ServiceLocations.ServiceLocationListItem

customerIdstring · required
The unique identifier of the customer associated with this service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

idstring | null
The unique identifier for the service location.
ratenumber · double
The service rate charged at this location.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
laborCostnumber · double
The labor cost associated with servicing this location.
laborCostTypestring · enum
The type of labor cost applied.
Enum values:
None
PerStop
PerMonth
deletedboolean
Indicates whether the service location has been marked as deleted.
taxGroupobject
The tax group.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

ServiceLocations.ServiceLocationRead

customerIdstring · required
The unique identifier of the customer associated with this service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

bodiesOfWaterobject[]
Bodies of water associated with the service location.
idstring | null
The unique identifier for the service location.
ratenumber · double
The service rate charged at this location.
rateTypestring · enum
The type of rate applied to the service.
Enum values:
None
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals
laborCostnumber · double
The labor cost associated with servicing this location.
laborCostTypestring · enum
The type of labor cost applied.
Enum values:
None
PerStop
PerMonth
deletedboolean
Indicates whether the service location has been marked as deleted.
taxGroupobject
The tax group.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

ServiceLocations.TaxGroup

idstring · required
The unique identifier for the tax group.
namestring · required
The name of the tax group.

deletedboolean
Indicates whether the tax group has been marked as deleted.
isActiveboolean
Indicates whether the tax group is currently active and available for use.

ServiceLocations.Writes.LaborCost

costnumber · double · required
The labor cost.
typestring · enum · required
The type of labor cost applied.
Enum values:
PerStop
PerMonth

ServiceLocations.Writes.LaborCostType

string · enum

Enum values:

PerStop

PerMonth

The type of labor cost applied.

ServiceLocations.Writes.RateType

string · enum

Enum values:

PerStopIncludingChemicals

PerStopPlusChemicals

FlatMonthlyRateIncludingChemicals

FlatMonthlyRatePlusChemicals

The type of rate applied to the service.

ServiceLocations.Writes.ServiceLocation.Create

customerIdstring · required
The unique identifier of the customer associated with this service location.
bodiesOfWaterobject[] · required
Bodies of water associated with the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

ServiceLocations.Writes.ServiceLocation.Update

idstring | null · required
The unique identifier for the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

ServiceLocations.Writes.ServiceLocationCreateDtoBase

bodiesOfWaterobject[] · required
Bodies of water associated with the service location.
addressstring | null · required
The street address of the service location.
citystring | null · required
The city where the service location is located.
statestring | null · required
The state or province of the service location.
zipstring | null · required
The ZIP or postal code of the service location.

serviceRateobject
The service rate charged at this location.
laborCostobject
The labor cost associated with servicing this location.
latitudenumber · double
The latitude coordinate of the service location.
longitudenumber · double
The longitude coordinate of the service location.
gateCodestring | null
The gate access code for the service location, if applicable.
dogsNamestring | null
The name of the dog at the service location, if applicable.
notesstring | null
Additional notes about the service location.
locationCodestring | null
A custom code assigned to the service location.
minutesAtStopinteger · int32
The estimated number of minutes spent at this service location per visit.

ServiceLocations.Writes.ServiceRate

costnumber · double · required
The service rate cost.
typestring · enum · required
The type of rate applied to the service.
Enum values:
PerStopIncludingChemicals
PerStopPlusChemicals
FlatMonthlyRateIncludingChemicals
FlatMonthlyRatePlusChemicals

Tags.Name

namestring · required
Name of the tag.

Tags.Tag

namestring · required
Name of the tag.

idstring | null
The unique identifier for the tag.
deletedboolean
Indicates whether the tag has been marked as deleted.

WorkOrders.WorkOrderType

idstring · required
The unique identifier for the work order type.

descriptionstring | null
The work order type name/description.
defaultPricenumber · double
The default price used when creating a work order.
priceIsTaxableboolean
Indicates that the work order price is taxable.
deletedboolean
Indicates whether the work order type has been marked as deleted.