POST
/
quickbooks-desktop
/
credit-card-charges

Authorizations

Authorization
string
headerrequired

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

Body

application/json
accountId
string
required

The bank or credit card account to whom money is owed for this credit card charge.

payeeId
string

The vendor or company from whom merchandise or services were purchased for this credit card charge.

transactionDate
string
required

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

refNumber
string

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

memo
string

A memo or note for this credit card charge, as entered by the user.

salesTaxCodeId
string

The sales-tax code associated with this credit card charge, determining whether it is taxable or non-taxable. It's used to assign a default tax status to all transactions for this credit card charge. 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.

exchangeRate
number

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

externalId
string

A globally unique identifier (GUID) you can provide for tracking this object in your external system.

IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.

expenseLines
object[]

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

itemLines
object[]

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

itemGroupLines
object[]

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

Response

200 - application/json
id
string
required

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

objectType
string
required

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

Allowed value: "qbd_credit_card_charge"
createdAt
string
required

The date and time when this credit card charge was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

updatedAt
string
required

The date and time when this credit card charge was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

revisionNumber
string
required

The current revision number of this credit card charge, 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.

account
object
required

The bank or credit card account to whom money is owed for this credit card charge.

payee
object | null
required

The vendor or company from whom merchandise or services were purchased for this credit card charge.

transactionDate
string
required

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

amount
string
required

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

currency
object | null
required

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

exchangeRate
number | null
required

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

amountInHomeCurrency
string | null
required

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

refNumber
string | null
required

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

memo
string | null
required

A memo or note for this credit card charge, as entered by the user.

salesTaxCode
object | null
required

The sales-tax code associated with this credit card charge, determining whether it is taxable or non-taxable. It's used to assign a default tax status to all transactions for this credit card charge. 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.

externalId
string | null
required

A globally unique identifier (GUID) you can provide for tracking this object in your external system.

IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.

expenseLines
object[]
required

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

itemLines
object[]
required

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

itemGroupLines
object[]
required

The credit card charge'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
object[]
required

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