Create a vendor credit

The vendor who sent this vendor credit for goods or services purchased.

The Accounts-Payable (A/P) account to which this vendor credit is assigned, used for accounts-payable tracking. If omitted, QuickBooks Desktop uses the default A/P account configured in the company file.

IMPORTANT: If this vendor credit is linked to other transactions, this A/P account must match the payablesAccount used in those other transactions.

The date of this vendor credit, in ISO 8601 format (YYYY-MM-DD).

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. When left blank in this create request, this field will be left blank in QuickBooks (i.e., it does not auto-increment).

Maximum length: 20 characters.

A memo or note for this vendor credit.

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 Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.

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

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

The unique identifier assigned by QuickBooks to this vendor credit. This ID is unique across all transaction types.

The type of object. This value is always "qbd_vendor_credit".

The date and time when this vendor credit was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

The date and time when this vendor credit was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

The current QuickBooks-assigned 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 date of this vendor credit, in ISO 8601 format (YYYY-MM-DD).

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 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 monetary amount of the vendor credit, converted to the home currency of the QuickBooks company file. Represented as a decimal string.

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.

A memo or note for this vendor credit.

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

The remaining unapplied credit on this vendor credit, represented as a decimal string. This equals the original credit amount minus any amounts that have been applied to bills.

NOTE: QuickBooks Desktop can omit this field in rare cases. If you ever encounter openAmount as null, we recommend the following fallback procedure: Re-query the vendor credits with includeLinkedTransactions=true and compute a fallback open amount as creditAmount minus the sum of linkedTransactions[].amount for all entries where linkedTransactions[].linkType is "amount".