curl --request POST \
--url https://qubesync.com/api/v2/connections/{connection_id}/journal-entries \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"journal_credit_line": [
{
"account_ref": {
"full_name": "Checking"
},
"amount": 250,
"memo": "Monthly service"
}
],
"journal_debit_line": [
{
"account_ref": {
"full_name": "Office Supplies"
},
"amount": 250,
"memo": "Monthly service"
}
],
"memo": "Monthly service",
"ref_number": "1001",
"txn_date": "2026-01-15"
}
'import requests
url = "https://qubesync.com/api/v2/connections/{connection_id}/journal-entries"
payload = {
"journal_credit_line": [
{
"account_ref": { "full_name": "Checking" },
"amount": 250,
"memo": "Monthly service"
}
],
"journal_debit_line": [
{
"account_ref": { "full_name": "Office Supplies" },
"amount": 250,
"memo": "Monthly service"
}
],
"memo": "Monthly service",
"ref_number": "1001",
"txn_date": "2026-01-15"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
journal_credit_line: [{account_ref: {full_name: 'Checking'}, amount: 250, memo: 'Monthly service'}],
journal_debit_line: [
{
account_ref: {full_name: 'Office Supplies'},
amount: 250,
memo: 'Monthly service'
}
],
memo: 'Monthly service',
ref_number: '1001',
txn_date: '2026-01-15'
})
};
fetch('https://qubesync.com/api/v2/connections/{connection_id}/journal-entries', 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}/journal-entries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'journal_credit_line' => [
[
'account_ref' => [
'full_name' => 'Checking'
],
'amount' => 250,
'memo' => 'Monthly service'
]
],
'journal_debit_line' => [
[
'account_ref' => [
'full_name' => 'Office Supplies'
],
'amount' => 250,
'memo' => 'Monthly service'
]
],
'memo' => 'Monthly service',
'ref_number' => '1001',
'txn_date' => '2026-01-15'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://qubesync.com/api/v2/connections/{connection_id}/journal-entries"
payload := strings.NewReader("{\n \"journal_credit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Checking\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"journal_debit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Office Supplies\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"memo\": \"Monthly service\",\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://qubesync.com/api/v2/connections/{connection_id}/journal-entries")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"journal_credit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Checking\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"journal_debit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Office Supplies\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"memo\": \"Monthly service\",\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://qubesync.com/api/v2/connections/{connection_id}/journal-entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"journal_credit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Checking\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"journal_debit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Office Supplies\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"memo\": \"Monthly service\",\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\"\n}"
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": {
"currency_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>"
}
],
"edit_sequence": "<string>",
"exchange_rate": 123,
"external_guid": "<string>",
"is_adjustment": true,
"is_amounts_entered_in_home_currency": true,
"is_home_currency_adjustment": true,
"journal_credit_line": [
{
"account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"amount": 123,
"billable_status": "Billable",
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"def_macro": "<string>",
"entity_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"item_sales_tax_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"memo": "<string>",
"tax_amount": 123,
"txn_line_id": "<string>"
}
],
"journal_debit_line": [
{
"account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"amount": 123,
"billable_status": "Billable",
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"def_macro": "<string>",
"entity_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"item_sales_tax_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"memo": "<string>",
"tax_amount": 123,
"txn_line_id": "<string>"
}
],
"memo": "<string>",
"ref_number": "<string>",
"time_created": "2023-11-07T05:31:56Z",
"time_modified": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25",
"txn_id": "<string>",
"txn_number": 123
},
"message": "<string>",
"warning": {
"code": 530,
"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"
]
}
}Create journal entry
qbXML: JournalEntryAddRq. The journal_entry_add wrapper from qbXML is also accepted.
In versions 1.0 and 1.1, all debit lines in a JournalEntryAdd request had to appear first, followed by all credit lines. But in versions 2.0 and above, the debit and credit lines can be intermingled. A credit line can legally come first in thejournal entry add.
In traditional accounting, transactions are entered into the general journal and categorized exclusively by account. In QuickBooks, most transactions can be categorized either by account or by type (invoice, check, and so on). For a few activities in QuickBooks, you must use the general journal directly, for example for recording depreciation.
Notice that you must supply the credit line and a corresponding debit line in the same request. It won’t work to supply them in two distinct requests. You can supply as many credit lines and debit lines in one single request as you want so long as the total monetary amount from the credits equals the total monetary amount from the debits in that request.
Finally, DO NOT supply negative sign for the monetary amounts. QuickBooks does that for you. If you do supply the negative sign amounts will add instead of cancel and you’ll get a runtime error.
Querying for Condensed Transactions
If you need the query to return condensed transactions, you can do this by using either an Entity or Account filter in the journal query request. Alternatively, you could use the The generic TransactionQuery, which can return condensed transactions.
If the transaction is a home currency adjustment, QuickBooks will ignore the is_amounts_entered_in_home_currency, currency_ref, and exchange_rate elements.
Intuit’s reference: JournalEntryAdd.
curl --request POST \
--url https://qubesync.com/api/v2/connections/{connection_id}/journal-entries \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"journal_credit_line": [
{
"account_ref": {
"full_name": "Checking"
},
"amount": 250,
"memo": "Monthly service"
}
],
"journal_debit_line": [
{
"account_ref": {
"full_name": "Office Supplies"
},
"amount": 250,
"memo": "Monthly service"
}
],
"memo": "Monthly service",
"ref_number": "1001",
"txn_date": "2026-01-15"
}
'import requests
url = "https://qubesync.com/api/v2/connections/{connection_id}/journal-entries"
payload = {
"journal_credit_line": [
{
"account_ref": { "full_name": "Checking" },
"amount": 250,
"memo": "Monthly service"
}
],
"journal_debit_line": [
{
"account_ref": { "full_name": "Office Supplies" },
"amount": 250,
"memo": "Monthly service"
}
],
"memo": "Monthly service",
"ref_number": "1001",
"txn_date": "2026-01-15"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
journal_credit_line: [{account_ref: {full_name: 'Checking'}, amount: 250, memo: 'Monthly service'}],
journal_debit_line: [
{
account_ref: {full_name: 'Office Supplies'},
amount: 250,
memo: 'Monthly service'
}
],
memo: 'Monthly service',
ref_number: '1001',
txn_date: '2026-01-15'
})
};
fetch('https://qubesync.com/api/v2/connections/{connection_id}/journal-entries', 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}/journal-entries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'journal_credit_line' => [
[
'account_ref' => [
'full_name' => 'Checking'
],
'amount' => 250,
'memo' => 'Monthly service'
]
],
'journal_debit_line' => [
[
'account_ref' => [
'full_name' => 'Office Supplies'
],
'amount' => 250,
'memo' => 'Monthly service'
]
],
'memo' => 'Monthly service',
'ref_number' => '1001',
'txn_date' => '2026-01-15'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://qubesync.com/api/v2/connections/{connection_id}/journal-entries"
payload := strings.NewReader("{\n \"journal_credit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Checking\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"journal_debit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Office Supplies\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"memo\": \"Monthly service\",\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://qubesync.com/api/v2/connections/{connection_id}/journal-entries")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"journal_credit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Checking\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"journal_debit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Office Supplies\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"memo\": \"Monthly service\",\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://qubesync.com/api/v2/connections/{connection_id}/journal-entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"journal_credit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Checking\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"journal_debit_line\": [\n {\n \"account_ref\": {\n \"full_name\": \"Office Supplies\"\n },\n \"amount\": 250,\n \"memo\": \"Monthly service\"\n }\n ],\n \"memo\": \"Monthly service\",\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\"\n}"
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": {
"currency_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>"
}
],
"edit_sequence": "<string>",
"exchange_rate": 123,
"external_guid": "<string>",
"is_adjustment": true,
"is_amounts_entered_in_home_currency": true,
"is_home_currency_adjustment": true,
"journal_credit_line": [
{
"account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"amount": 123,
"billable_status": "Billable",
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"def_macro": "<string>",
"entity_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"item_sales_tax_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"memo": "<string>",
"tax_amount": 123,
"txn_line_id": "<string>"
}
],
"journal_debit_line": [
{
"account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"amount": 123,
"billable_status": "Billable",
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"def_macro": "<string>",
"entity_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"item_sales_tax_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"memo": "<string>",
"tax_amount": 123,
"txn_line_id": "<string>"
}
],
"memo": "<string>",
"ref_number": "<string>",
"time_created": "2023-11-07T05:31:56Z",
"time_modified": "2023-11-07T05:31:56Z",
"txn_date": "2023-12-25",
"txn_id": "<string>",
"txn_number": 123
},
"message": "<string>",
"warning": {
"code": 530,
"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
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.
2048Body
A currency record defines how QuickBooks stores and displays a currency. Built-in currency name/code values are fixed; formatting and active status can vary by settings and workflow.
Choose at most one of: is_home_currency_adjustment, or the set (currency_ref, exchange_rate, is_amounts_entered_in_home_currency). Members of a set combine with each other, not with the other choices.
Show child attributes
Show child attributes
def_macro lets you assign a reusable name to a returned txn_id or txn_line_id so later requests can reference it with useMacro. This feature requires SDK 2.0+.
exchange_rate is the rate from this currency to the company’s home currency at AsOfDate. You can supply a rate when adding transactions, but QuickBooks does not provide rates through the SDK. If your home currency is USD and internet access is available, rates can be downloaded in the QuickBooks UI via Lists > Currency > Activities > Download Latest Exchange Rates.
Choose at most one of: is_home_currency_adjustment, or the set (currency_ref, exchange_rate, is_amounts_entered_in_home_currency). Members of a set combine with each other, not with the other choices.
Allows for the attachment of a user defined GUID value.
CurrencyRef, DataExtRet, EditSequence, ExchangeRate, ExternalGUID, IsAdjustment, IsAmountsEnteredInHomeCurrency, IsHomeCurrencyAdjustment, JournalCreditLine, JournalDebitLine, ListID, Memo, OwnerID, RefNumber, TimeCreated, TimeModified, TxnDate, TxnID, TxnNumber When a change is an “adjustment,” the original information is retained, usually so an accountant can see the effects of the adjustment.
Flag that indicates the amount being entered is in the home currency.
Choose at most one of: is_home_currency_adjustment, or the set (currency_ref, exchange_rate, is_amounts_entered_in_home_currency). Members of a set combine with each other, not with the other choices.
Indicates whether the transaction is using a home currency or foreign currency.
Choose at most one of: is_home_currency_adjustment, or the set (currency_ref, exchange_rate, is_amounts_entered_in_home_currency). Members of a set combine with each other, not with the other choices.
If no amount is included in the first credit line (or debit line) of a journal entry in the QuickBooks user interface, then subsequent SDK queries on that JournalEntry object will fail XML validation.
At least one entry is required across journal_debit_line and journal_credit_line; they combine, any number of each. QuickBooks receives them in that order: every journal_debit_line, then every journal_credit_line.
Show child attributes
Show child attributes
If no amount is included in the first debit line (or credit line) of a journal entry in the QuickBooks user interface, then subsequent SDK queries on that JournalEntry object will fail XML validation.
At least one entry is required across journal_debit_line and journal_credit_line; they combine, any number of each. QuickBooks receives them in that order: every journal_debit_line, then every journal_credit_line.
Show child attributes
Show child attributes
Additional information.
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.
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.
The date of the transaction. In some cases, if you leave txn_date out of an -Add message, QuickBooks will prefill txn_date with the date of the last-saved transaction of the same type.
Callbacks
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