LedgerWire

ReceivePayment · Query

simulated in sandbox

ReceivePaymentQuery

Received payments close out invoices. Each one is applied to one or more open invoices through AppliedToTxnAdd, or auto-applied oldest-first with IsAutoApply.

qbXML request

ReceivePaymentQueryRq
<?xml version="1.0" encoding="utf-8"?>
<?qbxml version="13.0"?>
<QBXML>
  <QBXMLMsgsRq onError="stopOnError">
    <ReceivePaymentQueryRq requestID="1">
      <MaxReturned>10</MaxReturned>
      <ModifiedDateRangeFilter>
        <FromModifiedDate>2026-10-01T00:00:00</FromModifiedDate>
      </ModifiedDateRangeFilter>
    </ReceivePaymentQueryRq>
  </QBXMLMsgsRq>
</QBXML>

JSON equivalent

GET /v1/receive-payments?limit=10&updatedAfter=2026-10-01
GET /v1/receive-payments?limit=10&updatedAfter=2026-10-01
curl
curl "https://ledgerwire.vibiz.app/v1/receive-payments?limit=10&updatedAfter=2026-10-01" \
  -H "Authorization: Bearer $LEDGERWIRE_KEY"
Sends this exact qbXML to the shared demo sandbox (simulated sample data).

qbXML response (from the sandbox seed data)

ReceivePaymentQueryRs
<?xml version="1.0" ?>
<QBXML>
  <QBXMLMsgsRs>
    <ReceivePaymentQueryRs requestID="1" statusCode="0" statusSeverity="Info" statusMessage="Status OK">
      <ReceivePaymentRet>
        <TxnID>2A3-1784071862</TxnID>
        <TimeCreated>2026-07-14T23:31:02+00:00</TimeCreated>
        <TimeModified>2026-07-14T23:31:02+00:00</TimeModified>
        <EditSequence>1784071862</EditSequence>
        <TxnNumber>3001</TxnNumber>
        <CustomerRef>
          <ListID>8000006F-1794871862</ListID>
          <FullName>Clearwater Facilities Group</FullName>
        </CustomerRef>
        <ARAccountRef>
          <ListID>80000003-1760311862</ListID>
          <FullName>Accounts Receivable</FullName>
        </ARAccountRef>
        <TxnDate>2026-07-14</TxnDate>
        <RefNumber>6964</RefNumber>
        <TotalAmount>24.75</TotalAmount>
        <PaymentMethodRef>
          <FullName>Check</FullName>
        </PaymentMethodRef>
        <DepositToAccountRef>
          <ListID>80000004-1760311862</ListID>
          <FullName>Undeposited Funds</FullName>
        </DepositToAccountRef>
        <UnusedPayment>0</UnusedPayment>
        <UnusedCredits>0</UnusedCredits>
        <AppliedToTxnRet>
          <TxnID>101-1780875062</TxnID>
          <TxnType>Invoice</TxnType>
          <TxnDate>2026-06-07</TxnDate>
          <RefNumber>1001</RefNumber>
          <BalanceRemaining>0.00</BalanceRemaining>
          <Amount>24.75</Amount>
        </AppliedToTxnRet>
      </ReceivePaymentRet>
    </ReceivePaymentQueryRs>
  </QBXMLMsgsRs>
</QBXML>

FAQ

How do I page through ReceivePaymentQuery results?

In qbXML, add iterator="Start" to ReceivePaymentQueryRq with MaxReturned, then send iterator="Continue" with the iteratorID until iteratorRemainingCount is 0. With LedgerWire, GET /v1/receive-payments?limit=100 and follow nextCursor.

How do I fetch only received payments changed since my last sync?

Use ModifiedDateRangeFilter/FromModifiedDate inside ReceivePaymentQueryRq, or updatedAfter on the REST endpoint.

Why does ReceivePaymentQuery return statusCode 1?

Status 1 is informational: "A query request did not find a matching object in QuickBooks". The request was valid and nothing matched the filters. LedgerWire returns an empty data array for it.

Sandbox fidelity

The LedgerWire sandbox simulates ReceivePaymentQuery 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 ReceivePayment messages

Other Query messages

Skip the XML: call GET /v1/receive-payments with JSON.

Get a free sandbox key