Update a sales-tax item
Updates an existing sales-tax item.
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 sales-tax item to update.
Body
The current revision number of the sales-tax item 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.
The sales-tax item's barcode.
The sales-tax item'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.
The sales-tax item's description that will appear on sales forms that include this item.
Indicates whether this sales-tax item is active. Inactive objects are typically hidden from views and reports in QuickBooks.
The case-insensitive unique name of this sales-tax item, unique across all sales-tax items.
NOTE: Sales-tax items do not have a fullName
field because they are not hierarchical objects, which is why name
is unique for them but not for objects that have parents. Maximum length: 31 characters.
31
The specific line on the sales tax return form where the tax collected using this sales-tax item should be reported.
The tax rate defined by this sales-tax item, represented as a decimal string. For example, "7.5" represents a 7.5% tax rate. This rate determines the amount of sales tax applied when this item is used in transactions. If a non-zero taxRate
is specified, then the taxVendor
field is required.
The tax agency (vendor) to whom collected sales taxes are owed for this sales-tax item. This field refers to a vendor in QuickBooks that represents the tax authority. If a non-zero taxRate
is specified, then taxVendor
is required.
Response
The sales-tax item's barcode.
The sales-tax item'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.
The date and time when this sales-tax item 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 custom fields for the sales-tax item object, added as user-defined data extensions, not included in the standard QuickBooks object.
The sales-tax item's description that will appear on sales forms that include this item.
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 sales-tax item. This ID is unique across all sales-tax items but not across different QuickBooks object types.
Indicates whether this sales-tax item is active. Inactive objects are typically hidden from views and reports in QuickBooks.
The case-insensitive unique name of this sales-tax item, unique across all sales-tax items.
NOTE: Sales-tax items do not have a fullName
field because they are not hierarchical objects, which is why name
is unique for them but not for objects that have parents. Maximum length: 31 characters.
The type of object. This value is always "qbd_sales_tax_item"
.
"qbd_sales_tax_item"
The current revision number of this sales-tax item 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 specific line on the sales tax return form where the tax collected using this sales-tax item should be reported.
The tax rate defined by this sales-tax item, represented as a decimal string. For example, "7.5" represents a 7.5% tax rate. This rate determines the amount of sales tax applied when this item is used in transactions. If a non-zero taxRate
is specified, then the taxVendor
field is required.
The tax agency (vendor) to whom collected sales taxes are owed for this sales-tax item. This field refers to a vendor in QuickBooks that represents the tax authority. If a non-zero taxRate
is specified, then taxVendor
is required.
The date and time when this sales-tax item 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.