Sign in

v48

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

Create an item receipt

Creates an item receipt to record inventory received from a vendor. You can link it to a purchase order during creation to pull in the order's lines automatically and update quantities, but that link can't be added later with an update.

post/quickbooks-desktop/item-receipts

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.

Request body

vendorIdstring required

The vendor who sent this item receipt for goods or services purchased.

payablesAccountIdstring

The Accounts-Payable (A/P) account to which this item receipt is assigned, used for accounts-payable tracking. If omitted, QuickBooks Desktop uses the default A/P account configured in the company file.

IMPORTANT: If this item receipt is linked to other transactions, this A/P account must match the payablesAccount used in those other transactions.

transactionDatestring date required

The date of this item receipt, in ISO 8601 format (YYYY-MM-DD).

refNumberstring

The case-sensitive user-defined reference number for this item receipt, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user. When left blank in this create request, this field will be left blank in QuickBooks (i.e., it does not auto-increment).

Maximum length: 20 characters.

memostring

A memo or note for this item receipt.

salesTaxCodeIdstring

The sales-tax code for this item receipt, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the vendor. This can be overridden on the item receipt's individual lines.

Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.

exchangeRatenumber

The market exchange rate between this item receipt's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).

externalIdstring uuid

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

linkToTransactionIdsstring[]

IDs of existing purchase orders that you wish to link to this item receipt. Note that this links entire transactions, not individual transaction lines. If you want to link individual lines in a transaction, instead use the field linkToTransactionLine on this item receipt's lines, if available.

Transactions can only be linked when creating this item receipt and cannot be unlinked later.

You can use both linkToTransactionIds (on this item receipt) and linkToTransactionLine (on its transaction lines) as long as they do NOT link to the same transaction (otherwise, QuickBooks will return an error). QuickBooks will also return an error if you attempt to link a transaction that is empty or already closed.

IMPORTANT: By default, QuickBooks will not return any information about the linked transactions in this endpoint's response even when this request is successful. To see the transactions linked via this field, refetch the item receipt and check the linkedTransactions response field. If fetching a list of item receipts, you must also specify the parameter includeLinkedTransactions=true to see the linkedTransactions response field.

Example request

{
  "vendorId": "80000001-1234567890",
  "payablesAccountId": "80000001-1234567890",
  "transactionDate": "2024-10-01",
  "refNumber": "RECEIPT-1234",
  "memo": "Received 100 units of Product X from Vendor Y",
  "salesTaxCodeId": "80000001-1234567890",
  "exchangeRate": 1.2345,
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "expenseLines": [
    {
      "accountId": "80000001-1234567890",
      "amount": "1000.00",
      "memo": "New office chair",
      "payeeId": "80000001-1234567890",
      "classId": "80000001-1234567890",
      "salesTaxCodeId": "80000001-1234567890",
      "billingStatus": "billable",
      "salesRepresentativeId": "80000001-1234567890",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "value": "Premium"
        }
      ]
    }
  ],
  "itemLines": [
    {
      "itemId": "80000001-1234567890",
      "inventorySiteId": "80000001-1234567890",
      "inventorySiteLocationId": "80000001-1234567890",
      "serialNumber": "SN1234567890",
      "lotNumber": "LOT2023-001",
      "expirationDate": "2025-12-31",
      "description": "High-quality widget with custom engraving",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "cost": "1000.00",
      "amount": "1000.00",
      "customerId": "80000001-1234567890",
      "classId": "80000001-1234567890",
      "salesTaxCodeId": "80000001-1234567890",
      "billingStatus": "billable",
      "overrideItemAccountId": "80000001-1234567890",
      "linkToTransactionLine": {
        "transactionId": "123ABC-1234567890",
        "transactionLineId": "456DEF-1234567890"
      },
      "salesRepresentativeId": "80000001-1234567890",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "value": "Premium"
        }
      ]
    }
  ],
  "itemGroupLines": [
    {
      "itemGroupId": "80000001-1234567890",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "inventorySiteId": "80000001-1234567890",
      "inventorySiteLocationId": "80000001-1234567890",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "value": "Premium"
        }
      ]
    }
  ]
}

Response

Returns the newly created item receipt.

idstring required

The unique identifier assigned by QuickBooks to this item receipt. This ID is unique across all transaction types.

objectType'qbd_item_receipt' required

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

createdAtstring required

The date and time when this item receipt was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this item receipt was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned revision number of this item receipt object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

transactionDatestring date required

The date of this item receipt, in ISO 8601 format (YYYY-MM-DD).

totalAmountstring required

The total monetary amount of this item receipt, equivalent to the sum of the amounts in expenseLines, itemLines, and itemGroupLines, represented as a decimal string.

exchangeRatenumber nullable required

The market exchange rate between this item receipt's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).

totalAmountInHomeCurrencystring nullable required

The total monetary amount of this item receipt converted to the home currency of the QuickBooks company file. Represented as a decimal string.

refNumberstring nullable required

The case-sensitive user-defined reference number for this item receipt, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.

memostring nullable required

A memo or note for this item receipt.

externalIdstring nullable required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

Example response

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_item_receipt",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "vendor": {
    "id": "80000001-1234567890",
    "fullName": "Acme Supplies Ltd."
  },
  "payablesAccount": {
    "id": "80000001-1234567890",
    "fullName": "Accounts-Payable"
  },
  "liabilityAccount": {
    "id": "80000001-1234567890",
    "fullName": "Liabilities:Accounts-Payable"
  },
  "transactionDate": "2024-10-01",
  "totalAmount": "1000.00",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "totalAmountInHomeCurrency": "1234.56",
  "refNumber": "RECEIPT-1234",
  "memo": "Received 100 units of Product X from Vendor Y",
  "salesTaxCode": {
    "id": "80000001-1234567890",
    "fullName": "Non"
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "linkedTransactions": [
    {
      "id": "123ABC-1234567890",
      "objectType": "qbd_linked_transaction",
      "transactionType": "invoice",
      "transactionDate": "2024-10-01",
      "refNumber": "LINK-1234",
      "linkType": "amount",
      "amount": "1000.00"
    }
  ],
  "expenseLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_expense_line",
      "account": {
        "id": "80000001-1234567890",
        "fullName": "Expenses:Office Supplies"
      },
      "amount": "1000.00",
      "memo": "New office chair",
      "payee": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Office Supplies"
      },
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "billingStatus": "billable",
      "salesRepresentative": {
        "id": "80000001-1234567890",
        "fullName": "Jane Doe"
      },
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "itemLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_item_line",
      "item": {
        "id": "80000001-1234567890",
        "fullName": "Widget A"
      },
      "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",
      "description": "High-quality widget with custom engraving",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "overrideUnitOfMeasureSet": {
        "id": "80000001-1234567890",
        "fullName": "Volume Units"
      },
      "cost": "1000.00",
      "amount": "1000.00",
      "customer": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Installation:Residential"
      },
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "billingStatus": "billable",
      "salesRepresentative": {
        "id": "80000001-1234567890",
        "fullName": "Jane Doe"
      },
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "itemGroupLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_item_group_line",
      "itemGroup": {
        "id": "80000001-1234567890",
        "fullName": "Office Supplies Bundle"
      },
      "description": "Standard widget bulk package",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "overrideUnitOfMeasureSet": {
        "id": "80000001-1234567890",
        "fullName": "Volume Units"
      },
      "totalAmount": "1000.00",
      "itemLines": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_item_line",
          "item": {
            "id": "80000001-1234567890",
            "fullName": "Widget A"
          },
          "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",
          "description": "High-quality widget with custom engraving",
          "quantity": 5,
          "unitOfMeasure": "Each",
          "overrideUnitOfMeasureSet": {
            "id": "80000001-1234567890",
            "fullName": "Volume Units"
          },
          "cost": "1000.00",
          "amount": "1000.00",
          "customer": {
            "id": "80000001-1234567890",
            "fullName": "Acme Corporation"
          },
          "class": {
            "id": "80000001-1234567890",
            "fullName": "Installation:Residential"
          },
          "salesTaxCode": {
            "id": "80000001-1234567890",
            "fullName": "Non"
          },
          "billingStatus": "billable",
          "salesRepresentative": {
            "id": "80000001-1234567890",
            "fullName": "Jane Doe"
          },
          "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"
    }
  ]
}