curl --request PUT \
--url https://qubesync.com/api/v2/connections/{connection_id}/charges \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 250,
"customer_ref": {
"full_name": "Acme Corp"
},
"edit_sequence": "1700000000",
"item_ref": {
"full_name": "Widget"
},
"ref_number": "1001",
"txn_date": "2026-01-15",
"txn_id": "1A2B-1700000000"
}
'import requests
url = "https://qubesync.com/api/v2/connections/{connection_id}/charges"
payload = {
"amount": 250,
"customer_ref": { "full_name": "Acme Corp" },
"edit_sequence": "1700000000",
"item_ref": { "full_name": "Widget" },
"ref_number": "1001",
"txn_date": "2026-01-15",
"txn_id": "1A2B-1700000000"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 250,
customer_ref: {full_name: 'Acme Corp'},
edit_sequence: '1700000000',
item_ref: {full_name: 'Widget'},
ref_number: '1001',
txn_date: '2026-01-15',
txn_id: '1A2B-1700000000'
})
};
fetch('https://qubesync.com/api/v2/connections/{connection_id}/charges', 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}/charges",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 250,
'customer_ref' => [
'full_name' => 'Acme Corp'
],
'edit_sequence' => '1700000000',
'item_ref' => [
'full_name' => 'Widget'
],
'ref_number' => '1001',
'txn_date' => '2026-01-15',
'txn_id' => '1A2B-1700000000'
]),
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}/charges"
payload := strings.NewReader("{\n \"amount\": 250,\n \"customer_ref\": {\n \"full_name\": \"Acme Corp\"\n },\n \"edit_sequence\": \"1700000000\",\n \"item_ref\": {\n \"full_name\": \"Widget\"\n },\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\",\n \"txn_id\": \"1A2B-1700000000\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://qubesync.com/api/v2/connections/{connection_id}/charges")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 250,\n \"customer_ref\": {\n \"full_name\": \"Acme Corp\"\n },\n \"edit_sequence\": \"1700000000\",\n \"item_ref\": {\n \"full_name\": \"Widget\"\n },\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\",\n \"txn_id\": \"1A2B-1700000000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://qubesync.com/api/v2/connections/{connection_id}/charges")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 250,\n \"customer_ref\": {\n \"full_name\": \"Acme Corp\"\n },\n \"edit_sequence\": \"1700000000\",\n \"item_ref\": {\n \"full_name\": \"Widget\"\n },\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\",\n \"txn_id\": \"1A2B-1700000000\"\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": {
"amount": 123,
"ar_account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"balance_remaining": 123,
"billed_date": "2023-12-25",
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"customer_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>",
"due_date": "2023-12-25",
"edit_sequence": "<string>",
"external_guid": "<string>",
"inventory_site_location_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"inventory_site_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"is_paid": true,
"item_ref": {
"full_name": "<string>",
"list_id": "<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"
}
],
"override_uom_set_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"quantity": 123,
"rate": 123,
"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,
"unit_of_measure": "<string>"
},
"message": "<string>",
"warning": {
"code": 123,
"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"
]
}
}Update charge
qbXML: ChargeModRq, from qbXML 3.0. The charge_mod wrapper from qbXML is also accepted.
Some fields in a ChargeMod request can’t be cleared. If any of the following fields is included in a charge modify request, it must contain a value:
customer_reftxn_dateitem_ref- Quantity
- Rate
- Amount
ar_account_refoverride_item_account_ref
(For more details about what it means for a field to be clearable or not clearable, see the QB SDK Programmer’s Guide (PDF, 9.6 MB).)
Intuit’s reference: ChargeMod.
curl --request PUT \
--url https://qubesync.com/api/v2/connections/{connection_id}/charges \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 250,
"customer_ref": {
"full_name": "Acme Corp"
},
"edit_sequence": "1700000000",
"item_ref": {
"full_name": "Widget"
},
"ref_number": "1001",
"txn_date": "2026-01-15",
"txn_id": "1A2B-1700000000"
}
'import requests
url = "https://qubesync.com/api/v2/connections/{connection_id}/charges"
payload = {
"amount": 250,
"customer_ref": { "full_name": "Acme Corp" },
"edit_sequence": "1700000000",
"item_ref": { "full_name": "Widget" },
"ref_number": "1001",
"txn_date": "2026-01-15",
"txn_id": "1A2B-1700000000"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 250,
customer_ref: {full_name: 'Acme Corp'},
edit_sequence: '1700000000',
item_ref: {full_name: 'Widget'},
ref_number: '1001',
txn_date: '2026-01-15',
txn_id: '1A2B-1700000000'
})
};
fetch('https://qubesync.com/api/v2/connections/{connection_id}/charges', 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}/charges",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 250,
'customer_ref' => [
'full_name' => 'Acme Corp'
],
'edit_sequence' => '1700000000',
'item_ref' => [
'full_name' => 'Widget'
],
'ref_number' => '1001',
'txn_date' => '2026-01-15',
'txn_id' => '1A2B-1700000000'
]),
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}/charges"
payload := strings.NewReader("{\n \"amount\": 250,\n \"customer_ref\": {\n \"full_name\": \"Acme Corp\"\n },\n \"edit_sequence\": \"1700000000\",\n \"item_ref\": {\n \"full_name\": \"Widget\"\n },\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\",\n \"txn_id\": \"1A2B-1700000000\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://qubesync.com/api/v2/connections/{connection_id}/charges")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 250,\n \"customer_ref\": {\n \"full_name\": \"Acme Corp\"\n },\n \"edit_sequence\": \"1700000000\",\n \"item_ref\": {\n \"full_name\": \"Widget\"\n },\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\",\n \"txn_id\": \"1A2B-1700000000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://qubesync.com/api/v2/connections/{connection_id}/charges")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 250,\n \"customer_ref\": {\n \"full_name\": \"Acme Corp\"\n },\n \"edit_sequence\": \"1700000000\",\n \"item_ref\": {\n \"full_name\": \"Widget\"\n },\n \"ref_number\": \"1001\",\n \"txn_date\": \"2026-01-15\",\n \"txn_id\": \"1A2B-1700000000\"\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": {
"amount": 123,
"ar_account_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"balance_remaining": 123,
"billed_date": "2023-12-25",
"class_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"customer_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>",
"due_date": "2023-12-25",
"edit_sequence": "<string>",
"external_guid": "<string>",
"inventory_site_location_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"inventory_site_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"is_paid": true,
"item_ref": {
"full_name": "<string>",
"list_id": "<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"
}
],
"override_uom_set_ref": {
"full_name": "<string>",
"list_id": "<string>"
},
"quantity": 123,
"rate": 123,
"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,
"unit_of_measure": "<string>"
},
"message": "<string>",
"warning": {
"code": 123,
"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
edit_sequence is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current edit_sequence. If your value is stale, the update is rejected to prevent overwriting newer changes.
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.
A monetary amount.
ar_account_ref points to an Accounts Receivable account. If both full_name and list_id are provided, full_name is ignored.
Show child attributes
Show child attributes
The date when the customer was billed for what is now being charged to their credit card. (billed_date is the same as the date listed on an invoice or, for a statement charge, the date entered in the Statement Date field when the statement was printed.)
Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A class_ref points to one class; if both full_name and list_id are provided, full_name is ignored. In InvoiceAdd, a header-level class_ref is applied to line items unless you override or clear it on individual lines.
Show child attributes
Show child attributes
customer_ref identifies a customer or customer job. If both full_name and list_id are provided, full_name is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit. In TimeTracking, it identifies who the time can be billed to and is required in TimeTrackingAdd when IsBillable is true.
Show child attributes
Show child attributes
A descriptive text field.
The date on which payment is due.
ARAccountRef, Amount, BalanceRemaining, BilledDate, ClassRef, CustomerRef, DataExtRet, Desc, DueDate, EditSequence, ExternalGUID, InventorySiteLocationRef, InventorySiteRef, IsPaid, ItemRef, LinkedTxn, ListID, OverrideUOMSetRef, OwnerID, Quantity, Rate, RefNumber, TimeCreated, TimeModified, TxnDate, TxnID, TxnNumber, UnitOfMeasure Location within the Inventory Site.
Show child attributes
Show child attributes
Site where inventory is located.
Show child attributes
Show child attributes
item_ref may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both full_name and list_id are provided, full_name is ignored.
Show child attributes
Show child attributes
Flag to override price rule conflict
BasePrice, Zero Refers to a QuickBooks account. If an override_item_account_ref aggregate includes both full_name and list_id, full_name will be ignored.
Show child attributes
Show child attributes
When you modify a transaction line to change the unit of measure used in that line, you use this aggregate to specify the UOM set within which you are choosing an available unit of measure. The “override” here refers to the unit within the set, not the UOM Set itself, which you can’t change or override–the UOM set that can be set or changed only in the item itself via an Item Mod request.
Show child attributes
Show child attributes
On transaction lines, QuickBooks can derive one value from the other two among Quantity, Rate, and Amount. If you supply Quantity and Amount, QuickBooks calculates Rate. If you supply Quantity and Rate, QuickBooks calculates Amount.
Indicates the price of something.
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.
In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!
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