COconductor-is

List all vendor credits

Changed on

Returns a list of vendor credits. Use the cursor parameter to paginate through the results.

get/quickbooks-desktop/vendor-credits

Request

Query parameters

idsstring[]

Filter for specific vendor credits by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

[
  "123ABC-1234567890"
]
refNumbersstring[]

Filter for specific vendor credits by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

[
  "VENDOR CREDIT-1234"
]
limitinteger

The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the cursor parameter. Each response will include a nextCursor value that can be passed to subsequent requests to retrieve the next page of results.

Example:150
cursorstring

The pagination token to fetch the next set of results when paginating with the limit parameter. Do not include this parameter on the first call. Use the nextCursor value returned in the previous response to request subsequent results.

IMPORTANT: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 10 seconds of the previous response. If you miss that window or a request fails, start over without a cursor.

Example:12345678-abcd-abcd-example-1234567890ab
updatedAfterstring

Filter for vendor credits updated on or after this date/time. Accepts the following ISO 8601 formats:

  • date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).
  • datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
  • datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.
Example:2025-01-01T12:34:56+00:00
updatedBeforestring

Filter for vendor credits updated on or before this date/time. Accepts the following ISO 8601 formats:

  • date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).
  • datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
  • datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.
Example:2025-02-01T12:34:56+00:00
transactionDateFromstring date

Filter for vendor credits whose date field is on or after this date, in ISO 8601 format (YYYY-MM-DD).

NOTE: QuickBooks Desktop interprets this date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).

Example:2025-01-01
transactionDateTostring date

Filter for vendor credits whose date field is on or before this date, in ISO 8601 format (YYYY-MM-DD).

NOTE: QuickBooks Desktop interprets this date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).

Example:2025-02-01
vendorIdsstring[]

Filter for vendor credits received from these vendors. These are the vendors who owe the QuickBooks user money.

[
  "80000001-1234567890"
]
accountIdsstring[]

Filter for vendor credits associated with these accounts.

[
  "80000001-1234567890"
]
refNumberContainsstring

Filter for vendor credits whose refNumber contains this substring.

NOTE: If you use this parameter, you cannot also use refNumberStartsWith or refNumberEndsWith.

Example:VCREDIT-1234
refNumberStartsWithstring

Filter for vendor credits whose refNumber starts with this substring.

NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberEndsWith.

Example:VCREDIT
refNumberEndsWithstring

Filter for vendor credits whose refNumber ends with this substring.

NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberStartsWith.

Example:1234
refNumberFromstring

Filter for vendor credits whose refNumber is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.

NOTE: If you use this parameter, you cannot also use refNumberContains, refNumberStartsWith, or refNumberEndsWith.

Example:VCREDIT-0001
refNumberTostring

Filter for vendor credits whose refNumber is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.

NOTE: If you use this parameter, you cannot also use refNumberContains, refNumberStartsWith, or refNumberEndsWith.

Example:VCREDIT-9999
currencyIdsstring[]

Filter for vendor credits in these currencies.

[
  "80000001-1234567890"
]
includeLineItemsboolean

Whether to include line items in the response. Defaults to true.

Example:true
includeLinkedTransactionsboolean

Whether to include linked transactions in the response. Defaults to false. For example, a payment linked to the corresponding vendor credit.

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Response

Returns a list of vendor credits.

objectType'list' required

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

urlstring required

The endpoint URL where this list can be accessed.

nextCursorstring nullable required

The nextCursor is a pagination token returned in the response when you use the limit parameter in your request. To retrieve subsequent pages of results, include this token as the value of the cursor request parameter in your following API calls.

NOTE: The nextCursor value remains constant throughout the pagination process for a specific list instance; continue to use the same nextCursor token in each request to fetch additional pages.

remainingCountnumber nullable required

The number of objects remaining to be fetched.

hasMoreboolean required

Indicates whether there are more objects to be fetched.

Example response

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/vendor-credits",
  "data": [
    {
      "id": "123ABC-1234567890",
      "objectType": "qbd_vendor_credit",
      "createdAt": "2025-01-01T12:34:56+00:00",
      "updatedAt": "2025-02-01T12:34:56+00:00",
      "revisionNumber": "1721172183",
      "vendor": {
        "id": "80000001-1234567890",
        "fullName": "Acme Supplies Ltd."
      },
      "payablesAccount": {
        "id": "80000001-1234567890",
        "fullName": "Accounts-Payable"
      },
      "transactionDate": "2024-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": "2024-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"
        }
      ]
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10
}

Changes

  • 8ee3502091a4Revision changes
    • warning

      added the new transfer_inventory enum value to the //// response property for the response status

  • 3767bfad12f0Revision changes
    • breaking

      response property data/items/expenseLines/items/id list-of-types was widened by adding types null to media type application/json of response 200