Skip to main content
POST
JavaScript

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 End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the credit card credit to update.

Maximum string length: 36
Example:

"123ABC-1234567890"

Body

application/json
​
revisionNumber
string
required

The current QuickBooks-assigned revision number of the credit card credit 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.

Example:

"1721172183"

​
accountId
string

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

Maximum string length: 36
Example:

"80000001-1234567890"

​
payeeId
string

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

Maximum string length: 36
Example:

"80000001-1234567890"

​
transactionDate
string<date>

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

Example:

"2024-10-01"

​
refNumber
string

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.

Maximum length: 11 characters.

Maximum string length: 11
Example:

"CREDIT-1234"

​
memo
string

A memo or note for this credit card credit.

Maximum length: 4095 characters.

Maximum string length: 4095
Example:

"Refund for returned office supplies"

​
salesTaxCodeId
string

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

Maximum string length: 36
Example:

"80000001-1234567890"

​
exchangeRate
number

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

​
clearExpenseLines
boolean

When true, removes all existing expense lines associated with this credit card credit. To modify or add individual expense lines, use the field expenseLines instead.

Example:

false

​
expenseLines
object[]

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

IMPORTANT:

  1. Including this array in your update request will REPLACE all existing expense lines for the credit card credit with this array. To keep any existing expense lines, you must include them in this array even if they have not changed. Any expense lines not included will be removed.

  2. To add a new expense line, include it here with the id field set to -1.

  3. If you do not wish to modify any expense lines, omit this field entirely to keep them unchanged.

Minimum array length: 1
​
clearItemLines
boolean

When true, removes all existing item lines associated with this credit card credit. To modify or add individual item lines, use the field itemLines instead.

Example:

false

​
itemLines
object[]

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

IMPORTANT:

  1. Including this array in your update request will REPLACE all existing item lines for the credit card credit with this array. To keep any existing item lines, you must include them in this array even if they have not changed. Any item lines not included will be removed.

  2. To add a new item line, include it here with the id field set to -1.

  3. If you do not wish to modify any item lines, omit this field entirely to keep them unchanged.

Minimum array length: 1
​
itemGroupLines
object[]

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.

IMPORTANT:

  1. Including this array in your update request will REPLACE all existing item group lines for the credit card credit with this array. To keep any existing item group lines, you must include them in this array even if they have not changed. Any item group lines not included will be removed.

  2. To add a new item group line, include it here with the id field set to -1.

  3. If you do not wish to modify any item group lines, omit this field entirely to keep them unchanged.

Minimum array length: 1

Response

200 - application/json

Returns the updated credit card credit.

​
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.000Z"

​
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.000Z"

​
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:
​
payee
object | null
required

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

Example:
​
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 ISO 4217 international values. For user-defined currencies, all values are editable.

Example:
​
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 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.

Example:
​
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.