QuickBooks Desktop API
Core Resources
- Accounts
- Classes
- Customers
- Date-Driven Terms
- Inventory Sites
- Sales-Tax Codes
- Standard Terms
- Vendors
Transactions
- Bill Check Payments
- Bill Credit Card Payments
- Bills
- Checks
- Credit Card Charges
- Credit Card Credits
- Credit Memos
- Estimates
- Invoices
- Journal Entries
- Purchase Orders
- Receive-Payments
- Sales Orders
- Sales Receipts
- Transfers
- Vendor Credits
Items
- Inventory Assembly Items
- Inventory Items
- Non-Inventory Items
- Sales-Tax Items
- Service Items
- Subtotal Items
Retrieve a vendor credit
Retrieves a vendor credit by ID.
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 retrieve.
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 fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The custom fields for the vendor credit object, added as user-defined data extensions, not included in the standard QuickBooks object.
The name of the custom field, unique for the specified ownerId. For public custom fields, this name is visible as a label in the QuickBooks UI.
The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an ownerId of "0") for all objects.
The data type of this custom field.
amount_type, date_time_type, integer_type, percent_type, price_type, quantity_type, string_1024_type, string_255_type The value of this custom field. The maximum length depends on the field's data type.
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.
The expense account being debited (increased) for this expense line. The corresponding account being credited is usually a liability account (e.g., Accounts-Payable) or an asset account (e.g., Cash), depending on the transaction type.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The monetary amount of this expense line, represented as a decimal string.
The billing status of this expense line.
billable, has_been_billed, not_billable The expense line's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. If a class is specified for the entire parent transaction, it is automatically applied to all expense lines unless overridden here, at the transaction line level.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The custom fields for the expense line object, added as user-defined data extensions, not included in the standard QuickBooks object.
The name of the custom field, unique for the specified ownerId. For public custom fields, this name is visible as a label in the QuickBooks UI.
The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an ownerId of "0") for all objects.
The data type of this custom field.
amount_type, date_time_type, integer_type, percent_type, price_type, quantity_type, string_1024_type, string_255_type The value of this custom field. The maximum length depends on the field's data type.
The unique identifier assigned by QuickBooks to this expense line. This ID is unique across all transaction line types.
A memo or note for this expense line.
The type of object. This value is always "qbd_expense_line".
"qbd_expense_line"If account refers to an Accounts-Payable (A/P) account, payee refers to the expense's vendor (not the customer). If account refers to any other type of account, payee refers to the expense's customer (not the vendor).
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The expense line's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The sales-tax code for this expense line, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the parent transaction or the associated item.
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 fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
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 custom fields for the item line group object, added as user-defined data extensions, not included in the standard QuickBooks object.
The name of the custom field, unique for the specified ownerId. For public custom fields, this name is visible as a label in the QuickBooks UI.
The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an ownerId of "0") for all objects.
The data type of this custom field.
amount_type, date_time_type, integer_type, percent_type, price_type, quantity_type, string_1024_type, string_255_type The value of this custom field. The maximum length depends on the field's data type.
A description of this item line group.
The unique identifier assigned by QuickBooks to this item line group. This ID is unique across all transaction line types.
The item line group's item group, representing a predefined set of items bundled because they are commonly purchased together or grouped for faster entry.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The item line group's item lines, each representing the purchase of a specific item or service.
The monetary amount of this item line, represented as a decimal string. If both quantity and cost are specified but not amount, QuickBooks will use them to calculate amount. If amount, cost, and quantity are all unspecified, then QuickBooks will calculate amount based on a quantity of 1 and the suggested cost. This field cannot be cleared.
The billing status of this item line.
billable, has_been_billed, not_billable The item line's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. If a class is specified for the entire parent transaction, it is automatically applied to all item lines unless overridden here, at the transaction line level.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The cost of this item line, represented as a decimal string. If both quantity and amount are specified but not cost, QuickBooks will use them to calculate cost.
The customer or customer-job associated with this item line.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The custom fields for the item line object, added as user-defined data extensions, not included in the standard QuickBooks object.
The name of the custom field, unique for the specified ownerId. For public custom fields, this name is visible as a label in the QuickBooks UI.
The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an ownerId of "0") for all objects.
The data type of this custom field.
amount_type, date_time_type, integer_type, percent_type, price_type, quantity_type, string_1024_type, string_255_type The value of this custom field. The maximum length depends on the field's data type.
A description of this item line.
The expiration date for the serial number or lot number of the item associated with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.
The unique identifier assigned by QuickBooks to this item line. This ID is unique across all transaction line types.
The site location where inventory for the item associated with this item line is stored.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The specific location (e.g., bin or shelf) within the inventory site where the item associated with this item line is stored.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The item associated with this item line. This can refer to any good or service that the business buys or sells, including item types such as a service item, inventory item, or special calculation item like a discount item or sales-tax item.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The lot number of the item associated with this item line. Used for tracking groups of inventory items that are purchased or manufactured together.
The type of object. This value is always "qbd_item_line".
"qbd_item_line"Specifies an alternative unit-of-measure set when updating this item line's unitOfMeasure field (e.g., "pound" or "kilogram"). This allows you to select units from a different set than the item's default unit-of-measure set, which remains unchanged on the item itself. The override applies only to this specific line. For example, you can sell an item typically measured in volume units using weight units in a specific transaction by specifying a different unit-of-measure set with this field.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The quantity of the item associated with this item line. This field cannot be cleared.
The item line's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The sales-tax code for this item line, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the parent transaction or the associated item.
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 fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The serial number of the item associated with this item line. This is used for tracking individual units of serialized inventory items.
The unit-of-measure used for the quantity in this item line. Must be a valid unit within the item's available units of measure.
The type of object. This value is always "qbd_item_line_group".
"qbd_item_line_group"Specifies an alternative unit-of-measure set when updating this item line group's unitOfMeasure field (e.g., "pound" or "kilogram"). This allows you to select units from a different set than the item's default unit-of-measure set, which remains unchanged on the item itself. The override applies only to this specific line. For example, you can sell an item typically measured in volume units using weight units in a specific transaction by specifying a different unit-of-measure set with this field.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The quantity of the item group associated with this item line group. This field cannot be cleared.
The total monetary amount of this item line group, equivalent to the sum of the amounts in lines, represented as a decimal string.
The unit-of-measure used for the quantity in this item line group. Must be a valid unit within the item's available units of measure.
The vendor credit's item lines, each representing the purchase of a specific item or service.
The monetary amount of this item line, represented as a decimal string. If both quantity and cost are specified but not amount, QuickBooks will use them to calculate amount. If amount, cost, and quantity are all unspecified, then QuickBooks will calculate amount based on a quantity of 1 and the suggested cost. This field cannot be cleared.
The billing status of this item line.
billable, has_been_billed, not_billable The item line's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. If a class is specified for the entire parent transaction, it is automatically applied to all item lines unless overridden here, at the transaction line level.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The cost of this item line, represented as a decimal string. If both quantity and amount are specified but not cost, QuickBooks will use them to calculate cost.
The customer or customer-job associated with this item line.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The custom fields for the item line object, added as user-defined data extensions, not included in the standard QuickBooks object.
The name of the custom field, unique for the specified ownerId. For public custom fields, this name is visible as a label in the QuickBooks UI.
The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an ownerId of "0") for all objects.
The data type of this custom field.
amount_type, date_time_type, integer_type, percent_type, price_type, quantity_type, string_1024_type, string_255_type The value of this custom field. The maximum length depends on the field's data type.
A description of this item line.
The expiration date for the serial number or lot number of the item associated with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.
The unique identifier assigned by QuickBooks to this item line. This ID is unique across all transaction line types.
The site location where inventory for the item associated with this item line is stored.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The specific location (e.g., bin or shelf) within the inventory site where the item associated with this item line is stored.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The item associated with this item line. This can refer to any good or service that the business buys or sells, including item types such as a service item, inventory item, or special calculation item like a discount item or sales-tax item.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The lot number of the item associated with this item line. Used for tracking groups of inventory items that are purchased or manufactured together.
The type of object. This value is always "qbd_item_line".
"qbd_item_line"Specifies an alternative unit-of-measure set when updating this item line's unitOfMeasure field (e.g., "pound" or "kilogram"). This allows you to select units from a different set than the item's default unit-of-measure set, which remains unchanged on the item itself. The override applies only to this specific line. For example, you can sell an item typically measured in volume units using weight units in a specific transaction by specifying a different unit-of-measure set with this field.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The quantity of the item associated with this item line. This field cannot be cleared.
The item line's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The sales-tax code for this item line, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the parent transaction or the associated item.
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 fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
The serial number of the item associated with this item line. This is used for tracking individual units of serialized inventory items.
The unit-of-measure used for the quantity in this item line. Must be a valid unit within the item's available units of measure.
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.
The monetary amount of this linked transaction, represented as a decimal string.
The unique identifier assigned by QuickBooks to this linked transaction. This ID is unique across all transaction types.
Indicates the nature of the link between the transactions: amount denotes an amount-based link (e.g., an invoice linked to a payment), and quantity denotes a quantity-based link (e.g., an invoice created from a sales order based on the quantity of items received).
amount, quantity The type of object. This value is always "qbd_linked_transaction".
"qbd_linked_transaction"The case-sensitive user-defined reference number for this linked transaction, 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 date of this linked transaction, in ISO 8601 format (YYYY-MM-DD).
The type of transaction for this linked transaction.
ar_refund_credit_card, bill, bill_payment_check, bill_payment_credit_card, build_assembly, charge, check, credit_card_charge, credit_card_credit, credit_memo, deposit, estimate, inventory_adjustment, invoice, item_receipt, journal_entry, liability_adjustment, paycheck, payroll_liability_check, purchase_order, receive_payment, sales_order, sales_receipt, sales_tax_payment_check, transfer, vendor_credit, ytd_adjustment 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 fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
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 fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
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.
The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.
The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.