LedgerWire

BillPaymentCheck · Add

simulated in sandbox

BillPaymentCheckAdd

A bill payment by check pays one or more open bills from a bank account. QuickBooks also has BillPaymentCreditCard for card-paid bills.

qbXML request

BillPaymentCheckAddRq
<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="13.0"?>
<QBXML>
  <QBXMLMsgsRq onError="stopOnError">
    <BillPaymentCheckAddRq requestID="1">
      <BillPaymentCheckAdd>
        <PayeeEntityRef>
          <FullName>City Utilities</FullName>
        </PayeeEntityRef>
        <TxnDate>2026-11-20</TxnDate>
        <BankAccountRef>
          <FullName>Checking</FullName>
        </BankAccountRef>
        <RefNumber>4188</RefNumber>
        <AppliedToTxnAdd>
          <TxnID>1F4-1731000000</TxnID>
          <PaymentAmount>312.40</PaymentAmount>
        </AppliedToTxnAdd>
      </BillPaymentCheckAdd>
    </BillPaymentCheckAddRq>
  </QBXMLMsgsRq>
</QBXML>

JSON equivalent

POST /v1/bill-payments
{
  "txnDate": "2026-11-20",
  "appliedTo": [
    {
      "txnId": "1F4-1731000000",
      "paymentAmount": 312.4
    }
  ],
  "refNumber": "4188",
  "bankAccountRef": {
    "fullName": "Checking"
  },
  "payeeEntityRef": {
    "fullName": "City Utilities"
  }
}
curl
curl -X POST https://ledgerwire.vibiz.app/v1/bill-payments \
  -H "Authorization: Bearer $LEDGERWIRE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"txnDate":"2026-11-20","appliedTo":[{"txnId":"1F4-1731000000","paymentAmount":312.4}],"refNumber":"4188","bankAccountRef":{"fullName":"Checking"},"payeeEntityRef":{"fullName":"City Utilities"}}'

Run this request against your own sandbox

Add and Mod requests change data, so they run in a private sandbox, not the shared demo. Get a free key (10 seconds), then POST the request above to /v1/qbxml.

qbXML response (from the sandbox seed data)

BillPaymentCheckAddRs
<?xml version="1.0" ?>
<QBXML>
  <QBXMLMsgsRs>
    <BillPaymentCheckAddRs requestID="1" statusCode="0" statusSeverity="Info" statusMessage="Status OK">
      <BillPaymentCheckRet>
        <TxnID>34E-1777159862</TxnID>
        <TimeCreated>2026-04-25T23:31:02+00:00</TimeCreated>
        <TimeModified>2026-04-25T23:31:02+00:00</TimeModified>
        <EditSequence>1777159862</EditSequence>
        <TxnNumber>9001</TxnNumber>
        <PayeeEntityRef>
          <FullName>City Utilities</FullName>
        </PayeeEntityRef>
        <APAccountRef>
          <ListID>80000007-1760311862</ListID>
          <FullName>Accounts Payable</FullName>
        </APAccountRef>
        <TxnDate>2026-11-20</TxnDate>
        <BankAccountRef>
          <FullName>Checking</FullName>
        </BankAccountRef>
        <IsToBePrinted>false</IsToBePrinted>
        <RefNumber>4188</RefNumber>
        <Amount>175.63</Amount>
        <AppliedToTxnRet>
          <TxnID>undefined</TxnID>
          <TxnId>1F4-1731000000</TxnId>
          <PaymentAmount>312.40</PaymentAmount>
        </AppliedToTxnRet>
      </BillPaymentCheckRet>
    </BillPaymentCheckAddRs>
  </QBXMLMsgsRs>
</QBXML>

FAQ

What is required in BillPaymentCheckAdd?

`payeeEntityRef`, `bankAccountRef`, `appliedTo` at minimum. Elements must appear in the order the qbXML schema lists them; LedgerWire orders them for you when you send JSON.

Why does BillPaymentCheckAdd fail with status 3140?

3140 means a reference (for example PayeeEntityRef or an ItemRef) points at something that does not exist in the company file. Look the record up first, or create it, and pass its ListID.

Can I set my own RefNumber on a bill payment (check)?

Yes. RefNumber is free text (up to 11 characters for most transactions). If you leave it out, QuickBooks auto-numbers when the preference is on.

Sandbox fidelity

The LedgerWire sandbox simulates BillPaymentCheckAdd with QuickBooks rules: required fields, element names, refs that must exist (3140), unique names (3100), field lengths (3070) and EditSequence locking (3200). Tax calculation, custom fields and preferences are not simulated.

More BillPaymentCheck messages

Other Add messages

Skip the XML: call POST /v1/bill-payments with JSON.

Get a free sandbox key