API docs by Redocly

OCR Invoice Job Page API (1.0.0)

Download OpenAPI specification:Download

URL: https://repzo.com

API for managing individual pages within OCR invoice jobs

OCR Invoice Job Page

Operations related to individual pages within OCR invoice jobs

Get all OCR invoice job pages

Retrieve a list of all OCR invoice job pages 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 page

Create a new OCR invoice job page with the provided data

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

OCR invoice job ID this page belongs to

pageNumber
required
integer >= 1

Page number within the document

pageUrl
required
string <uri>

URL of the page image

pageType
string
Enum: "cover" "header" "content" "footer" "summary" "attachment"

Type of page content

object
Array of objects
object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "job": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "pageNumber": 1,
  • "pageUrl": "https://storage.example.com/pages/invoice_2023_001_page_1.png",
  • "pageType": "content",
  • "imageProperties": {
    },
  • "annotations": [
    ],
  • "metadata": { }
}

Response samples

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

Get OCR invoice job page by ID

Retrieve a specific OCR invoice job page by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job page ID

Responses

Response samples

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

Update OCR invoice job page

Update an existing OCR invoice job page with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job page ID

Request Body schema: application/json
job
required
string

OCR invoice job ID this page belongs to

pageNumber
required
integer >= 1

Page number within the document

pageUrl
required
string <uri>

URL of the page image

pageType
string
Enum: "cover" "header" "content" "footer" "summary" "attachment"

Type of page content

object
Array of objects
object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "job": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "pageNumber": 1,
  • "pageUrl": "https://storage.example.com/pages/invoice_2023_001_page_1.png",
  • "pageType": "content",
  • "imageProperties": {
    },
  • "annotations": [
    ],
  • "metadata": { }
}

Response samples

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

Delete OCR invoice job page

Delete an existing OCR invoice job page

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job page ID

Responses

Response samples

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

Process OCR invoice job page

Start processing a specific page of an OCR invoice job

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

OCR invoice job page ID

Responses

Response samples

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