Sales Receipts
The Sales Receipt object
QuickBooks Desktop API
Core Resources
- Auth Sessions
- End Users
Utilities
Transactions
- All Transactions
- Bill Check Payments
- Bill Credit Card Payments
- Bills
- Checks
- Credit Card Charges
- Credit Card Credits
- Credit Memos
- Estimates
- Inventory Adjustments
- Invoices
- Item Receipts
- Journal Entries
- Purchase Orders
- Receive-Payments
- Sales Orders
- Sales Receipts
- Time Tracking Activities
- Transfers
- Vendor Credits
General
- Account Tax Lines
- Accounts
- Classes
- Company
- Customers / Jobs
- Date-Driven Terms
- Employees
- Inventory Sites
- Payment Methods
- Payroll Wage Items
- Preferences
- Price Levels
- Sales Representatives
- Sales-Tax Codes
- Standard Terms
- Vendors
Items
- Discount Items
- Inventory Assembly Items
- Inventory Items
- Item Groups
- Item Sites
- Non-Inventory Items
- Sales-Tax Items
- Service Items
- Subtotal Items
Sales Receipts
The Sales Receipt object
A sales receipt records a sale where complete payment is received at the time of the transaction, whether by cash, check, or credit card. It combines the sale and payment into a single transaction. For situations requiring partial or delayed payments, use an invoice with receive-payments instead.
The schema is of type object
.
{
"id": "123ABC-1234567890",
"objectType": "qbd_sales_receipt",
"createdAt": "2021-10-01T17:34:56.000Z",
"updatedAt": "2021-10-01T20:45:30.000Z",
"revisionNumber": "1721172183",
"customer": {
"id": "80000001-1234567890",
"fullName": "Acme Corporation"
},
"class": {
"id": "80000001-1234567890",
"fullName": "Retail Sales"
},
"documentTemplate": {
"id": "80000001-1234567890",
"fullName": "Sales Receipt Template"
},
"transactionDate": "2021-10-01",
"refNumber": "RECEIPT-1234",
"billingAddress": {
"line1": "Conductor Labs Inc.",
"line2": "540 Market St.",
"line3": "Suite 100",
"line4": "",
"line5": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94110",
"country": "United States",
"note": "Conductor HQ"
},
"shippingAddress": {
"line1": "Conductor Labs Inc.",
"line2": "540 Market St.",
"line3": "Suite 100",
"line4": "",
"line5": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94110",
"country": "United States",
"note": "Conductor HQ"
},
"isPending": false,
"checkNumber": "1234567890",
"paymentMethod": {
"id": "80000001-1234567890",
"fullName": "Credit Card"
},
"dueDate": "2021-10-31",
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"shippingDate": "2021-10-01",
"shippingMethod": {
"id": "80000001-1234567890",
"fullName": "FedEx Ground"
},
"shipmentOrigin": "San Francisco, CA",
"subtotal": "1000.00",
"salesTaxItem": {
"id": "80000001-1234567890",
"fullName": "State Sales Tax"
},
"salesTaxPercentage": "0.07",
"salesTaxTotal": "10.00",
"totalAmount": "1000.00",
"currency": {
"id": "80000001-1234567890",
"fullName": "USD"
},
"exchangeRate": 1.2345,
"totalAmountInHomeCurrency": "1234.56",
"memo": "Payment received at store location - cash",
"customerMessage": {
"id": "80000001-1234567890",
"fullName": "Thank you for your business!"
},
"isQueuedForPrint": true,
"isQueuedForEmail": true,
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"depositToAccount": {
"id": "80000001-1234567890",
"fullName": "Undeposited Funds"
},
"creditCardTransaction": {
"request": {
"number": "xxxxxxxxxxxx1234",
"expirationMonth": 12,
"expirationYear": 2024,
"name": "John Doe",
"address": "1234 Main St, Anytown, USA, 12345",
"postalCode": "12345",
"commercialCardCode": "corporate",
"transactionMode": "card_not_present",
"transactionType": "charge"
},
"response": {
"statusCode": 0,
"statusMessage": "Success",
"creditCardTransactionId": "1234567890",
"merchantAccountNumber": "1234567890",
"authorizationCode": "1234567890",
"avsStreetStatus": "pass",
"avsZipStatus": "pass",
"cardSecurityCodeMatch": "pass",
"reconBatchId": "1234567890",
"paymentGroupingCode": 2,
"paymentStatus": "completed",
"transactionAuthorizedAt": "2024-01-01T12:34:56.000Z",
"transactionAuthorizationStamp": 2,
"clientTransactionId": "1234567890"
}
},
"otherCustomField": "Special handling required",
"externalId": "12345678-abcd-1234-abcd-1234567890ab",
"lines": [
{
"id": "456DEF-1234567890",
"objectType": "qbd_sales_receipt_line",
"item": {
"id": "80000001-1234567890",
"fullName": "Widget A"
},
"description": "New office chair",
"quantity": 5,
"unitOfMeasure": "Each",
"overrideUnitOfMeasureSet": {
"id": "80000001-1234567890",
"fullName": "Volume Units"
},
"rate": "10.00",
"ratePercent": "10.5",
"class": {
"id": "80000001-1234567890",
"fullName": "Supplies:Furniture"
},
"amount": "1000.00",
"inventorySite": {
"id": "80000001-1234567890",
"fullName": "Main Warehouse"
},
"inventorySiteLocation": {
"id": "80000001-1234567890",
"fullName": "Aisle 3, Shelf B"
},
"serialNumber": "SN1234567890",
"lotNumber": "LOT2023-001",
"expirationDate": "2025-12-31",
"serviceDate": "2024-03-15",
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"otherCustomField1": "Special handling required",
"otherCustomField2": "Always ship with a spare",
"creditCardTransaction": {
"request": {
"number": "xxxxxxxxxxxx1234",
"expirationMonth": 12,
"expirationYear": 2024,
"name": "John Doe",
"address": "1234 Main St, Anytown, USA, 12345",
"postalCode": "12345",
"commercialCardCode": "corporate",
"transactionMode": "card_not_present",
"transactionType": "charge"
},
"response": {
"statusCode": 0,
"statusMessage": "Success",
"creditCardTransactionId": "1234567890",
"merchantAccountNumber": "1234567890",
"authorizationCode": "1234567890",
"avsStreetStatus": "pass",
"avsZipStatus": "pass",
"cardSecurityCodeMatch": "pass",
"reconBatchId": "1234567890",
"paymentGroupingCode": 2,
"paymentStatus": "completed",
"transactionAuthorizedAt": "2024-01-01T12:34:56.000Z",
"transactionAuthorizationStamp": 2,
"clientTransactionId": "1234567890"
}
},
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"lineGroups": [
{
"id": "456DEF-1234567890",
"objectType": "qbd_sales_receipt_line_group",
"itemGroup": {
"id": "80000001-1234567890",
"fullName": "Office Supplies Bundle"
},
"description": "Standard widget bulk package",
"quantity": 5,
"unitOfMeasure": "Each",
"overrideUnitOfMeasureSet": {
"id": "80000001-1234567890",
"fullName": "Volume Units"
},
"shouldPrintItemsInGroup": true,
"totalAmount": "1000.00",
"lines": [
{
"id": "456DEF-1234567890",
"objectType": "qbd_sales_receipt_line",
"item": {
"id": "80000001-1234567890",
"fullName": "Widget A"
},
"description": "New office chair",
"quantity": 5,
"unitOfMeasure": "Each",
"overrideUnitOfMeasureSet": {
"id": "80000001-1234567890",
"fullName": "Volume Units"
},
"rate": "10.00",
"ratePercent": "10.5",
"class": {
"id": "80000001-1234567890",
"fullName": "Supplies:Furniture"
},
"amount": "1000.00",
"inventorySite": {
"id": "80000001-1234567890",
"fullName": "Main Warehouse"
},
"inventorySiteLocation": {
"id": "80000001-1234567890",
"fullName": "Aisle 3, Shelf B"
},
"serialNumber": "SN1234567890",
"lotNumber": "LOT2023-001",
"expirationDate": "2025-12-31",
"serviceDate": "2024-03-15",
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"otherCustomField1": "Special handling required",
"otherCustomField2": "Always ship with a spare",
"creditCardTransaction": {
"request": {
"number": "xxxxxxxxxxxx1234",
"expirationMonth": 12,
"expirationYear": 2024,
"name": "John Doe",
"address": "1234 Main St, Anytown, USA, 12345",
"postalCode": "12345",
"commercialCardCode": "corporate",
"transactionMode": "card_not_present",
"transactionType": "charge"
},
"response": {
"statusCode": 0,
"statusMessage": "Success",
"creditCardTransactionId": "1234567890",
"merchantAccountNumber": "1234567890",
"authorizationCode": "1234567890",
"avsStreetStatus": "pass",
"avsZipStatus": "pass",
"cardSecurityCodeMatch": "pass",
"reconBatchId": "1234567890",
"paymentGroupingCode": 2,
"paymentStatus": "completed",
"transactionAuthorizedAt": "2024-01-01T12:34:56.000Z",
"transactionAuthorizationStamp": 2,
"clientTransactionId": "1234567890"
}
},
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}