POST
/
quickbooks-desktop
/
payment-methods
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: 'sk_conductor_...',
});

const paymentMethod = await conductor.qbd.paymentMethods.create({
  name: 'Cash',
  paymentMethodType: 'cash',
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(paymentMethod.id);
{
  "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"
}

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"

Body

application/json
​
name
string
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.

Maximum length: 31 characters.

Maximum length: 31
Example:

"Cash"

​
paymentMethodType
enum<string>
required

This payment method's type.

Available options:
american_express,
cash,
check,
debit_card,
discover,
e_check,
gift_card,
master_card,
other,
other_credit_card,
visa
Example:

"cash"

​
isActive
boolean
default:true

Indicates whether this payment method is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

Response

200 - application/json

Returns the newly created payment method.

​
id
string
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.

Example:

"80000001-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_payment_method"
Example:

"qbd_payment_method"

​
createdAt
string
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.

Example:

"2025-01-01T12:34:56+00:00"

​
updatedAt
string
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.

Example:

"2025-02-01T12:34:56+00:00"

​
revisionNumber
string
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.

Example:

"1721172183"

​
name
string
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.

Example:

"Cash"

​
isActive
boolean
required

Indicates whether this payment method is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

​
paymentMethodType
enum<string>
required

This payment method's type.

Available options:
american_express,
cash,
check,
debit_card,
discover,
e_check,
gift_card,
master_card,
other,
other_credit_card,
visa
Example:

"cash"