​
id
string
required

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

Example:

"123ABC-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_credit_card_credit"
Example:

"qbd_credit_card_credit"

​
createdAt
string
required

The date and time when this credit card credit 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 credit card credit 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 credit card credit 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"

​
account
object
required

The bank or credit card account to which this credit card credit is posted.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Visa"
}
​
payee
object | null
required

The vendor or company from whom this credit card credit was received for purchased merchandise or services.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Office Depot"
}
​
transactionDate
string<date>
required

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

Example:

"2024-10-01"

​
amount
string
required

The total monetary amount of this credit card credit, represented as a decimal string. This equals the sum of the amounts in the credit card credit's expense lines, item lines, and item group lines.

Example:

"1000.00"

​
currency
object | null
required

The credit card credit's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "USD"
}
​
exchangeRate
number | null
required

The market exchange rate between this credit card credit'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

​
amountInHomeCurrency
string | null
required

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

Example:

"1234.56"

​
refNumber
string | null
required

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

Example:

"CREDIT-1234"

​
memo
string | null
required

A memo or note for this credit card credit.

Example:

"Refund for returned office supplies"

​
salesTaxCode
object | null
required

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

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

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Non"
}
​
externalId
string | null
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:

"12345678-abcd-1234-abcd-1234567890ab"

​
expenseLines
The Expense Line object · object[]
required

The credit card credit's expense lines, each representing one line in this expense.

​
itemLines
The Item Line object · object[]
required

The credit card credit's item lines, each representing the purchase of a specific item or service.

​
itemGroupLines
The Item Group Line object · object[]
required

The credit card credit's item group lines, each representing a predefined set of items bundled together because they are commonly purchased together or grouped for faster entry.

​
customFields
The Custom Field object · object[]
required

The custom fields for the credit card credit object, added as user-defined data extensions, not included in the standard QuickBooks object.