Retrieve a sales receipt
Changed onRetrieves a sales receipt by ID.
IMPORTANT: If you need to fetch multiple specific sales receipts by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.
Request
- Base URLhttps://api.conductor.is/v1
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The QuickBooks-assigned unique identifier of the sales receipt to retrieve.
Headers
The ID of the End-User to receive this request.
Response
Returns the specified sales receipt.
Example response
{
"id": "123ABC-1234567890",
"objectType": "qbd_sales_receipt",
"createdAt": "2025-01-01T12:34:56+00:00",
"updatedAt": "2025-02-01T12:34:56+00:00",
"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": "2024-10-01",
"refNumber": "RECEIPT-1234",
"billingAddress": {
"line1": "Conductor Labs Inc.",
"line2": "540 Market St.",
"line3": "Suite 100",
"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",
"city": "San Francisco",
"state": "CA",
"postalCode": "94110",
"country": "United States",
"note": "Conductor HQ"
},
"checkNumber": "1234567890",
"paymentMethod": {
"id": "80000001-1234567890",
"fullName": "Credit Card"
},
"dueDate": "2024-10-31",
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"shippingDate": "2024-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": {
"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:56Z",
"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": {
"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:56Z",
"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",
"serviceDate": "2024-03-15",
"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": {
"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:56Z",
"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"
}
]
}Changes
- warning
for the
pathrequest parameterid, the maxLength was set to36
- warning
- breaking
response property
checkNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
dueDatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
exchangeRatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
externalIdlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
isPendinglist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
isQueuedForEmaillist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
isQueuedForPrintlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/descriptionlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/itemGroup/fullNamelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/itemGroup/idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/amountlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/descriptionlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/expirationDatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/lotNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/otherCustomField1list-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/otherCustomField2list-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/quantitylist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/ratelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/ratePercentlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/serialNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/serviceDatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/lines/items/unitOfMeasurelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/quantitylist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/serviceDatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lineGroups/items/unitOfMeasurelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/amountlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/descriptionlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/expirationDatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/lotNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/otherCustomField1list-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/otherCustomField2list-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/quantitylist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/ratelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/ratePercentlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/serialNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/serviceDatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
lines/items/unitOfMeasurelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
memolist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
otherCustomFieldlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
refNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
salesTaxPercentagelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
salesTaxTotallist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
shipmentOriginlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
shippingDatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
totalAmountInHomeCurrencylist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
the
response's property type changed fromobjectnullto no type for status - breaking
the
response's property type changed fromobjectnullto no type for status - breaking
the
response's property type changed fromobjectnullto no type for status - breaking
the
response's property type changed fromobjectnullto no type for status - breaking
the
response's property type changed fromobjectnullto no type for status - breaking
the
response's property type changed fromobjectnullto no type for status - breaking
the
////response's property type changed fromobjectnullto no type for status - breaking
the
////response's property type changed fromobjectnullto no type for status - breaking
the
////response's property type changed fromobjectnullto no type for status - breaking
the
////response's property type changed fromobjectnullto no type for status - breaking
the
////response's property type changed fromobjectnullto no type for status - breaking
the
////response's property type changed fromobjectnullto no type for status - breaking
the
//response's property type changed fromobjectnullto no type for status - breaking
the
//response's property type changed fromobjectnullto no type for status - breaking
the
//response's property type changed fromobjectnullto no type for status - breaking
the
//response's property type changed fromobjectnullto no type for status - breaking
the
//response's property type changed fromobjectnullto no type for status - breaking
the
//response's property type changed fromobjectnullto no type for status - breaking
the
//response's property type changed fromobjectnullto no type for status - breaking
the
response's property type changed fromobjectnullto no type for status - breaking
the
response's property type changed fromobjectnullto no type for status - breaking
the
response's property type changed fromobjectnullto no type for status - breaking
the
response's property type changed fromobjectnullto no type for status - breaking
the
response's property type changed fromobjectnullto no type for status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
/////from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
///from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - info
added
subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #2to the////response propertyanyOflist for the response status - info
added
subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #1subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #1subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #1subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #1subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #1subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #1subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #1subschema #2to the////response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the////response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the////response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the////response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the////response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the////response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #1subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #1subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #1subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #1subschema #2to theresponse propertyanyOflist for the response status - info
added
subschema #1subschema #2to theresponse propertyanyOflist for the response status - info
removed
subschema #2from theresponse propertyoneOflist for the response status - info
removed
subschema #2from theresponse propertyoneOflist for the response status - info
removed
subschema #2from theresponse propertyoneOflist for the response status - info
removed
subschema #2from the////response propertyoneOflist for the response status - info
removed
subschema #2from the//response propertyoneOflist for the response status
- breaking