Create a bill payment check
Creates a bill payment check.
Authorizations
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").
Headers
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").
Body
The vendor who sent the bill(s) that this check is paying and who will receive this check 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".
The Accounts-Payable (A/P) account to which this bill payment check is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default Accounts-Payable account.
IMPORTANT: If this bill payment check is linked to other transactions, this A/P account must match the payablesAccount used in the other transactions.
The date of this bill payment check, in ISO 8601 format (YYYY-MM-DD).
The bank account from which the funds are being drawn for this bill payment check; e.g., Checking or Savings. This bill payment check will decrease the balance of this account.
Indicates whether this bill payment check is included in the queue of documents for QuickBooks to print.
The case-sensitive user-defined reference number for this bill payment check, 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.
A memo or note for this bill payment check, as entered by the user.
The market exchange rate between this bill payment check'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).
A globally unique identifier (GUID) you can provide for tracking this object in your external system.
IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.
The bills to be paid by this bill payment check. This will create a link between this bill payment check 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".
Response
A bill payment check is a transaction that represents a payment by check for a bill.
The unique identifier assigned by QuickBooks to this bill payment check. This ID is unique across all transaction types.
The type of object. This value is always "qbd_bill_payment_check".
"qbd_bill_payment_check"The date and time when this bill payment check 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.
The date and time when this bill payment check 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.
The current revision number of this bill payment check, 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.
The vendor who sent the bill(s) that this check is paying and who will receive this check payment.
IMPORTANT: This vendor must match the vendor on the bill(s) specified in applyToTransactions.
The Accounts-Payable (A/P) account to which this bill payment check is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default Accounts-Payable account.
IMPORTANT: If this bill payment check is linked to other transactions, this A/P account must match the payablesAccount used in the other transactions.
The date of this bill payment check, in ISO 8601 format (YYYY-MM-DD).
The bank account from which the funds are being drawn for this bill payment check; e.g., Checking or Savings. This bill payment check will decrease the balance of this account.
The monetary amount of this bill payment check, represented as a decimal string.
The bill payment check's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.
The market exchange rate between this bill payment check'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).
The total amount for this bill payment check converted to the home currency of the QuickBooks company file. Represented as a decimal string.
The case-sensitive user-defined reference number for this bill payment check, 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.
A memo or note for this bill payment check, as entered by the user.
The address that is printed on the bill payment check.
Indicates whether this bill payment check is included in the queue of documents for QuickBooks to print.
A globally unique identifier (GUID) you can provide for tracking this object in your external system.
IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.
The bill(s) paid by this bill payment check.
The custom fields for the bill payment check object, added as user-defined data extensions, not included in the standard QuickBooks object.