Update a vendor credit
Updates an existing vendor credit.
Authorizations
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
Headers
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}"
).
Path Parameters
The QuickBooks-assigned unique identifier of the vendor credit to update.
Body
The current revision number of the vendor credit object you are updating, which you can get by fetching the object first. Provide the most recent revisionNumber
to ensure you're working with the latest data; otherwise, the update will return an error.
When true
, removes all existing expense lines associated with this vendor credit. To modify or add individual expense lines, use the field expenseLines
instead.
When true
, removes all existing item lines associated with this vendor credit. To modify or add individual item lines, use the field itemLines
instead.
The market exchange rate between this vendor credit's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
The vendor credit's expense lines, each representing one line in this expense.
IMPORTANT:
-
Including this array in your update request will REPLACE all existing expense lines for the vendor credit with this array. To keep any existing expense lines, you must include them in this array even if they have not changed. Any expense lines not included will be removed.
-
To add a new expense line, include it here with the
id
field set to-1
. -
If you do not wish to modify any expense lines, omit this field entirely to keep them unchanged.
The vendor credit's item group lines, each representing a predefined set of items bundled together because they are commonly purchased together or grouped for faster entry.
IMPORTANT:
-
Including this array in your update request will REPLACE all existing item group lines for the vendor credit with this array. To keep any existing item group lines, you must include them in this array even if they have not changed. Any item group lines not included will be removed.
-
To add a new item group line, include it here with the
id
field set to-1
. -
If you do not wish to modify any item group lines, omit this field entirely to keep them unchanged.
The vendor credit's item lines, each representing the purchase of a specific item or service.
IMPORTANT:
-
Including this array in your update request will REPLACE all existing item lines for the vendor credit with this array. To keep any existing item lines, you must include them in this array even if they have not changed. Any item lines not included will be removed.
-
To add a new item line, include it here with the
id
field set to-1
. -
If you do not wish to modify any item lines, omit this field entirely to keep them unchanged.
A memo or note for this vendor credit.
The Accounts-Payable (A/P) account to which this vendor credit is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/P account.
IMPORTANT: If this vendor credit is linked to other transactions, this A/P account must match the payablesAccount
used in those other transactions.
The case-sensitive user-defined reference number for this vendor credit, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.
The sales-tax code for this vendor credit, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the vendor. This can be overridden on the vendor credit's individual lines.
Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.
The date of this vendor credit, in ISO 8601 format (YYYY-MM-DD).
The vendor who sent this vendor credit for goods or services purchased.
Response
The date and time when this vendor credit was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
The monetary amount of the vendor credit, represented as a decimal string. When applied to a vendor bill, this amount reduces the outstanding balance owed to the vendor.
The monetary amount of the vendor credit, converted to the home currency of the QuickBooks company file. Represented as a decimal string.
The vendor credit's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.
The custom fields for the vendor credit object, added as user-defined data extensions, not included in the standard QuickBooks object.
The market exchange rate between this vendor credit's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
The vendor credit's expense lines, each representing one line in this expense.
A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system.
The unique identifier assigned by QuickBooks to this vendor credit. This ID is unique across all transaction types.
The vendor credit's item group lines, each representing a predefined set of items bundled together because they are commonly purchased together or grouped for faster entry.
The vendor credit's item lines, each representing the purchase of a specific item or service.
The vendor credit's linked transactions, such as payments applied, credits used, or associated purchase orders.
IMPORTANT: You must specify the parameter includeLinkedTransactions
when fetching a list of vendor credits to receive this field because it is not returned by default.
A memo or note for this vendor credit.
The type of object. This value is always "qbd_vendor_credit"
.
"qbd_vendor_credit"
The remaining amount still owed on this vendor credit, represented as a decimal string. This equals the vendor credit's amount minus any credits or discounts.
The Accounts-Payable (A/P) account to which this vendor credit is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/P account.
IMPORTANT: If this vendor credit is linked to other transactions, this A/P account must match the payablesAccount
used in those other transactions.
The case-sensitive user-defined reference number for this vendor credit, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.
The current revision number of this vendor credit object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber
to ensure you're working with the latest data; otherwise, the update will return an error.
The sales-tax code for this vendor credit, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the vendor. This can be overridden on the vendor credit's individual lines.
Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.
The date of this vendor credit, in ISO 8601 format (YYYY-MM-DD).
The date and time when this vendor credit was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
The vendor who sent this vendor credit for goods or services purchased.