Update a sales receipt
Updates an existing sales receipt.
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 receipt to update.
Body
The current revision number of the sales receipt 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 receipt's billing address.
The check number of a check received for this sales receipt.
The sales receipt'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. A class defined here is automatically used in this sales receipt's line items unless overridden at the line item level.
The customer or customer-job to which the payment for this sales receipt is credited.
The message to display to the customer on the sales receipt.
The account where the funds for this sales receipt will be or have been deposited.
The predefined template in QuickBooks that determines the layout and formatting for this sales receipt when printed or displayed.
The date by which this sales receipt must be paid, in ISO 8601 format (YYYY-MM-DD).
NOTE: For sales receipts, this field is often null because sales receipts are generally used for point-of-sale payments, where full payment is received at the time of purchase.
The market exchange rate between this sales receipt'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).
Indicates whether this sales receipt has not been completed.
Indicates whether this sales receipt is included in the queue of documents for QuickBooks to email to the customer.
Indicates whether this sales receipt is included in the queue of documents for QuickBooks to print.
The sales receipt's line item groups, each representing a predefined set of related items.
IMPORTANT:
-
Including this array in your update request will REPLACE all existing line item groups for the sales receipt with this array. To keep any existing line item groups, you must include them in this array even if they have not changed. Any line item groups not included will be removed.
-
To add a new line item group, include it here with the
idfield set to-1. -
If you do not wish to modify any line item groups, omit this field entirely to keep them unchanged.
The sales receipt's line items, each representing a single product or service sold.
IMPORTANT:
-
Including this array in your update request will REPLACE all existing line items for the sales receipt with this array. To keep any existing line items, you must include them in this array even if they have not changed. Any line items not included will be removed.
-
To add a new line item, include it here with the
idfield set to-1. -
If you do not wish to modify any line items, omit this field entirely to keep them unchanged.
A memo or note for this sales receipt that appears in reports, but not on the sales receipt.
A built-in custom field for additional information specific to this sales receipt. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all sales receipts for convenience. Developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Unlike otherCustomField1 and otherCustomField2, which are line item fields, this exists at the transaction level. Hidden by default in the QuickBooks UI.
The sales receipt's payment method (e.g., cash, check, credit card).
The case-sensitive user-defined reference number for this sales receipt, 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 receipt's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.
The sales-tax code for this sales receipt, determining whether it is taxable or non-taxable. This can be overridden at the transaction-line level.
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 sales-tax item used to calculate the actual tax amount for this sales receipt's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.
For sales receipts, while using this field to specify a single tax item/group that applies uniformly is recommended, complex tax scenarios may require alternative approaches. In such cases, you can set this field to a 0% tax item (conventionally named "Tax Calculated On Invoice") and handle tax calculations through line items instead. When using line items for taxes, note that only individual tax items (not tax groups) can be used, subtotals can help apply a tax to multiple items but only the first tax line after a subtotal is calculated automatically (subsequent tax lines require manual amounts), and the rate column will always display the actual tax amount rather than the rate percentage.
The origin location from where the product associated with this sales receipt is shipped. This is the point at which ownership and liability for goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB" for this field, which stands for "freight on board". This field is informational and has no accounting implications.
The sales receipt's shipping address.
The date when the products or services for this sales receipt were shipped or are expected to be shipped, in ISO 8601 format (YYYY-MM-DD).
The shipping method used for this sales receipt, such as standard mail or overnight delivery.
The date of this sales receipt, in ISO 8601 format (YYYY-MM-DD).
Response
The sales receipt's billing address.
The check number of a check received for this sales receipt.
The sales receipt'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. A class defined here is automatically used in this sales receipt's line items unless overridden at the line item level.
The date and time when this sales receipt 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 credit card transaction data for this sales receipt's payment when using QuickBooks Merchant Services (QBMS).
The sales receipt's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.
The customer or customer-job to which the payment for this sales receipt is credited.
The message to display to the customer on the sales receipt.
The custom fields for the sales receipt object, added as user-defined data extensions, not included in the standard QuickBooks object.
The account where the funds for this sales receipt will be or have been deposited.
The predefined template in QuickBooks that determines the layout and formatting for this sales receipt when printed or displayed.
The date by which this sales receipt must be paid, in ISO 8601 format (YYYY-MM-DD).
NOTE: For sales receipts, this field is often null because sales receipts are generally used for point-of-sale payments, where full payment is received at the time of purchase.
The market exchange rate between this sales receipt'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.
The unique identifier assigned by QuickBooks to this sales receipt. This ID is unique across all transaction types.
Indicates whether this sales receipt has not been completed.
Indicates whether this sales receipt is included in the queue of documents for QuickBooks to email to the customer.
Indicates whether this sales receipt is included in the queue of documents for QuickBooks to print.
The sales receipt's line item groups, each representing a predefined set of related items.
The sales receipt's line items, each representing a single product or service sold.
A memo or note for this sales receipt that appears in reports, but not on the sales receipt.
The type of object. This value is always "qbd_sales_receipt".
"qbd_sales_receipt"A built-in custom field for additional information specific to this sales receipt. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all sales receipts for convenience. Developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Unlike otherCustomField1 and otherCustomField2, which are line item fields, this exists at the transaction level. Hidden by default in the QuickBooks UI.
The sales receipt's payment method (e.g., cash, check, credit card).
The case-sensitive user-defined reference number for this sales receipt, 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 sales receipt 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 receipt's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.
The sales-tax code for this sales receipt, determining whether it is taxable or non-taxable. This can be overridden at the transaction-line level.
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 sales-tax item used to calculate the actual tax amount for this sales receipt's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.
For sales receipts, while using this field to specify a single tax item/group that applies uniformly is recommended, complex tax scenarios may require alternative approaches. In such cases, you can set this field to a 0% tax item (conventionally named "Tax Calculated On Invoice") and handle tax calculations through line items instead. When using line items for taxes, note that only individual tax items (not tax groups) can be used, subtotals can help apply a tax to multiple items but only the first tax line after a subtotal is calculated automatically (subsequent tax lines require manual amounts), and the rate column will always display the actual tax amount rather than the rate percentage.
The sales tax percentage applied to this sales receipt, represented as a decimal string.
The total amount of sales tax charged for this sales receipt, represented as a decimal string.
The origin location from where the product associated with this sales receipt is shipped. This is the point at which ownership and liability for goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB" for this field, which stands for "freight on board". This field is informational and has no accounting implications.
The sales receipt's shipping address.
The date when the products or services for this sales receipt were shipped or are expected to be shipped, in ISO 8601 format (YYYY-MM-DD).
The shipping method used for this sales receipt, such as standard mail or overnight delivery.
The subtotal of this sales receipt, which is the sum of all sales receipt lines before taxes and payments are applied, represented as a decimal string.
The total monetary amount of this sales receipt, equivalent to the sum of the amounts in lines and lineGroups, represented as a decimal string.
The total monetary amount of this sales receipt converted to the home currency of the QuickBooks company file. Represented as a decimal string.
The date of this sales receipt, in ISO 8601 format (YYYY-MM-DD).
The date and time when this sales receipt 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.