Accountant Portal

Read companies documents queue

One offset-paged page of a single customer's documents queue, newest upload first by default (#2015). data is a bare array of at most meta.limit rows; page with offset.

get/accountant/companies/{customerId}/documents/queue

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/accountant/companies/{customerId}/documents/queue
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

limitinteger

Rows per page. Defaults to 200 and is capped at 500; an out-of-range or non-numeric value falls back to the 200-row default rather than erroring.

offsetinteger

Rows to skip before the page. Defaults to 0; a negative or non-numeric value falls back to 0.

searchstring

Case-insensitive substring match applied before status, so the status counts in meta.totalByStatus reflect it.

type'invoice' | 'bill' | 'receipt' | 'contract' | 'statement'

Filters on the queue's normalized document type. Applied before status, so it is reflected in meta.totalByStatus. An unrecognized value is ignored rather than erroring.

status'needs_review' | 'pending_payment' | 'reviewed' | 'paid' | 'processed' | 'archived'

Filters on the queue's display status. Applied AFTER the counts, so meta.total narrows with it while meta.totalByStatus and meta.metrics do not. An unrecognized value is ignored rather than erroring.

sort'uploaded_desc' | 'uploaded_asc' | 'doc_desc' | 'doc_asc'

Orders the whole filtered queue before the page is sliced, so sorting and paging compose. Defaults to uploaded_desc. An unrecognized value falls back to the default rather than erroring.

Response

One page of the documents queue. meta.total is the row count AFTER the status filter; meta.totalByStatus and meta.metrics are counted BEFORE it, so the summary cards stay populated while a status is selected. The two denominators answer different questions and are expected to differ (#2015).

successboolean

Changes

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