OCR Invoice Job Template API (1.0.0)

Download OpenAPI specification:Download

URL: https://repzo.com

API for managing OCR invoice job templates

OCR Invoice Job Template

Operations related to OCR invoice job template management

Get all OCR invoice job templates

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

200

Content type

application/json

{"success": true,
"data": [{"_id": "60f7b1b3e4b0e8b3f8b3f8b3",
"name": "Standard Invoice OCR Template",
"description": "string",
"version": "1.0.0",
"ocrEngine": "google-vision",
"documentType": "invoice",
"extractionRules": {"fields": [{"name": "string",
"type": "text",
"required": true,
"pattern": "string",
"coordinates": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"validation": {"minLength": 0,
"maxLength": 0,
"format": "string"
}
}
],
"lineItems": {"enabled": true,
"tableStructure": {"headerRow": 0,
"dataStartRow": 0,
"columns": [{"name": "string",
"index": 0,
"type": "text"
}
]
}
}
},
"preprocessingSettings": {"imageEnhancement": true,
"deskew": true,
"denoising": true,
"binarization": false,
"resolutionDPI": 300
},
"postprocessingSettings": {"spellCheck": false,
"confidenceThreshold": 0.8,
"validationRules": [{"field": "string",
"rule": "required",
"message": "string"
}
]
},
"supportedFormats": ["pdf"
],
"languages": ["en",
"es",
"fr"
],
"accuracy": {"averageAccuracy": 1,
"fieldAccuracy": {"property1": 0,
"property2": 0
}
},
"isActive": true,
"isDefault": false,
"createdBy": "string",
"lastModifiedBy": "string",
"metadata": { },
"createdAt": "2023-01-15T08:00:00Z",
"updatedAt": "2023-01-15T10:30:00Z"
}
],
"total": 0
}

Create a new OCR invoice job template

Create a new OCR invoice job template with the provided data

Authorizations:

ApiKeyAuth

Request Body schema: application/json

name required	string Name of the template
description	string Description of the template
version	string Template version
ocrEngine required	string Enum: "tesseract" "google-vision" "aws-textract" "azure-cognitive" "custom" OCR engine to use
documentType required	string Enum: "invoice" "receipt" "bill" "statement" "other" Type of document
required	object
	object
	object
supportedFormats	Array of strings Items Enum: "pdf" "png" "jpg" "jpeg" "tiff" "bmp" Supported document formats
languages	Array of strings Supported languages for OCR
isActive	boolean Default: true Whether the template is active
isDefault	boolean Default: false Whether this is the default template
createdBy	string User who created the template
lastModifiedBy	string User who last modified the template
	object Additional metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "Standard Invoice OCR Template",
"description": "string",
"version": "1.0.0",
"ocrEngine": "google-vision",
"documentType": "invoice",
"extractionRules": {"fields": [{"name": "string",
"type": "text",
"required": true,
"pattern": "string",
"coordinates": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"validation": {"minLength": 0,
"maxLength": 0,
"format": "string"
}
}
],
"lineItems": {"enabled": true,
"tableStructure": {"headerRow": 0,
"dataStartRow": 0,
"columns": [{"name": "string",
"index": 0,
"type": "text"
}
]
}
}
},
"preprocessingSettings": {"imageEnhancement": true,
"deskew": true,
"denoising": true,
"binarization": false,
"resolutionDPI": 300
},
"postprocessingSettings": {"spellCheck": false,
"confidenceThreshold": 0.8,
"validationRules": [{"field": "string",
"rule": "required",
"message": "string"
}
]
},
"supportedFormats": ["pdf"
],
"languages": ["en",
"es",
"fr"
],
"isActive": true,
"isDefault": false,
"createdBy": "string",
"lastModifiedBy": "string",
"metadata": { }
}

Response samples

201

Content type

application/json

{"success": true,
"data": {"_id": "60f7b1b3e4b0e8b3f8b3f8b3",
"name": "Standard Invoice OCR Template",
"description": "string",
"version": "1.0.0",
"ocrEngine": "google-vision",
"documentType": "invoice",
"extractionRules": {"fields": [{"name": "string",
"type": "text",
"required": true,
"pattern": "string",
"coordinates": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"validation": {"minLength": 0,
"maxLength": 0,
"format": "string"
}
}
],
"lineItems": {"enabled": true,
"tableStructure": {"headerRow": 0,
"dataStartRow": 0,
"columns": [{"name": "string",
"index": 0,
"type": "text"
}
]
}
}
},
"preprocessingSettings": {"imageEnhancement": true,
"deskew": true,
"denoising": true,
"binarization": false,
"resolutionDPI": 300
},
"postprocessingSettings": {"spellCheck": false,
"confidenceThreshold": 0.8,
"validationRules": [{"field": "string",
"rule": "required",
"message": "string"
}
]
},
"supportedFormats": ["pdf"
],
"languages": ["en",
"es",
"fr"
],
"accuracy": {"averageAccuracy": 1,
"fieldAccuracy": {"property1": 0,
"property2": 0
}
},
"isActive": true,
"isDefault": false,
"createdBy": "string",
"lastModifiedBy": "string",
"metadata": { },
"createdAt": "2023-01-15T08:00:00Z",
"updatedAt": "2023-01-15T10:30:00Z"
}
}

Get OCR invoice job template by ID

Retrieve a specific OCR invoice job template by its ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

OCR invoice job template ID

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"_id": "60f7b1b3e4b0e8b3f8b3f8b3",
"name": "Standard Invoice OCR Template",
"description": "string",
"version": "1.0.0",
"ocrEngine": "google-vision",
"documentType": "invoice",
"extractionRules": {"fields": [{"name": "string",
"type": "text",
"required": true,
"pattern": "string",
"coordinates": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"validation": {"minLength": 0,
"maxLength": 0,
"format": "string"
}
}
],
"lineItems": {"enabled": true,
"tableStructure": {"headerRow": 0,
"dataStartRow": 0,
"columns": [{"name": "string",
"index": 0,
"type": "text"
}
]
}
}
},
"preprocessingSettings": {"imageEnhancement": true,
"deskew": true,
"denoising": true,
"binarization": false,
"resolutionDPI": 300
},
"postprocessingSettings": {"spellCheck": false,
"confidenceThreshold": 0.8,
"validationRules": [{"field": "string",
"rule": "required",
"message": "string"
}
]
},
"supportedFormats": ["pdf"
],
"languages": ["en",
"es",
"fr"
],
"accuracy": {"averageAccuracy": 1,
"fieldAccuracy": {"property1": 0,
"property2": 0
}
},
"isActive": true,
"isDefault": false,
"createdBy": "string",
"lastModifiedBy": "string",
"metadata": { },
"createdAt": "2023-01-15T08:00:00Z",
"updatedAt": "2023-01-15T10:30:00Z"
}
}

Update OCR invoice job template

Update an existing OCR invoice job template with new data

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

OCR invoice job template ID

Request Body schema: application/json

name required	string Name of the template
description	string Description of the template
version	string Template version
ocrEngine required	string Enum: "tesseract" "google-vision" "aws-textract" "azure-cognitive" "custom" OCR engine to use
documentType required	string Enum: "invoice" "receipt" "bill" "statement" "other" Type of document
required	object
	object
	object
supportedFormats	Array of strings Items Enum: "pdf" "png" "jpg" "jpeg" "tiff" "bmp" Supported document formats
languages	Array of strings Supported languages for OCR
isActive	boolean Default: true Whether the template is active
isDefault	boolean Default: false Whether this is the default template
createdBy	string User who created the template
lastModifiedBy	string User who last modified the template
	object Additional metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "Standard Invoice OCR Template",
"description": "string",
"version": "1.0.0",
"ocrEngine": "google-vision",
"documentType": "invoice",
"extractionRules": {"fields": [{"name": "string",
"type": "text",
"required": true,
"pattern": "string",
"coordinates": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"validation": {"minLength": 0,
"maxLength": 0,
"format": "string"
}
}
],
"lineItems": {"enabled": true,
"tableStructure": {"headerRow": 0,
"dataStartRow": 0,
"columns": [{"name": "string",
"index": 0,
"type": "text"
}
]
}
}
},
"preprocessingSettings": {"imageEnhancement": true,
"deskew": true,
"denoising": true,
"binarization": false,
"resolutionDPI": 300
},
"postprocessingSettings": {"spellCheck": false,
"confidenceThreshold": 0.8,
"validationRules": [{"field": "string",
"rule": "required",
"message": "string"
}
]
},
"supportedFormats": ["pdf"
],
"languages": ["en",
"es",
"fr"
],
"isActive": true,
"isDefault": false,
"createdBy": "string",
"lastModifiedBy": "string",
"metadata": { }
}

Response samples

200

Content type

application/json

{"success": true,
"data": {"_id": "60f7b1b3e4b0e8b3f8b3f8b3",
"name": "Standard Invoice OCR Template",
"description": "string",
"version": "1.0.0",
"ocrEngine": "google-vision",
"documentType": "invoice",
"extractionRules": {"fields": [{"name": "string",
"type": "text",
"required": true,
"pattern": "string",
"coordinates": {"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"validation": {"minLength": 0,
"maxLength": 0,
"format": "string"
}
}
],
"lineItems": {"enabled": true,
"tableStructure": {"headerRow": 0,
"dataStartRow": 0,
"columns": [{"name": "string",
"index": 0,
"type": "text"
}
]
}
}
},
"preprocessingSettings": {"imageEnhancement": true,
"deskew": true,
"denoising": true,
"binarization": false,
"resolutionDPI": 300
},
"postprocessingSettings": {"spellCheck": false,
"confidenceThreshold": 0.8,
"validationRules": [{"field": "string",
"rule": "required",
"message": "string"
}
]
},
"supportedFormats": ["pdf"
],
"languages": ["en",
"es",
"fr"
],
"accuracy": {"averageAccuracy": 1,
"fieldAccuracy": {"property1": 0,
"property2": 0
}
},
"isActive": true,
"isDefault": false,
"createdBy": "string",
"lastModifiedBy": "string",
"metadata": { },
"createdAt": "2023-01-15T08:00:00Z",
"updatedAt": "2023-01-15T10:30:00Z"
}
}

Delete OCR invoice job template

Delete an existing OCR invoice job template

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

OCR invoice job template ID

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "OCR invoice job template deleted successfully"
}