Skip to main content
GET
Query Sales Tax Items

Authorizations

Authorization
string
header
required

Use your app's API_KEY as the username, and leave the password blank

Path Parameters

connection_id
string<uuid>
required

ID of the connection to use for the query

Query Parameters

request_id
string

A custom ID that can be used to identify the request and response. This could be your local ID for the request.

Example:

"1"

iterate
boolean

Page through every result, one webhook per page (see the iterate schema). Ignored with list_id[] or full_name[]: QuickBooks pages only a filtered query, and a lookup by id gets every match back in one answer. If true, QuBe Sync will automatically handle the QBXML iteration until all records are returned. Each page of results will have its own request record and webhook. The id and webhook_url will be the same across each page request, and there will also be page_request_id, page values to distinguish pages from each other.

Example:

true

max_returned
integer

Maximum number of results to return

include[]
enum<string>[]

List of fields for QuickBooks to include in the response

Available options:
FullName,
ListID,
etc
name
string

Filter by name (partial match, case-insensitive)

from_name
string

Filter by lower bound of FullName (range query)

to_name
string

Filter by upper bound of FullName (range query)

list_id[]
string[]

Filter by one or more QuickBooks ListID values. With this, iterate is ignored: every match comes back in one answer.

full_name[]
string[]

Filter by one or more QuickBooks FullName values. With this, iterate is ignored: every match comes back in one answer.

active
enum<string>
default:ActiveOnly

Filter by active status

Available options:
ActiveOnly,
InactiveOnly,
All
from_modified_date
string<date-time>

Filter by modification date (start, inclusive)

to_modified_date
string<date-time>

Filter by modification date (end, inclusive)

webhook_url
string<uri>

Optional absolute http or https URL to receive a webhook when the request is completed. It may not contain a username or password, and in production it may not point at localhost or a private, loopback or link-local address. A qube listen URL must be one of this app's.

Maximum string length: 2048

Response

Sales tax item query accepted and queued for processing. Returns a queued request object.

data
object