repzo 1.0.143 → 1.0.144
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/api/activity-ai-sales-order-examples.md +3 -3
- package/docs/api/activity-ai-sales-order.md +0 -7
- package/docs/api/activity-feedback-examples.md +4 -4
- package/docs/api/activity-feedback-v2-examples.md +5 -5
- package/docs/api/activity-feedback-v2.md +0 -9
- package/docs/api/activity-feedback.md +0 -9
- package/docs/api/activity-storecheck-examples.md +3 -3
- package/docs/api/activity-storecheck.md +0 -6
- package/docs/api/adjust-account-examples.md +3 -3
- package/docs/api/adjust-account.md +0 -5
- package/docs/api/adjust-inventory-examples.md +3 -3
- package/docs/api/adjust-inventory.md +0 -7
- package/docs/api/approval-request-examples.md +3 -3
- package/docs/api/approval-request.md +0 -12
- package/docs/api/approvals-examples.md +3 -3
- package/docs/api/approvals.md +0 -12
- package/docs/api/asset-examples.md +2 -2
- package/docs/api/asset-part-examples.md +3 -3
- package/docs/api/asset-part-receival-examples.md +3 -3
- package/docs/api/asset-part-receival.md +0 -6
- package/docs/api/asset-part-transfer-examples.md +3 -3
- package/docs/api/asset-part-transfer.md +0 -7
- package/docs/api/asset-part-type-examples.md +3 -3
- package/docs/api/asset-part-type.md +0 -6
- package/docs/api/asset-part-unit-examples.md +3 -3
- package/docs/api/asset-part-unit.md +0 -6
- package/docs/api/asset-part.md +0 -6
- package/docs/api/asset-type-examples.md +3 -3
- package/docs/api/asset-type.md +0 -12
- package/docs/api/asset-unit-examples.md +3 -3
- package/docs/api/asset-unit.md +0 -9
- package/docs/api/asset.md +0 -12
- package/docs/api/banks-examples.md +2 -2
- package/docs/api/banks.md +0 -12
- package/docs/api/bankslists-examples.md +3 -3
- package/docs/api/bankslists.md +0 -12
- package/docs/api/brand-examples.md +3 -3
- package/docs/api/brand.md +0 -8
- package/docs/api/category-examples.md +3 -3
- package/docs/api/category.md +0 -8
- package/docs/api/checks-examples.md +2 -2
- package/docs/api/checks.md +0 -5
- package/docs/api/client-channel-examples.md +3 -3
- package/docs/api/client-channel.md +0 -8
- package/docs/api/client-contact-examples.md +3 -3
- package/docs/api/client-contact.md +0 -11
- package/docs/api/client-examples.md +2 -2
- package/docs/api/client-location-examples.md +3 -3
- package/docs/api/client-location.md +0 -9
- package/docs/api/client.md +0 -8
- package/docs/api/contract-examples.md +3 -3
- package/docs/api/contract-installment-examples.md +4 -4
- package/docs/api/contract-installment.md +0 -10
- package/docs/api/contract.md +0 -12
- package/docs/api/custom-list-examples.md +3 -3
- package/docs/api/custom-list-item-examples.md +3 -3
- package/docs/api/custom-list-item.md +0 -12
- package/docs/api/custom-list.md +0 -12
- package/docs/api/custom-status-examples.md +3 -3
- package/docs/api/custom-status.md +0 -12
- package/docs/api/day-examples.md +2 -2
- package/docs/api/day.md +0 -5
- package/docs/api/feedback-options-examples.md +5 -5
- package/docs/api/feedback-options.md +0 -11
- package/docs/api/fullinvoices-examples.md +3 -3
- package/docs/api/fullinvoices.md +0 -10
- package/docs/api/integration-action-log-examples.md +3 -3
- package/docs/api/integration-action-log.md +0 -6
- package/docs/api/integration-app-examples.md +3 -3
- package/docs/api/integration-app.md +0 -7
- package/docs/api/integration-command-log-examples.md +3 -3
- package/docs/api/integration-command-log.md +0 -6
- package/docs/api/inventory-adjustment-reason-examples.md +3 -3
- package/docs/api/inventory-adjustment-reason.md +0 -12
- package/docs/api/inventory-examples.md +2 -2
- package/docs/api/inventory.md +0 -3
- package/docs/api/mail-unsubscribe-examples.md +3 -3
- package/docs/api/mail-unsubscribe.md +0 -6
- package/docs/api/measureunit-examples.md +3 -3
- package/docs/api/measureunit-family-examples.md +3 -3
- package/docs/api/measureunit-family.md +0 -8
- package/docs/api/measureunit.md +0 -9
- package/docs/api/media-examples.md +2 -2
- package/docs/api/media-storage-examples.md +3 -3
- package/docs/api/media-storage.md +0 -8
- package/docs/api/media.md +0 -8
- package/docs/api/msl-examples.md +2 -2
- package/docs/api/msl-products-examples.md +3 -3
- package/docs/api/msl-products.md +0 -12
- package/docs/api/msl.md +0 -12
- package/docs/api/ocr-invoice-job-examples.md +4 -4
- package/docs/api/ocr-invoice-job-group-examples.md +4 -4
- package/docs/api/ocr-invoice-job-group.md +0 -7
- package/docs/api/ocr-invoice-job-page-examples.md +3 -3
- package/docs/api/ocr-invoice-job-page.md +0 -7
- package/docs/api/ocr-invoice-job-template-examples.md +3 -3
- package/docs/api/ocr-invoice-job-template.md +0 -6
- package/docs/api/ocr-invoice-job.md +0 -9
- package/docs/api/patch-action-examples.md +3 -3
- package/docs/api/patch-action.md +0 -7
- package/docs/api/payment-terms-examples.md +3 -3
- package/docs/api/payment-terms.md +0 -13
- package/docs/api/payments-examples.md +3 -3
- package/docs/api/payments.md +0 -10
- package/docs/api/pricelist-examples.md +3 -3
- package/docs/api/pricelist-item-examples.md +3 -3
- package/docs/api/pricelist-item.md +0 -11
- package/docs/api/pricelist.md +0 -8
- package/docs/api/product-examples.md +3 -3
- package/docs/api/product-group-examples.md +3 -3
- package/docs/api/product-group.md +0 -8
- package/docs/api/product-modifiers-group-examples.md +3 -3
- package/docs/api/product-modifiers-group.md +0 -9
- package/docs/api/product.md +0 -9
- package/docs/api/proforma-examples.md +3 -3
- package/docs/api/proforma.md +0 -10
- package/docs/api/quick-convert-to-pdf-examples.md +1 -1
- package/docs/api/quick-convert-to-pdf.md +0 -2
- package/docs/api/receiving-material-examples.md +3 -3
- package/docs/api/receiving-material.md +0 -7
- package/docs/api/refund-examples.md +2 -2
- package/docs/api/refund.md +0 -7
- package/docs/api/rep-balance-summary-examples.md +2 -2
- package/docs/api/rep-balance-summary.md +0 -2
- package/docs/api/rep-examples.md +2 -2
- package/docs/api/rep.md +0 -8
- package/docs/api/return-asset-part-unit-examples.md +3 -3
- package/docs/api/return-asset-part-unit.md +0 -6
- package/docs/api/return-reason-examples.md +3 -3
- package/docs/api/return-reason.md +0 -8
- package/docs/api/route-examples.md +2 -2
- package/docs/api/route.md +0 -8
- package/docs/api/safe-invoice-serial-counter-examples.md +3 -3
- package/docs/api/safe-invoice-serial-counter.md +0 -8
- package/docs/api/settings-examples.md +3 -3
- package/docs/api/settings.md +0 -8
- package/docs/api/settlement-examples.md +3 -3
- package/docs/api/settlement.md +0 -5
- package/docs/api/speciality-examples.md +3 -3
- package/docs/api/speciality.md +0 -8
- package/docs/api/store-asset-part-unit-examples.md +3 -3
- package/docs/api/store-asset-part-unit.md +0 -6
- package/docs/api/storecheck-template-examples.md +3 -3
- package/docs/api/storecheck-template.md +0 -8
- package/docs/api/subcategory-examples.md +3 -3
- package/docs/api/subcategory.md +0 -8
- package/docs/api/supplier-examples.md +3 -3
- package/docs/api/supplier.md +0 -12
- package/docs/api/svix-integration-examples.md +3 -3
- package/docs/api/svix-integration.md +0 -6
- package/docs/api/tag-examples.md +2 -2
- package/docs/api/tag.md +0 -8
- package/docs/api/tax-examples.md +2 -2
- package/docs/api/tax.md +0 -8
- package/docs/api/team-examples.md +2 -2
- package/docs/api/team.md +0 -8
- package/docs/api/transfer-examples.md +3 -3
- package/docs/api/transfer.md +0 -7
- package/docs/api/update-integration-meta-examples.md +3 -3
- package/docs/api/update-integration-meta.md +0 -7
- package/docs/api/variant-examples.md +3 -3
- package/docs/api/variant.md +0 -9
- package/docs/api/visit-examples.md +2 -2
- package/docs/api/visit.md +0 -10
- package/docs/api/warehouse-examples.md +3 -3
- package/docs/api/warehouse.md +0 -8
- package/docs/api/workorder-category-examples.md +3 -3
- package/docs/api/workorder-category.md +0 -9
- package/docs/api/workorder-examples.md +3 -3
- package/docs/api/workorder-portal-examples.md +3 -3
- package/docs/api/workorder-portal-link-examples.md +3 -3
- package/docs/api/workorder-portal-link.md +0 -11
- package/docs/api/workorder-portal.md +0 -9
- package/docs/api/workorder-request-examples.md +3 -3
- package/docs/api/workorder-request.md +0 -12
- package/docs/api/workorder.md +0 -12
- package/lib/index.d.ts +388 -387
- package/lib/index.js +366 -365
- package/lib/types/index.d.ts +14663 -13407
- package/package.json +6 -5
- package/src/types/index.ts +22 -18
|
@@ -37,7 +37,6 @@ This API uses the following authentication methods:
|
|
|
37
37
|
| Name | Location | Type | Required | Description |
|
|
38
38
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
39
39
|
|
|
40
|
-
|
|
41
40
|
| `page` | query | integer | No | Page number for pagination |
|
|
42
41
|
|
|
43
42
|
| `per_page` | query | integer | No | Number of items per page |
|
|
@@ -119,7 +118,6 @@ Content-Type: `application/json`
|
|
|
119
118
|
| Name | Location | Type | Required | Description |
|
|
120
119
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
121
120
|
|
|
122
|
-
|
|
123
121
|
| `id` | path | string | Yes | Channel ID |
|
|
124
122
|
|
|
125
123
|
##### Responses
|
|
@@ -149,7 +147,6 @@ Content-Type: `application/json`
|
|
|
149
147
|
| Name | Location | Type | Required | Description |
|
|
150
148
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
151
149
|
|
|
152
|
-
|
|
153
150
|
| `id` | path | string | Yes | Channel ID |
|
|
154
151
|
|
|
155
152
|
##### Request Body
|
|
@@ -187,7 +184,6 @@ Content-Type: `application/json`
|
|
|
187
184
|
| Name | Location | Type | Required | Description |
|
|
188
185
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
189
186
|
|
|
190
|
-
|
|
191
187
|
| `id` | path | string | Yes | Channel ID |
|
|
192
188
|
|
|
193
189
|
##### Responses
|
|
@@ -211,7 +207,6 @@ Content-Type: `application/json`
|
|
|
211
207
|
| Property | Type | Required | Description |
|
|
212
208
|
| -------- | ---- | -------- | ----------- |
|
|
213
209
|
|
|
214
|
-
|
|
215
210
|
| `_id` | string | Yes | Unique identifier for the channel |
|
|
216
211
|
|
|
217
212
|
| `name` | string | Yes | Channel name |
|
|
@@ -235,7 +230,6 @@ Content-Type: `application/json`
|
|
|
235
230
|
| Property | Type | Required | Description |
|
|
236
231
|
| -------- | ---- | -------- | ----------- |
|
|
237
232
|
|
|
238
|
-
|
|
239
233
|
| `name` | string | Yes | Channel name (required) |
|
|
240
234
|
|
|
241
235
|
| `local_name` | string | No | Local/translated name |
|
|
@@ -251,7 +245,6 @@ Content-Type: `application/json`
|
|
|
251
245
|
| Property | Type | Required | Description |
|
|
252
246
|
| -------- | ---- | -------- | ----------- |
|
|
253
247
|
|
|
254
|
-
|
|
255
248
|
| `name` | string | No | Channel name |
|
|
256
249
|
|
|
257
250
|
| `local_name` | string | No | Local/translated name |
|
|
@@ -275,7 +268,6 @@ Content-Type: `application/json`
|
|
|
275
268
|
| Property | Type | Required | Description |
|
|
276
269
|
| -------- | ---- | -------- | ----------- |
|
|
277
270
|
|
|
278
|
-
|
|
279
271
|
| `page` | integer | No | No description |
|
|
280
272
|
|
|
281
273
|
| `per_page` | integer | No | No description |
|
|
@@ -59,7 +59,7 @@ const result = await fetch(
|
|
|
59
59
|
Authorization: `Bearer ${apiKey}`,
|
|
60
60
|
"Content-Type": "application/json",
|
|
61
61
|
},
|
|
62
|
-
}
|
|
62
|
+
},
|
|
63
63
|
);
|
|
64
64
|
|
|
65
65
|
const data = await result.json();
|
|
@@ -125,7 +125,7 @@ const result = await fetch(
|
|
|
125
125
|
Authorization: `Bearer ${apiKey}`,
|
|
126
126
|
"Content-Type": "application/json",
|
|
127
127
|
},
|
|
128
|
-
}
|
|
128
|
+
},
|
|
129
129
|
);
|
|
130
130
|
|
|
131
131
|
const data = await result.json();
|
|
@@ -264,7 +264,7 @@ const result = await fetch(
|
|
|
264
264
|
Authorization: `Bearer ${apiKey}`,
|
|
265
265
|
"Content-Type": "application/json",
|
|
266
266
|
},
|
|
267
|
-
}
|
|
267
|
+
},
|
|
268
268
|
);
|
|
269
269
|
|
|
270
270
|
const data = await result.json();
|
|
@@ -37,7 +37,6 @@ This API uses the following authentication methods:
|
|
|
37
37
|
| Name | Location | Type | Required | Description |
|
|
38
38
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
39
39
|
|
|
40
|
-
|
|
41
40
|
| `page` | query | integer | No | Page number for pagination |
|
|
42
41
|
|
|
43
42
|
| `per_page` | query | integer | No | Number of items per page |
|
|
@@ -117,7 +116,6 @@ Content-Type: `application/json`
|
|
|
117
116
|
| Name | Location | Type | Required | Description |
|
|
118
117
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
119
118
|
|
|
120
|
-
|
|
121
119
|
| `id` | path | string | Yes | Client contact ID |
|
|
122
120
|
|
|
123
121
|
##### Responses
|
|
@@ -147,7 +145,6 @@ Content-Type: `application/json`
|
|
|
147
145
|
| Name | Location | Type | Required | Description |
|
|
148
146
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
149
147
|
|
|
150
|
-
|
|
151
148
|
| `id` | path | string | Yes | Client contact ID |
|
|
152
149
|
|
|
153
150
|
##### Request Body
|
|
@@ -185,7 +182,6 @@ Content-Type: `application/json`
|
|
|
185
182
|
| Name | Location | Type | Required | Description |
|
|
186
183
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
187
184
|
|
|
188
|
-
|
|
189
185
|
| `id` | path | string | Yes | Client contact ID |
|
|
190
186
|
|
|
191
187
|
##### Responses
|
|
@@ -209,7 +205,6 @@ Content-Type: `application/json`
|
|
|
209
205
|
| Property | Type | Required | Description |
|
|
210
206
|
| -------- | ---- | -------- | ----------- |
|
|
211
207
|
|
|
212
|
-
|
|
213
208
|
| `_id` | string | Yes | Unique identifier for the client contact |
|
|
214
209
|
|
|
215
210
|
| `creator` | object | Yes | User who created this contact |
|
|
@@ -251,7 +246,6 @@ Content-Type: `application/json`
|
|
|
251
246
|
| Property | Type | Required | Description |
|
|
252
247
|
| -------- | ---- | -------- | ----------- |
|
|
253
248
|
|
|
254
|
-
|
|
255
249
|
| `name` | string | Yes | Contact name (required) |
|
|
256
250
|
|
|
257
251
|
| `creator` | object | No | User who created this contact |
|
|
@@ -285,7 +279,6 @@ Content-Type: `application/json`
|
|
|
285
279
|
| Property | Type | Required | Description |
|
|
286
280
|
| -------- | ---- | -------- | ----------- |
|
|
287
281
|
|
|
288
|
-
|
|
289
282
|
| `name` | string | No | Contact name |
|
|
290
283
|
|
|
291
284
|
| `creator` | object | No | User who created this contact |
|
|
@@ -327,7 +320,6 @@ Content-Type: `application/json`
|
|
|
327
320
|
| Property | Type | Required | Description |
|
|
328
321
|
| -------- | ---- | -------- | ----------- |
|
|
329
322
|
|
|
330
|
-
|
|
331
323
|
| `_id` | string | Yes | No description |
|
|
332
324
|
|
|
333
325
|
| `username` | string | Yes | No description |
|
|
@@ -341,7 +333,6 @@ Content-Type: `application/json`
|
|
|
341
333
|
| Property | Type | Required | Description |
|
|
342
334
|
| -------- | ---- | -------- | ----------- |
|
|
343
335
|
|
|
344
|
-
|
|
345
336
|
| `_id` | string | Yes | No description |
|
|
346
337
|
|
|
347
338
|
| `username` | string | Yes | No description |
|
|
@@ -355,7 +346,6 @@ Content-Type: `application/json`
|
|
|
355
346
|
| Property | Type | Required | Description |
|
|
356
347
|
| -------- | ---- | -------- | ----------- |
|
|
357
348
|
|
|
358
|
-
|
|
359
349
|
| `_id` | string | Yes | No description |
|
|
360
350
|
|
|
361
351
|
| `username` | string | Yes | No description |
|
|
@@ -369,7 +359,6 @@ Content-Type: `application/json`
|
|
|
369
359
|
| Property | Type | Required | Description |
|
|
370
360
|
| -------- | ---- | -------- | ----------- |
|
|
371
361
|
|
|
372
|
-
|
|
373
362
|
| `page` | integer | No | No description |
|
|
374
363
|
|
|
375
364
|
| `per_page` | integer | No | No description |
|
|
@@ -96,7 +96,7 @@ const result = await fetch(
|
|
|
96
96
|
Authorization: `Bearer ${apiKey}`,
|
|
97
97
|
"Content-Type": "application/json",
|
|
98
98
|
},
|
|
99
|
-
}
|
|
99
|
+
},
|
|
100
100
|
);
|
|
101
101
|
|
|
102
102
|
const data = await result.json();
|
|
@@ -231,7 +231,7 @@ const result = await fetch(
|
|
|
231
231
|
Authorization: `Bearer ${apiKey}`,
|
|
232
232
|
"Content-Type": "application/json",
|
|
233
233
|
},
|
|
234
|
-
}
|
|
234
|
+
},
|
|
235
235
|
);
|
|
236
236
|
|
|
237
237
|
const data = await result.json();
|
|
@@ -51,7 +51,7 @@ const result = await fetch(
|
|
|
51
51
|
Authorization: `Bearer ${apiKey}`,
|
|
52
52
|
"Content-Type": "application/json",
|
|
53
53
|
},
|
|
54
|
-
}
|
|
54
|
+
},
|
|
55
55
|
);
|
|
56
56
|
|
|
57
57
|
const data = await result.json();
|
|
@@ -117,7 +117,7 @@ const result = await fetch(
|
|
|
117
117
|
Authorization: `Bearer ${apiKey}`,
|
|
118
118
|
"Content-Type": "application/json",
|
|
119
119
|
},
|
|
120
|
-
}
|
|
120
|
+
},
|
|
121
121
|
);
|
|
122
122
|
|
|
123
123
|
const data = await result.json();
|
|
@@ -313,7 +313,7 @@ const result = await fetch(
|
|
|
313
313
|
Authorization: `Bearer ${apiKey}`,
|
|
314
314
|
"Content-Type": "application/json",
|
|
315
315
|
},
|
|
316
|
-
}
|
|
316
|
+
},
|
|
317
317
|
);
|
|
318
318
|
|
|
319
319
|
const data = await result.json();
|
|
@@ -37,7 +37,6 @@ This API uses the following authentication methods:
|
|
|
37
37
|
| Name | Location | Type | Required | Description |
|
|
38
38
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
39
39
|
|
|
40
|
-
|
|
41
40
|
| `page` | query | integer | No | Page number for pagination |
|
|
42
41
|
|
|
43
42
|
| `per_page` | query | integer | No | Number of items per page |
|
|
@@ -115,7 +114,6 @@ Content-Type: `application/json`
|
|
|
115
114
|
| Name | Location | Type | Required | Description |
|
|
116
115
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
117
116
|
|
|
118
|
-
|
|
119
117
|
| `id` | path | string | Yes | Client location ID |
|
|
120
118
|
|
|
121
119
|
##### Responses
|
|
@@ -149,7 +147,6 @@ Content-Type: `application/json`
|
|
|
149
147
|
| Name | Location | Type | Required | Description |
|
|
150
148
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
151
149
|
|
|
152
|
-
|
|
153
150
|
| `id` | path | string | Yes | Client location ID |
|
|
154
151
|
|
|
155
152
|
##### Request Body
|
|
@@ -191,7 +188,6 @@ Content-Type: `application/json`
|
|
|
191
188
|
| Name | Location | Type | Required | Description |
|
|
192
189
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
193
190
|
|
|
194
|
-
|
|
195
191
|
| `id` | path | string | Yes | Client location ID |
|
|
196
192
|
|
|
197
193
|
##### Responses
|
|
@@ -251,7 +247,6 @@ Content-Type: `application/json`
|
|
|
251
247
|
| Property | Type | Required | Description |
|
|
252
248
|
| -------- | ---- | -------- | ----------- |
|
|
253
249
|
|
|
254
|
-
|
|
255
250
|
| `_id` | string | No | Unique identifier |
|
|
256
251
|
|
|
257
252
|
| `client` | string | Yes | Client ID |
|
|
@@ -297,7 +292,6 @@ Content-Type: `application/json`
|
|
|
297
292
|
| Property | Type | Required | Description |
|
|
298
293
|
| -------- | ---- | -------- | ----------- |
|
|
299
294
|
|
|
300
|
-
|
|
301
295
|
| `open` | string | No | Opening time (HH:MM format) |
|
|
302
296
|
|
|
303
297
|
| `close` | string | No | Closing time (HH:MM format) |
|
|
@@ -309,7 +303,6 @@ Content-Type: `application/json`
|
|
|
309
303
|
| Property | Type | Required | Description |
|
|
310
304
|
| -------- | ---- | -------- | ----------- |
|
|
311
305
|
|
|
312
|
-
|
|
313
306
|
| `client` | string | Yes | Client ID |
|
|
314
307
|
|
|
315
308
|
| `name` | string | Yes | Location name |
|
|
@@ -345,7 +338,6 @@ Content-Type: `application/json`
|
|
|
345
338
|
| Property | Type | Required | Description |
|
|
346
339
|
| -------- | ---- | -------- | ----------- |
|
|
347
340
|
|
|
348
|
-
|
|
349
341
|
| `name` | string | No | Location name |
|
|
350
342
|
|
|
351
343
|
| `address` | string | No | Street address |
|
|
@@ -379,7 +371,6 @@ Content-Type: `application/json`
|
|
|
379
371
|
| Property | Type | Required | Description |
|
|
380
372
|
| -------- | ---- | -------- | ----------- |
|
|
381
373
|
|
|
382
|
-
|
|
383
374
|
| `total` | integer | No | Total number of items |
|
|
384
375
|
|
|
385
376
|
| `page` | integer | No | Current page number |
|
package/docs/api/client.md
CHANGED
|
@@ -27,7 +27,6 @@ No authentication required.
|
|
|
27
27
|
| Name | Location | Type | Required | Description |
|
|
28
28
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
29
29
|
|
|
30
|
-
|
|
31
30
|
| `params` | query | object | No | Query parameters for filtering clients |
|
|
32
31
|
|
|
33
32
|
##### Responses
|
|
@@ -67,7 +66,6 @@ Content-Type: `application/json`
|
|
|
67
66
|
| Name | Location | Type | Required | Description |
|
|
68
67
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
69
68
|
|
|
70
|
-
|
|
71
69
|
| `id` | path | string | Yes | No description |
|
|
72
70
|
|
|
73
71
|
##### Responses
|
|
@@ -87,7 +85,6 @@ Content-Type: `application/json`
|
|
|
87
85
|
| Name | Location | Type | Required | Description |
|
|
88
86
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
89
87
|
|
|
90
|
-
|
|
91
88
|
| `id` | path | string | Yes | No description |
|
|
92
89
|
|
|
93
90
|
##### Request Body
|
|
@@ -113,7 +110,6 @@ Content-Type: `application/json`
|
|
|
113
110
|
| Name | Location | Type | Required | Description |
|
|
114
111
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
115
112
|
|
|
116
|
-
|
|
117
113
|
| `id` | path | string | Yes | No description |
|
|
118
114
|
|
|
119
115
|
##### Responses
|
|
@@ -133,7 +129,6 @@ Result of finding clients
|
|
|
133
129
|
| Property | Type | Required | Description |
|
|
134
130
|
| -------- | ---- | -------- | ----------- |
|
|
135
131
|
|
|
136
|
-
|
|
137
132
|
| `data` | array | No | No description |
|
|
138
133
|
|
|
139
134
|
| `total_result` | number | No | Total number of clients |
|
|
@@ -163,7 +158,6 @@ Client schema
|
|
|
163
158
|
| Property | Type | Required | Description |
|
|
164
159
|
| -------- | ---- | -------- | ----------- |
|
|
165
160
|
|
|
166
|
-
|
|
167
161
|
| `_id` | string | No | Unique identifier for the client |
|
|
168
162
|
|
|
169
163
|
| `name` | string | No | Name of the client |
|
|
@@ -283,7 +277,6 @@ Body for creating a client
|
|
|
283
277
|
| Property | Type | Required | Description |
|
|
284
278
|
| -------- | ---- | -------- | ----------- |
|
|
285
279
|
|
|
286
|
-
|
|
287
280
|
| `name` | string | Yes | Name of the client |
|
|
288
281
|
|
|
289
282
|
| `local_name` | string | No | Localized name of the client |
|
|
@@ -389,7 +382,6 @@ Body for updating a client
|
|
|
389
382
|
| Property | Type | Required | Description |
|
|
390
383
|
| -------- | ---- | -------- | ----------- |
|
|
391
384
|
|
|
392
|
-
|
|
393
385
|
| `name` | string | No | Name of the client |
|
|
394
386
|
|
|
395
387
|
| `local_name` | string | No | Localized name of the client |
|
|
@@ -37,7 +37,7 @@ const result = await fetch(
|
|
|
37
37
|
Authorization: `Bearer ${apiKey}`,
|
|
38
38
|
"Content-Type": "application/json",
|
|
39
39
|
},
|
|
40
|
-
}
|
|
40
|
+
},
|
|
41
41
|
);
|
|
42
42
|
|
|
43
43
|
const data = await result.json();
|
|
@@ -99,7 +99,7 @@ const result = await fetch(
|
|
|
99
99
|
Authorization: `Bearer ${apiKey}`,
|
|
100
100
|
"Content-Type": "application/json",
|
|
101
101
|
},
|
|
102
|
-
}
|
|
102
|
+
},
|
|
103
103
|
);
|
|
104
104
|
|
|
105
105
|
const data = await result.json();
|
|
@@ -234,7 +234,7 @@ const result = await fetch(
|
|
|
234
234
|
Authorization: `Bearer ${apiKey}`,
|
|
235
235
|
"Content-Type": "application/json",
|
|
236
236
|
},
|
|
237
|
-
}
|
|
237
|
+
},
|
|
238
238
|
);
|
|
239
239
|
|
|
240
240
|
const data = await result.json();
|
|
@@ -55,7 +55,7 @@ const result = await fetch(
|
|
|
55
55
|
Authorization: `Bearer ${apiKey}`,
|
|
56
56
|
"Content-Type": "application/json",
|
|
57
57
|
},
|
|
58
|
-
}
|
|
58
|
+
},
|
|
59
59
|
);
|
|
60
60
|
|
|
61
61
|
const data = await result.json();
|
|
@@ -121,7 +121,7 @@ const result = await fetch(
|
|
|
121
121
|
Authorization: `Bearer ${apiKey}`,
|
|
122
122
|
"Content-Type": "application/json",
|
|
123
123
|
},
|
|
124
|
-
}
|
|
124
|
+
},
|
|
125
125
|
);
|
|
126
126
|
|
|
127
127
|
const data = await result.json();
|
|
@@ -277,7 +277,7 @@ const result = await fetch(
|
|
|
277
277
|
Authorization: `Bearer ${apiKey}`,
|
|
278
278
|
"Content-Type": "application/json",
|
|
279
279
|
},
|
|
280
|
-
}
|
|
280
|
+
},
|
|
281
281
|
);
|
|
282
282
|
|
|
283
283
|
const data = await result.json();
|
|
@@ -360,7 +360,7 @@ const result = await fetch(
|
|
|
360
360
|
Authorization: `Bearer ${apiKey}`,
|
|
361
361
|
"Content-Type": "application/json",
|
|
362
362
|
},
|
|
363
|
-
}
|
|
363
|
+
},
|
|
364
364
|
);
|
|
365
365
|
|
|
366
366
|
const data = await result.json();
|
|
@@ -37,7 +37,6 @@ This API uses the following authentication methods:
|
|
|
37
37
|
| Name | Location | Type | Required | Description |
|
|
38
38
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
39
39
|
|
|
40
|
-
|
|
41
40
|
| `page` | query | integer | No | Page number for pagination |
|
|
42
41
|
|
|
43
42
|
| `per_page` | query | integer | No | Number of items per page |
|
|
@@ -119,7 +118,6 @@ Content-Type: `application/json`
|
|
|
119
118
|
| Name | Location | Type | Required | Description |
|
|
120
119
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
121
120
|
|
|
122
|
-
|
|
123
121
|
| `id` | path | string | Yes | Contract installment ID |
|
|
124
122
|
|
|
125
123
|
##### Responses
|
|
@@ -153,7 +151,6 @@ Content-Type: `application/json`
|
|
|
153
151
|
| Name | Location | Type | Required | Description |
|
|
154
152
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
155
153
|
|
|
156
|
-
|
|
157
154
|
| `id` | path | string | Yes | Contract installment ID |
|
|
158
155
|
|
|
159
156
|
##### Request Body
|
|
@@ -195,7 +192,6 @@ Content-Type: `application/json`
|
|
|
195
192
|
| Name | Location | Type | Required | Description |
|
|
196
193
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
197
194
|
|
|
198
|
-
|
|
199
195
|
| `id` | path | string | Yes | Contract installment ID |
|
|
200
196
|
|
|
201
197
|
##### Responses
|
|
@@ -231,7 +227,6 @@ Content-Type: `application/json`
|
|
|
231
227
|
| Name | Location | Type | Required | Description |
|
|
232
228
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
233
229
|
|
|
234
|
-
|
|
235
230
|
| `id` | path | string | Yes | Contract installment ID |
|
|
236
231
|
|
|
237
232
|
##### Request Body
|
|
@@ -273,7 +268,6 @@ Content-Type: `application/json`
|
|
|
273
268
|
| Name | Location | Type | Required | Description |
|
|
274
269
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
275
270
|
|
|
276
|
-
|
|
277
271
|
| `page` | query | integer | No | Page number for pagination |
|
|
278
272
|
|
|
279
273
|
| `per_page` | query | integer | No | Number of items per page |
|
|
@@ -303,7 +297,6 @@ Content-Type: `application/json`
|
|
|
303
297
|
| Property | Type | Required | Description |
|
|
304
298
|
| -------- | ---- | -------- | ----------- |
|
|
305
299
|
|
|
306
|
-
|
|
307
300
|
| `_id` | string | No | Unique identifier |
|
|
308
301
|
|
|
309
302
|
| `contract` | string | Yes | Contract ID reference |
|
|
@@ -361,7 +354,6 @@ Content-Type: `application/json`
|
|
|
361
354
|
| Property | Type | Required | Description |
|
|
362
355
|
| -------- | ---- | -------- | ----------- |
|
|
363
356
|
|
|
364
|
-
|
|
365
357
|
| `contract` | string | Yes | Contract ID reference |
|
|
366
358
|
|
|
367
359
|
| `installment_number` | integer | Yes | Installment sequence number |
|
|
@@ -393,7 +385,6 @@ Content-Type: `application/json`
|
|
|
393
385
|
| Property | Type | Required | Description |
|
|
394
386
|
| -------- | ---- | -------- | ----------- |
|
|
395
387
|
|
|
396
|
-
|
|
397
388
|
| `due_date` | string | No | Due date for this installment |
|
|
398
389
|
|
|
399
390
|
| `amount` | number | No | Installment amount |
|
|
@@ -429,7 +420,6 @@ Content-Type: `application/json`
|
|
|
429
420
|
| Property | Type | Required | Description |
|
|
430
421
|
| -------- | ---- | -------- | ----------- |
|
|
431
422
|
|
|
432
|
-
|
|
433
423
|
| `total` | integer | No | Total number of items |
|
|
434
424
|
|
|
435
425
|
| `page` | integer | No | Current page number |
|
package/docs/api/contract.md
CHANGED
|
@@ -27,7 +27,6 @@ No authentication required.
|
|
|
27
27
|
| Name | Location | Type | Required | Description |
|
|
28
28
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
29
29
|
|
|
30
|
-
|
|
31
30
|
| `params` | query | object | No | Query parameters for filtering contracts |
|
|
32
31
|
|
|
33
32
|
##### Responses
|
|
@@ -67,7 +66,6 @@ Content-Type: `application/json`
|
|
|
67
66
|
| Name | Location | Type | Required | Description |
|
|
68
67
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
69
68
|
|
|
70
|
-
|
|
71
69
|
| `id` | path | string | Yes | No description |
|
|
72
70
|
|
|
73
71
|
##### Responses
|
|
@@ -87,7 +85,6 @@ Content-Type: `application/json`
|
|
|
87
85
|
| Name | Location | Type | Required | Description |
|
|
88
86
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
89
87
|
|
|
90
|
-
|
|
91
88
|
| `id` | path | string | Yes | No description |
|
|
92
89
|
|
|
93
90
|
##### Request Body
|
|
@@ -113,7 +110,6 @@ Content-Type: `application/json`
|
|
|
113
110
|
| Name | Location | Type | Required | Description |
|
|
114
111
|
| ---- | -------- | ---- | -------- | ----------- |
|
|
115
112
|
|
|
116
|
-
|
|
117
113
|
| `id` | path | string | Yes | No description |
|
|
118
114
|
|
|
119
115
|
##### Responses
|
|
@@ -131,7 +127,6 @@ Content-Type: `application/json`
|
|
|
131
127
|
| Property | Type | Required | Description |
|
|
132
128
|
| -------- | ---- | -------- | ----------- |
|
|
133
129
|
|
|
134
|
-
|
|
135
130
|
| `data` | array | No | No description |
|
|
136
131
|
|
|
137
132
|
| `meta` | object | No | No description |
|
|
@@ -141,7 +136,6 @@ Content-Type: `application/json`
|
|
|
141
136
|
| Property | Type | Required | Description |
|
|
142
137
|
| -------- | ---- | -------- | ----------- |
|
|
143
138
|
|
|
144
|
-
|
|
145
139
|
| `title` | string | No | No description |
|
|
146
140
|
|
|
147
141
|
| `client` | string | No | No description |
|
|
@@ -165,7 +159,6 @@ Content-Type: `application/json`
|
|
|
165
159
|
| Property | Type | Required | Description |
|
|
166
160
|
| -------- | ---- | -------- | ----------- |
|
|
167
161
|
|
|
168
|
-
|
|
169
162
|
| `data` | object | No | No description |
|
|
170
163
|
|
|
171
164
|
### ContractGetResult
|
|
@@ -173,7 +166,6 @@ Content-Type: `application/json`
|
|
|
173
166
|
| Property | Type | Required | Description |
|
|
174
167
|
| -------- | ---- | -------- | ----------- |
|
|
175
168
|
|
|
176
|
-
|
|
177
169
|
| `data` | object | No | No description |
|
|
178
170
|
|
|
179
171
|
### ContractUpdateBody
|
|
@@ -181,7 +173,6 @@ Content-Type: `application/json`
|
|
|
181
173
|
| Property | Type | Required | Description |
|
|
182
174
|
| -------- | ---- | -------- | ----------- |
|
|
183
175
|
|
|
184
|
-
|
|
185
176
|
| `title` | string | No | No description |
|
|
186
177
|
|
|
187
178
|
| `client` | string | No | No description |
|
|
@@ -205,7 +196,6 @@ Content-Type: `application/json`
|
|
|
205
196
|
| Property | Type | Required | Description |
|
|
206
197
|
| -------- | ---- | -------- | ----------- |
|
|
207
198
|
|
|
208
|
-
|
|
209
199
|
| `data` | object | No | No description |
|
|
210
200
|
|
|
211
201
|
### ContractRemoveResult
|
|
@@ -213,7 +203,6 @@ Content-Type: `application/json`
|
|
|
213
203
|
| Property | Type | Required | Description |
|
|
214
204
|
| -------- | ---- | -------- | ----------- |
|
|
215
205
|
|
|
216
|
-
|
|
217
206
|
| `success` | boolean | No | No description |
|
|
218
207
|
|
|
219
208
|
### Contract
|
|
@@ -221,7 +210,6 @@ Content-Type: `application/json`
|
|
|
221
210
|
| Property | Type | Required | Description |
|
|
222
211
|
| -------- | ---- | -------- | ----------- |
|
|
223
212
|
|
|
224
|
-
|
|
225
213
|
| `_id` | string | No | No description |
|
|
226
214
|
|
|
227
215
|
| `title` | string | No | No description |
|
|
@@ -37,7 +37,7 @@ const result = await fetch(
|
|
|
37
37
|
Authorization: `Bearer ${apiKey}`,
|
|
38
38
|
"Content-Type": "application/json",
|
|
39
39
|
},
|
|
40
|
-
}
|
|
40
|
+
},
|
|
41
41
|
);
|
|
42
42
|
|
|
43
43
|
const data = await result.json();
|
|
@@ -99,7 +99,7 @@ const result = await fetch(
|
|
|
99
99
|
Authorization: `Bearer ${apiKey}`,
|
|
100
100
|
"Content-Type": "application/json",
|
|
101
101
|
},
|
|
102
|
-
}
|
|
102
|
+
},
|
|
103
103
|
);
|
|
104
104
|
|
|
105
105
|
const data = await result.json();
|
|
@@ -234,7 +234,7 @@ const result = await fetch(
|
|
|
234
234
|
Authorization: `Bearer ${apiKey}`,
|
|
235
235
|
"Content-Type": "application/json",
|
|
236
236
|
},
|
|
237
|
-
}
|
|
237
|
+
},
|
|
238
238
|
);
|
|
239
239
|
|
|
240
240
|
const data = await result.json();
|
|
@@ -37,7 +37,7 @@ const result = await fetch(
|
|
|
37
37
|
Authorization: `Bearer ${apiKey}`,
|
|
38
38
|
"Content-Type": "application/json",
|
|
39
39
|
},
|
|
40
|
-
}
|
|
40
|
+
},
|
|
41
41
|
);
|
|
42
42
|
|
|
43
43
|
const data = await result.json();
|
|
@@ -99,7 +99,7 @@ const result = await fetch(
|
|
|
99
99
|
Authorization: `Bearer ${apiKey}`,
|
|
100
100
|
"Content-Type": "application/json",
|
|
101
101
|
},
|
|
102
|
-
}
|
|
102
|
+
},
|
|
103
103
|
);
|
|
104
104
|
|
|
105
105
|
const data = await result.json();
|
|
@@ -234,7 +234,7 @@ const result = await fetch(
|
|
|
234
234
|
Authorization: `Bearer ${apiKey}`,
|
|
235
235
|
"Content-Type": "application/json",
|
|
236
236
|
},
|
|
237
|
-
}
|
|
237
|
+
},
|
|
238
238
|
);
|
|
239
239
|
|
|
240
240
|
const data = await result.json();
|