API docs by Redocly

OCR Invoice Job API (1.0.0)

Download OpenAPI specification:Download

URL: https://repzo.com

API for managing individual OCR invoice jobs

OCR Invoice Job

Operations related to individual OCR invoice job management

Get all OCR invoice jobs

Retrieve a list of all OCR invoice jobs with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new OCR invoice job

Create a new OCR invoice job with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
jobNumber
required
string

Unique job number

documentName
required
string

Name of the document being processed

documentUrl
required
string <uri>

URL of the document to process

documentType
string
Enum: "pdf" "png" "jpg" "jpeg" "tiff" "bmp"

Type of document

template
required
string

OCR template ID to use

group
string

OCR job group ID if part of a batch

priority
string
Default: "medium"
Enum: "low" "medium" "high" "urgent"

Processing priority

createdBy
string

User who created the job

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "jobNumber": "OCR-2023-001",
  • "documentName": "invoice_2023_001.pdf",
  • "documentUrl": "https://storage.example.com/invoices/invoice_2023_001.pdf",
  • "documentType": "pdf",
  • "template": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "group": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "priority": "low",
  • "createdBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get OCR invoice job by ID

Retrieve a specific OCR invoice job by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update OCR invoice job

Update an existing OCR invoice job with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job ID

Request Body schema: application/json
jobNumber
required
string

Unique job number

documentName
required
string

Name of the document being processed

documentUrl
required
string <uri>

URL of the document to process

documentType
string
Enum: "pdf" "png" "jpg" "jpeg" "tiff" "bmp"

Type of document

template
required
string

OCR template ID to use

group
string

OCR job group ID if part of a batch

priority
string
Default: "medium"
Enum: "low" "medium" "high" "urgent"

Processing priority

createdBy
string

User who created the job

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "jobNumber": "OCR-2023-001",
  • "documentName": "invoice_2023_001.pdf",
  • "documentUrl": "https://storage.example.com/invoices/invoice_2023_001.pdf",
  • "documentType": "pdf",
  • "template": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "group": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "priority": "low",
  • "createdBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete OCR invoice job

Delete an existing OCR invoice job

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "OCR invoice job deleted successfully"
}

Process OCR invoice job

Start processing an OCR invoice job

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get OCR results

Retrieve the OCR processing results for a job

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}