Skip to main content
GET
JavaScript

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the sales receipt to retrieve.

Maximum string length: 36
Example:

"123ABC-1234567890"

Response

200 - application/json

Returns the specified sales receipt.

​
id
string
required

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

Example:

"123ABC-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_sales_receipt"
Example:

"qbd_sales_receipt"

​
createdAt
string
required

The date and time when this sales receipt 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.

Example:

"2025-01-01T12:34:56.000Z"

​
updatedAt
string
required

The date and time when this sales receipt 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.

Example:

"2025-02-01T12:34:56.000Z"

​
revisionNumber
string
required

The current QuickBooks-assigned 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.

Example:

"1721172183"

​
customer
object | null
required

The customer or customer-job to which the payment for this sales receipt is credited.

Example:
​
class
object | null
required

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.

Example:
​
documentTemplate
object | null
required

The predefined template in QuickBooks that determines the layout and formatting for this sales receipt when printed or displayed.

Example:
​
transactionDate
string<date>
required

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

Example:

"2024-10-01"

​
refNumber
string | null
required

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.

Example:

"RECEIPT-1234"

​
billingAddress
The Address object · object | null
required

The sales receipt's billing address.

​
shippingAddress
The Address object · object | null
required

The sales receipt's shipping address.

​
isPending
boolean | null
required

Indicates whether this sales receipt has not been completed.

Example:

false

​
checkNumber
string | null
required

The check number of a check received for this sales receipt.

Example:

"1234567890"

​
paymentMethod
object | null
required

The sales receipt's payment method (e.g., cash, check, credit card).

Example:
​
dueDate
string<date> | null
required

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.

Example:

"2024-10-31T00:00:00.000Z"

​
salesRepresentative
object | null
required

The sales receipt's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.

Example:
​
shippingDate
string<date> | null
required

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

Example:

"2024-10-01T00:00:00.000Z"

​
shippingMethod
object | null
required

The shipping method used for this sales receipt, such as standard mail or overnight delivery.

Example:
​
shipmentOrigin
string | null
required

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.

Example:

"San Francisco, CA"

​
subtotal
string
required

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.

Example:

"1000.00"

​
salesTaxItem
object | null
required

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.

Example:
​
salesTaxPercentage
string | null
required

The sales tax percentage applied to this sales receipt, represented as a decimal string.

Example:

"0.07"

​
salesTaxTotal
string | null
required

The total amount of sales tax charged for this sales receipt, represented as a decimal string.

Example:

"10.00"

​
totalAmount
string
required

The total monetary amount of this sales receipt, equivalent to the sum of the amounts in lines and lineGroups, represented as a decimal string.

Example:

"1000.00"

​
currency
object | null
required

The sales receipt's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.

Example:
​
exchangeRate
number | null
required

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

Example:

1.2345

​
totalAmountInHomeCurrency
string | null
required

The total monetary amount of this sales receipt converted to the home currency of the QuickBooks company file. Represented as a decimal string.

Example:

"1234.56"

​
memo
string | null
required

A memo or note for this sales receipt that appears in reports, but not on the sales receipt.

Example:

"Payment received at store location - cash"

​
customerMessage
object | null
required

The message to display to the customer on the sales receipt.

Example:
​
isQueuedForPrint
boolean | null
required

Indicates whether this sales receipt is included in the queue of documents for QuickBooks to print.

Example:

true

​
isQueuedForEmail
boolean | null
required

Indicates whether this sales receipt is included in the queue of documents for QuickBooks to email to the customer.

Example:

true

​
salesTaxCode
object | null
required

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

Example:
​
depositToAccount
object | null
required

The account where the funds for this sales receipt will be or have been deposited.

Example:
​
creditCardTransaction
The Credit Card Transaction object · object | null
required

The credit card transaction data for this sales receipt's payment when using QuickBooks Merchant Services (QBMS).

​
otherCustomField
string | null
required

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.

Example:

"Special handling required"

​
externalId
string | null
required

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.

Example:

"12345678-abcd-1234-abcd-1234567890ab"

​
lines
The Sales Receipt Line object · object[]
required

The sales receipt's line items, each representing a single product or service sold.

​
lineGroups
The Sales Receipt Line Group object · object[]
required

The sales receipt's line item groups, each representing a predefined set of related items.

​
customFields
The Custom Field object · object[]
required

The custom fields for the sales receipt object, added as user-defined data extensions, not included in the standard QuickBooks object.