qbo_bill_payments_update
Update an existing bill payment in QuickBooks Online by modifying only the specified fields. Requires the bill payment ID and current SyncToken to ensure accurate record changes.
Instructions
Sparse-update an existing BillPayment record. Only provided fields are changed; Id and SyncToken are required.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"billPaymentId": "<billPaymentId>",
"SyncToken": "<SyncToken>",
"VendorRef": "<VendorRef>",
"TotalAmt": "<TotalAmt>",
"PayType": "<PayType>",
"Line": "<Line>"
},
"name": "qbo_bill_payments_update"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| Line | Yes | Array of LinkedTxn entries: [{Amount, LinkedTxn: [{TxnId: "billId", TxnType: "Bill"}]}]. | |
| PayType | Yes | Payment method: "Check" or "CreditCard" (required) | |
| TxnDate | No | Payment date (YYYY-MM-DD); defaults to today if omitted | |
| TotalAmt | Yes | Total payment amount across all linked bills (required) | |
| DocNumber | No | Reference number (e.g. check number) | |
| SyncToken | Yes | Current SyncToken of the record (required by QBO for sparse updates; fetch the record first to obtain it) | |
| VendorRef | Yes | Vendor reference, e.g. {"value": "56"} (required) | |
| PrivateNote | No | Private note | |
| CheckPayment | No | Required when PayType is "Check". Shape: {BankAccountRef: {value}, PrintStatus: "NeedToPrint"|"PrintComplete"} | |
| billPaymentId | Yes | The BillPayment ID to update | |
| CreditCardPayment | No | Required when PayType is "CreditCard". Shape: {CCAccountRef: {value}} |