Create a bill check payment
Creates a new bill check payment.
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 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".
The date of this bill check payment, in ISO 8601 format (YYYY-MM-DD).
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.
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".
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.
Indicates whether this bill check payment is included in the queue of documents for QuickBooks to print.
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.
A memo or note for this bill check payment.
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).
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.
Response
The unique identifier assigned by QuickBooks to this bill check payment. This ID is unique across all transaction types.
The type of object. This value is always "qbd_bill_check_payment".
"qbd_bill_check_payment"The date and time when this bill check payment 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 check payment 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 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.
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.
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.
The date of this bill check payment, in ISO 8601 format (YYYY-MM-DD).
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.
The monetary amount of this bill check payment, represented as a decimal string.
The bill check payment'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 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).
The total monetary amount for this bill check payment 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 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.
A memo or note for this bill check payment.
The address that is printed on the bill check payment.
Indicates whether this bill check payment 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 check payment.
The custom fields for the bill check payment object, added as user-defined data extensions, not included in the standard QuickBooks object.