FieldRoutes APIBilling
glAccount
3 endpoints. Start at search to collect IDs, then resolve them through get.
Read operations
search glAccount
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
><>=<==!=INBETWEENLIKESTARTSWITHENDSWITHCONTAINSEach 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
glAccountIDsintegerNo description in the upstream reference.
glAccountIDintegerNo description in the upstream reference.
glNumberintegerNo description in the upstream reference.
officeIDsintegerNo description in the upstream reference.
includeDatainteger{0,1} Sends the resolved objects for the first 1000 IDs. If there are more than 1000 items an additional property glAccountIDsNoDataExported will specify the items that are not included in the resolved glAccount array.
Returns
glAccountIDsarrayNo description in the upstream reference.
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/glAccount/search' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'glAccountIDs=1' \
--data-urlencode 'glAccountID=1' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
get glAccount
Get Bulk data for glAccount. Accepts an array of glAccountIDs. Returns a max of 1000 records.
Parameters
glAccountIDsarrayNo description in the upstream reference.
Returns
glAccountIDintegerNo description in the upstream reference.
glNumberintegerNo description in the upstream reference.
officeIDintegerNo description in the upstream reference.
titlestringNo description in the upstream reference.
descriptionstringNo description in the upstream reference.
visibleintegerNo description in the upstream reference.
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/glAccount/get' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'glAccountIDs=value' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response
Fetch by id glAccount
Get glAccount data for single ID -- please provide a specific record ID in the URL structure.
Parameters
No parameters beyond authentication.
Returns
glAccountIDintegerNo description in the upstream reference.
glNumberintegerNo description in the upstream reference.
officeIDintegerNo description in the upstream reference.
titlestringNo description in the upstream reference.
descriptionstringNo description in the upstream reference.
visibleintegerNo description in the upstream reference.
Request
curl -X POST 'https://{subdomain}.pestroutes.com/api/glAccount/{id}' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
--data-urlencode 'authenticationKey=<your-key>' \
--data-urlencode 'authenticationToken=<your-token>'Response