GET
/
quickbooks-desktop
/
currencies
/
{id}
JavaScript
import Conductor from 'conductor-node';

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

const currency = await conductor.qbd.currencies.retrieve('80000001-1234567890', {
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(currency.id);
{
  "id": "80000001-1234567890",
  "objectType": "qbd_currency",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "United States Dollar",
  "isActive": true,
  "currencyCode": "USD",
  "currencyFormat": {
    "thousandSeparator": "comma",
    "thousandSeparatorGrouping": "xx_xxx_xxx",
    "decimalPlaces": "2",
    "decimalSeparator": "period"
  },
  "isUserDefinedCurrency": false,
  "exchangeRate": 1.2345,
  "asOfDate": "2024-08-01"
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

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

Example:

"80000001-1234567890"

Response

200 - application/json

Returns the specified currency.

​
id
string
required

The unique identifier assigned by QuickBooks to this currency. This ID is unique across all currencies but not across different QuickBooks object types.

Example:

"80000001-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_currency"
Example:

"qbd_currency"

​
createdAt
string
required

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

Example:

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

​
updatedAt
string
required

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

Example:

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

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this currency 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.

Example:

"1721172183"

​
name
string
required

The case-insensitive unique name of this currency, unique across all currencies. For built-in currencies, the name is the internationally accepted currency name and is not editable.

NOTE: Currencies do not have a fullName field because they are not hierarchical objects, which is why name is unique for them but not for objects that have parents.

Example:

"United States Dollar"

​
isActive
boolean
required

Indicates whether this currency is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

​
currencyCode
string
required

The internationally accepted currency code used by this currency, typically based on the ISO 4217 standard (for example, USD for US Dollars). Built-in QuickBooks currencies follow ISO 4217. For user-defined currencies, following ISO 4217 is recommended but not required. In many cases, the three-letter code is formed from the country's two-letter internet code plus a currency letter (e.g., BZ + D → BZD for Belize Dollar).

Example:

"USD"

​
currencyFormat
object | null
required

Controls how this currency displays thousands separators, grouping, and decimal places.

​
isUserDefinedCurrency
boolean | null
required

Indicates whether this currency was created by a QuickBooks user (true) or is a built-in currency (false).

Example:

false

​
exchangeRate
number | null
required

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

Example:

1.2345

​
asOfDate
string<date> | null
required

The date when the exchange rate for this currency was last updated, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-08-01"