Developers

PUBLIC API v1

Read document processing progress and per-file results

GET /api/v1/accounting/transactions/upload-documents/{job_id}/status/

Mixin for viewsets that need company scoping. Uses request.company set by CompanyContextMiddleware, which handles both regular users (first company) and tax advisors (X-Company-Id header).

Permission: read_documents read_transactions · Direct link

Company-scoped. Account permissions, plan limits and document state still apply.

Path and query parameters

ParameterLocation / typeDescription
job_idRequiredpath · string (uuid)Not specified

Responses

200 Response fields

application/json

FieldType / accepted valuesDescription
jobIdRequiredstring (uuid)Not specified
totalFilesRequiredintegerNot specified
processedFilesRequiredintegerNot specified
failedFilesRequiredintegerNot specified
statusRequired"processing" | "completed" | "failed"* `processing` - Processing * `completed` - Completed * `failed` - Failed
createdTransactionsRequiredobject[]Not specified
Nested fields
FieldType / accepted valuesDescription
idRequiredstring (uuid)Not specified
descriptionRequiredstringNot specified
amountRequirednumber (double)Amount in minor currency units.
failuresRequiredobject[]Not specified
Nested fields
FieldType / accepted valuesDescription
fileNameRequiredstringNot specified
reasonRequired"unsupported_file_type" | "file_too_large" | "invalid_file" | "no_usable_data" | "duplicate_document" | "processing_error"* `unsupported_file_type` - Unsupported File Type * `file_too_large` - File Too Large * `invalid_file` - Invalid File * `no_usable_data` - No Usable Data * `duplicate_document` - Duplicate Document * `processing_error` - Processing Error
401 The API key is invalid, expired or revoked.
403 Missing scope, company mismatch, unsupported operation, or a plan/account restriction.
429 Rate limit exceeded. Wait for the Retry-After header before retrying.

Use the base URL https://api.norman.finance/api/v1. Sign up or log in to Norman to create an API key, then send it as a Bearer token. For an OpenAPI JSON file, contact support.