Skip to main content

Get Bill Invoice Reading Status

GET 

/api/bills/ocr/status

Get whether invoice reading (OCR) is switched on for the workspace, and the confidence threshold below which a read value is flagged for review.

Required scope: purchase-orders:read

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

Response fields:

  • enabled (boolean) - true when uploaded invoices are read automatically. When false, upload the file with Upload Bill Invoice File and enter the bill by hand.
  • confidence_threshold (integer, 0-100) - read values with a lower confidence are flagged for a person to check.
  • can_configure (boolean) - true when the calling user is an administrator and can change these settings.

Authentication: Requires Bearer token. Permission: view bills (bills.index). Scope: purchase-orders (read/write).

Request​

Responses​

OK

Response Headers
    Content-Type