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
List all sales receipts
Returns a list of sales receipts. Use the cursor parameter to paginate through the results.
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}}").
Query Parameters
Filter for specific sales receipts by their QuickBooks-assigned unique identifier(s).
IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.
Filter for specific sales receipts by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.
IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.
The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the cursor parameter. Each response will include a nextCursor value that can be passed to subsequent requests to retrieve the next page of results.
1 < x < 150The pagination token to fetch the next set of results when paginating with the limit parameter. Retrieve this value from the nextCursor field in the previous response. If omitted, the API returns the first page of results.
Filter for sales receipts updated on or after this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.
Filter for sales receipts updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.
Filter for sales receipts created on or after this date, in ISO 8601 format (YYYY-MM-DD).
Filter for sales receipts created on or before this date, in ISO 8601 format (YYYY-MM-DD).
Filter for sales receipts created for these customers.
Filter for sales receipts associated with these accounts.
Filter for sales receipts whose refNumber contains this substring. NOTE: If you use this parameter, you cannot also use refNumberStartsWith or refNumberEndsWith.
Filter for sales receipts whose refNumber starts with this substring. NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberEndsWith.
Filter for sales receipts whose refNumber ends with this substring. NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberStartsWith.
Filter for sales receipts whose refNumber is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.
Filter for sales receipts whose refNumber is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.
Filter for sales receipts in these currencies.
Whether to include line items in the response. Defaults to true.
Response
The array of sales receipts.
The sales receipt's billing address.
The city, district, suburb, town, or village name of the address.
The country name of the address.
The first line of the address (e.g., street, PO Box, or company name).
The second line of the address, if needed (e.g., apartment, suite, unit, or building).
The third line of the address, if needed.
The fourth line of the address, if needed.
The fifth line of the address, if needed.
A note written at the bottom of the address in the form in which it appears, such as the invoice form.
The postal code or ZIP code of the address.
The state, county, province, or region name of the 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 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 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 transaction request data originally supplied for this credit card transaction when using QuickBooks Merchant Services (QBMS).
The card's billing address.
The commercial card code identifies the type of business credit card being used (purchase, corporate, or business) for Visa and Mastercard transactions only. When provided, this code may qualify the transaction for lower processing fees compared to the standard rates that apply when no code is specified.
The month when the credit card expires.
The year when the credit card expires.
The cardholder's name on the card.
The credit card number. Must be masked with lower case "x" and no dashes.
The card's billing address ZIP or postal code.
Indicates whether this credit card transaction came from a card swipe (card_present) or not (card_not_present).
card_not_present, card_present The QBMS transaction type from which the current transaction data originated.
authorization, capture, charge, refund, voice_authorization The transaction response data for this credit card transaction when using QuickBooks Merchant Services (QBMS).
The authorization code returned from the credit card processor to indicate that this charge will be paid by the card issuer.
Indicates whether the street address supplied in the transaction request matches the customer's address on file at the card issuer.
fail, not_available, pass Indicates whether the customer postal ZIP code supplied in the transaction request matches the customer's postal code recognized at the card issuer.
fail, not_available, pass Indicates whether the card security code supplied in the transaction request matches the card security code recognized for that credit card number at the card issuer.
fail, not_available, pass A value returned from QBMS transactions for future use by the QuickBooks Reconciliation feature.
The ID returned from the credit card processor for this credit card transaction.
The QBMS account number of the merchant who is running this transaction using the customer's credit card.
An internal code returned by QuickBooks Merchant Services (QBMS) from the transaction request, needed for the QuickBooks reconciliation feature.
Indicates whether this credit card transaction is known to have been successfully processed by the card issuer.
completed, unknown An internal ID returned by QuickBooks Merchant Services (QBMS) from the transaction request, needed for the QuickBooks reconciliation feature.
The status code returned in the original QBMS transaction response for this credit card transaction.
The status message returned in the original QBMS transaction response for this credit card transaction.
An internal value for this credit card transaction, needed for the QuickBooks reconciliation feature.
The date and time when the credit card processor authorized this credit card transaction.
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 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 customer or customer-job to which the payment for this sales receipt is credited.
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 message to display to the customer on the sales receipt.
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 sales receipt 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 account where the funds for this sales receipt will be or have been deposited.
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 predefined template in QuickBooks that determines the layout and formatting for this sales receipt when printed or displayed.
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 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 custom fields for the sales receipt 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 sales receipt line group.
The unique identifier assigned by QuickBooks to this sales receipt line group. This ID is unique across all transaction line types.
The sales receipt 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 sales receipt line group's line items, each representing a single product or service sold.
The monetary amount of this sales receipt line, represented as a decimal string. If both quantity and rate are specified but not amount, QuickBooks will use them to calculate amount. If amount, rate, and quantity are all unspecified, then QuickBooks will calculate amount based on a quantity of 1 and the suggested rate. This field cannot be cleared.
The sales receipt 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 sales receipt 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 credit card transaction data for this sales receipt line's payment when using QuickBooks Merchant Services (QBMS).
The transaction request data originally supplied for this credit card transaction when using QuickBooks Merchant Services (QBMS).
The transaction response data for this credit card transaction when using QuickBooks Merchant Services (QBMS).
The custom fields for the sales receipt 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 sales receipt line.
The expiration date for the serial number or lot number of the item associated with this sales receipt 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 sales receipt line. This ID is unique across all transaction line types.
The site location where inventory for the item associated with this sales receipt 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 sales receipt 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 sales receipt 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 sales receipt line. Used for tracking groups of inventory items that are purchased or manufactured together.
The type of object. This value is always "qbd_sales_receipt_line".
"qbd_sales_receipt_line"A built-in custom field for additional information specific to this sales receipt line. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all sales receipt lines for convenience. Developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
A second built-in custom field for additional information specific to this sales receipt line. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all sales receipt lines for convenience. Like otherCustomField1, developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
Specifies an alternative unit-of-measure set when updating this sales receipt 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 sales receipt line. This field cannot be cleared.
The price per unit for this sales receipt line. If both rate and amount are specified, rate will be ignored. If both quantity and amount are specified but not rate, QuickBooks will use them to calculate rate. Represented as a decimal string. This field cannot be cleared.
The price of this sales receipt line expressed as a percentage. Typically used for discount or markup items.
The sales-tax code for this sales receipt 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 sales receipt line. This is used for tracking individual units of serialized inventory items.
The date on which the service for this sales receipt line was or will be performed, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for service items.
The unit-of-measure used for the quantity in this sales receipt line. Must be a valid unit within the item's available units of measure.
The type of object. This value is always "qbd_sales_receipt_line_group".
"qbd_sales_receipt_line_group"Specifies an alternative unit-of-measure set when updating this sales receipt 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 sales receipt line group. This field cannot be cleared.
Indicates whether the individual items in this sales receipt line group and their separate amounts appear on printed forms.
The total monetary amount of this sales receipt 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 sales receipt line group. Must be a valid unit within the item's available units of measure.
The sales receipt's line items, each representing a single product or service sold.
The monetary amount of this sales receipt line, represented as a decimal string. If both quantity and rate are specified but not amount, QuickBooks will use them to calculate amount. If amount, rate, and quantity are all unspecified, then QuickBooks will calculate amount based on a quantity of 1 and the suggested rate. This field cannot be cleared.
The sales receipt 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 sales receipt 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 credit card transaction data for this sales receipt line's payment when using QuickBooks Merchant Services (QBMS).
The transaction request data originally supplied for this credit card transaction when using QuickBooks Merchant Services (QBMS).
The card's billing address.
The commercial card code identifies the type of business credit card being used (purchase, corporate, or business) for Visa and Mastercard transactions only. When provided, this code may qualify the transaction for lower processing fees compared to the standard rates that apply when no code is specified.
The month when the credit card expires.
The year when the credit card expires.
The cardholder's name on the card.
The credit card number. Must be masked with lower case "x" and no dashes.
The card's billing address ZIP or postal code.
Indicates whether this credit card transaction came from a card swipe (card_present) or not (card_not_present).
card_not_present, card_present The QBMS transaction type from which the current transaction data originated.
authorization, capture, charge, refund, voice_authorization The transaction response data for this credit card transaction when using QuickBooks Merchant Services (QBMS).
The authorization code returned from the credit card processor to indicate that this charge will be paid by the card issuer.
Indicates whether the street address supplied in the transaction request matches the customer's address on file at the card issuer.
fail, not_available, pass Indicates whether the customer postal ZIP code supplied in the transaction request matches the customer's postal code recognized at the card issuer.
fail, not_available, pass Indicates whether the card security code supplied in the transaction request matches the card security code recognized for that credit card number at the card issuer.
fail, not_available, pass A value returned from QBMS transactions for future use by the QuickBooks Reconciliation feature.
The ID returned from the credit card processor for this credit card transaction.
The QBMS account number of the merchant who is running this transaction using the customer's credit card.
An internal code returned by QuickBooks Merchant Services (QBMS) from the transaction request, needed for the QuickBooks reconciliation feature.
Indicates whether this credit card transaction is known to have been successfully processed by the card issuer.
completed, unknown An internal ID returned by QuickBooks Merchant Services (QBMS) from the transaction request, needed for the QuickBooks reconciliation feature.
The status code returned in the original QBMS transaction response for this credit card transaction.
The status message returned in the original QBMS transaction response for this credit card transaction.
An internal value for this credit card transaction, needed for the QuickBooks reconciliation feature.
The date and time when the credit card processor authorized this credit card transaction.
The custom fields for the sales receipt 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 sales receipt line.
The expiration date for the serial number or lot number of the item associated with this sales receipt 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 sales receipt line. This ID is unique across all transaction line types.
The site location where inventory for the item associated with this sales receipt 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 sales receipt 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 sales receipt 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 sales receipt line. Used for tracking groups of inventory items that are purchased or manufactured together.
The type of object. This value is always "qbd_sales_receipt_line".
"qbd_sales_receipt_line"A built-in custom field for additional information specific to this sales receipt line. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all sales receipt lines for convenience. Developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
A second built-in custom field for additional information specific to this sales receipt line. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all sales receipt lines for convenience. Like otherCustomField1, developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
Specifies an alternative unit-of-measure set when updating this sales receipt 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 sales receipt line. This field cannot be cleared.
The price per unit for this sales receipt line. If both rate and amount are specified, rate will be ignored. If both quantity and amount are specified but not rate, QuickBooks will use them to calculate rate. Represented as a decimal string. This field cannot be cleared.
The price of this sales receipt line expressed as a percentage. Typically used for discount or markup items.
The sales-tax code for this sales receipt 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 sales receipt line. This is used for tracking individual units of serialized inventory items.
The date on which the service for this sales receipt line was or will be performed, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for service items.
The unit-of-measure used for the quantity in this sales receipt line. Must be a valid unit within the item's available units of measure.
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 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 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 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 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 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 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 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 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 city, district, suburb, town, or village name of the address.
The country name of the address.
The first line of the address (e.g., street, PO Box, or company name).
The second line of the address, if needed (e.g., apartment, suite, unit, or building).
The third line of the address, if needed.
The fourth line of the address, if needed.
The fifth line of the address, if needed.
A note written at the bottom of the address in the form in which it appears, such as the invoice form.
The postal code or ZIP code of the address.
The state, county, province, or region name of the 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 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 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.
Indicates whether there are more objects to be fetched.
The nextCursor is a pagination token returned in the response when you use the limit parameter in your request. To retrieve subsequent pages of results, include this token as the value of the cursor request parameter in your following API calls.
NOTE: The nextCursor value remains constant throughout the pagination process for a specific list instance; continue to use the same nextCursor token in each request to fetch additional pages.
The type of object. This value is always "list".
"list"The number of objects remaining to be fetched.
The endpoint URL where this list can be accessed.