Skip to main content
PUT
Update vendor credit

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

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.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]+$

Path Parameters

​
connection_id
string<uuid>
required

The connection (a customer's QuickBooks company file) this request is queued for.

Query Parameters

​
webhook_url
string<uri>

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.

Maximum string length: 2048

Body

application/json
​
edit_sequence
string
required

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
string
required

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.

​
ap_account_ref
object

Refers to an accounts payable account in the QuickBooks file. (The AccountType of this account will be AccountsPayable.) If ap_account_ref is missing, the SDK will use the QuickBooks default AP account. In a request, if an ap_account_ref aggregate includes both full_name and list_id, full_name will be ignored.

​
clear_expense_lines
boolean

Set clear_expense_lines to true to clear all the expense lines. To modify individual lines, use expense_line_mod.

​
clear_item_lines
boolean

Set clear_item_lines to true to clear all the item lines. To modify individual lines, use item_line_mod.

​
exchange_rate
number

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.

​
expense_line_mod
object[]
​
include_ret_element
enum<string>[]
Available options:
APAccountRef,
CreditAmount,
CreditAmountInHomeCurrency,
CurrencyRef,
DataExtRet,
EditSequence,
ExchangeRate,
ExpenseLineRet,
ExternalGUID,
IsTaxIncluded,
ItemGroupLineRet,
ItemLineRet,
LinkedTxn,
ListID,
Memo,
OpenAmount,
OwnerID,
RefNumber,
SalesTaxCodeRef,
TimeCreated,
TimeModified,
TxnDate,
TxnID,
TxnNumber,
VendorRef
​
is_tax_included
boolean

For future use with international versions of QuickBooks.

​
item_group_line_mod
object[]

Refers to items that are grouped together in QuickBooks for fast entry.

item_line_mod and item_group_line_mod combine: any number of each. QuickBooks receives them in that order: every item_line_mod, then every item_group_line_mod.

​
item_line_mod
object[]

An ItemLine is used to track any portion of a transaction that represents the purchase of an “item.” If ItemLineAdd doesn’t specify an Amount, Cost, or Quantity, then QuickBooks will calculate Amount based on a Quantity of 1 and the suggested Cost.

item_line_mod and item_group_line_mod combine: any number of each. QuickBooks receives them in that order: every item_line_mod, then every item_group_line_mod.

​
memo
string

Appears in the A/P register and in reports that include this credit.

​
ref_number
string

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.

​
request_id
string

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.

​
sales_tax_code_ref
object

sales_tax_code_ref points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the default non-taxable code. If both full_name and list_id are provided in sales_tax_code_ref, full_name is ignored.

​
txn_date
string<date>

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.

​
vendor_ref
object

A vendor is any person or company from whom a small business owner buys goods and services. (Banks and tax agencies usually are included on the vendor list.) A company’s vendor list contains information such as account balance and contact information about each vendor. A vendor_ref aggregate refers to one of the vendors on the list.

Callbacks

POST
{$request.query.webhook_url}answered

Body

application/json

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>).

​
app_id
string<uuid>
required

Your app's id.

​
app_name
string
required
​
error
object | null
required

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.

​
id
string<uuid>
required

The request's id, as the 201 returned it. For an iterated query, every page carries the first page's id here.

​
page_request_id
string<uuid>
required

This page's own id. Equal to id except on later pages of an iterated query.

​
response_json
Success · object
required

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.

​
sandbox
boolean
required

Whether the app is a sandbox app.

​
state
enum<string>
required

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.

Available options:
response_received,
error,
retryable,
timed_out,
discarded
​
timestamp
integer
required

Unix seconds; the same t the signature covers.

​
iteration_state
enum<string>

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.

Available options:
not_applicable,
continue,
done,
max_sandbox_iterations_reached
​
links
object

Present only with response_xml_omitted.

​
page
integer | null

The page number, when iterated.

​
response_xml
string | null

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.

​
response_xml_omitted
boolean

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

2XX

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.

​
data
object
required