> ## Documentation Index > Fetch the complete documentation index at: https://docs.conductor.is/llms.txt > Use this file to discover all available pages before exploring further. # Create a bill check payment > Records a check payment against one vendor’s open bills. Each bill allocation must include a payment amount, discount, or vendor credit, and the accounts payable account has to match the one used on the bills you’re closing. ## OpenAPI ````yaml POST /quickbooks-desktop/bill-check-payments openapi: 3.1.0 info: title: Conductor API version: 0.0.1 servers: - url: https://api.conductor.is/v1 security: - BearerAuth: [] paths: /quickbooks-desktop/bill-check-payments: post: summary: Create a bill check payment description: >- Records a check payment against one vendor’s open bills. Each bill allocation must include a payment amount, discount, or vendor credit, and the accounts payable account has to match the one used on the bills you’re closing. parameters: - in: header name: Conductor-End-User-Id description: The ID of the End-User to receive this request. schema: type: string description: The ID of the End-User to receive this request. example: end_usr_1234567abcdefg x-stainless-naming: typescript: method_argument: conductorEndUserId mcp: method_argument: conductorEndUserId required: true requestBody: required: true content: application/json: schema: type: object properties: vendorId: type: string description: >- 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`; otherwise, QuickBooks will say the `transactionId` in `applyToTransactions` "does not exist". example: 80000001-1234567890 payablesAccountId: type: string description: >- The Accounts-Payable (A/P) account to which this bill check payment is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/P account. **IMPORTANT**: If this bill check payment is linked to other transactions, this A/P account must match the `payablesAccount` used in those other transactions. example: 80000001-1234567890 transactionDate: type: string format: date description: >- The date of this bill check payment, in ISO 8601 format (YYYY-MM-DD). example: '2024-10-01' bankAccountId: type: string description: >- 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. example: 80000001-1234567890 isQueuedForPrint: type: boolean description: >- Indicates whether this bill check payment is included in the queue of documents for QuickBooks to print. example: true refNumber: type: string description: >- 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. When left blank in this create request, this field will be left blank in QuickBooks (i.e., it does *not* auto-increment). **IMPORTANT**: For checks, this field is the check number. example: CHECK-1234 memo: type: string description: A memo or note for this bill check payment. example: Payment for office supplies - Invoice INV-1234 exchangeRate: type: number description: >- 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 externalId: type: string format: uuid description: >- 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 applyToTransactions: type: array items: type: object properties: transactionId: type: string description: >- The ID of the receivable transaction to which this payment is applied. example: 123ABC-1234567890 paymentAmount: type: string description: >- The monetary amount to apply to the receivable transaction, represented as a decimal string. example: '25.00' applyCredits: type: array items: type: object properties: creditTransactionId: type: string description: >- The unique identifier of the credit transaction (credit memo or vendor credit) to apply to this transaction. example: ABCDEF-1234567890 appliedAmount: type: string description: >- The amount of credit applied to this transaction. This could include customer deposits, payments, or credits. Represented as a decimal string. example: '100.00' overrideCreditApplication: type: boolean description: Indicates whether to override the credit. example: false default: false required: - creditTransactionId - appliedAmount additionalProperties: false minItems: 1 description: >- Credit memos to apply to this receivable transaction, reducing its balance. This creates a link between this receivable transaction and the specified credit memos. **IMPORTANT**: By default, QuickBooks will not return any information about the linked transactions in this endpoint's response even when this request is successful. To see the transactions linked via this field, refetch the receivable transaction and check the `linkedTransactions` response field. If fetching a list of receivable transactions, you must also specify the parameter `includeLinkedTransactions=true` to see the `linkedTransactions` response field. discountAmount: type: string description: >- The monetary amount by which to reduce the receivable transaction's receivable amount, represented as a decimal string. example: '50.00' discountAccountId: type: string description: >- The financial account used to track this receivable transaction's discount. example: 80000001-1234567890 discountClassId: type: string description: >- The class used to track this receivable transaction's discount. example: 80000001-1234567890 required: - transactionId additionalProperties: false minItems: 1 description: >- 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". required: - vendorId - transactionDate - bankAccountId - applyToTransactions additionalProperties: false responses: '200': description: Returns the newly created bill check payment. headers: Conductor-Request-Id: schema: type: string description: The unique identifier for this API request. example: req_1234567abcdefg required: true content: application/json: schema: $ref: '#/components/schemas/qbd_bill_check_payment' security: - BearerAuth: [] x-codeSamples: - lang: JavaScript source: >- 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.create({ applyToTransactions: [{ transactionId: '123ABC-1234567890' }], bankAccountId: '80000001-1234567890', transactionDate: '2024-10-01', vendorId: '80000001-1234567890', conductorEndUserId: 'end_usr_1234567abcdefg', }); console.log(billCheckPayment.id); - lang: Python source: |- import os from datetime import date 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.create( apply_to_transactions=[{ "transaction_id": "123ABC-1234567890" }], bank_account_id="80000001-1234567890", transaction_date=date.fromisoformat("2024-10-01"), vendor_id="80000001-1234567890", conductor_end_user_id="end_usr_1234567abcdefg", ) print(bill_check_payment.id) components: schemas: qbd_bill_check_payment: type: object properties: id: type: string description: >- The unique identifier assigned by QuickBooks to this bill check payment. This ID is unique across all transaction types. example: 123ABC-1234567890 objectType: type: string const: qbd_bill_check_payment description: The type of object. This value is always `"qbd_bill_check_payment"`. example: qbd_bill_check_payment createdAt: type: string description: >- 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: type: string description: >- 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: type: string description: >- 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: type: - object - 'null' properties: id: type: - string - 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- 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`. example: id: 80000001-1234567890 fullName: Suppliers:ABC Office Supplies payablesAccount: type: - object - 'null' properties: id: type: - string - 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- The Accounts-Payable (A/P) account to which this bill check payment is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/P account. **IMPORTANT**: If this bill check payment 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: type: string format: date description: >- The date of this bill check payment, in ISO 8601 format (YYYY-MM-DD). example: '2024-10-01' bankAccount: type: object properties: id: type: - string - 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- 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. example: id: 80000001-1234567890 fullName: Checking amount: type: string description: >- The monetary amount of this bill check payment, represented as a decimal string. example: '1000.00' currency: type: - object - 'null' properties: id: type: - string - 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- 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. example: id: 80000001-1234567890 fullName: USD exchangeRate: type: - number - 'null' description: >- 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 amountInHomeCurrency: type: - string - 'null' description: >- 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: type: - string - 'null' description: >- 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. example: CHECK-1234 memo: type: - string - 'null' description: A memo or note for this bill check payment. example: Payment for office supplies - Invoice INV-1234 address: oneOf: - $ref: '#/components/schemas/qbd_address' - type: 'null' description: The address that is printed on the bill check payment. isQueuedForPrint: type: - boolean - 'null' description: >- Indicates whether this bill check payment is included in the queue of documents for QuickBooks to print. example: true externalId: type: - string - 'null' description: >- 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: type: array items: $ref: '#/components/schemas/qbd_receivable_transaction' description: The bill(s) paid by this bill check payment. customFields: type: array items: $ref: '#/components/schemas/qbd_custom_field' description: >- The custom fields for the bill check payment object, added as user-defined data extensions, not included in the standard QuickBooks object. required: - id - objectType - createdAt - updatedAt - revisionNumber - vendor - payablesAccount - transactionDate - bankAccount - amount - currency - exchangeRate - amountInHomeCurrency - refNumber - memo - address - isQueuedForPrint - externalId - appliedToTransactions - customFields additionalProperties: false title: The Bill Check Payment object x-conductor-object-type: transaction summary: >- A bill check payment records a payment made by check to pay off one or more vendor bills. It reduces accounts payable and decreases the bank account balance. This transaction links the original bill(s) with the payment, allowing QuickBooks to track which bills have been paid and maintain accurate vendor balances. qbd_address: type: object properties: line1: type: - string - 'null' description: >- The first line of the address (e.g., street, PO Box, or company name). example: Conductor Labs Inc. line2: type: - string - 'null' description: >- The second line of the address, if needed (e.g., apartment, suite, unit, or building). example: 540 Market St. line3: type: - string - 'null' description: The third line of the address, if needed. example: Suite 100 line4: type: - string - 'null' description: The fourth line of the address, if needed. example: '' line5: type: - string - 'null' description: The fifth line of the address, if needed. example: '' city: type: - string - 'null' description: The city, district, suburb, town, or village name of the address. example: San Francisco state: type: - string - 'null' description: The state, county, province, or region name of the address. example: CA postalCode: type: - string - 'null' description: The postal code or ZIP code of the address. example: '94110' country: type: - string - 'null' description: The country name of the address. example: United States note: type: - string - 'null' description: >- A note written at the bottom of the address in the form in which it appears, such as the invoice form. example: Conductor HQ required: - line1 - line2 - line3 - line4 - line5 - city - state - postalCode - country - note additionalProperties: false title: The Address object x-conductor-object-type: nested qbd_receivable_transaction: type: object properties: transactionId: type: string description: >- The ID of the receivable transaction to which this payment is applied. example: 123ABC-1234567890 transactionType: type: string enum: - ar_refund_credit_card - bill - bill_payment_check - bill_payment_credit_card - build_assembly - charge - check - credit_card_charge - credit_card_credit - credit_memo - deposit - estimate - inventory_adjustment - invoice - item_receipt - journal_entry - liability_adjustment - paycheck - payroll_liability_check - purchase_order - receive_payment - sales_order - sales_receipt - sales_tax_payment_check - transfer - vendor_credit - ytd_adjustment description: The type of transaction for this receivable transaction. example: invoice transactionDate: type: - string - 'null' format: date description: >- The date of this receivable transaction, in ISO 8601 format (YYYY-MM-DD). example: '2024-10-01' refNumber: type: - string - 'null' description: >- The case-sensitive user-defined reference number for this receivable transaction, 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: PAYMENT-1234 balanceRemaining: type: - string - 'null' description: >- The outstanding balance of this receivable transaction after applying any credits or payments. Represented as a decimal string. example: '100.00' amount: type: - string - 'null' description: >- The monetary amount of this receivable transaction, represented as a decimal string. example: '1000.00' discountAmount: type: - string - 'null' description: >- The monetary amount by which to reduce the receivable transaction's receivable amount, represented as a decimal string. example: '50.00' discountAccount: type: - object - 'null' properties: id: type: - string - 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- The financial account used to track this receivable transaction's discount. example: id: 80000001-1234567890 fullName: Discount Account discountClass: type: - object - 'null' properties: id: type: - string - 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: The class used to track this receivable transaction's discount. example: id: 80000001-1234567890 fullName: Discounts linkedTransactions: type: array items: $ref: '#/components/schemas/qbd_linked_transaction' description: >- The receivable transaction'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 receivable transactions to receive this field because it is not returned by default. required: - transactionId - transactionType - transactionDate - refNumber - balanceRemaining - amount - discountAmount - discountAccount - discountClass - linkedTransactions additionalProperties: false title: The Receivable Transaction object x-conductor-object-type: nested qbd_custom_field: type: object properties: ownerId: type: string description: >- The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects. example: '0' name: type: string description: >- The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI. example: Customer Rating type: type: string enum: - amount_type - date_time_type - integer_type - percent_type - price_type - quantity_type - string_1024_type - string_255_type description: The data type of this custom field. example: string_1024_type value: type: string description: >- The value of this custom field. The maximum length depends on the field's data type. example: Premium required: - ownerId - name - type - value additionalProperties: false title: The Custom Field object x-conductor-object-type: nested qbd_linked_transaction: type: object properties: id: type: string description: >- The unique identifier assigned by QuickBooks to this linked transaction. This ID is unique across all transaction types. example: 123ABC-1234567890 objectType: type: string const: qbd_linked_transaction description: The type of object. This value is always `"qbd_linked_transaction"`. example: qbd_linked_transaction transactionType: type: string enum: - ar_refund_credit_card - bill - bill_payment_check - bill_payment_credit_card - build_assembly - charge - check - credit_card_charge - credit_card_credit - credit_memo - deposit - estimate - inventory_adjustment - invoice - item_receipt - journal_entry - liability_adjustment - paycheck - payroll_liability_check - purchase_order - receive_payment - sales_order - sales_receipt - sales_tax_payment_check - transfer - vendor_credit - ytd_adjustment - unknown description: The type of transaction for this linked transaction. example: invoice transactionDate: type: string format: date description: >- The date of this linked transaction, in ISO 8601 format (YYYY-MM-DD). example: '2024-10-01' refNumber: type: - string - 'null' description: >- The case-sensitive user-defined reference number for this linked transaction, 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: LINK-1234 linkType: type: - string - 'null' enum: - amount - quantity - null description: >- Indicates the nature of the link between the transactions: `amount` denotes an amount-based link (e.g., an invoice linked to a payment), and `quantity` denotes a quantity-based link (e.g., an invoice created from a sales order based on the quantity of items received). example: amount amount: type: - string - 'null' description: >- The monetary amount of this linked transaction, represented as a decimal string. example: '1000.00' required: - id - objectType - transactionType - transactionDate - refNumber - linkType - amount additionalProperties: false title: The Linked Transaction object x-conductor-object-type: nested securitySchemes: BearerAuth: type: http scheme: bearer description: >- Your Conductor secret key using Bearer auth (e.g., `"Authorization: Bearer {{YOUR_SECRET_KEY}}"`). ```` Built with [Mintlify](https://mintlify.com).