Retrieve an invoice (accounts receivable)

Returns a single invoice, i.e. an accounts receivable (AR) record of money a customer owes the organization, by its ID. The invoice is in the same shape as an item of the list endpoint (getBooksInvoices): its id, referenceNumber (the invoice number), customer (the customer billed, with its id and name; omitted when the invoice has no recorded customer), effectiveDate (invoice date), dueDate, status, displayStatus, grossAmount (total of all lines), amountRemaining (still owed after applied payments), lines (each with its ledger ID, i.e. general ledger (GL) account, description, and amount), notes (omitted when none), and paymentApplications (each a line entry ID, such as a bank transaction's line, and the amount of it applied). status is the stored lifecycle status (draft, open, processing, paid, cancelled); displayStatus is what users see, which also distinguishes overdue (open and past due) and partiallyPaid (open with some payment applied). A customer's id is a Mercury Invoicing customer ID, as used by the Mercury Invoicing customers API (/ar/customers); a deleted customer still appears with its name. Amounts are in dollars. The ID must be an invoice: an unknown id, a bill, or an id from another Books instance returns 404. To discover invoice IDs, use the list endpoint (getBooksInvoices) or the ID returned by createBooksInvoice.

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

The ID of the invoice to retrieve, as returned by getBooksInvoices or createBooksInvoice.

Query Params
uuid

The Books instance to act on. Required for agent organization tokens; defaults to the token organization's instance.

Responses

400

Invalid booksId

404

invoiceId 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