COconductor-is

Retrieve a transaction

Changed on

Retrieves a transaction by ID.

IMPORTANT: If you need to fetch multiple specific transactions 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.

get/quickbooks-desktop/transactions/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the transaction to retrieve.

Example:123ABC-1234567890

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Response

Returns the specified transaction.

transactionType'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment' | 'transfer_inventory' | 'unknown' required

The type of transaction.

transactionIdstring required

The QuickBooks-assigned unique identifier of this transaction. If transactionLineId is also defined, this is the identifier of the line's parent transaction object.

transactionLineIdstring nullable required

The QuickBooks-assigned unique identifier of this transaction line. If null, this result is a transaction object.

createdAtstring required

The date and time when this transaction 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 transaction 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.

transactionDatestring date required

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

refNumberstring nullable required

The case-sensitive user-defined reference number for this transaction, 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.

amountstring required

The monetary amount of this transaction, represented as a decimal string.

exchangeRatenumber nullable required

The market exchange rate between this transaction'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).

amountInHomeCurrencystring nullable required

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

memostring nullable required

A memo or note for this transaction.

Example response

{
  "transactionType": "invoice",
  "transactionId": "123ABC-1234567890",
  "transactionLineId": "456DEF-1234567890",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "entity": {
    "id": "80000001-1234567890",
    "fullName": "Acme Corporation"
  },
  "account": {
    "id": "80000001-1234567890",
    "fullName": "Checking"
  },
  "transactionDate": "2024-10-01",
  "refNumber": "INV-1234",
  "amount": "1000.00",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "amountInHomeCurrency": "1234.56",
  "memo": "Customer requested rush delivery"
}

Changes

  • 8ee3502091a4Revision changes
    • warning

      added the new transfer_inventory enum value to the response property for the response status

  • daabb801a173Revision changes
    • warning

      added the new unknown enum value to the response property for the response status