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

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

const salesReceipt = await conductor.qbd.salesReceipts.create({
  transactionDate: '2024-10-01',
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(salesReceipt.id);
{
  "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": "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"
        }
      },
      "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: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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

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

Body

application/json
​
transactionDate
string<date>
required
Example:
​
customerId
string
Example:
​
classId
string
Example:
​
documentTemplateId
string
Example:
​
refNumber
string
Example:
​
billingAddress
object
​
shippingAddress
object
​
isPending
boolean
Example:
​
checkNumber
string
Example:
​
paymentMethodId
string
Example:
​
dueDate
string<date>
Example:
​
salesRepresentativeId
string
Example:
​
shippingDate
string<date>
Example:
​
shippingMethodId
string
Example:
​
shipmentOrigin
string
Example:
​
salesTaxItemId
string
Example:
​
memo
string
Example:
​
customerMessageId
string
Example:
​
isQueuedForPrint
boolean
Example:
​
isQueuedForEmail
boolean
Example:
​
salesTaxCodeId
string
Example:
​
depositToAccountId
string
Example:
​
creditCardTransaction
object
​
otherCustomField
string
Example:
​
exchangeRate
number
Example:
​
externalId
string<uuid>
Example:
​
lines
object[]
Minimum length: 1
​
lineGroups
object[]
Minimum length: 1

Response

200 - application/json
​
id
string
required
Example:
​
objectType
string
required
Allowed value: "qbd_sales_receipt"
Example:
​
createdAt
string
required
Example:
​
updatedAt
string
required
Example:
​
revisionNumber
string
required
Example:
​
customer
object | null
required
Example:
​
class
object | null
required
Example:
​
documentTemplate
object | null
required
Example:
​
transactionDate
string<date>
required
Example:
​
refNumber
string | null
required
Example:
​
billingAddress
object | null
required
​
shippingAddress
object | null
required
​
isPending
boolean | null
required
Example:
​
checkNumber
string | null
required
Example:
​
paymentMethod
object | null
required
Example:
​
dueDate
string<date> | null
required
Example:
​
salesRepresentative
object | null
required
Example:
​
shippingDate
string<date> | null
required
Example:
​
shippingMethod
object | null
required
Example:
​
shipmentOrigin
string | null
required
Example:
​
subtotal
string
required
Example:
​
salesTaxItem
object | null
required
Example:
​
salesTaxPercentage
string | null
required
Example:
​
salesTaxTotal
string | null
required
Example:
​
totalAmount
string
required
Example:
​
currency
object | null
required
Example:
​
exchangeRate
number | null
required
Example:
​
totalAmountInHomeCurrency
string | null
required
Example:
​
memo
string | null
required
Example:
​
customerMessage
object | null
required
Example:
​
isQueuedForPrint
boolean | null
required
Example:
​
isQueuedForEmail
boolean | null
required
Example:
​
salesTaxCode
object | null
required
Example:
​
depositToAccount
object | null
required
Example:
​
creditCardTransaction
object | null
required
​
otherCustomField
string | null
required
Example:
​
externalId
string | null
required
Example:
​
lines
The Sales Receipt Line object · object[]
required
​
lineGroups
The Sales Receipt Line Group object · object[]
required
​
customFields
The Custom Field object · object[]
required