Update a bill check payment
Updates a bill check payment so you can reallocate how amounts, discounts, or credits are applied to the vendor’s bills. When you update a payment, QuickBooks clears the prior allocations but keeps any existing vendor credits unchanged, so submit the full list of bill applications in this request.
Path parameters
The QuickBooks-assigned unique identifier of the bill check payment to update.
The QuickBooks-assigned unique identifier of the bill check payment to update.
Headers
The ID of the End-User to receive this request.
The ID of the End-User to receive this request.
Request body
Example request
{
"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"
}
],
"discountAmount": "50.00",
"discountAccountId": "80000001-1234567890",
"discountClassId": "80000001-1234567890"
}
]
}Response
Returns the updated bill check payment.
Example response
{
"id": "123ABC-1234567890",
"objectType": "qbd_bill_check_payment",
"createdAt": "2025-01-01T12:34:56+00:00",
"updatedAt": "2025-02-01T12:34:56+00:00",
"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",
"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-01",
"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"
}
]
}Changes
Changed in 6 of the 46 revisions of this API.901157
- ●
added the new
unknownenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
- ●
for the
pathrequest parameterid, the maxLength was set to36request-parameter-max-length-set
- ●
the
////request property's maxLength was set to36request-property-max-length-set
- ●
the
//request property's maxLength was set to36request-property-max-length-set
- ●
the
//request property's maxLength was set to36request-property-max-length-set
- ●
the
//request property's maxLength was set to36request-property-max-length-set
- ●
the
request property's maxLength was set to36request-property-max-length-set
- ●
- ●
the
request property's maxLength was set to11request-property-max-length-set
- ●
- ▲
response property
amountInHomeCurrencylist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/amountlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/balanceRemaininglist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/discountAmountlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/linkedTransactions/items/amountlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/linkedTransactions/items/linkTypelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/linkedTransactions/items/refNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/refNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/transactionDatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
bankAccount/fullNamelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
bankAccount/idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
exchangeRatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
externalIdlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
isQueuedForPrintlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
memolist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
refNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
the
//response's property type changed fromobjectnullto no type for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromobjectnullto no type for statusresponse-property-type-changed
- ▲
the
response's property type changed fromobjectnullto no type for statusresponse-property-type-changed
- ▲
the
response's property type changed fromobjectnullto no type for statusresponse-property-type-changed
- ▲
the
response's property type changed fromobjectnullto no type for statusresponse-property-type-changed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ○
added
subschema #2to theresponse propertyanyOflist for the response statusresponse-property-any-of-added
- ○
added
subschema #1subschema #2to the//response propertyanyOflist for the response statusresponse-property-any-of-added
- ○
added
subschema #1subschema #2to the//response propertyanyOflist for the response statusresponse-property-any-of-added
- ○
added
subschema #1subschema #2to theresponse propertyanyOflist for the response statusresponse-property-any-of-added
- ○
added
subschema #1subschema #2to theresponse propertyanyOflist for the response statusresponse-property-any-of-added
- ○
added
subschema #1subschema #2to theresponse propertyanyOflist for the response statusresponse-property-any-of-added
- ○
removed the
amountenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
quantityenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
undefinedenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed
subschema #2from theresponse propertyoneOflist for the response statusresponse-property-one-of-removed
- ▲
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
//became nullable for the statusresponse-property-became-nullable
- ▲
the response property
//became nullable for the statusresponse-property-became-nullable
- ▲
the response property
//became nullable for the statusresponse-property-became-nullable
- ▲
the response property
//became nullable for the statusresponse-property-became-nullable
- ▲
the response property
//became nullable for the statusresponse-property-became-nullable
- ▲
the response property
////became nullable for the statusresponse-property-became-nullable
- ▲
the response property
////became nullable for the statusresponse-property-became-nullable
- ▲
the response property
////became nullable for the statusresponse-property-became-nullable
- ▲
the response property
//became nullable for the statusresponse-property-became-nullable
- ▲
the response property
//became nullable for the statusresponse-property-became-nullable
- ▲
the response property
/became nullable for the statusresponse-property-became-nullable
- ▲
the response property
/became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
added
subschema #2to theresponse propertyoneOflist for the response statusresponse-property-one-of-added
- ▲
the
//response's property type changed from no type toobjectnullfor statusresponse-property-type-changed
- ▲
the
//response's property type changed from no type toobjectnullfor statusresponse-property-type-changed
- ▲
the
response's property type changed from no type toobjectnullfor statusresponse-property-type-changed
- ▲
the
response's property type changed from no type toobjectnullfor statusresponse-property-type-changed
- ▲
the
response's property type changed from no type toobjectnullfor statusresponse-property-type-changed
- ●
added the new
amountenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
quantityenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
undefinedenum value to the////response property for the response statusresponse-property-enum-value-added
- ○
removed the pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$from the request propertyrequest-property-pattern-removed
- ○
removed
subschema #2from theresponse propertyanyOflist for the response statusresponse-property-any-of-removed
- ○
removed
subschema #1subschema #2from the//response propertyanyOflist for the response statusresponse-property-any-of-removed
- ○
removed
subschema #1subschema #2from the//response propertyanyOflist for the response statusresponse-property-any-of-removed
- ○
removed
subschema #1subschema #2from theresponse propertyanyOflist for the response statusresponse-property-any-of-removed
- ○
removed
subschema #1subschema #2from theresponse propertyanyOflist for the response statusresponse-property-any-of-removed
- ○
removed
subschema #1subschema #2from theresponse propertyanyOflist for the response statusresponse-property-any-of-removed
- ○
response property
amountInHomeCurrencylist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
appliedToTransactions/items/amountlist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
appliedToTransactions/items/balanceRemaininglist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
appliedToTransactions/items/discountAmountlist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
appliedToTransactions/items/linkedTransactions/items/amountlist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
appliedToTransactions/items/linkedTransactions/items/linkTypelist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
appliedToTransactions/items/linkedTransactions/items/refNumberlist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
appliedToTransactions/items/refNumberlist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
appliedToTransactions/items/transactionDatelist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
bankAccount/fullNamelist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
bankAccount/idlist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
exchangeRatelist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
externalIdlist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
isQueuedForPrintlist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
memolist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
response property
refNumberlist-of-types was narrowed by removing typesnullfrom media typeapplication/jsonof response200response-property-list-of-types-narrowed
- ○
the
////response's property pattern^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$was removed for the statusresponse-property-pattern-removed
- ○
the
response's property pattern^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$was removed for the statusresponse-property-pattern-removed
- ○
added the required property
///to the response with the statusresponse-required-property-added
- ○
added the required property
///to the response with the statusresponse-required-property-added
- ○
added the required property
///to the response with the statusresponse-required-property-added
- ○
added the required property
///to the response with the statusresponse-required-property-added
- ○
added the required property
/to the response with the statusresponse-required-property-added
- ○
added the required property
/to the response with the statusresponse-required-property-added
- ○
added the required property
/to the response with the statusresponse-required-property-added
- ○
added the required property
/to the response with the statusresponse-required-property-added
- ○
added the required property
/to the response with the statusresponse-required-property-added
- ○
added the required property
/to the response with the statusresponse-required-property-added
- ▲
- ▲
added the pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$to the request propertyrequest-property-pattern-added
- ▲
response property
amountInHomeCurrencylist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/amountlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/balanceRemaininglist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/discountAmountlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/linkedTransactions/items/amountlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/linkedTransactions/items/linkTypelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/linkedTransactions/items/refNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/refNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
appliedToTransactions/items/transactionDatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
bankAccount/fullNamelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
bankAccount/idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
exchangeRatelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
externalIdlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
isQueuedForPrintlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
memolist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
refNumberlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
the
//response's property type changed fromobjectnullto no type for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromobjectnullto no type for statusresponse-property-type-changed
- ▲
the
response's property type changed fromobjectnullto no type for statusresponse-property-type-changed
- ▲
the
response's property type changed fromobjectnullto no type for statusresponse-property-type-changed
- ▲
the
response's property type changed fromobjectnullto no type for statusresponse-property-type-changed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ○
added
subschema #2to theresponse propertyanyOflist for the response statusresponse-property-any-of-added
- ○
added
subschema #1subschema #2to the//response propertyanyOflist for the response statusresponse-property-any-of-added
- ○
added
subschema #1subschema #2to the//response propertyanyOflist for the response statusresponse-property-any-of-added
- ○
added
subschema #1subschema #2to theresponse propertyanyOflist for the response statusresponse-property-any-of-added
- ○
added
subschema #1subschema #2to theresponse propertyanyOflist for the response statusresponse-property-any-of-added
- ○
added
subschema #1subschema #2to theresponse propertyanyOflist for the response statusresponse-property-any-of-added
- ○
removed the
amountenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
quantityenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
undefinedenum value from the////response property for the response statusresponse-property-enum-value-removed
- ○
removed
subschema #2from theresponse propertyoneOflist for the response statusresponse-property-one-of-removed
- ○
the
////response's property pattern^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$was added for the statusresponse-property-pattern-added
- ○
the
response's property pattern^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$was added for the statusresponse-property-pattern-added
- ▲