Update vendor credit
update_vendor_creditModifies a vendor credit. Be careful! If you modify ANY line item, you must fully re-construct the line item table as you want it because if you edit even a single line item, any line item that is NOT in the vendor credit mod will be omitted. For full details, see the QB SDK Programmer’s Guide (PDF, 9.6 MB) chapter on modifying and deleting transactions and list objects.
The vendor_credit_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"edit_sequence": "<edit_sequence>",
"txn_id": "<txn_id>"
},
"name": "update_vendor_credit"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| memo | No | Appears in the A/P register and in reports that include this credit. | |
| txn_id | Yes | `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. | |
| txn_date | No | 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. | |
| ref_number | No | `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. | |
| request_id | No | 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`. | |
| vendor_ref | No | 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.) | |
| edit_sequence | Yes | `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`. | |
| exchange_rate | No | `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. | |
| include_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| item_line_mod | No | An ItemLine is used to track any portion of a transaction that represents the purchase of an “item.” `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`. | |
| ap_account_ref | No | Refers to an accounts payable account in the QuickBooks file. (The AccountType of this account will be AccountsPayable.) | |
| is_tax_included | No | For future use with international versions of QuickBooks. | |
| clear_item_lines | No | Set `clear_item_lines` to true to clear all the item lines. To modify individual lines, use `item_line_mod`. | |
| expense_line_mod | No | ||
| sales_tax_code_ref | No | `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. | |
| clear_expense_lines | No | Set `clear_expense_lines` to true to clear all the expense lines. To modify individual lines, use `expense_line_mod`. | |
| include_ret_element | No | ||
| item_group_line_mod | No | 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`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Replace {connection_id} with the customer's connection. | |
| body | Yes | The JSON body: the arguments you passed. | |
| qbxml | No | The qbXML it compiles to. Only with include_qbxml. | |
| method | Yes | ||
| headers | Yes | Send with the request. Resent unchanged when no 201 came back, it answers with the request already queued. | |
| webhook | Yes | JSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes). |