COconductor-is

Retrieve a payment method

Changed on

Retrieves a payment method by ID.

IMPORTANT: If you need to fetch multiple specific payment methods by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/payment-methods/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the payment method to retrieve.

Example:80000001-1234567890

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Response

Returns the specified payment method.

idstring required

The unique identifier assigned by QuickBooks to this payment method. This ID is unique across all payment methods but not across different QuickBooks object types.

objectType'qbd_payment_method' required

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

createdAtstring required

The date and time when this payment method 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 payment method 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 payment method 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 payment method, unique across all payment methods.

NOTE: Payment methods 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 payment method is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

paymentMethodType'american_express' | 'cash' | 'check' | 'debit_card' | 'discover' | 'e_check' | 'gift_card' | 'master_card' | 'other' | 'other_credit_card' | 'visa' required

This payment method's type.

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_payment_method",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Cash",
  "isActive": true,
  "paymentMethodType": "cash"
}

Changes