Unmatch a transaction from its bills or invoices

Unmatches a transaction's line entry from every bill or invoice it was matched to, and removes its adjustments, so the bills or invoices are owed again. Use the transaction's own lineEntryId from GET /books/transactions (getBooksTransactions) or GET /books/transaction/{transactionId} (getBooksTransaction). The transaction's other lines are replaced by one uncategorized line, so categorize it again afterwards with categorizeBooksTransactions; the line entry itself keeps its ID. When the unmatch completes, an invoice sent with Mercury Invoicing is also marked unpaid there. Unmatching a line entry with no matches changes nothing and returns 200 with empty bills and invoices, so retrying an unmatch is safe for Books. 409, and nothing changes, when the line entry has no matches in Books but Mercury Invoicing still records its payment, as after an unmatch whose result was lost: the invoice stays paid in Mercury Invoicing. Retrying won't fix this; contact Mercury support. Refused with 400, and nothing changes, when the line entry is matched to a payroll run, which this API can't unmatch, or when the payment was made through Bill Pay or is applied to a bill that came from Bill Pay. 404 when the Books instance has no such line entry. Returns the same shape as createBooksPaymentApplications: lineEntry (its id, journalEntryId, transactionId, unsigned amount, and amountApplied and amountAdjusted, both 0 now, in dollars) and the unmatched bills or invoices, each with its id, amountPaid, amountAdjusted, amountOutstanding, status, and displayStatus. A 503 response means Books couldn't unmatch the line entry or confirm the unmatch right now; retry the same request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

unique id for a line entry; emitted as base-58, but a base-16 UUID is also accepted

Query Params
uuid

The Books instance to act on. Must be the token organization's own instance, which it defaults to.

Responses

400

Invalid booksId

404

lineEntryId not found

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json