Schemas

Record identifier

The chemical description.

Record identifier

The customer's first name.

The customer's last name.

The customer's company name if specified.

Mobile phone

Home phone

Work phone

Primary email address

Secondary email address

Billing street address

Billing city

Billing state

Billing postal code

The customer's service locations that included billable activity.

Record identifier

The type of the applied dosage.

The unit of measure quantity dosed.

Record identifier

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

A description of the installed item.

Number of units installed.

The unit price.

A part installed as part of a work order or route stop.

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.

The product (if any) referenced by the installed item.

The category of the installed item part.

The make of the installed item part.

The model of the installed item part.

Customers' billable service activity.

Tax groups referenced by included activity.

Work order types referenced by included activity.

Dosage types referenced by the included activity.

Products referenced by the included activity.

Record identifier

The service date of the route stop.

The time at which the route stop was completed. Currently reported in UTC only but this may change at a future date.

Bodies of water that included billable activity.

Record identifier

The body of water name.

Dosages applied to the body of water.

Items installed as part of completing a route stop.

Record identifier

Street address

City

State

Postal code

The service rate.

The type of rate applied to the service.

The tax group assigned to the service location.

Work orders completed at the service location.

Route stops completed at the service location.

Record identifier

The type of the work order.

The service date of the work order.

The time at which the work order was completed. Currently reported in UTC only but this may change at a future date.

The price of the work order. Independent of installed items or dosages.

A description of work performed as part of service.

Bodies of water that included billable activity.

Items installed as part of completing a work order.

Record identifier

The body of water name

Dosages applied to the body of water.

Name of the pool.

The volume of water in the pool, measured in gallons.

The baseline pressure reading of the pool's filter system, measured in PSI.

Additional notes or comments about the pool.

The Service Location ID this pool belongs to.

Name of the pool.

The volume of water in the pool, measured in gallons.

The baseline pressure reading of the pool's filter system, measured in PSI.

Additional notes or comments about the pool.

The unique identifier for the pool.

Name of the pool.

The volume of water in the pool, measured in gallons.

The baseline pressure reading of the pool's filter system, measured in PSI.

Additional notes or comments about the pool.

Name of the pool.

The unique identifier for the pool.

The Service Location ID this pool belongs to.

Indicates whether the pool has been marked as deleted.

The volume of water in the pool, measured in gallons.

The baseline pressure reading of the pool's filter system, measured in PSI.

Additional notes or comments about the pool.

Name of the pool.

The unique identifier for the pool.

The Service Location ID this pool belongs to.

Indicates whether the pool has been marked as deleted.

The volume of water in the pool, measured in gallons.

The baseline pressure reading of the pool's filter system, measured in PSI.

Additional notes or comments about the pool.

Manual customer activity types available through the Public API.

The activity title. Required, max 60 characters, letters/numbers/dashes/spaces only.

The activity description. Optional, max 300 characters.

Optional identifier of the author. Defaults to "System" if not provided.

Optional name of the author. Defaults to "System" if not provided.

The activity type (Call, Text, Email, Other).

The activity title. Required, max 60 characters, letters/numbers/dashes/spaces only.

The activity description. Optional, max 300 characters.

Optional identifier of the author. Defaults to "System" if not provided.

Optional name of the author. Defaults to "System" if not provided.

The customer identifier.

The activity type (e.g. "Call", "Text", "Email", "Other").

The activity title.

The unique identifier.

The activity description.

Whether this activity was system-generated.

The related entity identifier (e.g. InvoiceId, PaymentId).

The related entity type (e.g. "Invoice", "Quote", "Payment", "PaymentMethod", "Job").

Display text for the related entity (e.g. "Invoice #123").

The secondary related entity identifier (e.g. JobId, QuoteId).

The secondary related entity type.

Display text for the secondary related entity (e.g. "Job #123").

The name of the user who created the activity.

When the activity was created.

The name of the user who last updated the activity.

When the activity was last updated.

The customer identifier.

Billing street address.

Billing city

Billing state code

Billing postal code

The customer's available account credit balance.

Indicates as to if the customer is not active.

Indicates as to if the customer is softly deleted.

The timestamp of record creation.

The timestamp of last record update.

A list of tags associated with the customer.

Indicates whether this customer is a lead (not yet converted to a full customer).

The name of the lead source that referred this customer.

First name of the customer.

Last name of the customer.

Company name of the customer.

Mobile phone number of the customer.

Type of phone number in the MobilePhone.

Additional mobile phone number of the customer.

Type of phone number in the MobilePhone2.

Home phone number of the customer.

Work phone number of the customer.

The primary email address of the customer.

The secondary email address of the customer.

Additional email address of the customer.

Additional email address of the customer.

Notes about the customer.

The unique code assigned to the customer.

Indicates as to if the customer should be displayed as a company.

Indicates whether the primary email address is used for billing.

Indicates whether the secondary email address is used for billing.

Indicates whether the third email address is used for billing.

Indicates whether the fourth email address is used for billing.

Specifies whether service-related text messages should be sent to the customer's mobile phone.

The unique identifier of the lead source that referred this customer.

The customer identifier.

Billing street address.

Billing city

Billing state code

Billing postal code

Service locations related to the customer.

The customer's available account credit balance.

Indicates as to if the customer is not active.

Indicates as to if the customer is softly deleted.

The timestamp of record creation.

The timestamp of last record update.

A list of tags associated with the customer.

Indicates whether this customer is a lead (not yet converted to a full customer).

The name of the lead source that referred this customer.

First name of the customer.

Last name of the customer.

Company name of the customer.

Mobile phone number of the customer.

Type of phone number in the MobilePhone.

Additional mobile phone number of the customer.

Type of phone number in the MobilePhone2.

Home phone number of the customer.

Work phone number of the customer.

The primary email address of the customer.

The secondary email address of the customer.

Additional email address of the customer.

Additional email address of the customer.

Notes about the customer.

The unique code assigned to the customer.

Indicates as to if the customer should be displayed as a company.

Indicates whether the primary email address is used for billing.

Indicates whether the secondary email address is used for billing.

Indicates whether the third email address is used for billing.

Indicates whether the fourth email address is used for billing.

Specifies whether service-related text messages should be sent to the customer's mobile phone.

The unique identifier of the lead source that referred this customer.

Service locations related to the customer

Billing street address.

Billing city

Billing state code

Billing postal code

A list of tags associated with the customer.

First name of the customer.

Last name of the customer.

Company name of the customer.

Mobile phone number of the customer.

Type of phone number in the MobilePhone.

Additional mobile phone number of the customer.

Type of phone number in the MobilePhone2.

Home phone number of the customer.

Work phone number of the customer.

The primary email address of the customer.

The secondary email address of the customer.

Additional email address of the customer.

Additional email address of the customer.

Notes about the customer.

The unique code assigned to the customer.

Indicates as to if the customer should be displayed as a company.

Indicates whether the primary email address is used for billing.

Indicates whether the secondary email address is used for billing.

Indicates whether the third email address is used for billing.

Indicates whether the fourth email address is used for billing.

Specifies whether service-related text messages should be sent to the customer's mobile phone.

The unique identifier of the lead source that referred this customer.

The customer identifier.

Billing street address.

Billing city

Billing state code

Billing postal code

A list of tags associated with the customer.

First name of the customer.

Last name of the customer.

Company name of the customer.

Mobile phone number of the customer.

Type of phone number in the MobilePhone.

Additional mobile phone number of the customer.

Type of phone number in the MobilePhone2.

Home phone number of the customer.

Work phone number of the customer.

The primary email address of the customer.

The secondary email address of the customer.

Additional email address of the customer.

Additional email address of the customer.

Notes about the customer.

The unique code assigned to the customer.

Indicates as to if the customer should be displayed as a company.

Indicates whether the primary email address is used for billing.

Indicates whether the secondary email address is used for billing.

Indicates whether the third email address is used for billing.

Indicates whether the fourth email address is used for billing.

Specifies whether service-related text messages should be sent to the customer's mobile phone.

The unique identifier of the lead source that referred this customer.

The list of customer IDs to deactivate.

If true, route assignments related to the customers will be deleted.

If true, work orders associated with the customers will be deleted.

If true, work order reminders associated with the customers will be deleted.

If true, tags associated with the customers will be deleted.

The unique identifier for the dosage.

Indicates whether the dosage is deleted.

A description of the dosage.

The unit of measure for the dosage.

The cost of the dosage.

The price of the dosage.

The unique identifier of the installed item.

The date when the item was installed during service.

The first name of the customer associated with the service location.

The last name of the customer associated with the service location.

The company name of the customer, if applicable.

The address of the service location where the item was installed.

The description of the installed item as entered during service.

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

Additional details about the installed item, derived from the associated equipment, chemical, or product name.

The first name of the technician who performed the service.

The last name of the technician who performed the service.

The type of service: "Work Order" or "Service Stop".

The type of work order (e.g., Repair, Maintenance). Only available for work order items.

The unique identifier of the associated work order. Only available for work order items.

The invoice identifier.

The customer identifier.

The current status of this invoice.

The status related to invoice payment.

The total before taxes.

Sales taxes owed on this invoice.

Total amount with taxes.

Amount due from the customer.

The date this invoice was created.

The due date for this invoice.

The customer's first name.

The customer's last name.

The customer's address.

The city for the customer's address.

The state for the customer's address.

The zip code for the customer's address.

The invoice identifier.

The customer identifier.

The current status of this invoice.

The status related to invoice payment.

The total before taxes.

Sales taxes owed on this invoice.

Total amount with taxes.

Amount due from the customer.

The date this invoice was created.

The due date for this invoice.

The list of payments associated with this invoice.

Service locations associated with this invoice.

The customer's first name.

The customer's last name.

The customer's address.

The city for the customer's address.

The state for the customer's address.

The zip code for the customer's address.

The name of the line item.

The quantity to multiply the cost and rates by to get the subtotals.

This is the unit rate for this item.

True when the item is subject to sales tax.

The total amount for this item.

The item description.

The unit cost for this item.

The address of the service location.

The city of the service location.

The state of the service location.

The zip code of the service location.

The line items for this service location.

The payment amount.

The method of payment.

Date the payment was made.

A note recorded with the payment for clarification.

The unique identifier for the lead source.

Indicates whether the lead source is deleted.

The name of the lead source.

The product category identifier.

The product category description.

Indicates as to if the product category is softly deleted.

The timestamp of record creation.

The timestamp of last record update.

The product category identifier.

The product category description.

The product ID.

The default price applied when the product is added to a quote or invoice.

The product identifier.

Indicates that a resulting invoice line item will default to be taxable.

The product name.

Indicates as to if the product is softly deleted.

The timestamp of record creation.

The timestamp of last record update.

The cost to the pool pro for the product.

The default price applied when the product is added to a quote or invoice.

A category for the grouping of products

The default description applied when the product is added to a quote or invoice.

The product category identifier.

Indicates that a resulting invoice line item will default to be taxable.

The product name.

The cost to the pool pro for the product.

The default price applied when the product is added to a quote or invoice.

The default description applied when the product is added to a quote or invoice.

The product category identifier.

The product identifier.

Indicates that a resulting invoice line item will default to be taxable.

The product name.

The cost to the pool pro for the product.

The default price applied when the product is added to a quote or invoice.

The default description applied when the product is added to a quote or invoice.

The product category identifier.

The job identifier.

The current status of the job.

The job number.

The total cost of the job.

Total tax amount.

Total discount amount.

Total fee amount.

Subtotal before adjustments.

Total amount.

Profit margin.

Total deposit amount.

Total invoiced amount.

Total amount paid on invoices.

The quote identifier.

The quote number.

The date the quote was created.

The current status of the quote.

The total before taxes.

Sales taxes on this quote.

Total amount with taxes.

The customer identifier.

The customer's first name.

The customer's last name.

The customer's display name.

The expiration date of the quote.

The deposit amount required.

Represents a job associated with a quote.

The service locations for this quote.

The quote identifier.

The quote number.

The date the quote was created.

The current status of the quote.

The total before taxes.

Sales taxes on this quote.

Total amount with taxes.

Service locations associated with this quote.

The customer identifier.

The customer's first name.

The customer's last name.

The customer's display name.

The expiration date of the quote.

The deposit amount required.

Represents a job associated with a quote.

The service locations for this quote.

The quantity.

The unit rate for this item.

The name of the line item.

The item description.

The unit cost for this item.

The service location identifier.

The address of the service location.

The city of the service location.

The state of the service location.

The zip code of the service location.

The line items for this service location.

The unique identifier of the service technician.

The first name of the service technician.

The last name of the service technician.

The date of the route.

The list of stops on this route.

The unique identifier of this route stop.

The unique identifier of the customer at this stop.

The first name of the customer at this stop.

The last name of the customer at this stop.

The company name of the customer at this stop, if applicable.

The sequence number of this stop on the route.

The unique identifier of the service location.

The street address of the service location.

The city of the service location.

The state of the service location.

The ZIP code of the service location.

The time when the stop was completed. Null if not yet completed.

The unique identifier of the customer associated with this service location.

The street address of the service location.

The city where the service location is located.

The state or province of the service location.

The ZIP or postal code of the service location.

The unique identifier for the service location.

The service rate charged at this location.

The type of rate applied to the service.

The labor cost associated with servicing this location.

The type of labor cost applied.

Indicates whether the service location has been marked as deleted.

The tax group.

The latitude coordinate of the service location.

The longitude coordinate of the service location.

The gate access code for the service location, if applicable.

The name of the dog at the service location, if applicable.

Additional notes about the service location.

A custom code assigned to the service location.

The estimated number of minutes spent at this service location per visit.

The unique identifier of the customer associated with this service location.

The street address of the service location.

The city where the service location is located.

The state or province of the service location.

The ZIP or postal code of the service location.

Bodies of water associated with the service location.

The unique identifier for the service location.

The service rate charged at this location.

The type of rate applied to the service.

The labor cost associated with servicing this location.

The type of labor cost applied.

Indicates whether the service location has been marked as deleted.

The tax group.

The latitude coordinate of the service location.

The longitude coordinate of the service location.

The gate access code for the service location, if applicable.

The name of the dog at the service location, if applicable.

Additional notes about the service location.

A custom code assigned to the service location.

The estimated number of minutes spent at this service location per visit.

The unique identifier for the tax group.

The name of the tax group.

Indicates whether the tax group has been marked as deleted.

Indicates whether the tax group is currently active and available for use.

The labor cost.

The type of labor cost applied.

The unique identifier of the customer associated with this service location.

Bodies of water associated with the service location.

The street address of the service location.

The city where the service location is located.

The state or province of the service location.

The ZIP or postal code of the service location.

The service rate charged at this location.

The labor cost associated with servicing this location.

The latitude coordinate of the service location.

The longitude coordinate of the service location.

The gate access code for the service location, if applicable.

The name of the dog at the service location, if applicable.

Additional notes about the service location.

A custom code assigned to the service location.

The estimated number of minutes spent at this service location per visit.

The unique identifier for the service location.

The street address of the service location.

The city where the service location is located.

The state or province of the service location.

The ZIP or postal code of the service location.

The service rate charged at this location.

The labor cost associated with servicing this location.

The latitude coordinate of the service location.

The longitude coordinate of the service location.

The gate access code for the service location, if applicable.

The name of the dog at the service location, if applicable.

Additional notes about the service location.

A custom code assigned to the service location.

The estimated number of minutes spent at this service location per visit.

Bodies of water associated with the service location.

The street address of the service location.

The city where the service location is located.

The state or province of the service location.

The ZIP or postal code of the service location.

The service rate charged at this location.

The labor cost associated with servicing this location.

The latitude coordinate of the service location.

The longitude coordinate of the service location.

The gate access code for the service location, if applicable.

The name of the dog at the service location, if applicable.