repzo 1.0.141 → 1.0.143
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/README.md +16 -315
- package/docs/api/activity-ai-sales-order-examples.md +63 -112
- package/docs/api/activity-ai-sales-order.md +15 -215
- package/docs/api/activity-feedback-examples.md +82 -136
- package/docs/api/activity-feedback-v2-examples.md +86 -138
- package/docs/api/activity-feedback-v2.md +19 -263
- package/docs/api/activity-feedback.md +19 -263
- package/docs/api/activity-storecheck-examples.md +62 -101
- package/docs/api/activity-storecheck.md +13 -186
- package/docs/api/adjust-account-examples.md +50 -78
- package/docs/api/adjust-account.md +12 -117
- package/docs/api/adjust-inventory-examples.md +50 -78
- package/docs/api/adjust-inventory.md +16 -121
- package/docs/api/approval-request-examples.md +58 -97
- package/docs/api/approval-request.md +26 -189
- package/docs/api/approvals-examples.md +58 -97
- package/docs/api/approvals.md +26 -189
- package/docs/api/asset-examples.md +53 -95
- package/docs/api/asset-part-examples.md +62 -101
- package/docs/api/asset-part-receival-examples.md +62 -101
- package/docs/api/asset-part-receival.md +13 -186
- package/docs/api/asset-part-transfer-examples.md +63 -112
- package/docs/api/asset-part-transfer.md +15 -215
- package/docs/api/asset-part-type-examples.md +62 -101
- package/docs/api/asset-part-type.md +13 -186
- package/docs/api/asset-part-unit-examples.md +62 -101
- package/docs/api/asset-part-unit.md +13 -186
- package/docs/api/asset-part.md +13 -186
- package/docs/api/asset-type-examples.md +58 -97
- package/docs/api/asset-type.md +26 -189
- package/docs/api/asset-unit-examples.md +80 -147
- package/docs/api/asset-unit.md +19 -306
- package/docs/api/asset.md +26 -189
- package/docs/api/banks-examples.md +53 -95
- package/docs/api/banks.md +26 -189
- package/docs/api/bankslists-examples.md +58 -97
- package/docs/api/bankslists.md +26 -189
- package/docs/api/brand-examples.md +58 -97
- package/docs/api/brand.md +18 -181
- package/docs/api/category-examples.md +58 -97
- package/docs/api/category.md +18 -181
- package/docs/api/checks-examples.md +45 -76
- package/docs/api/checks.md +12 -117
- package/docs/api/client-channel-examples.md +62 -101
- package/docs/api/client-channel.md +20 -207
- package/docs/api/client-contact-examples.md +62 -101
- package/docs/api/client-contact.md +25 -233
- package/docs/api/client-examples.md +53 -95
- package/docs/api/client-location-examples.md +71 -126
- package/docs/api/client-location.md +19 -275
- package/docs/api/client.md +18 -181
- package/docs/api/contract-examples.md +58 -97
- package/docs/api/contract-installment-examples.md +84 -148
- package/docs/api/contract-installment.md +21 -303
- package/docs/api/contract.md +26 -189
- package/docs/api/custom-list-examples.md +58 -97
- package/docs/api/custom-list-item-examples.md +58 -97
- package/docs/api/custom-list-item.md +26 -189
- package/docs/api/custom-list.md +26 -189
- package/docs/api/custom-status-examples.md +58 -97
- package/docs/api/custom-status.md +26 -189
- package/docs/api/day-examples.md +45 -76
- package/docs/api/day.md +12 -117
- package/docs/api/feedback-options-examples.md +90 -153
- package/docs/api/feedback-options.md +23 -307
- package/docs/api/fullinvoices-examples.md +51 -83
- package/docs/api/fullinvoices.md +22 -162
- package/docs/api/index.md +99 -705
- package/docs/api/integration-action-log-examples.md +62 -101
- package/docs/api/integration-action-log.md +13 -186
- package/docs/api/integration-app-examples.md +51 -83
- package/docs/api/integration-app.md +16 -156
- package/docs/api/integration-command-log-examples.md +62 -101
- package/docs/api/integration-command-log.md +13 -186
- package/docs/api/inventory-adjustment-reason-examples.md +58 -97
- package/docs/api/inventory-adjustment-reason.md +26 -189
- package/docs/api/inventory-examples.md +35 -45
- package/docs/api/inventory.md +8 -53
- package/docs/api/mail-unsubscribe-examples.md +69 -124
- package/docs/api/mail-unsubscribe.md +13 -251
- package/docs/api/measureunit-examples.md +58 -97
- package/docs/api/measureunit-family-examples.md +58 -97
- package/docs/api/measureunit-family.md +18 -188
- package/docs/api/measureunit.md +20 -190
- package/docs/api/media-examples.md +53 -95
- package/docs/api/media-storage-examples.md +58 -97
- package/docs/api/media-storage.md +18 -181
- package/docs/api/media.md +18 -181
- package/docs/api/msl-examples.md +53 -95
- package/docs/api/msl-products-examples.md +58 -97
- package/docs/api/msl-products.md +26 -189
- package/docs/api/msl.md +26 -189
- package/docs/api/ocr-invoice-job-examples.md +74 -132
- package/docs/api/ocr-invoice-job-group-examples.md +73 -121
- package/docs/api/ocr-invoice-job-group.md +15 -215
- package/docs/api/ocr-invoice-job-page-examples.md +63 -112
- package/docs/api/ocr-invoice-job-page.md +15 -215
- package/docs/api/ocr-invoice-job-template-examples.md +62 -101
- package/docs/api/ocr-invoice-job-template.md +13 -186
- package/docs/api/ocr-invoice-job.md +19 -253
- package/docs/api/patch-action-examples.md +63 -112
- package/docs/api/patch-action.md +15 -215
- package/docs/api/payment-terms-examples.md +58 -97
- package/docs/api/payment-terms.md +28 -198
- package/docs/api/payments-examples.md +51 -83
- package/docs/api/payments.md +22 -162
- package/docs/api/pricelist-examples.md +58 -97
- package/docs/api/pricelist-item-examples.md +58 -97
- package/docs/api/pricelist-item.md +24 -208
- package/docs/api/pricelist.md +18 -181
- package/docs/api/product-examples.md +58 -97
- package/docs/api/product-group-examples.md +58 -97
- package/docs/api/product-group.md +18 -181
- package/docs/api/product-modifiers-group-examples.md +70 -125
- package/docs/api/product-modifiers-group.md +19 -275
- package/docs/api/product.md +20 -190
- package/docs/api/proforma-examples.md +51 -83
- package/docs/api/proforma.md +22 -162
- package/docs/api/quick-convert-to-pdf-examples.md +30 -41
- package/docs/api/quick-convert-to-pdf.md +6 -56
- package/docs/api/receiving-material-examples.md +51 -83
- package/docs/api/receiving-material.md +16 -156
- package/docs/api/refund-examples.md +46 -81
- package/docs/api/refund.md +16 -156
- package/docs/api/rep-balance-summary-examples.md +36 -46
- package/docs/api/rep-balance-summary.md +6 -53
- package/docs/api/rep-examples.md +53 -95
- package/docs/api/rep.md +18 -181
- package/docs/api/return-asset-part-unit-examples.md +62 -101
- package/docs/api/return-asset-part-unit.md +13 -186
- package/docs/api/return-reason-examples.md +58 -97
- package/docs/api/return-reason.md +18 -181
- package/docs/api/route-examples.md +53 -95
- package/docs/api/route.md +18 -181
- package/docs/api/safe-invoice-serial-counter-examples.md +72 -127
- package/docs/api/safe-invoice-serial-counter.md +17 -266
- package/docs/api/settings-examples.md +47 -70
- package/docs/api/settings.md +18 -123
- package/docs/api/settlement-examples.md +50 -78
- package/docs/api/settlement.md +12 -117
- package/docs/api/speciality-examples.md +70 -125
- package/docs/api/speciality.md +17 -266
- package/docs/api/store-asset-part-unit-examples.md +62 -101
- package/docs/api/store-asset-part-unit.md +13 -186
- package/docs/api/storecheck-template-examples.md +58 -97
- package/docs/api/storecheck-template.md +18 -181
- package/docs/api/subcategory-examples.md +58 -97
- package/docs/api/subcategory.md +18 -181
- package/docs/api/supplier-examples.md +58 -97
- package/docs/api/supplier.md +26 -189
- package/docs/api/svix-integration-examples.md +62 -101
- package/docs/api/svix-integration.md +13 -186
- package/docs/api/tag-examples.md +53 -95
- package/docs/api/tag.md +18 -181
- package/docs/api/tax-examples.md +53 -95
- package/docs/api/tax.md +18 -181
- package/docs/api/team-examples.md +53 -95
- package/docs/api/team.md +18 -181
- package/docs/api/transfer-examples.md +51 -83
- package/docs/api/transfer.md +16 -156
- package/docs/api/update-integration-meta-examples.md +63 -112
- package/docs/api/update-integration-meta.md +15 -215
- package/docs/api/variant-examples.md +58 -97
- package/docs/api/variant.md +20 -183
- package/docs/api/visit-examples.md +46 -81
- package/docs/api/visit.md +22 -162
- package/docs/api/warehouse-examples.md +58 -97
- package/docs/api/warehouse.md +18 -181
- package/docs/api/workorder-category-examples.md +76 -141
- package/docs/api/workorder-category.md +19 -305
- package/docs/api/workorder-examples.md +58 -97
- package/docs/api/workorder-portal-examples.md +75 -132
- package/docs/api/workorder-portal-link-examples.md +70 -145
- package/docs/api/workorder-portal-link.md +23 -336
- package/docs/api/workorder-portal.md +19 -271
- package/docs/api/workorder-request-examples.md +58 -97
- package/docs/api/workorder-request.md +26 -189
- package/docs/api/workorder.md +26 -189
- package/docs/generated/index.html +1 -1
- package/docs/generated/repzo-api-complete.yaml +2585 -2585
- package/lib/index.d.ts +180 -0
- package/lib/index.js +90 -0
- package/lib/types/index.d.ts +13393 -14636
- package/package.json +3 -4
- package/src/types/index.ts +14 -1
|
@@ -6,56 +6,39 @@ API for managing individual OCR invoice jobs
|
|
|
6
6
|
|
|
7
7
|
## Overview
|
|
8
8
|
|
|
9
|
-
|
|
10
9
|
### Base URLs
|
|
11
10
|
|
|
12
11
|
- **Production server**: `https://sv.api.repzo.me`
|
|
13
12
|
|
|
14
13
|
- **Staging server**: `https://staging.sv.api.repzo.me`
|
|
15
14
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
15
|
### API Categories
|
|
20
16
|
|
|
21
17
|
- **OCR Invoice Job**: Operations related to individual OCR invoice job management
|
|
22
18
|
|
|
23
|
-
|
|
24
|
-
|
|
25
19
|
## Authentication
|
|
26
20
|
|
|
27
|
-
|
|
28
21
|
This API uses the following authentication methods:
|
|
29
22
|
|
|
30
|
-
|
|
31
23
|
- **ApiKeyAuth**
|
|
32
24
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
25
|
## Endpoints
|
|
37
26
|
|
|
38
|
-
|
|
39
27
|
### `/ocr-invoice-job`
|
|
40
28
|
|
|
41
|
-
|
|
42
29
|
#### GET /ocr-invoice-job
|
|
43
30
|
|
|
44
31
|
**Summary:** Get all OCR invoice jobs
|
|
45
32
|
|
|
46
|
-
|
|
47
33
|
**Description:** Retrieve a list of all OCR invoice jobs with optional filtering and pagination
|
|
48
34
|
|
|
49
|
-
|
|
50
|
-
|
|
51
35
|
**Tags:** OCR Invoice Job
|
|
52
36
|
|
|
53
|
-
|
|
54
|
-
|
|
55
37
|
##### Parameters
|
|
56
38
|
|
|
57
39
|
| Name | Location | Type | Required | Description |
|
|
58
|
-
|
|
40
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
41
|
+
|
|
59
42
|
|
|
60
43
|
| `limit` | query | integer | No | Maximum number of records to return |
|
|
61
44
|
|
|
@@ -69,415 +52,219 @@ This API uses the following authentication methods:
|
|
|
69
52
|
|
|
70
53
|
| `search` | query | string | No | Search term for text fields |
|
|
71
54
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
55
|
##### Responses
|
|
77
56
|
|
|
78
|
-
|
|
79
57
|
**200** - List of OCR invoice jobs retrieved successfully
|
|
80
58
|
|
|
81
|
-
|
|
82
|
-
|
|
83
59
|
Content-Type: `application/json`
|
|
84
60
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
61
|
**400** - Bad request
|
|
89
62
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
63
|
**401** - Unauthorized
|
|
94
64
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
65
|
**500** - Internal server error
|
|
99
66
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
67
|
---
|
|
105
68
|
|
|
106
|
-
|
|
107
69
|
#### POST /ocr-invoice-job
|
|
108
70
|
|
|
109
71
|
**Summary:** Create a new OCR invoice job
|
|
110
72
|
|
|
111
|
-
|
|
112
73
|
**Description:** Create a new OCR invoice job with the provided data
|
|
113
74
|
|
|
114
|
-
|
|
115
|
-
|
|
116
75
|
**Tags:** OCR Invoice Job
|
|
117
76
|
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
77
|
##### Request Body
|
|
123
78
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
79
|
**Content Types:**
|
|
128
80
|
|
|
129
81
|
- `application/json`
|
|
130
82
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
83
|
##### Responses
|
|
135
84
|
|
|
136
|
-
|
|
137
85
|
**201** - OCR invoice job created successfully
|
|
138
86
|
|
|
139
|
-
|
|
140
|
-
|
|
141
87
|
Content-Type: `application/json`
|
|
142
88
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
89
|
**400** - Bad request
|
|
147
90
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
91
|
**401** - Unauthorized
|
|
152
92
|
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
93
|
**500** - Internal server error
|
|
157
94
|
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
95
|
---
|
|
163
96
|
|
|
164
|
-
|
|
165
|
-
|
|
166
97
|
### `/ocr-invoice-job/{id}`
|
|
167
98
|
|
|
168
|
-
|
|
169
99
|
#### GET /ocr-invoice-job/{id}
|
|
170
100
|
|
|
171
101
|
**Summary:** Get OCR invoice job by ID
|
|
172
102
|
|
|
173
|
-
|
|
174
103
|
**Description:** Retrieve a specific OCR invoice job by its ID
|
|
175
104
|
|
|
176
|
-
|
|
177
|
-
|
|
178
105
|
**Tags:** OCR Invoice Job
|
|
179
106
|
|
|
180
|
-
|
|
181
|
-
|
|
182
107
|
##### Parameters
|
|
183
108
|
|
|
184
109
|
| Name | Location | Type | Required | Description |
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
| `id` | path | string | Yes | OCR invoice job ID |
|
|
188
|
-
|
|
189
|
-
|
|
110
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
190
111
|
|
|
191
112
|
|
|
113
|
+
| `id` | path | string | Yes | OCR invoice job ID |
|
|
192
114
|
|
|
193
115
|
##### Responses
|
|
194
116
|
|
|
195
|
-
|
|
196
117
|
**200** - OCR invoice job retrieved successfully
|
|
197
118
|
|
|
198
|
-
|
|
199
|
-
|
|
200
119
|
Content-Type: `application/json`
|
|
201
120
|
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
121
|
**404** - OCR invoice job not found
|
|
206
122
|
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
123
|
**401** - Unauthorized
|
|
211
124
|
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
125
|
**500** - Internal server error
|
|
216
126
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
127
|
---
|
|
222
128
|
|
|
223
|
-
|
|
224
129
|
#### PUT /ocr-invoice-job/{id}
|
|
225
130
|
|
|
226
131
|
**Summary:** Update OCR invoice job
|
|
227
132
|
|
|
228
|
-
|
|
229
133
|
**Description:** Update an existing OCR invoice job with new data
|
|
230
134
|
|
|
231
|
-
|
|
232
|
-
|
|
233
135
|
**Tags:** OCR Invoice Job
|
|
234
136
|
|
|
235
|
-
|
|
236
|
-
|
|
237
137
|
##### Parameters
|
|
238
138
|
|
|
239
139
|
| Name | Location | Type | Required | Description |
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
| `id` | path | string | Yes | OCR invoice job ID |
|
|
243
|
-
|
|
140
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
244
141
|
|
|
245
142
|
|
|
143
|
+
| `id` | path | string | Yes | OCR invoice job ID |
|
|
246
144
|
|
|
247
145
|
##### Request Body
|
|
248
146
|
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
147
|
**Content Types:**
|
|
253
148
|
|
|
254
149
|
- `application/json`
|
|
255
150
|
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
151
|
##### Responses
|
|
260
152
|
|
|
261
|
-
|
|
262
153
|
**200** - OCR invoice job updated successfully
|
|
263
154
|
|
|
264
|
-
|
|
265
|
-
|
|
266
155
|
Content-Type: `application/json`
|
|
267
156
|
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
157
|
**400** - Bad request
|
|
272
158
|
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
159
|
**404** - OCR invoice job not found
|
|
277
160
|
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
161
|
**401** - Unauthorized
|
|
282
162
|
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
163
|
**500** - Internal server error
|
|
287
164
|
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
165
|
---
|
|
293
166
|
|
|
294
|
-
|
|
295
167
|
#### DELETE /ocr-invoice-job/{id}
|
|
296
168
|
|
|
297
169
|
**Summary:** Delete OCR invoice job
|
|
298
170
|
|
|
299
|
-
|
|
300
171
|
**Description:** Delete an existing OCR invoice job
|
|
301
172
|
|
|
302
|
-
|
|
303
|
-
|
|
304
173
|
**Tags:** OCR Invoice Job
|
|
305
174
|
|
|
306
|
-
|
|
307
|
-
|
|
308
175
|
##### Parameters
|
|
309
176
|
|
|
310
177
|
| Name | Location | Type | Required | Description |
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
| `id` | path | string | Yes | OCR invoice job ID |
|
|
314
|
-
|
|
315
|
-
|
|
178
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
316
179
|
|
|
317
180
|
|
|
181
|
+
| `id` | path | string | Yes | OCR invoice job ID |
|
|
318
182
|
|
|
319
183
|
##### Responses
|
|
320
184
|
|
|
321
|
-
|
|
322
185
|
**200** - OCR invoice job deleted successfully
|
|
323
186
|
|
|
324
|
-
|
|
325
|
-
|
|
326
187
|
Content-Type: `application/json`
|
|
327
188
|
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
189
|
**404** - OCR invoice job not found
|
|
332
190
|
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
191
|
**401** - Unauthorized
|
|
337
192
|
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
193
|
**500** - Internal server error
|
|
342
194
|
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
195
|
---
|
|
348
196
|
|
|
349
|
-
|
|
350
|
-
|
|
351
197
|
### `/ocr-invoice-job/{id}/process`
|
|
352
198
|
|
|
353
|
-
|
|
354
199
|
#### POST /ocr-invoice-job/{id}/process
|
|
355
200
|
|
|
356
201
|
**Summary:** Process OCR invoice job
|
|
357
202
|
|
|
358
|
-
|
|
359
203
|
**Description:** Start processing an OCR invoice job
|
|
360
204
|
|
|
361
|
-
|
|
362
|
-
|
|
363
205
|
**Tags:** OCR Invoice Job
|
|
364
206
|
|
|
365
|
-
|
|
366
|
-
|
|
367
207
|
##### Parameters
|
|
368
208
|
|
|
369
209
|
| Name | Location | Type | Required | Description |
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
| `id` | path | string | Yes | OCR invoice job ID |
|
|
373
|
-
|
|
374
|
-
|
|
210
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
375
211
|
|
|
376
212
|
|
|
213
|
+
| `id` | path | string | Yes | OCR invoice job ID |
|
|
377
214
|
|
|
378
215
|
##### Responses
|
|
379
216
|
|
|
380
|
-
|
|
381
217
|
**200** - OCR invoice job processing started
|
|
382
218
|
|
|
383
|
-
|
|
384
|
-
|
|
385
219
|
Content-Type: `application/json`
|
|
386
220
|
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
221
|
**404** - OCR invoice job not found
|
|
391
222
|
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
223
|
**401** - Unauthorized
|
|
396
224
|
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
225
|
**500** - Internal server error
|
|
401
226
|
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
227
|
---
|
|
407
228
|
|
|
408
|
-
|
|
409
|
-
|
|
410
229
|
### `/ocr-invoice-job/{id}/results`
|
|
411
230
|
|
|
412
|
-
|
|
413
231
|
#### GET /ocr-invoice-job/{id}/results
|
|
414
232
|
|
|
415
233
|
**Summary:** Get OCR results
|
|
416
234
|
|
|
417
|
-
|
|
418
235
|
**Description:** Retrieve the OCR processing results for a job
|
|
419
236
|
|
|
420
|
-
|
|
421
|
-
|
|
422
237
|
**Tags:** OCR Invoice Job
|
|
423
238
|
|
|
424
|
-
|
|
425
|
-
|
|
426
239
|
##### Parameters
|
|
427
240
|
|
|
428
241
|
| Name | Location | Type | Required | Description |
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
| `id` | path | string | Yes | OCR invoice job ID |
|
|
432
|
-
|
|
433
|
-
|
|
242
|
+
| ---- | -------- | ---- | -------- | ----------- |
|
|
434
243
|
|
|
435
244
|
|
|
245
|
+
| `id` | path | string | Yes | OCR invoice job ID |
|
|
436
246
|
|
|
437
247
|
##### Responses
|
|
438
248
|
|
|
439
|
-
|
|
440
249
|
**200** - OCR results retrieved successfully
|
|
441
250
|
|
|
442
|
-
|
|
443
|
-
|
|
444
251
|
Content-Type: `application/json`
|
|
445
252
|
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
253
|
**404** - OCR invoice job not found
|
|
450
254
|
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
255
|
**401** - Unauthorized
|
|
455
256
|
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
257
|
**500** - Internal server error
|
|
460
258
|
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
259
|
---
|
|
466
260
|
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
261
|
## Data Models
|
|
471
262
|
|
|
472
|
-
|
|
473
|
-
|
|
474
263
|
### OcrInvoiceJob
|
|
475
264
|
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
265
|
| Property | Type | Required | Description |
|
|
480
|
-
|
|
266
|
+
| -------- | ---- | -------- | ----------- |
|
|
267
|
+
|
|
481
268
|
|
|
482
269
|
| `_id` | string | No | Unique identifier for the OCR invoice job |
|
|
483
270
|
|
|
@@ -529,18 +316,11 @@ Content-Type: `application/json`
|
|
|
529
316
|
|
|
530
317
|
| `updatedAt` | string | No | Record last update timestamp |
|
|
531
318
|
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
319
|
### OcrInvoiceJobInput
|
|
538
320
|
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
321
|
| Property | Type | Required | Description |
|
|
543
|
-
|
|
322
|
+
| -------- | ---- | -------- | ----------- |
|
|
323
|
+
|
|
544
324
|
|
|
545
325
|
| `jobNumber` | string | Yes | Unique job number |
|
|
546
326
|
|
|
@@ -560,18 +340,11 @@ Content-Type: `application/json`
|
|
|
560
340
|
|
|
561
341
|
| `metadata` | object | No | Additional metadata |
|
|
562
342
|
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
343
|
### OcrResults
|
|
569
344
|
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
345
|
| Property | Type | Required | Description |
|
|
574
|
-
|
|
346
|
+
| -------- | ---- | -------- | ----------- |
|
|
347
|
+
|
|
575
348
|
|
|
576
349
|
| `extractedData` | object | No | All extracted data from the document |
|
|
577
350
|
|
|
@@ -581,13 +354,6 @@ Content-Type: `application/json`
|
|
|
581
354
|
|
|
582
355
|
| `processingTime` | number | No | Total processing time |
|
|
583
356
|
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
357
|
## TypeScript Usage
|
|
592
358
|
|
|
593
|
-
See [ocr-invoice-job-examples.md](./ocr-invoice-job-examples.md) for detailed TypeScript usage examples.
|
|
359
|
+
See [ocr-invoice-job-examples.md](./ocr-invoice-job-examples.md) for detailed TypeScript usage examples.
|