v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

List all sales receipts

Returns a list of sales receipts. Use the cursor parameter to paginate through the results.

get/quickbooks-desktop/sales-receipts

Query parameters

idsstring[]

Filter for specific sales receipts by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

Filter for specific sales receipts by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

[
  "123ABC-1234567890"
]

refNumbersstring[]

Filter for specific sales receipts by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

Filter for specific sales receipts by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

[
  "SALES RECEIPT-1234"
]

limitinteger

The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the cursor parameter. Each response will include a nextCursor value that can be passed to subsequent requests to retrieve the next page of results.

Example:150

cursorstring

The pagination token to fetch the next set of results when paginating with the limit parameter. Do not include this parameter on the first call. Use the nextCursor value returned in the previous response to request subsequent results.

Example:12345678-abcd-abcd-example-1234567890ab

updatedAfterstring

Filter for sales receipts updated on or after this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Example:2025-01-01T12:34:56+00:00

Filter for sales receipts updated on or after this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

updatedBeforestring

Filter for sales receipts updated on or before this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Example:2025-02-01T12:34:56+00:00

Filter for sales receipts updated on or before this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

transactionDateFromstring date

Filter for sales receipts whose date field is on or after this date, in ISO 8601 format (YYYY-MM-DD).

NOTE: QuickBooks Desktop interprets this date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).

Example:2025-01-01

Filter for sales receipts whose date field is on or after this date, in ISO 8601 format (YYYY-MM-DD).

NOTE: QuickBooks Desktop interprets this date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).

transactionDateTostring date

Filter for sales receipts whose date field is on or before this date, in ISO 8601 format (YYYY-MM-DD).

NOTE: QuickBooks Desktop interprets this date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).

Example:2025-02-01

Filter for sales receipts whose date field is on or before this date, in ISO 8601 format (YYYY-MM-DD).

NOTE: QuickBooks Desktop interprets this date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).

customerIdsstring[]

Filter for sales receipts created for these customers.

[
  "80000001-1234567890"
]

accountIdsstring[]

Filter for sales receipts associated with these accounts.

[
  "80000001-1234567890"
]

refNumberContainsstring

Filter for sales receipts whose refNumber contains this substring.

NOTE: If you use this parameter, you cannot also use refNumberStartsWith or refNumberEndsWith.

Example:RECEIPT-1234

Filter for sales receipts whose refNumber contains this substring.

NOTE: If you use this parameter, you cannot also use refNumberStartsWith or refNumberEndsWith.

refNumberStartsWithstring

Filter for sales receipts whose refNumber starts with this substring.

NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberEndsWith.

Example:RECEIPT

Filter for sales receipts whose refNumber starts with this substring.

NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberEndsWith.

refNumberEndsWithstring

Filter for sales receipts whose refNumber ends with this substring.

NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberStartsWith.

Example:1234

Filter for sales receipts whose refNumber ends with this substring.

NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberStartsWith.

refNumberFromstring

Filter for sales receipts whose refNumber is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.

Example:RECEIPT-0001

refNumberTostring

Filter for sales receipts whose refNumber is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.

Example:RECEIPT-9999

currencyIdsstring[]

Filter for sales receipts in these currencies.

[
  "80000001-1234567890"
]

includeLineItemsboolean

Whether to include line items in the response. Defaults to true.

Example:true

Whether to include line items in the response. Defaults to true.

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

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

Response

Returns a list of sales receipts.

objectType'list' required

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

urlstring required

The endpoint URL where this list can be accessed.

nextCursorstring nullable required

The nextCursor is a pagination token returned in the response when you use the limit parameter in your request. To retrieve subsequent pages of results, include this token as the value of the cursor request parameter in your following API calls.

NOTE: The nextCursor value remains constant throughout the pagination process for a specific list instance; continue to use the same nextCursor token in each request to fetch additional pages.

remainingCountnumber nullable required

The number of objects remaining to be fetched.

hasMoreboolean required

Indicates whether there are more objects to be fetched.

Example response

{
  "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",
        "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"
        }
      ]
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10
}