COconductor-is

Update a currency

Changed on

Updates an existing currency. For built-in currencies, only the isActive status can be changed; name and currency code are not editable. For user-defined currencies, all fields in this request are editable.

post/quickbooks-desktop/currencies/{id}

Request

Path parameters

idstring required

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

Example:80000001-1234567890

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Request body

revisionNumberstring required

The current QuickBooks-assigned revision number of the currency object you are updating, which you can get by fetching the object first. Provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

namestring

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.

Maximum length: 64 characters.

isActiveboolean

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

currencyCodestring

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).

Maximum length: 3 characters.

Example request

{
  "revisionNumber": "1721172183",
  "name": "United States Dollar",
  "isActive": true,
  "currencyCode": "USD",
  "currencyFormat": {
    "thousandSeparator": "comma",
    "thousandSeparatorGrouping": "xx_xxx_xxx",
    "decimalPlaces": "2",
    "decimalSeparator": "period"
  }
}

Response

Returns the updated currency.

idstring required

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

objectType'qbd_currency' required

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

createdAtstring 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.

updatedAtstring 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.

revisionNumberstring 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.

namestring 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.

isActiveboolean required

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

currencyCodestring 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).

isUserDefinedCurrencyboolean nullable required

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

exchangeRatenumber nullable 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).

asOfDatestring date nullable required

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

Example response

{
  "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"
  },
  "exchangeRate": 1.2345,
  "asOfDate": "2024-08-01"
}

Changes

  • 1de07095c4b7Revision changes
    • warning

      for the path request parameter id, the maxLength was set to 36

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property asOfDate list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property exchangeRate list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property isUserDefinedCurrency list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      removed subschema #2 from the response property oneOf list for the response status