Update a bill check payment

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 billCheckPayment = await conductor.qbd.billCheckPayments.update('123ABC-1234567890', {
  revisionNumber: '1721172183',
  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
)
bill_check_payment = conductor.qbd.bill_check_payments.update(
    id="123ABC-1234567890",
    revision_number="1721172183",
    conductor_end_user_id="end_usr_1234567abcdefg",
)
print(bill_check_payment.id)

curl --request POST \
  --url https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Conductor-End-User-Id: <conductor-end-user-id>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "revisionNumber": "1721172183",
  "transactionDate": "2024-10-01",
  "bankAccountId": "80000001-1234567890",
  "amount": "1000.00",
  "exchangeRate": 1.2345,
  "isQueuedForPrint": true,
  "refNumber": "CHECK-1234",
  "memo": "Payment for office supplies - Invoice INV-1234",
  "applyToTransactions": [
    {
      "transactionId": "123ABC-1234567890",
      "paymentAmount": "25.00",
      "applyCredits": [
        {
          "creditTransactionId": "ABCDEF-1234567890",
          "appliedAmount": "100.00",
          "overrideCreditApplication": false
        }
      ],
      "discountAmount": "50.00",
      "discountAccountId": "80000001-1234567890",
      "discountClassId": "80000001-1234567890"
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'revisionNumber' => '1721172183',
    'transactionDate' => '2024-10-01',
    'bankAccountId' => '80000001-1234567890',
    'amount' => '1000.00',
    'exchangeRate' => 1.2345,
    'isQueuedForPrint' => true,
    'refNumber' => 'CHECK-1234',
    'memo' => 'Payment for office supplies - Invoice INV-1234',
    'applyToTransactions' => [
        [
                'transactionId' => '123ABC-1234567890',
                'paymentAmount' => '25.00',
                'applyCredits' => [
                                [
                                                                'creditTransactionId' => 'ABCDEF-1234567890',
                                                                'appliedAmount' => '100.00',
                                                                'overrideCreditApplication' => false
                                ]
                ],
                'discountAmount' => '50.00',
                'discountAccountId' => '80000001-1234567890',
                'discountClassId' => '80000001-1234567890'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Conductor-End-User-Id: <conductor-end-user-id>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"revisionNumber\": \"1721172183\",\n  \"transactionDate\": \"2024-10-01\",\n  \"bankAccountId\": \"80000001-1234567890\",\n  \"amount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"isQueuedForPrint\": true,\n  \"refNumber\": \"CHECK-1234\",\n  \"memo\": \"Payment for office supplies - Invoice INV-1234\",\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments/{id}")
  .header("Conductor-End-User-Id", "<conductor-end-user-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"revisionNumber\": \"1721172183\",\n  \"transactionDate\": \"2024-10-01\",\n  \"bankAccountId\": \"80000001-1234567890\",\n  \"amount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"isQueuedForPrint\": true,\n  \"refNumber\": \"CHECK-1234\",\n  \"memo\": \"Payment for office supplies - Invoice INV-1234\",\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Conductor-End-User-Id"] = '<conductor-end-user-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"revisionNumber\": \"1721172183\",\n  \"transactionDate\": \"2024-10-01\",\n  \"bankAccountId\": \"80000001-1234567890\",\n  \"amount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"isQueuedForPrint\": true,\n  \"refNumber\": \"CHECK-1234\",\n  \"memo\": \"Payment for office supplies - Invoice INV-1234\",\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}"

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

{
  "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"
    }
  ]
}

POST

quickbooks-desktop

bill-check-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 billCheckPayment = await conductor.qbd.billCheckPayments.update('123ABC-1234567890', {
  revisionNumber: '1721172183',
  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
)
bill_check_payment = conductor.qbd.bill_check_payments.update(
    id="123ABC-1234567890",
    revision_number="1721172183",
    conductor_end_user_id="end_usr_1234567abcdefg",
)
print(bill_check_payment.id)

curl --request POST \
  --url https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Conductor-End-User-Id: <conductor-end-user-id>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "revisionNumber": "1721172183",
  "transactionDate": "2024-10-01",
  "bankAccountId": "80000001-1234567890",
  "amount": "1000.00",
  "exchangeRate": 1.2345,
  "isQueuedForPrint": true,
  "refNumber": "CHECK-1234",
  "memo": "Payment for office supplies - Invoice INV-1234",
  "applyToTransactions": [
    {
      "transactionId": "123ABC-1234567890",
      "paymentAmount": "25.00",
      "applyCredits": [
        {
          "creditTransactionId": "ABCDEF-1234567890",
          "appliedAmount": "100.00",
          "overrideCreditApplication": false
        }
      ],
      "discountAmount": "50.00",
      "discountAccountId": "80000001-1234567890",
      "discountClassId": "80000001-1234567890"
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'revisionNumber' => '1721172183',
    'transactionDate' => '2024-10-01',
    'bankAccountId' => '80000001-1234567890',
    'amount' => '1000.00',
    'exchangeRate' => 1.2345,
    'isQueuedForPrint' => true,
    'refNumber' => 'CHECK-1234',
    'memo' => 'Payment for office supplies - Invoice INV-1234',
    'applyToTransactions' => [
        [
                'transactionId' => '123ABC-1234567890',
                'paymentAmount' => '25.00',
                'applyCredits' => [
                                [
                                                                'creditTransactionId' => 'ABCDEF-1234567890',
                                                                'appliedAmount' => '100.00',
                                                                'overrideCreditApplication' => false
                                ]
                ],
                'discountAmount' => '50.00',
                'discountAccountId' => '80000001-1234567890',
                'discountClassId' => '80000001-1234567890'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Conductor-End-User-Id: <conductor-end-user-id>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"revisionNumber\": \"1721172183\",\n  \"transactionDate\": \"2024-10-01\",\n  \"bankAccountId\": \"80000001-1234567890\",\n  \"amount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"isQueuedForPrint\": true,\n  \"refNumber\": \"CHECK-1234\",\n  \"memo\": \"Payment for office supplies - Invoice INV-1234\",\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.conductor.is/v1/quickbooks-desktop/bill-check-payments/{id}")
  .header("Conductor-End-User-Id", "<conductor-end-user-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"revisionNumber\": \"1721172183\",\n  \"transactionDate\": \"2024-10-01\",\n  \"bankAccountId\": \"80000001-1234567890\",\n  \"amount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"isQueuedForPrint\": true,\n  \"refNumber\": \"CHECK-1234\",\n  \"memo\": \"Payment for office supplies - Invoice INV-1234\",\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Conductor-End-User-Id"] = '<conductor-end-user-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"revisionNumber\": \"1721172183\",\n  \"transactionDate\": \"2024-10-01\",\n  \"bankAccountId\": \"80000001-1234567890\",\n  \"amount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"isQueuedForPrint\": true,\n  \"refNumber\": \"CHECK-1234\",\n  \"memo\": \"Payment for office supplies - Invoice INV-1234\",\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}"

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

{
  "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"
    }
  ]
}

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

string

required

The QuickBooks-assigned unique identifier of the bill check payment to update.

Maximum string length: 36

Example:

"123ABC-1234567890"

Body

application/json

revisionNumber

string

required

The current QuickBooks-assigned revision number of the bill check payment object you are updating, which you can get by fetching the object first. Provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

Example:

"1721172183"

transactionDate

string<date>

The date of this bill check payment, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-01"

bankAccountId

string

The bank account from which the funds are being drawn for this bill check payment; e.g., Checking or Savings. This bill check payment will decrease the balance of this account.

Maximum string length: 36

Example:

"80000001-1234567890"

amount

string

The monetary amount of this bill check payment, represented as a decimal string.

Decimal string format: exactly 2 decimal places when cents are included and up to 13 digits before the decimal point (for example, "123.45").

Example:

"1000.00"

exchangeRate

number

The market exchange rate between this bill check payment'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

isQueuedForPrint

boolean

Indicates whether this bill check payment is included in the queue of documents for QuickBooks to print.

Example:

true

refNumber

string

The case-sensitive user-defined reference number for this bill check payment, 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.

IMPORTANT: For checks, this field is the check number.

Maximum length: 11 characters.

Maximum string length: 11

Example:

"CHECK-1234"

memo

string

A memo or note for this bill check payment.

Maximum length: 4095 characters.

Maximum string length: 4095

Example:

"Payment for office supplies - Invoice INV-1234"

applyToTransactions

object[]

The bills to be paid by this bill check payment. This will create a link between this bill check payment and the specified bills.

IMPORTANT: In each applyToTransactions object, you must specify either paymentAmount, applyCredits, discountAmount, or any combination of these; if none of these are specified, you will receive an error for an empty transaction.

IMPORTANT: The target bill must have isPaid=false, otherwise, QuickBooks will report this object as "cannot be found".

Minimum array length: 1

Show child attributes

Response

200 - application/json

Returns the updated bill check payment.

string

required

The unique identifier assigned by QuickBooks to this bill check payment. This ID is unique across all transaction types.

Example:

"123ABC-1234567890"

objectType

string

required

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

Allowed value: "qbd_bill_check_payment"

Example:

"qbd_bill_check_payment"

createdAt

string

required

The date and time when this bill check payment 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.000Z"

updatedAt

string

required

The date and time when this bill check payment 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.000Z"

revisionNumber

string

required

The current QuickBooks-assigned revision number of this bill check payment 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 | null

required

The vendor who sent the bill(s) that this bill check payment is paying and who will receive this payment.

IMPORTANT: This vendor must match the vendor on the bill(s) specified in applyToTransactions.

Show child attributes

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Suppliers:ABC Office Supplies"
}

payablesAccount

object | null

required

The Accounts-Payable (A/P) account to which this bill check payment is assigned, used for accounts-payable tracking.

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

Show child attributes

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Accounts-Payable"
}

transactionDate

string<date>

required

The date of this bill check payment, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-01"

bankAccount

object

required

The bank account from which the funds are being drawn for this bill check payment; e.g., Checking or Savings. This bill check payment will decrease the balance of this account.

Show child attributes

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Checking"
}

amount

string

required

The monetary amount of this bill check payment, represented as a decimal string.

Example:

"1000.00"

currency

object | null

required

The bill check payment's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.

Show child attributes

Example:

{
  "id": "80000001-1234567890",
  "fullName": "USD"
}

exchangeRate

number | null

required

Example:

1.2345

amountInHomeCurrency

string | null

required

The monetary amount of this bill check payment converted to the home currency of the QuickBooks company file. Represented as a decimal string.

Example:

"1234.56"

refNumber

string | null

required

IMPORTANT: For checks, this field is the check number.

Example:

"CHECK-1234"

memo

string | null

required

A memo or note for this bill check payment.

Example:

"Payment for office supplies - Invoice INV-1234"

address

The Address object · object | null

required

The address that is printed on the bill check payment.

Show child attributes

isQueuedForPrint

boolean | null

required

Indicates whether this bill check payment is included in the queue of documents for QuickBooks to print.

Example:

true

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"

appliedToTransactions

The Target Transaction object · object[]

required

The bill(s) paid by this bill check payment.

Show child attributes

customFields

The Custom Field object · object[]

required

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

Show child attributes

QuickBooks Desktop API

Core Resources

Utilities

Transactions

General

Items

More

Update a bill check payment

Authorizations

Headers

Path Parameters

Body

Response