Skip to main content
DELETE
/
quickbooks-desktop
/
receive-payments
/
{id}
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

const receivePayment = await conductor.qbd.receivePayments.delete('123ABC-1234567890', {
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(receivePayment.id);
{
  "id": "123ABC-1234567890",
  "objectType": "qbd_receive_payment",
  "refNumber": "PAYMENT-1234",
  "deleted": true
}

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 receive-payment to delete.

Example:

"123ABC-1234567890"

Response

200 - application/json

Returns a confirmation of the deletion with the ID of the deleted receive-payment.

​
id
string
required

The QuickBooks-assigned unique identifier of the deleted receive-payment.

Example:

"123ABC-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_receive_payment"
Example:

"qbd_receive_payment"

​
refNumber
string | null
required

The case-sensitive user-defined reference number of the deleted receive-payment.

Example:

"PAYMENT-1234"

​
deleted
boolean
required

Indicates whether the receive-payment was deleted.

Example:

true