POST
/
quickbooks-desktop
/
vendor-credits
import Conductor from 'conductor-node';

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

async function main() {
  const vendorCredit = await client.qbd.vendorCredits.create({
    transactionDate: '2021-10-01',
    vendorId: '80000001-1234567890',
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(vendorCredit.id);
}

main();
{
  "id": "123ABC-1234567890",
  "objectType": "qbd_vendor_credit",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "vendor": {
    "id": "80000001-1234567890",
    "fullName": "Acme Supplies Ltd."
  },
  "payablesAccount": {
    "id": "80000001-1234567890",
    "fullName": "Accounts-Payable"
  },
  "transactionDate": "2021-10-01",
  "creditAmount": "25.00",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "creditAmountInHomeCurrency": "20.00",
  "refNumber": "VCREDIT-1234",
  "memo": "Credit for returned merchandise - Invoice INV-1234",
  "salesTaxCode": {
    "id": "80000001-1234567890",
    "fullName": "Non"
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "linkedTransactions": [
    {
      "id": "123ABC-1234567890",
      "objectType": "qbd_linked_transaction",
      "transactionType": "invoice",
      "transactionDate": "2021-10-01",
      "refNumber": "LINK-1234",
      "linkType": "amount",
      "amount": "1000.00"
    }
  ],
  "expenseLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_expense_line",
      "account": {
        "id": "80000001-1234567890",
        "fullName": "Expenses:Office Supplies"
      },
      "amount": "1000.00",
      "memo": "New office chair",
      "payee": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Office Supplies"
      },
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "billingStatus": "billable",
      "salesRepresentative": {
        "id": "80000001-1234567890",
        "fullName": "Jane Doe"
      },
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "itemLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_item_line",
      "item": {
        "id": "80000001-1234567890",
        "fullName": "Widget A"
      },
      "inventorySite": {
        "id": "80000001-1234567890",
        "fullName": "Main Warehouse"
      },
      "inventorySiteLocation": {
        "id": "80000001-1234567890",
        "fullName": "Aisle 3, Shelf B"
      },
      "serialNumber": "SN1234567890",
      "lotNumber": "LOT2023-001",
      "expirationDate": "2025-12-31",
      "description": "High-quality widget with custom engraving",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "overrideUnitOfMeasureSet": {
        "id": "80000001-1234567890",
        "fullName": "Volume Units"
      },
      "cost": "1000.00",
      "amount": "1000.00",
      "customer": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Installation:Residential"
      },
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "billingStatus": "billable",
      "salesRepresentative": {
        "id": "80000001-1234567890",
        "fullName": "Jane Doe"
      },
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "itemGroupLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_item_group_line",
      "itemGroup": {
        "id": "80000001-1234567890",
        "fullName": "Office Supplies Bundle"
      },
      "description": "Standard widget bulk package",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "overrideUnitOfMeasureSet": {
        "id": "80000001-1234567890",
        "fullName": "Volume Units"
      },
      "totalAmount": "1000.00",
      "itemLines": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_item_line",
          "item": {
            "id": "80000001-1234567890",
            "fullName": "Widget A"
          },
          "inventorySite": {
            "id": "80000001-1234567890",
            "fullName": "Main Warehouse"
          },
          "inventorySiteLocation": {
            "id": "80000001-1234567890",
            "fullName": "Aisle 3, Shelf B"
          },
          "serialNumber": "SN1234567890",
          "lotNumber": "LOT2023-001",
          "expirationDate": "2025-12-31",
          "description": "High-quality widget with custom engraving",
          "quantity": 5,
          "unitOfMeasure": "Each",
          "overrideUnitOfMeasureSet": {
            "id": "80000001-1234567890",
            "fullName": "Volume Units"
          },
          "cost": "1000.00",
          "amount": "1000.00",
          "customer": {
            "id": "80000001-1234567890",
            "fullName": "Acme Corporation"
          },
          "class": {
            "id": "80000001-1234567890",
            "fullName": "Installation:Residential"
          },
          "salesTaxCode": {
            "id": "80000001-1234567890",
            "fullName": "Non"
          },
          "billingStatus": "billable",
          "salesRepresentative": {
            "id": "80000001-1234567890",
            "fullName": "Jane Doe"
          },
          "customFields": [
            {
              "ownerId": "0",
              "name": "Customer Rating",
              "type": "string_1024_type",
              "value": "Premium"
            }
          ]
        }
      ],
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "openAmount": "500.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"

Body

application/json
​
vendorId
string
required

The vendor who sent this vendor credit for goods or services purchased.

Example:

"80000001-1234567890"

​
transactionDate
string
required

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

Example:

"2021-10-01"

​
payablesAccountId
string

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

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

Example:

"80000001-1234567890"

​
refNumber
string

The case-sensitive user-defined reference number for this vendor credit, 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. When left blank in this create request, this field will be left blank in QuickBooks (i.e., it does not auto-increment).

Example:

"VCREDIT-1234"

​
memo
string

A memo or note for this vendor credit.

Example:

"Credit for returned merchandise - Invoice INV-1234"

​
salesTaxCodeId
string

The sales-tax code for this vendor credit, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the vendor. This can be overridden on the vendor credit's individual lines.

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.

Example:

"80000001-1234567890"

​
exchangeRate
number

The market exchange rate between this vendor credit'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

​
externalId
string

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.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

Example:

"12345678-abcd-1234-abcd-1234567890ab"

​
expenseLines
object[]

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

Minimum length: 1
​
itemLines
object[]

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

Minimum length: 1
​
itemGroupLines
object[]

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

Minimum length: 1

Response

200 - application/json

Returns the newly created vendor credit.

​
id
string
required

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

Example:

"123ABC-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_vendor_credit"
Example:

"qbd_vendor_credit"

​
createdAt
string
required

The date and time when this vendor credit 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 vendor credit 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 vendor credit 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
required

The vendor who sent this vendor credit for goods or services purchased.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Acme Supplies Ltd."
}
​
payablesAccount
object | null
required

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

IMPORTANT: If this vendor credit 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 vendor credit, in ISO 8601 format (YYYY-MM-DD).

Example:

"2021-10-01"

​
creditAmount
string
required

The monetary amount of the vendor credit, represented as a decimal string. When applied to a vendor bill, this amount reduces the outstanding balance owed to the vendor.

Example:

"25.00"

​
currency
object | null
required

The vendor credit'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 vendor credit'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

​
creditAmountInHomeCurrency
string | null
required

The monetary amount of the vendor credit, converted to the home currency of the QuickBooks company file. Represented as a decimal string.

Example:

"20.00"

​
refNumber
string | null
required

The case-sensitive user-defined reference number for this vendor credit, 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:

"VCREDIT-1234"

​
memo
string | null
required

A memo or note for this vendor credit.

Example:

"Credit for returned merchandise - Invoice INV-1234"

​
salesTaxCode
object | null
required

The sales-tax code for this vendor credit, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the vendor. This can be overridden on the vendor credit's individual lines.

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.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Non"
}
​
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"

​
linkedTransactions
object[]
required

The vendor credit's linked transactions, such as payments applied, credits used, or associated purchase orders.

IMPORTANT: You must specify the parameter includeLinkedTransactions when fetching a list of vendor credits to receive this field because it is not returned by default.

​
expenseLines
object[]
required

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

​
itemLines
object[]
required

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

​
itemGroupLines
object[]
required

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

​
openAmount
string
required

The remaining amount still owed on this vendor credit, represented as a decimal string. This equals the vendor credit's amount minus any credits or discounts.

Example:

"500.00"

​
customFields
object[]
required

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