OCR Invoice Job Group API (1.0.0)

Download OpenAPI specification:Download

URL: https://repzo.com

API for managing OCR invoice job groups

OCR Invoice Job Group

Operations related to OCR invoice job group management

Get all OCR invoice job groups

Retrieve a list of all OCR invoice job groups 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": "Monthly Invoice Batch - January 2023",
"description": "string",
"batchNumber": "BATCH-2023-001",
"template": "60f7b1b3e4b0e8b3f8b3f8b4",
"totalJobs": 150,
"completedJobs": 120,
"pendingJobs": 20,
"failedJobs": 10,
"status": "created",
"priority": "low",
"startedAt": "2023-01-15T08:00:00Z",
"completedAt": "2023-01-15T10:30:00Z",
"estimatedCompletionTime": "2023-01-15T11:00:00Z",
"processingSettings": {"parallelJobs": 3,
"retryCount": 2,
"timeoutMinutes": 30
},
"statistics": {"totalDocuments": 0,
"totalPages": 0,
"averageProcessingTime": 0,
"successRate": 1,
"totalCost": 0,
"currency": "USD"
},
"notifications": {"onCompletion": false,
"onFailure": true,
"recipients": ["user@example.com"
]
},
"createdBy": "60f7b1b3e4b0e8b3f8b3f8b5",
"assignedTo": "60f7b1b3e4b0e8b3f8b3f8b6",
"tags": ["monthly",
"invoices",
"accounting"
],
"metadata": { },
"createdAt": "2023-01-15T08:00:00Z",
"updatedAt": "2023-01-15T10:30:00Z"
}
],
"total": 0
}

Create a new OCR invoice job group

Create a new OCR invoice job group with the provided data

Authorizations:

ApiKeyAuth

Request Body schema: application/json

name required	string Name of the job group
description	string Description of the job group
batchNumber	string Batch number for tracking
template required	string OCR template ID to use for this group
priority	string Default: "medium" Enum: "low" "medium" "high" "urgent" Processing priority
	object
	object
createdBy	string User who created the job group
assignedTo	string User assigned to manage this group
tags	Array of strings Tags for categorization
	object Additional metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "Monthly Invoice Batch - January 2023",
"description": "string",
"batchNumber": "BATCH-2023-001",
"template": "60f7b1b3e4b0e8b3f8b3f8b4",
"priority": "low",
"processingSettings": {"parallelJobs": 3,
"retryCount": 2,
"timeoutMinutes": 30
},
"notifications": {"onCompletion": false,
"onFailure": true,
"recipients": ["user@example.com"
]
},
"createdBy": "60f7b1b3e4b0e8b3f8b3f8b5",
"assignedTo": "60f7b1b3e4b0e8b3f8b3f8b6",
"tags": ["monthly",
"invoices",
"accounting"
],
"metadata": { }
}

Response samples

201

Content type

application/json

{"success": true,
"data": {"_id": "60f7b1b3e4b0e8b3f8b3f8b3",
"name": "Monthly Invoice Batch - January 2023",
"description": "string",
"batchNumber": "BATCH-2023-001",
"template": "60f7b1b3e4b0e8b3f8b3f8b4",
"totalJobs": 150,
"completedJobs": 120,
"pendingJobs": 20,
"failedJobs": 10,
"status": "created",
"priority": "low",
"startedAt": "2023-01-15T08:00:00Z",
"completedAt": "2023-01-15T10:30:00Z",
"estimatedCompletionTime": "2023-01-15T11:00:00Z",
"processingSettings": {"parallelJobs": 3,
"retryCount": 2,
"timeoutMinutes": 30
},
"statistics": {"totalDocuments": 0,
"totalPages": 0,
"averageProcessingTime": 0,
"successRate": 1,
"totalCost": 0,
"currency": "USD"
},
"notifications": {"onCompletion": false,
"onFailure": true,
"recipients": ["user@example.com"
]
},
"createdBy": "60f7b1b3e4b0e8b3f8b3f8b5",
"assignedTo": "60f7b1b3e4b0e8b3f8b3f8b6",
"tags": ["monthly",
"invoices",
"accounting"
],
"metadata": { },
"createdAt": "2023-01-15T08:00:00Z",
"updatedAt": "2023-01-15T10:30:00Z"
}
}

Get OCR invoice job group by ID

Retrieve a specific OCR invoice job group by its ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

OCR invoice job group ID

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": {"_id": "60f7b1b3e4b0e8b3f8b3f8b3",
"name": "Monthly Invoice Batch - January 2023",
"description": "string",
"batchNumber": "BATCH-2023-001",
"template": "60f7b1b3e4b0e8b3f8b3f8b4",
"totalJobs": 150,
"completedJobs": 120,
"pendingJobs": 20,
"failedJobs": 10,
"status": "created",
"priority": "low",
"startedAt": "2023-01-15T08:00:00Z",
"completedAt": "2023-01-15T10:30:00Z",
"estimatedCompletionTime": "2023-01-15T11:00:00Z",
"processingSettings": {"parallelJobs": 3,
"retryCount": 2,
"timeoutMinutes": 30
},
"statistics": {"totalDocuments": 0,
"totalPages": 0,
"averageProcessingTime": 0,
"successRate": 1,
"totalCost": 0,
"currency": "USD"
},
"notifications": {"onCompletion": false,
"onFailure": true,
"recipients": ["user@example.com"
]
},
"createdBy": "60f7b1b3e4b0e8b3f8b3f8b5",
"assignedTo": "60f7b1b3e4b0e8b3f8b3f8b6",
"tags": ["monthly",
"invoices",
"accounting"
],
"metadata": { },
"createdAt": "2023-01-15T08:00:00Z",
"updatedAt": "2023-01-15T10:30:00Z"
}
}

Update OCR invoice job group

Update an existing OCR invoice job group with new data

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

OCR invoice job group ID

Request Body schema: application/json

name required	string Name of the job group
description	string Description of the job group
batchNumber	string Batch number for tracking
template required	string OCR template ID to use for this group
priority	string Default: "medium" Enum: "low" "medium" "high" "urgent" Processing priority
	object
	object
createdBy	string User who created the job group
assignedTo	string User assigned to manage this group
tags	Array of strings Tags for categorization
	object Additional metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "Monthly Invoice Batch - January 2023",
"description": "string",
"batchNumber": "BATCH-2023-001",
"template": "60f7b1b3e4b0e8b3f8b3f8b4",
"priority": "low",
"processingSettings": {"parallelJobs": 3,
"retryCount": 2,
"timeoutMinutes": 30
},
"notifications": {"onCompletion": false,
"onFailure": true,
"recipients": ["user@example.com"
]
},
"createdBy": "60f7b1b3e4b0e8b3f8b3f8b5",
"assignedTo": "60f7b1b3e4b0e8b3f8b3f8b6",
"tags": ["monthly",
"invoices",
"accounting"
],
"metadata": { }
}

Response samples

200

Content type

application/json

{"success": true,
"data": {"_id": "60f7b1b3e4b0e8b3f8b3f8b3",
"name": "Monthly Invoice Batch - January 2023",
"description": "string",
"batchNumber": "BATCH-2023-001",
"template": "60f7b1b3e4b0e8b3f8b3f8b4",
"totalJobs": 150,
"completedJobs": 120,
"pendingJobs": 20,
"failedJobs": 10,
"status": "created",
"priority": "low",
"startedAt": "2023-01-15T08:00:00Z",
"completedAt": "2023-01-15T10:30:00Z",
"estimatedCompletionTime": "2023-01-15T11:00:00Z",
"processingSettings": {"parallelJobs": 3,
"retryCount": 2,
"timeoutMinutes": 30
},
"statistics": {"totalDocuments": 0,
"totalPages": 0,
"averageProcessingTime": 0,
"successRate": 1,
"totalCost": 0,
"currency": "USD"
},
"notifications": {"onCompletion": false,
"onFailure": true,
"recipients": ["user@example.com"
]
},
"createdBy": "60f7b1b3e4b0e8b3f8b3f8b5",
"assignedTo": "60f7b1b3e4b0e8b3f8b3f8b6",
"tags": ["monthly",
"invoices",
"accounting"
],
"metadata": { },
"createdAt": "2023-01-15T08:00:00Z",
"updatedAt": "2023-01-15T10:30:00Z"
}
}

Delete OCR invoice job group

Delete an existing OCR invoice job group

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

OCR invoice job group ID

Responses

Response samples

200

Content type

application/json

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

Get jobs in a group

Retrieve all OCR jobs belonging to a specific group

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

OCR invoice job group ID

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": [{"jobId": "string",
"status": "string",
"documentName": "string"
}
]
}