Skip to main content
GET
/
quickbooks-desktop
/
sales-receipts
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: 'sk_conductor_...',
});

// Automatically fetches more pages as needed.
for await (const salesReceipt of conductor.qbd.salesReceipts.list({
  conductorEndUserId: 'end_usr_1234567abcdefg',
})) {
  console.log(salesReceipt.id);
}
{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/sales-receipts",
  "data": [
    {
      "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",
        "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": "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": {
          "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: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": "<any>",
              "expirationMonth": "<any>",
              "expirationYear": "<any>",
              "name": "<any>",
              "address": "<any>",
              "postalCode": "<any>",
              "commercialCardCode": "<any>",
              "transactionMode": "<any>",
              "transactionType": "<any>"
            },
            "response": {
              "statusCode": "<any>",
              "statusMessage": "<any>",
              "creditCardTransactionId": "<any>",
              "merchantAccountNumber": "<any>",
              "authorizationCode": "<any>",
              "avsStreetStatus": "<any>",
              "avsZipStatus": "<any>",
              "cardSecurityCodeMatch": "<any>",
              "reconBatchId": "<any>",
              "paymentGroupingCode": "<any>",
              "paymentStatus": "<any>",
              "transactionAuthorizedAt": "<any>",
              "transactionAuthorizationStamp": "<any>",
              "clientTransactionId": "<any>"
            }
          },
          "customFields": [
            {
              "ownerId": "<any>",
              "name": "<any>",
              "type": "<any>",
              "value": "<any>"
            }
          ]
        }
      ],
      "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": "<any>",
                  "expirationMonth": "<any>",
                  "expirationYear": "<any>",
                  "name": "<any>",
                  "address": "<any>",
                  "postalCode": "<any>",
                  "commercialCardCode": "<any>",
                  "transactionMode": "<any>",
                  "transactionType": "<any>"
                },
                "response": {
                  "statusCode": "<any>",
                  "statusMessage": "<any>",
                  "creditCardTransactionId": "<any>",
                  "merchantAccountNumber": "<any>",
                  "authorizationCode": "<any>",
                  "avsStreetStatus": "<any>",
                  "avsZipStatus": "<any>",
                  "cardSecurityCodeMatch": "<any>",
                  "reconBatchId": "<any>",
                  "paymentGroupingCode": "<any>",
                  "paymentStatus": "<any>",
                  "transactionAuthorizedAt": "<any>",
                  "transactionAuthorizationStamp": "<any>",
                  "clientTransactionId": "<any>"
                }
              },
              "customFields": [
                {
                  "ownerId": "<any>",
                  "name": "<any>",
                  "type": "<any>",
                  "value": "<any>"
                }
              ]
            }
          ],
          "customFields": [
            {
              "ownerId": "<any>",
              "name": "<any>",
              "type": "<any>",
              "value": "<any>"
            }
          ]
        }
      ],
      "customFields": [
        {
          "ownerId": "<any>",
          "name": "<any>",
          "type": "<any>",
          "value": "<any>"
        }
      ]
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10,
  "hasMore": true
}

Authorizations

​
Authorization
string
header
required

Headers

​
Conductor-End-User-Id
string
required
Example:

Query Parameters

​
ids
string[]
Example:
​
refNumbers
string[]
Example:
​
limit
integer
default:150
Required range: 1 <= x <= 150
Example:
​
cursor
string
Example:
​
updatedAfter
string
Example:
​
updatedBefore
string
Example:
​
transactionDateFrom
string<date>
Example:
​
transactionDateTo
string<date>
Example:
​
customerIds
string[]
Example:
​
accountIds
string[]
Example:
​
refNumberContains
string
Example:
​
refNumberStartsWith
string
Example:
​
refNumberEndsWith
string
Example:
​
refNumberFrom
string
Example:
​
refNumberTo
string
Example:
​
currencyIds
string[]
Example:
​
includeLineItems
boolean
default:true
Example:

Response

200 - application/json
​
objectType
string
required
Allowed value: "list"
Example:
​
url
string
required
Example:
​
data
The Sales Receipt object · object[]
required
​
nextCursor
string | null
required
Example:
​
remainingCount
number | null
required
Example:
​
hasMore
boolean
required