List all bill check payments

JavaScript

import Conductor from 'conductor-node';

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

// Automatically fetches more pages as needed.
for await (const billCheckPayment of conductor.qbd.billCheckPayments.list({
  conductorEndUserId: 'end_usr_1234567abcdefg',
})) {
  console.log(billCheckPayment.id);
}

import os
from conductor import Conductor

conductor = Conductor(
    api_key=os.environ.get("CONDUCTOR_SECRET_KEY"),  # This is the default and can be omitted
)
page = conductor.qbd.bill_check_payments.list(
    conductor_end_user_id="end_usr_1234567abcdefg",
)
page = page.data[0]
print(page.id)

curl --request GET \
  --url https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Conductor-End-User-Id: <conductor-end-user-id>'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Conductor-End-User-Id: <conductor-end-user-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Conductor-End-User-Id", "<conductor-end-user-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments")
  .header("Conductor-End-User-Id", "<conductor-end-user-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Conductor-End-User-Id"] = '<conductor-end-user-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/bill-check-payments",
  "data": [
    {
      "id": "123ABC-1234567890",
      "objectType": "qbd_bill_check_payment",
      "createdAt": "2025-01-01T12:34:56.000Z",
      "updatedAt": "2025-02-01T12:34:56.000Z",
      "revisionNumber": "1721172183",
      "vendor": {
        "id": "80000001-1234567890",
        "fullName": "Suppliers:ABC Office Supplies"
      },
      "payablesAccount": {
        "id": "80000001-1234567890",
        "fullName": "Accounts-Payable"
      },
      "transactionDate": "2024-10-01",
      "bankAccount": {
        "id": "80000001-1234567890",
        "fullName": "Checking"
      },
      "amount": "1000.00",
      "currency": {
        "id": "80000001-1234567890",
        "fullName": "USD"
      },
      "exchangeRate": 1.2345,
      "amountInHomeCurrency": "1234.56",
      "refNumber": "CHECK-1234",
      "memo": "Payment for office supplies - Invoice INV-1234",
      "address": {
        "line1": "Conductor Labs Inc.",
        "line2": "540 Market St.",
        "line3": "Suite 100",
        "line4": "",
        "line5": "",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94110",
        "country": "United States",
        "note": "Conductor HQ"
      },
      "isQueuedForPrint": true,
      "externalId": "12345678-abcd-1234-abcd-1234567890ab",
      "appliedToTransactions": [
        {
          "transactionId": "123ABC-1234567890",
          "transactionType": "invoice",
          "transactionDate": "2024-10-01T00:00:00.000Z",
          "refNumber": "TXN-1234",
          "balanceRemaining": "100.00",
          "amount": "1000.00",
          "discountAmount": "50.00",
          "discountAccount": {
            "id": "80000001-1234567890",
            "fullName": "Discount Account"
          },
          "discountClass": {
            "id": "80000001-1234567890",
            "fullName": "Discounts"
          },
          "linkedTransactions": [
            {
              "id": "123ABC-1234567890",
              "objectType": "qbd_linked_transaction",
              "transactionType": "invoice",
              "transactionDate": "2024-10-01",
              "refNumber": "LINK-1234",
              "linkType": "amount",
              "amount": "1000.00"
            }
          ]
        }
      ],
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10,
  "hasMore": true
}

GET

quickbooks-desktop

bill-check-payments

JavaScript

import Conductor from 'conductor-node';

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

// Automatically fetches more pages as needed.
for await (const billCheckPayment of conductor.qbd.billCheckPayments.list({
  conductorEndUserId: 'end_usr_1234567abcdefg',
})) {
  console.log(billCheckPayment.id);
}

import os
from conductor import Conductor

conductor = Conductor(
    api_key=os.environ.get("CONDUCTOR_SECRET_KEY"),  # This is the default and can be omitted
)
page = conductor.qbd.bill_check_payments.list(
    conductor_end_user_id="end_usr_1234567abcdefg",
)
page = page.data[0]
print(page.id)

curl --request GET \
  --url https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Conductor-End-User-Id: <conductor-end-user-id>'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Conductor-End-User-Id: <conductor-end-user-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Conductor-End-User-Id", "<conductor-end-user-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments")
  .header("Conductor-End-User-Id", "<conductor-end-user-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Conductor-End-User-Id"] = '<conductor-end-user-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/bill-check-payments",
  "data": [
    {
      "id": "123ABC-1234567890",
      "objectType": "qbd_bill_check_payment",
      "createdAt": "2025-01-01T12:34:56.000Z",
      "updatedAt": "2025-02-01T12:34:56.000Z",
      "revisionNumber": "1721172183",
      "vendor": {
        "id": "80000001-1234567890",
        "fullName": "Suppliers:ABC Office Supplies"
      },
      "payablesAccount": {
        "id": "80000001-1234567890",
        "fullName": "Accounts-Payable"
      },
      "transactionDate": "2024-10-01",
      "bankAccount": {
        "id": "80000001-1234567890",
        "fullName": "Checking"
      },
      "amount": "1000.00",
      "currency": {
        "id": "80000001-1234567890",
        "fullName": "USD"
      },
      "exchangeRate": 1.2345,
      "amountInHomeCurrency": "1234.56",
      "refNumber": "CHECK-1234",
      "memo": "Payment for office supplies - Invoice INV-1234",
      "address": {
        "line1": "Conductor Labs Inc.",
        "line2": "540 Market St.",
        "line3": "Suite 100",
        "line4": "",
        "line5": "",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94110",
        "country": "United States",
        "note": "Conductor HQ"
      },
      "isQueuedForPrint": true,
      "externalId": "12345678-abcd-1234-abcd-1234567890ab",
      "appliedToTransactions": [
        {
          "transactionId": "123ABC-1234567890",
          "transactionType": "invoice",
          "transactionDate": "2024-10-01T00:00:00.000Z",
          "refNumber": "TXN-1234",
          "balanceRemaining": "100.00",
          "amount": "1000.00",
          "discountAmount": "50.00",
          "discountAccount": {
            "id": "80000001-1234567890",
            "fullName": "Discount Account"
          },
          "discountClass": {
            "id": "80000001-1234567890",
            "fullName": "Discounts"
          },
          "linkedTransactions": [
            {
              "id": "123ABC-1234567890",
              "objectType": "qbd_linked_transaction",
              "transactionType": "invoice",
              "transactionDate": "2024-10-01",
              "refNumber": "LINK-1234",
              "linkType": "amount",
              "amount": "1000.00"
            }
          ]
        }
      ],
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10,
  "hasMore": 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"

Query Parameters

ids

string[]

Filter for specific bill check payments 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.

Example:

["123ABC-1234567890"]

refNumbers

string[]

Filter for specific bill check payments 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.

Example:

["BILL CHECK PAYMENT-1234"]

limit

integer

default:150

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.

Required range: 1 <= x <= 150

Example:

150

cursor

string

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"

updatedAfter

string

Filter for bill check payments 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.000Z"

updatedBefore

string

Filter for bill check payments 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.000Z"

transactionDateFrom

string<date>

Filter for bill check payments 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"

transactionDateTo

string<date>

Filter for bill check payments 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"

vendorIds

string[]

Filter for bill check payments sent to these vendors. These are the vendors who sent the bills paid by these checks.

Example:

["80000001-1234567890"]

accountIds

string[]

Filter for bill check payments associated with these accounts.

Example:

["80000001-1234567890"]

refNumberContains

string

Filter for bill check payments whose refNumber contains this substring. (For checks, this field is the check number.)

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

Example:

"CHECK-1234"

refNumberStartsWith

string

Filter for bill check payments whose refNumber starts with this substring. (For checks, this field is the check number.)

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

Example:

"CHECK"

refNumberEndsWith

string

Filter for bill check payments whose refNumber ends with this substring. (For checks, this field is the check number.)

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

Example:

"1234"

refNumberFrom

string

Filter for bill check payments whose refNumber is greater than or equal to this value. (For checks, this field is the check number.) 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:

"CHECK-0001"

refNumberTo

string

Filter for bill check payments whose refNumber is less than or equal to this value. (For checks, this field is the check number.) 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:

"CHECK-9999"

currencyIds

string[]

Filter for bill check payments in these currencies.

Example:

["80000001-1234567890"]

includeLineItems

boolean

default:true

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

Example:

true

Response

200 - application/json

Returns a list of bill check payments.

objectType

string

required

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

Allowed value: "list"

Example:

"list"

url

string

required

The endpoint URL where this list can be accessed.

Example:

"/v1/quickbooks-desktop/bill-check-payments"

data

The Bill Check Payment object · object[]

required

The array of bill check payments.

Show child attributes

nextCursor

string | null

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.

Example:

"12345678-abcd-abcd-example-1234567890ab"

remainingCount

number | null

required

The number of objects remaining to be fetched.

Example:

10

hasMore

boolean

required

Indicates whether there are more objects to be fetched.

QuickBooks Desktop API

Core Resources

Utilities

Transactions

General

Items

More

List all bill check payments

Authorizations

Headers

Query Parameters

Response