Billing

ticket

9 endpoints. Start at search to collect IDs, then resolve them through get.

Read · 4

search get by id getAddOns

Write · 5

create update createAddOn setAddOns updateAddOn

Read operations

search/ticket/searchTry it

search ticket

Provide a set of parameters which will return a list of ids. There is no limit to the number of IDs this will return. You can then supply these ids to the get endpoint in order to retrieve bulk data. Every parameter available supports a simple value OR a powerful query object that gives you access to all basic comparators.

Example

dateAdded={"operator":">","value":"2016-01-01"}

Example

dateAdded={"operator\":\"BETWEEN\",\"value\":[\"2016-05-12\",\"2016-05-13\"]}

Available operators

><>=<==!=INBETWEENLIKESTARTSWITHENDSWITHCONTAINS

Each of the search endpoints allows for an optional parameter 'includeData'. When sent, the API will additionally send the resolved objects for the first 1000 IDs.

Keep in mind when using 'includeData' that if there are more than 1000 items an additional property '{entity}IDsNoDataExported' will specify the items that are not included in the resolved data array.

Parameters

officeIDsinteger

No description in the upstream reference.

ticketIDsinteger

No description in the upstream reference.

statusinteger

Whether this ticket/invoice is active: 1 or inactive: 0. Inactive tickets are not added to the customer's balance or A/R aging

customerIDsinteger

The customer who owns this ticket

recurringTemplateSubscriptionIDsinteger

When a ticket has a recurring template subscription ID it represents a recurring ticket template

dateCreatedstring

The date this ticket was created

invoiceDatestring

Invoice date

dateUpdatedstring

The date the ticket was updated

Returns

ticketIDsarray

No description in the upstream reference.

Request

/ticket/search

curl -X POST 'https://{subdomain}.pestroutes.com/api/ticket/search' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'officeIDs=1' \
  --data-urlencode 'ticketIDs=1' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

0:10000

1:10007

2:10014

3:10021

4:10028

5:10035

6:10042

7:10049

]

count:8

}

get/ticket/getTry it

get ticket

Get Bulk data for ticket. Accepts an array of ticketIDs. Returns a max of 1000 records.

Parameters

ticketIDsarray

No description in the upstream reference.

Returns

ticketIDinteger

Unique ID

customerIDinteger

Customer ID which this subscription belongs to

billToAccountIDinteger

Billing Account which this subscription belongs to

officeIDinteger

Office ID which this subscription belongs to

dateCreatedstring

Date this ticket was added / created.

invoiceDatestring

Invoice date

dateUpdatedstring

The date the ticket was updated

activeinteger

0: pending, 1: active and counts towards customer's outstanding balance, -1: a ticket template.

Request

/ticket/get

curl -X POST 'https://{subdomain}.pestroutes.com/api/ticket/get' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'ticketIDs=value' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

]

count:2

}

by id/ticket/{id}Try it

Fetch by id ticket

Get ticket data for single ID -- please provide a specific record ID in the URL structure.

Parameters

No parameters beyond authentication.

Returns

ticketIDinteger

Unique ID

customerIDinteger

Customer ID which this subscription belongs to

billToAccountIDinteger

Billing Account which this subscription belongs to

officeIDinteger

Office ID which this subscription belongs to

dateCreatedstring

Date this ticket was added / created.

invoiceDatestring

Invoice date

dateUpdatedstring

The date the ticket was updated

activeinteger

0: pending, 1: active and counts towards customer's outstanding balance, -1: a ticket template.

Request

/ticket/{id}

curl -X POST 'https://{subdomain}.pestroutes.com/api/ticket/{id}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

ticketID:1786

customerID:2124

billToAccountID:7833

officeID:2602

dateCreated:"2026-03-03 00:00:00"

invoiceDate:"2026-06-12 00:00:00"

dateUpdated:"2026-04-07 00:00:00"

active:1

subTotal:17.5

taxAmount:32.5

total:49.5

serviceCharge:110.5

serviceTaxable:2

productionValue:125.5

taxRate:160.5

appointmentID:7501

balance:81.5

subscriptionID:5259

autoGenerated:2

autoGeneratedType:"sample-autoGeneratedType"

renewalID:6502

serviceID:1795

items:"sample-items"

invoiceNumber:"sample-invoiceNumber"

templateType:"sample-templateType"

glNumber:"sample-glNumber"

}

getAddOns/ticket/getAddOnsTry it

getAddOns ticket

Get Addons for a ticket.

Parameters

No parameters beyond authentication.

Returns

itemIDinteger

Primary key for ticketItems

ticketIDinteger

Foreign key to tickets table. Retrieve via getAddons(subscriptionID).

descriptionstring

Customer Facing text for item.

quantityinteger

Number of products or services to add.

amountdouble

Charge Amount for item.

productIDinteger

Foreign key to products table.

serviceIDinteger

Foreign key to services Table.

taxableinteger

0 for untaxable, 1 for taxable. Items with negative amounts cannot be taxable.

Request

/ticket/getAddOns

curl -X POST 'https://{subdomain}.pestroutes.com/api/ticket/getAddOns' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

itemID:6267

ticketID:1780

description:"Sample value returned by the mock engine."

quantity:2

amount:15.5

productID:1815

serviceID:1789

taxable:1

creditTo:1

unitID:8844

}

Write operations

create/ticket/createTry it

create ticket

Parameters

serviceTaxableinteger

1- tax 0 - no tax; Defaults to the value specified for given serviceID. date - string - required Date this invoice should be applied

billToAccountIDinteger

Foreign key to customers table. serviceCharge - number - required Value in USD.

additionalNotesstring

Add notes about the invoice.

statusstring

0 = not active, 1 = active, -1 = ticket template, -3 = lead

templateTypestring

R = recurring, I = initial, NA = not applicable/not a template

addonsarray

Array of ticket addon objects, see ticket/createAddon. Send as empty array or false to unset.

Returns

Returns a success acknowledgement.

Request

/ticket/create

curl -X POST 'https://{subdomain}.pestroutes.com/api/ticket/create' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'serviceTaxable=1' \
  --data-urlencode 'billToAccountID=1' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

ticketID:4821

}

update/ticket/updateTry it

update ticket

Parameters

customerIDinteger

Foreign key to customers table.

subscriptionIDinteger

Foreign key to subscription table.

serviceIDinteger

Foreign key to serviceTypes table.

serviceTaxableinteger

1- tax 0 - no tax; Defaults to the value specified for given serviceID.

datestring

Date this invoice should be applied

billToAccountIDinteger

Foreign key to customers table.

serviceChargedouble

Value in USD.

additionalNotesstring

Add notes about the invoice.

Returns

Returns a success acknowledgement.

Request

/ticket/update

curl -X POST 'https://{subdomain}.pestroutes.com/api/ticket/update' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'customerID=1' \
  --data-urlencode 'subscriptionID=1' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

ticketID:4821

}

createAddOn/ticket/createAddOnTry it

createAddOn ticket

Parameters

descriptionstring

Customer Facing text for item.

quantityinteger

Number of products or services to add. amount - number - required Charge Amount for item.

productIDinteger

Foreign key to products table.

serviceIDinteger

Foreign key to services Table. taxable - integer - required 0 for untaxable, 1 for taxable. Items with negative amounts cannot be taxable.

creditTointeger

Foreign key to employees table.

unitIDinteger

Foreign key to unit table (if applicable for unit specific addons on multi-unit customers)

Returns

Returns a success acknowledgement.

Request

/ticket/createAddOn

curl -X POST 'https://{subdomain}.pestroutes.com/api/ticket/createAddOn' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'description=value' \
  --data-urlencode 'quantity=1' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

ticketID:4821

}

setAddOns/ticket/setAddOnsTry it

setAddOns ticket

Delete all existing addons and set the addons for the specified ticket to the received array.

Parameters

addonsarray

Addon Entity - see createAddOn params

Returns

Returns a success acknowledgement.

Request

/ticket/setAddOns

curl -X POST 'https://{subdomain}.pestroutes.com/api/ticket/setAddOns' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'addons=value' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

ticketID:4821

}

updateAddOn/ticket/updateAddOnTry it

updateAddOn ticket

Parameters

descriptionstring

Customer Facing text for item.

quantityinteger

Number of products or services to add.

amountdouble

Charge Amount for item.

productIDinteger

Foreign key to products table.

serviceIDinteger

Foreign key to services Table.

taxableinteger

0 for untaxable, 1 for taxable. Items with negative amounts cannot be taxable.

creditTointeger

Foreign key to employees table.

unitIDinteger

Foreign key to unit table (if applicable for unit specific addons on multi-unit customers) itemID - integer - required Primary key to the ticketItems table.

Returns

Returns a success acknowledgement.

Request

/ticket/updateAddOn

curl -X POST 'https://{subdomain}.pestroutes.com/api/ticket/updateAddOn' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'description=value' \
  --data-urlencode 'quantity=1' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

ticketID:4821

}