curl --request GET \
--url https://qubesync.com/api/v2/connections/{connection_id}/invoices \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://qubesync.com/api/v2/connections/{connection_id}/invoices"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://qubesync.com/api/v2/connections/{connection_id}/invoices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://qubesync.com/api/v2/connections/{connection_id}/invoices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://qubesync.com/api/v2/connections/{connection_id}/invoices"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://qubesync.com/api/v2/connections/{connection_id}/invoices")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://qubesync.com/api/v2/connections/{connection_id}/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"connection_ui": "<string>",
"pages": "<string>",
"self": "<string>",
"ui": "<string>"
},
"request_xml": "<string>",
"state": "waiting",
"error": {
"debug_message": "<string>",
"error_code": 123,
"error_type": "xml_error",
"hresult": "<string>",
"message": "<string>",
"user_message": "<string>"
},
"inserted_at": "2023-11-07T05:31:56Z",
"iteration_state": "not_applicable",
"original_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": 123,
"request_types": [
"<string>"
],
"response_json": {
"status": "success",
"data": [
{
"discount_line_ret": {
"account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"amount": 123,
"is_taxable": true,
"rate_percent": 123
},
"ship_address": {
"addr1": "<string>",
"addr2": "<string>",
"addr3": "<string>",
"addr4": "<string>",
"addr5": "<string>",
"city": "<string>",
"country": "<string>",
"note": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"fob": "<string>",
"bill_address": {
"addr1": "<string>",
"addr2": "<string>",
"addr3": "<string>",
"addr4": "<string>",
"addr5": "<string>",
"city": "<string>",
"country": "<string>",
"note": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"invoice_line_ret": [
{
"amount": 123,
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"data_ext_ret": [
{
"data_ext_name": "<string>",
"data_ext_type": "AMTTYPE",
"data_ext_value": "<string>",
"owner_id": "<string>"
}
],
"desc": "<string>",
"inventory_site_location_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"inventory_site_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"is_taxable": true,
"item_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"lot_number": "<string>",
"other1": "<string>",
"other2": "<string>",
"override_uom_set_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"quantity": 123,
"rate": 123,
"rate_percent": 123,
"sales_tax_code_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"serial_number": "<string>",
"service_date": "2023-12-25",
"tax_amount": 123,
"txn_line_id": "<string>",
"unit_of_measure": "<string>"
}
],
"txn_number": 123,
"sales_tax_percentage": 123,
"other": "<string>",
"is_paid": true,
"ship_address_block": {
"addr1": "<string>",
"addr2": "<string>",
"addr3": "<string>",
"addr4": "<string>",
"addr5": "<string>"
},
"time_modified": "2023-11-07T05:31:56Z",
"is_tax_included": true,
"customer_sales_tax_code_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"is_to_be_printed": true,
"is_pending": true,
"ref_number": "<string>",
"linked_txn": [
{
"amount": 123,
"link_type": "AMTTYPE",
"ref_number": "<string>",
"txn_date": "2023-12-25",
"txn_id": "<string>",
"txn_line_detail": [
{
"amount": 123,
"txn_line_id": "<string>"
}
],
"txn_type": "ARRefundCreditCard"
}
],
"applied_amount": 123,
"is_finance_charge": true,
"txn_id": "<string>",
"customer_msg_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"suggested_discount_amount": 123,
"bill_address_block": {
"addr1": "<string>",
"addr2": "<string>",
"addr3": "<string>",
"addr4": "<string>",
"addr5": "<string>"
},
"customer_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"terms_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"due_date": "2023-12-25",
"subtotal": 123,
"sales_tax_total": 123,
"time_created": "2023-11-07T05:31:56Z",
"edit_sequence": "<string>",
"sales_rep_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"sales_tax_line_ret": {
"account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"amount": 123,
"rate_percent": 123
},
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"data_ext_ret": [
{
"data_ext_name": "<string>",
"data_ext_type": "AMTTYPE",
"data_ext_value": "<string>",
"owner_id": "<string>"
}
],
"external_guid": "<string>",
"ship_method_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"po_number": "<string>",
"shipping_line_ret": {
"account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"amount": 123
},
"invoice_line_group_ret": [
{
"data_ext_ret": [
{
"data_ext_name": "<string>",
"data_ext_type": "AMTTYPE",
"data_ext_value": "<string>",
"owner_id": "<string>"
}
],
"desc": "<string>",
"invoice_line_ret": [
{
"amount": 123,
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"data_ext_ret": [
{
"data_ext_name": "<string>",
"data_ext_type": "AMTTYPE",
"data_ext_value": "<string>",
"owner_id": "<string>"
}
],
"desc": "<string>",
"inventory_site_location_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"inventory_site_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"is_taxable": true,
"item_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"lot_number": "<string>",
"other1": "<string>",
"other2": "<string>",
"override_uom_set_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"quantity": 123,
"rate": 123,
"rate_percent": 123,
"sales_tax_code_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"serial_number": "<string>",
"service_date": "2023-12-25",
"tax_amount": 123,
"txn_line_id": "<string>",
"unit_of_measure": "<string>"
}
],
"is_print_items_in_group": true,
"item_group_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"override_uom_set_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"quantity": 123,
"service_date": "2023-12-25",
"total_amount": 123,
"txn_line_id": "<string>",
"unit_of_measure": "<string>"
}
],
"memo": "<string>",
"currency_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"txn_date": "2023-12-25",
"item_sales_tax_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"is_to_be_emailed": true,
"template_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"balance_remaining": 123,
"suggested_discount_date": "2023-12-25",
"balance_remaining_in_home_currency": 123,
"ar_account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"exchange_rate": 123,
"ship_date": "2023-12-25"
}
],
"message": "<string>",
"warning": {
"code": 500,
"message": "<string>"
}
},
"response_xml": "<string>",
"webhook_attempts": [
{}
],
"webhook_error": "<string>",
"webhook_state": "not_applicable",
"webhook_url": "<string>"
}
}{
"errors": "unknown parameter: \"emial\""
}Unauthorized{
"errors": {
"detail": "Sandbox access is paused for this organization because the sandbox period expired and the organization does not currently have both active billing and a recent production connection. Please request an extension if you're still working on your integration or contact support if you have questions."
}
}{
"errors": {
"detail": "Not Found"
}
}{
"errors": {
"webhook_url": [
"may not contain a username or password"
]
}
}List invoices
qbXML: InvoiceQueryRq.
Finds invoices: exact ones by txn_id or ref_number, or a filtered set by customer (entity_filter), date, account or paid_status. Lines come back only with include_line_items, and the payments and credits applied to each invoice only with include_linked_txns. An invoice’s applied_amount comes back negative (-80.00 for one paid 80.00), so balance_remaining is its total plus applied_amount (observed on QuickBooks Enterprise 24.0). Set iterator to page through many results.
Intuit’s reference: InvoiceQuery.
curl --request GET \
--url https://qubesync.com/api/v2/connections/{connection_id}/invoices \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://qubesync.com/api/v2/connections/{connection_id}/invoices"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://qubesync.com/api/v2/connections/{connection_id}/invoices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://qubesync.com/api/v2/connections/{connection_id}/invoices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://qubesync.com/api/v2/connections/{connection_id}/invoices"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://qubesync.com/api/v2/connections/{connection_id}/invoices")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://qubesync.com/api/v2/connections/{connection_id}/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"links": {
"connection_ui": "<string>",
"pages": "<string>",
"self": "<string>",
"ui": "<string>"
},
"request_xml": "<string>",
"state": "waiting",
"error": {
"debug_message": "<string>",
"error_code": 123,
"error_type": "xml_error",
"hresult": "<string>",
"message": "<string>",
"user_message": "<string>"
},
"inserted_at": "2023-11-07T05:31:56Z",
"iteration_state": "not_applicable",
"original_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": 123,
"request_types": [
"<string>"
],
"response_json": {
"status": "success",
"data": [
{
"discount_line_ret": {
"account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"amount": 123,
"is_taxable": true,
"rate_percent": 123
},
"ship_address": {
"addr1": "<string>",
"addr2": "<string>",
"addr3": "<string>",
"addr4": "<string>",
"addr5": "<string>",
"city": "<string>",
"country": "<string>",
"note": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"fob": "<string>",
"bill_address": {
"addr1": "<string>",
"addr2": "<string>",
"addr3": "<string>",
"addr4": "<string>",
"addr5": "<string>",
"city": "<string>",
"country": "<string>",
"note": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"invoice_line_ret": [
{
"amount": 123,
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"data_ext_ret": [
{
"data_ext_name": "<string>",
"data_ext_type": "AMTTYPE",
"data_ext_value": "<string>",
"owner_id": "<string>"
}
],
"desc": "<string>",
"inventory_site_location_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"inventory_site_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"is_taxable": true,
"item_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"lot_number": "<string>",
"other1": "<string>",
"other2": "<string>",
"override_uom_set_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"quantity": 123,
"rate": 123,
"rate_percent": 123,
"sales_tax_code_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"serial_number": "<string>",
"service_date": "2023-12-25",
"tax_amount": 123,
"txn_line_id": "<string>",
"unit_of_measure": "<string>"
}
],
"txn_number": 123,
"sales_tax_percentage": 123,
"other": "<string>",
"is_paid": true,
"ship_address_block": {
"addr1": "<string>",
"addr2": "<string>",
"addr3": "<string>",
"addr4": "<string>",
"addr5": "<string>"
},
"time_modified": "2023-11-07T05:31:56Z",
"is_tax_included": true,
"customer_sales_tax_code_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"is_to_be_printed": true,
"is_pending": true,
"ref_number": "<string>",
"linked_txn": [
{
"amount": 123,
"link_type": "AMTTYPE",
"ref_number": "<string>",
"txn_date": "2023-12-25",
"txn_id": "<string>",
"txn_line_detail": [
{
"amount": 123,
"txn_line_id": "<string>"
}
],
"txn_type": "ARRefundCreditCard"
}
],
"applied_amount": 123,
"is_finance_charge": true,
"txn_id": "<string>",
"customer_msg_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"suggested_discount_amount": 123,
"bill_address_block": {
"addr1": "<string>",
"addr2": "<string>",
"addr3": "<string>",
"addr4": "<string>",
"addr5": "<string>"
},
"customer_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"terms_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"due_date": "2023-12-25",
"subtotal": 123,
"sales_tax_total": 123,
"time_created": "2023-11-07T05:31:56Z",
"edit_sequence": "<string>",
"sales_rep_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"sales_tax_line_ret": {
"account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"amount": 123,
"rate_percent": 123
},
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"data_ext_ret": [
{
"data_ext_name": "<string>",
"data_ext_type": "AMTTYPE",
"data_ext_value": "<string>",
"owner_id": "<string>"
}
],
"external_guid": "<string>",
"ship_method_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"po_number": "<string>",
"shipping_line_ret": {
"account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"amount": 123
},
"invoice_line_group_ret": [
{
"data_ext_ret": [
{
"data_ext_name": "<string>",
"data_ext_type": "AMTTYPE",
"data_ext_value": "<string>",
"owner_id": "<string>"
}
],
"desc": "<string>",
"invoice_line_ret": [
{
"amount": 123,
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"data_ext_ret": [
{
"data_ext_name": "<string>",
"data_ext_type": "AMTTYPE",
"data_ext_value": "<string>",
"owner_id": "<string>"
}
],
"desc": "<string>",
"inventory_site_location_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"inventory_site_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"is_taxable": true,
"item_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"lot_number": "<string>",
"other1": "<string>",
"other2": "<string>",
"override_uom_set_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"quantity": 123,
"rate": 123,
"rate_percent": 123,
"sales_tax_code_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"serial_number": "<string>",
"service_date": "2023-12-25",
"tax_amount": 123,
"txn_line_id": "<string>",
"unit_of_measure": "<string>"
}
],
"is_print_items_in_group": true,
"item_group_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"override_uom_set_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"quantity": 123,
"service_date": "2023-12-25",
"total_amount": 123,
"txn_line_id": "<string>",
"unit_of_measure": "<string>"
}
],
"memo": "<string>",
"currency_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"txn_date": "2023-12-25",
"item_sales_tax_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"is_to_be_emailed": true,
"template_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"balance_remaining": 123,
"suggested_discount_date": "2023-12-25",
"balance_remaining_in_home_currency": 123,
"ar_account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"exchange_rate": 123,
"ship_date": "2023-12-25"
}
],
"message": "<string>",
"warning": {
"code": 500,
"message": "<string>"
}
},
"response_xml": "<string>",
"webhook_attempts": [
{}
],
"webhook_error": "<string>",
"webhook_state": "not_applicable",
"webhook_url": "<string>"
}
}{
"errors": "unknown parameter: \"emial\""
}Unauthorized{
"errors": {
"detail": "Sandbox access is paused for this organization because the sandbox period expired and the organization does not currently have both active billing and a recent production connection. Please request an extension if you're still working on your integration or contact support if you have questions."
}
}{
"errors": {
"detail": "Not Found"
}
}{
"errors": {
"webhook_url": [
"may not contain a username or password"
]
}
}Authorizations
Use your app's API key as the username, and leave the password blank
Headers
Makes a retry safe when you never got the answer to a call: a timeout, a dropped connection, a worker that crashed. Send a new key (a UUID, say) with each request you mean to make once, and the same key when you send that request again. A repeat with the key and the same method, path, query and body answers 201 with what the first call created, as it is now, marked Idempotent-Replayed: true, and queues nothing. The same key with a different request is a 422. A key belongs to your app (sandbox and production apps never share one), lasts as long as what it created, and is 1 to 255 printable ASCII characters.
1 - 255^[\x20-\x7E]+$Path Parameters
The connection (a customer's QuickBooks company file) this request is queued for.
Query Parameters
Your own label for the request, sent to QuickBooks as its qbXML requestID and echoed in the raw answer (response_xml); optional, since the answer's webhook already carries the request's id.
Use the meta_data attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects). Counts are approximate and may vary slightly if records are created or deleted during processing.
MetaDataAndResponseData, MetaDataOnly, NoMetaData Page through every match: QuBe Sync asks QuickBooks for each page in turn and sends each to your webhook_url as it arrives, all with the same id. On by default, with pages of 100 records (25 with include_line_items or include_linked_txns); send iterator=true with max_returned for another size. Off when you send iterator=false (every match in one answer) or max_returned alone (at most that many, in one answer). It pages a filtered query only: with ref_number, ref_number_case_sensitive or txn_id every match comes back in one answer, so leave iterator out.
Filters according to the account name or list_id. If the “Use account numbers” preference is enabled in the QuickBooks company file, you can specify an account number (instead of an account name) for full_name and get the account you’re looking for. But if numbers have been used as account names, confusion could arise.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
- ListID
- FullName
- ListIDWithChildren
- FullNameWithChildren
Show child attributes
Show child attributes
Filters by the specified currency.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
- ListID
- FullName
Show child attributes
Show child attributes
An entity refers to a person on the QuickBooks Customer list, Vendor list, Employee list, or Other Names list. You can use an EntityQuery request to get information about all the entities that are set up in the QuickBooks file. In an ARRefundCreditCard query, this must be a customer/customer job.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
- ListID
- FullName
- ListIDWithChildren
- FullNameWithChildren
Show child attributes
Show child attributes
This filter allows you to omit line items from a query response to get a smaller result. The default value is false, so line items are omitted by default. Set include_line_items to true to include line items in the response if you don’t mind getting a larger result.
If you set include_linked_txns to true, then the returned object will include a list of all the transactions linked to the queried object. (This list is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items.) Each linked transaction will be represented by a linked_txn aggregate.
ARAccountRef, AppliedAmount, BalanceRemaining, BalanceRemainingInHomeCurrency, BillAddress, BillAddressBlock, ClassRef, CurrencyRef, CustomerMsgRef, CustomerRef, CustomerSalesTaxCodeRef, DataExtRet, DiscountLineRet, DueDate, EditSequence, ExchangeRate, ExternalGUID, FOB, InvoiceLineGroupRet, InvoiceLineRet, IsFinanceCharge, IsPaid, IsPending, IsTaxIncluded, IsToBeEmailed, IsToBePrinted, ItemSalesTaxRef, LinkedTxn, Memo, Other, PONumber, RefNumber, SalesRepRef, SalesTaxLineRet, SalesTaxPercentage, SalesTaxTotal, ShipAddress, ShipAddressBlock, ShipDate, ShipMethodRef, ShippingLineRet, Subtotal, SuggestedDiscountAmount, SuggestedDiscountDate, TemplateRef, TermsRef, TimeCreated, TimeModified, TxnDate, TxnID, TxnNumber Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the meta_data query attribute.) If you include a max_returned value, it must be at least 1.
The page size, with iterator=true. Sent without iterator, or with iterator=false, it's a cap instead: at most this many records come back, in one answer, and QuickBooks doesn't say whether more matched.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
x >= 1Filters according to the dates when transactions were last modified. The modified_date_range_filter aggregate isn’t required to contain any elements, but if it is empty, we recommend that you leave it out altogether. Note that the time portion of the from_modified_date and to_modified_date fields wasn’t supported in qbXML version 1.0 or 1.1.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
Show child attributes
Show child attributes
Allows you to filter for transactions according to whether or not they are paid.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
All, NotPaidOnly, PaidOnly ref_number is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate ref_number when omitted, based on QuickBooks preferences and numbering state.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
Filters by ref_number range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
Show child attributes
Show child attributes
Filters by ref_number range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
Show child attributes
Show child attributes
Filters according to the original transaction dates.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
- FromTxnDate + ToTxnDate
- DateMacro
Show child attributes
Show child attributes
txn_id is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. txn_id values are transaction-specific and should not be reused across unrelated transaction types.
Choose at most one of: txn_id, or ref_number, or ref_number_case_sensitive, or the set (account_filter, currency_filter, entity_filter, max_returned, modified_date_range_filter, paid_status, ref_number_filter, ref_number_range_filter, txn_date_range_filter). Members of a set combine with each other, not with the other choices.
owner_id identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same owner_id and data_ext_name, because that pair uniquely identifies the extension.
Where QuBe Sync POSTs the answered request (this same document with response_json filled in), signed with X-QUBE-Signature. Send one with every request: it is how answers are delivered. Optional only so a script can queue and look up links.self by hand. It must be an absolute http or https URL. 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.
2048Callbacks
POST{$request.query.webhook_url}answered
Body
POSTed to webhook_url as JSON, signed with X-QUBE-Signature (t=<timestamp>,v1=<hex HMAC-SHA256 of "<timestamp>.<raw body>" with your app's webhook secret>).
Your app's id.
Set when state is error, retryable, timed_out or discarded. error_type says where it failed: for a timed_out request it is timed_out, and for a discarded one discarded, unless the request was retryable when your app discarded it, which keeps the connection error that held it up. user_message is safe to show an end user; error_code is QuickBooks' own status code for a business error, hresult the Web Connector's for a connection/XML error; debug_message is for you.
Show child attributes
Show child attributes
The request's id, as the 201 returned it. For an iterated query, every page carries the first page's id here.
This page's own id. Equal to id except on later pages of an iterated query.
QuBe Sync's summary of QuickBooks' answer. Only an Error severity from QuickBooks is status: "error" (and makes the request's state error), so a query that matched nothing is still success. A Warn severity is a success with warning beside it.
- Success
- Error
Show child attributes
Show child attributes
Whether the app is a sandbox app.
response_received: QuickBooks accepted it; read response_json. error: it is over and QuBe Sync won't try again -- see error, and response_json.error for a QuickBooks business error; with error_type outcome_unknown a write may still have been applied, so look before sending it again. retryable: QuickBooks could not be reached and QuBe Sync keeps trying; show the customer error.user_message so they can fix it. timed_out: no answer came back -- the customer's computer lost its connection, or QuickBooks or the Web Connector was closed, mid-request. QuickBooks may still have applied it, so look before sending it again. discarded: your app discarded it before the Web Connector picked it up, so QuickBooks never got it. Both carry an error.
response_received, error, retryable, timed_out, discarded Unix seconds; the same t the signature covers.
continue: more pages will follow, each its own webhook. done: this was the last page. max_sandbox_iterations_reached: a sandbox app's page limit stopped the iteration.
not_applicable, continue, done, max_sandbox_iterations_reached Present only with response_xml_omitted.
Show child attributes
Show child attributes
The page number, when iterated.
QuickBooks' raw qbXML answer. response_json is the same, summarized. One answer can be at most 4 MB as the Web Connector sends it, about 3 MB of qbXML; QuickBooks' answer over that isn't kept: this is null and error.error_type is response_too_large. A webhook whose body would be over 1 MB is sent without it: null, with response_xml_omitted true; fetch it from links.self.
Present, and true, only when response_xml was left out to keep the body under 1 MB. response_json is still here; GET links.self for response_xml.
Response
Received. Anything else is retried with backoff for about 8 hours.
Response
Queued for the connection's Web Connector. Pass webhook_url and QuBe Sync POSTs the answer to it once QuickBooks has answered (see the answered callback: its own payload, not this document). links.self returns this document on demand, with response_json filled in.
Show child attributes
Show child attributes