GET
/
quickbooks-desktop
/
bill-credit-card-payments
/
{id}
Retrieve a bill credit card payment
curl --request GET \
  --url https://api.conductor.is/v1/quickbooks-desktop/bill-credit-card-payments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Conductor-End-User-Id: <conductor-end-user-id>'
{
  "id": "123ABC-1234567890",
  "objectType": "qbd_bill_credit_card_payment",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "vendor": {
    "id": "80000001-1234567890",
    "fullName": "Suppliers:ABC Office Supplies"
  },
  "payablesAccount": {
    "id": "80000001-1234567890",
    "fullName": "Accounts-Payable"
  },
  "transactionDate": "2021-10-01",
  "creditCardAccount": {
    "id": "80000001-1234567890",
    "fullName": "Credit Card"
  },
  "amount": "1000.00",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "amountInHomeCurrency": "1234.56",
  "refNumber": "CARD-1234",
  "memo": "Payment for office supplies - Invoice INV-1234",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "appliedToTransactions": [
    {
      "transactionId": "123ABC-1234567890",
      "transactionType": "invoice",
      "transactionDate": "2021-10-01",
      "refNumber": "PAYMENT-1234",
      "balanceRemaining": "100.00",
      "amount": "1000.00",
      "discountAmount": "50.00",
      "discountAccount": {
        "id": "80000001-1234567890",
        "fullName": "Discount Account"
      },
      "discountClass": {
        "id": "80000001-1234567890",
        "fullName": "Discounts"
      },
      "linkedTransactions": [
        {
          "id": "123ABC-1234567890",
          "objectType": "qbd_linked_transaction",
          "transactionType": "invoice",
          "transactionDate": "2021-10-01",
          "refNumber": "LINK-1234",
          "linkType": "amount",
          "amount": "1000.00"
        }
      ]
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

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 bill credit card payment to retrieve.

Example:

"123ABC-1234567890"

Response

200 - application/json

Returns the specified bill credit card payment.

​
id
string
required

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

Example:

"123ABC-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_bill_credit_card_payment"
Example:

"qbd_bill_credit_card_payment"

​
createdAt
string
required

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

Example:

"2021-10-01T17:34:56.000Z"

​
updatedAt
string
required

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

Example:

"2021-10-01T20:45:30.000Z"

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this bill credit card payment 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"

​
vendor
object | null
required

The vendor who sent the bill(s) that this bill credit card payment is paying and who will receive this payment.

IMPORTANT: This vendor must match the vendor on the bill(s) specified in applyToTransactions.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Suppliers:ABC Office Supplies"
}
​
payablesAccount
object | null
required

The Accounts-Payable (A/P) account to which this bill credit card payment is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/P account.

IMPORTANT: If this bill credit card payment is linked to other transactions, this A/P account must match the payablesAccount used in those other transactions.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Accounts-Payable"
}
​
transactionDate
string
required

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

Example:

"2021-10-01"

​
creditCardAccount
object
required

The credit card account to which this bill credit card payment is being charged. This bill credit card payment will decrease the balance of this account.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Credit Card"
}
​
amount
string
required

The monetary amount of this bill credit card payment, represented as a decimal string.

Example:

"1000.00"

​
currency
object | null
required

The bill credit card payment'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 bill credit card payment'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 bill credit card payment 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 bill credit card payment, 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:

"CARD-1234"

​
memo
string | null
required

A memo or note for this bill credit card payment.

Example:

"Payment for office supplies - Invoice INV-1234"

​
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"

​
appliedToTransactions
The Receivable Transaction object · object[]
required

The bill(s) paid by this bill credit card payment.

​
customFields
The Custom Field object · object[]
required

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