Skip to main content

List Bill Documents

GET 

/api/bills/:bill/documents

List every file kept with a bill, newest first: invoices read by OCR for it and documents attached to it (uploads, the invoice file kept with a bill entered by hand). A document made from one of the bill's own scans is listed once, as the scan.

Required scope: purchase-orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Each entry has:

  • key - unique key (extraction-{id} or document-{id}); kind - ocr_scan or file.
  • id, extraction_id, document_id - the scan and/or document behind the entry.
  • file_name, mime_type, file_size, source, description, uploaded_by.
  • status, page_count - for a scan only.
  • file_url - where to download the file; review_url - app path of a scan's review.
  • can_delete - true for an attached document, false for a scan.
  • created_at.

The bill's documents_count on List Bills counts the same set.

Authentication: Requires Bearer token. Scope: purchase-orders (read/write).

Request​

Responses​

OK

Response Headers
    Content-Type