Documents

List documents for a company

get/companies/{companyId}/documents

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/companies/{companyId}/documents
  • Auth: HTTP bearer

Query parameters

limitinteger
cursorstring
type'invoice' | 'bill' | 'receipt' | 'contract' | 'statement'
status'needs_review' | 'reviewed' | 'processed' | 'archived'
categorystring
searchstring

Case-insensitive substring over the document's own descriptive fields (name, vendor name, customer name, invoice number). Deliberately not a filter on type: the displayed type is re-derived from metadata at read time, so a column filter would drop rows the UI labels bill/receipt.

displayStatus'active' | 'archived' | 'paid' | 'pending_payment' | 'pending' | 'matched' | 'unmatched' | 'processed' | 'needs_review' | 'reviewed'

Derived Feed chip status (matched ⇔ transaction linked, unmatched ⇔ needs review with no link, bill payment labels, …). Not the stored status column — forwarding a chip value as status returns nothing because the column never holds those values. active (#2738) is every document that is not archived; the customer list sends it by default.

Response

A list of documents

successboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.