repzo 1.0.155 → 1.0.157
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/lib/index.d.ts +1 -2
- package/lib/index.js +1 -1
- package/lib/types/index.d.ts +2 -2
- package/package.json +2 -2
- package/src/index.ts +4890 -0
- package/src/oas/activity-ai-sales-order.yaml +623 -0
- package/src/oas/activity-feedback-v2.yaml +753 -0
- package/src/oas/activity-feedback.yaml +645 -0
- package/src/oas/activity-storecheck.yaml +379 -0
- package/src/oas/adjust-account.yaml +241 -0
- package/src/oas/adjust-inventory.yaml +133 -0
- package/src/oas/approval-request.yaml +211 -0
- package/src/oas/approvals.yaml +176 -0
- package/src/oas/asset-part-receival.yaml +591 -0
- package/src/oas/asset-part-transfer.yaml +618 -0
- package/src/oas/asset-part-type.yaml +383 -0
- package/src/oas/asset-part-unit.yaml +722 -0
- package/src/oas/asset-part.yaml +485 -0
- package/src/oas/asset-type.yaml +180 -0
- package/src/oas/asset-unit.yaml +705 -0
- package/src/oas/asset.yaml +204 -0
- package/src/oas/banks.yaml +168 -0
- package/src/oas/bankslists.yaml +168 -0
- package/src/oas/brand.yaml +246 -0
- package/src/oas/category.yaml +285 -0
- package/src/oas/checks.yaml +247 -0
- package/src/oas/client-channel.yaml +480 -0
- package/src/oas/client-contact.yaml +665 -0
- package/src/oas/client-location.yaml +687 -0
- package/src/oas/client.yaml +669 -0
- package/src/oas/contract-installment.yaml +740 -0
- package/src/oas/contract.yaml +210 -0
- package/src/oas/custom-list-item.yaml +168 -0
- package/src/oas/custom-list.yaml +168 -0
- package/src/oas/custom-status.yaml +168 -0
- package/src/oas/day.yaml +246 -0
- package/src/oas/feedback-options.yaml +802 -0
- package/src/oas/fullinvoices.yaml +584 -0
- package/src/oas/integration-action-log.yaml +361 -0
- package/src/oas/integration-app.yaml +303 -0
- package/src/oas/integration-command-log.yaml +381 -0
- package/src/oas/inventory-adjustment-reason.yaml +165 -0
- package/src/oas/inventory.yaml +64 -0
- package/src/oas/mail-unsubscribe.yaml +463 -0
- package/src/oas/measureunit-family.yaml +354 -0
- package/src/oas/measureunit.yaml +366 -0
- package/src/oas/media-storage.yaml +329 -0
- package/src/oas/media.yaml +472 -0
- package/src/oas/msl-products.yaml +180 -0
- package/src/oas/msl.yaml +186 -0
- package/src/oas/ocr-invoice-job-group.yaml +528 -0
- package/src/oas/ocr-invoice-job-page.yaml +602 -0
- package/src/oas/ocr-invoice-job-template.yaml +628 -0
- package/src/oas/ocr-invoice-job.yaml +603 -0
- package/src/oas/patch-action.yaml +421 -0
- package/src/oas/payment-terms.yaml +235 -0
- package/src/oas/payments.yaml +536 -0
- package/src/oas/pricelist-item.yaml +369 -0
- package/src/oas/pricelist.yaml +287 -0
- package/src/oas/product-group.yaml +278 -0
- package/src/oas/product-modifiers-group.yaml +524 -0
- package/src/oas/product.yaml +578 -0
- package/src/oas/proforma.yaml +180 -0
- package/src/oas/quick-convert-to-pdf.yaml +95 -0
- package/src/oas/receiving-material.yaml +336 -0
- package/src/oas/refund.yaml +281 -0
- package/src/oas/rep-balance-summary.yaml +135 -0
- package/src/oas/rep.yaml +1824 -0
- package/src/oas/return-asset-part-unit.yaml +573 -0
- package/src/oas/return-reason.yaml +286 -0
- package/src/oas/route.yaml +337 -0
- package/src/oas/safe-invoice-serial-counter.yaml +525 -0
- package/src/oas/settings.yaml +123 -0
- package/src/oas/settlement.yaml +505 -0
- package/src/oas/speciality.yaml +447 -0
- package/src/oas/store-asset-part-unit.yaml +658 -0
- package/src/oas/storecheck-template.yaml +415 -0
- package/src/oas/subcategory.yaml +355 -0
- package/src/oas/supplier.yaml +183 -0
- package/src/oas/svix-integration.yaml +335 -0
- package/src/oas/tag.yaml +272 -0
- package/src/oas/tax.yaml +303 -0
- package/src/oas/team.yaml +268 -0
- package/src/oas/transfer.yaml +347 -0
- package/src/oas/update-integration-meta.yaml +387 -0
- package/src/oas/variant.yaml +569 -0
- package/src/oas/visit.yaml +174 -0
- package/src/oas/warehouse.yaml +311 -0
- package/src/oas/workorder-category.yaml +751 -0
- package/src/oas/workorder-portal-link.yaml +811 -0
- package/src/oas/workorder-portal.yaml +650 -0
- package/src/oas/workorder-request.yaml +193 -0
- package/src/oas/workorder.yaml +204 -0
- package/src/types/index.ts +2 -1
package/src/oas/rep.yaml
ADDED
|
@@ -0,0 +1,1824 @@
|
|
|
1
|
+
openapi: 3.0.3
|
|
2
|
+
info:
|
|
3
|
+
title: Repzo API - Rep
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
description: OpenAPI specification for Repzo Rep (Sales Representative) endpoints.
|
|
6
|
+
servers:
|
|
7
|
+
- url: https://sv.api.repzo.me
|
|
8
|
+
paths:
|
|
9
|
+
/rep:
|
|
10
|
+
get:
|
|
11
|
+
summary: Find reps
|
|
12
|
+
operationId: findReps
|
|
13
|
+
parameters:
|
|
14
|
+
- in: query
|
|
15
|
+
name: params
|
|
16
|
+
schema:
|
|
17
|
+
type: object
|
|
18
|
+
properties:
|
|
19
|
+
_id:
|
|
20
|
+
oneOf:
|
|
21
|
+
- type: array
|
|
22
|
+
items:
|
|
23
|
+
type: string
|
|
24
|
+
- type: string
|
|
25
|
+
search:
|
|
26
|
+
type: string
|
|
27
|
+
name:
|
|
28
|
+
oneOf:
|
|
29
|
+
- type: array
|
|
30
|
+
items:
|
|
31
|
+
type: string
|
|
32
|
+
- type: string
|
|
33
|
+
team_id:
|
|
34
|
+
oneOf:
|
|
35
|
+
- type: array
|
|
36
|
+
items:
|
|
37
|
+
type: string
|
|
38
|
+
- type: string
|
|
39
|
+
password:
|
|
40
|
+
type: string
|
|
41
|
+
email:
|
|
42
|
+
type: string
|
|
43
|
+
phone:
|
|
44
|
+
type: string
|
|
45
|
+
username:
|
|
46
|
+
type: string
|
|
47
|
+
disabled:
|
|
48
|
+
type: boolean
|
|
49
|
+
role:
|
|
50
|
+
oneOf:
|
|
51
|
+
- type: array
|
|
52
|
+
items:
|
|
53
|
+
type: string
|
|
54
|
+
- type: string
|
|
55
|
+
from_updatedAt:
|
|
56
|
+
type: number
|
|
57
|
+
from__id:
|
|
58
|
+
type: string
|
|
59
|
+
to__id:
|
|
60
|
+
type: string
|
|
61
|
+
createdAt:
|
|
62
|
+
type: number
|
|
63
|
+
updatedAt:
|
|
64
|
+
type: number
|
|
65
|
+
identifier:
|
|
66
|
+
oneOf:
|
|
67
|
+
- type: array
|
|
68
|
+
items:
|
|
69
|
+
type: number
|
|
70
|
+
- type: number
|
|
71
|
+
msl_sales:
|
|
72
|
+
oneOf:
|
|
73
|
+
- type: array
|
|
74
|
+
items:
|
|
75
|
+
type: string
|
|
76
|
+
- type: string
|
|
77
|
+
job_category:
|
|
78
|
+
oneOf:
|
|
79
|
+
- type: array
|
|
80
|
+
items:
|
|
81
|
+
type: string
|
|
82
|
+
- type: string
|
|
83
|
+
assigned_warehouse:
|
|
84
|
+
oneOf:
|
|
85
|
+
- type: array
|
|
86
|
+
items:
|
|
87
|
+
type: string
|
|
88
|
+
- type: string
|
|
89
|
+
assigned_main_warehouse:
|
|
90
|
+
oneOf:
|
|
91
|
+
- type: array
|
|
92
|
+
items:
|
|
93
|
+
type: string
|
|
94
|
+
- type: string
|
|
95
|
+
assigned_plan:
|
|
96
|
+
oneOf:
|
|
97
|
+
- type: array
|
|
98
|
+
items:
|
|
99
|
+
type: string
|
|
100
|
+
- type: string
|
|
101
|
+
force_online_connectivity:
|
|
102
|
+
type: boolean
|
|
103
|
+
assigned_targets:
|
|
104
|
+
oneOf:
|
|
105
|
+
- type: array
|
|
106
|
+
items:
|
|
107
|
+
type: string
|
|
108
|
+
- type: string
|
|
109
|
+
lines:
|
|
110
|
+
oneOf:
|
|
111
|
+
- type: array
|
|
112
|
+
items:
|
|
113
|
+
type: string
|
|
114
|
+
- type: string
|
|
115
|
+
job_option:
|
|
116
|
+
oneOf:
|
|
117
|
+
- type: array
|
|
118
|
+
items:
|
|
119
|
+
type: number
|
|
120
|
+
enum: [0, 1, 2]
|
|
121
|
+
- type: number
|
|
122
|
+
enum: [0, 1, 2]
|
|
123
|
+
is_test:
|
|
124
|
+
type: boolean
|
|
125
|
+
form_v2_option:
|
|
126
|
+
type: string
|
|
127
|
+
enum: ["all", "none", "assigned", "client_assigned"]
|
|
128
|
+
assigned_forms_v2:
|
|
129
|
+
oneOf:
|
|
130
|
+
- type: array
|
|
131
|
+
items:
|
|
132
|
+
type: string
|
|
133
|
+
- type: string
|
|
134
|
+
retail_execution_template_option:
|
|
135
|
+
type: string
|
|
136
|
+
enum: ["all", "client_assigned", "assigned", "none"]
|
|
137
|
+
assigned_retail_execution_templates:
|
|
138
|
+
oneOf:
|
|
139
|
+
- type: array
|
|
140
|
+
items:
|
|
141
|
+
type: string
|
|
142
|
+
- type: string
|
|
143
|
+
media:
|
|
144
|
+
oneOf:
|
|
145
|
+
- type: array
|
|
146
|
+
items:
|
|
147
|
+
type: string
|
|
148
|
+
- type: string
|
|
149
|
+
cover_photo:
|
|
150
|
+
type: string
|
|
151
|
+
last_login_time:
|
|
152
|
+
type: number
|
|
153
|
+
populatedKeys:
|
|
154
|
+
type: array
|
|
155
|
+
items:
|
|
156
|
+
type: string
|
|
157
|
+
enum:
|
|
158
|
+
[
|
|
159
|
+
"line",
|
|
160
|
+
"lines",
|
|
161
|
+
"job_category",
|
|
162
|
+
"teams",
|
|
163
|
+
"assigned_forms_v2",
|
|
164
|
+
"cover_photo",
|
|
165
|
+
"assigned_plan",
|
|
166
|
+
"assigned_retail_execution_templates",
|
|
167
|
+
"warehouse",
|
|
168
|
+
]
|
|
169
|
+
withProductLines:
|
|
170
|
+
type: boolean
|
|
171
|
+
withStatus:
|
|
172
|
+
type: boolean
|
|
173
|
+
sortBy:
|
|
174
|
+
type: array
|
|
175
|
+
items:
|
|
176
|
+
type: object
|
|
177
|
+
properties:
|
|
178
|
+
field:
|
|
179
|
+
type: string
|
|
180
|
+
enum: [_id]
|
|
181
|
+
type:
|
|
182
|
+
type: string
|
|
183
|
+
enum: [asc, desc]
|
|
184
|
+
"permissions.rep_can_add_client":
|
|
185
|
+
type: boolean
|
|
186
|
+
"permissions.rep_can_edit_client":
|
|
187
|
+
type: boolean
|
|
188
|
+
"permissions.rep_can_add_calendar":
|
|
189
|
+
type: boolean
|
|
190
|
+
"permissions.rep_can_edit_calendar":
|
|
191
|
+
type: boolean
|
|
192
|
+
"permissions.rep_can_skip_photo_tag":
|
|
193
|
+
type: boolean
|
|
194
|
+
"permissions.rep_can_edit_others_calendar":
|
|
195
|
+
type: boolean
|
|
196
|
+
"permissions.rep_can_edit_product_price":
|
|
197
|
+
type: boolean
|
|
198
|
+
"permissions.rep_must_add_client_with_location":
|
|
199
|
+
type: boolean
|
|
200
|
+
"permissions.rep_can_access_shared_history":
|
|
201
|
+
type: boolean
|
|
202
|
+
"permissions.rep_can_edit_total_shelf_share":
|
|
203
|
+
type: boolean
|
|
204
|
+
"permissions.rep_can_create_transfer":
|
|
205
|
+
type: boolean
|
|
206
|
+
"permissions.rep_can_make_call":
|
|
207
|
+
type: boolean
|
|
208
|
+
"permissions.rep_can_read_stock":
|
|
209
|
+
type: boolean
|
|
210
|
+
"permissions.can_rep_pay_other_reps_invoices":
|
|
211
|
+
type: boolean
|
|
212
|
+
"permissions.rep_can_create_sales_order":
|
|
213
|
+
type: boolean
|
|
214
|
+
"permissions.rep_can_create_invoice":
|
|
215
|
+
type: boolean
|
|
216
|
+
"permissions.rep_can_create_transfer_load":
|
|
217
|
+
type: boolean
|
|
218
|
+
"permissions.rep_can_create_transfer_unload":
|
|
219
|
+
type: boolean
|
|
220
|
+
"permissions.rep_can_create_return_invoice":
|
|
221
|
+
type: boolean
|
|
222
|
+
"permissions.rep_can_create_partial_return_invoice":
|
|
223
|
+
type: boolean
|
|
224
|
+
"permissions.rep_can_sell_zero_product_price":
|
|
225
|
+
type: boolean
|
|
226
|
+
"permissions.rep_can_create_sales_order_out_of_visit":
|
|
227
|
+
type: boolean
|
|
228
|
+
"permissions.rep_can_create_cash_invoice":
|
|
229
|
+
type: boolean
|
|
230
|
+
"permissions.rep_can_sell_above_product_price":
|
|
231
|
+
type: boolean
|
|
232
|
+
"permissions.rep_can_sell_below_product_price":
|
|
233
|
+
type: boolean
|
|
234
|
+
"permissions.rep_can_create_return_out_of_visit":
|
|
235
|
+
type: boolean
|
|
236
|
+
"permissions.rep_can_create_partial_return_out_of_visit":
|
|
237
|
+
type: boolean
|
|
238
|
+
"permissions.rep_can_skip_return_reason":
|
|
239
|
+
type: boolean
|
|
240
|
+
"permissions.rep_can_create_invoice_out_of_visit":
|
|
241
|
+
type: boolean
|
|
242
|
+
"permissions.rep_can_create_free_payments":
|
|
243
|
+
type: boolean
|
|
244
|
+
"permissions.rep_can_partially_pay_invoice":
|
|
245
|
+
type: boolean
|
|
246
|
+
"permissions.auto_close_visit_when_out_of_geo_fence":
|
|
247
|
+
type: boolean
|
|
248
|
+
"permissions.end_visit_when_out_of_geofence":
|
|
249
|
+
type: boolean
|
|
250
|
+
"permissions.end_visit_when_low_accuracy":
|
|
251
|
+
type: boolean
|
|
252
|
+
"permissions.rep_can_create_workorder":
|
|
253
|
+
type: boolean
|
|
254
|
+
"permissions.rep_can_create_asset":
|
|
255
|
+
type: boolean
|
|
256
|
+
"permissions.rep_can_skip_promotions":
|
|
257
|
+
type: boolean
|
|
258
|
+
"permissions.rep_can_skip_item_status_feedback":
|
|
259
|
+
type: boolean
|
|
260
|
+
"permissions.rep_can_skip_item_status_note":
|
|
261
|
+
type: boolean
|
|
262
|
+
"permissions.rep_can_skip_item_status_type":
|
|
263
|
+
type: boolean
|
|
264
|
+
"permissions.rep_can_end_visit_without_submitting_item_status":
|
|
265
|
+
type: boolean
|
|
266
|
+
"permissions.rep_can_submit_multiple_item_status_products":
|
|
267
|
+
type: boolean
|
|
268
|
+
"permissions.rep_can_edit_return_product_price":
|
|
269
|
+
type: boolean
|
|
270
|
+
"permissions.rep_can_skip_cart_calculation_until_checkout":
|
|
271
|
+
type: boolean
|
|
272
|
+
"permissions.rep_can_start_day_without_gps_signal":
|
|
273
|
+
type: boolean
|
|
274
|
+
"permissions.rep_can_create_add_client_approval_request":
|
|
275
|
+
type: boolean
|
|
276
|
+
"permissions.rep_can_create_edit_client_details_approval_request":
|
|
277
|
+
type: boolean
|
|
278
|
+
"permissions.rep_can_create_edit_client_assigned_to_approval_request":
|
|
279
|
+
type: boolean
|
|
280
|
+
"permissions.rep_can_create_edit_client_location_approval_request":
|
|
281
|
+
type: boolean
|
|
282
|
+
"permissions.rep_can_create_delete_client_approval_request":
|
|
283
|
+
type: boolean
|
|
284
|
+
"permissions.rep_can_create_skip_job_at_visit_end_approval_request":
|
|
285
|
+
type: boolean
|
|
286
|
+
"permissions.rep_can_create_skip_geofence_at_visit_end_approval_request":
|
|
287
|
+
type: boolean
|
|
288
|
+
"permissions.rep_can_create_credit_invoice_for_cash_client":
|
|
289
|
+
type: boolean
|
|
290
|
+
"permissions.rep_can_view_client_credit_limit":
|
|
291
|
+
type: boolean
|
|
292
|
+
"permissions.rep_can_create_edit_client_credit_limit_approval_request":
|
|
293
|
+
type: boolean
|
|
294
|
+
"permissions.rep_can_assign_workorder":
|
|
295
|
+
type: boolean
|
|
296
|
+
"permissions.rep_can_visit_outside_route":
|
|
297
|
+
type: boolean
|
|
298
|
+
"permissions.rep_can_edit_retail_execution_entry":
|
|
299
|
+
type: boolean
|
|
300
|
+
"permissions.rep_can_edit_form_entry":
|
|
301
|
+
type: boolean
|
|
302
|
+
"permissions.rep_can_skip_visit_from_route_sequence":
|
|
303
|
+
type: boolean
|
|
304
|
+
"permissions.rep_can_create_return_sales_order":
|
|
305
|
+
type: boolean
|
|
306
|
+
"permissions.rep_can_edit_sales_order_custom_status":
|
|
307
|
+
type: boolean
|
|
308
|
+
"permissions.rep_can_edit_invoice_custom_status":
|
|
309
|
+
type: boolean
|
|
310
|
+
"permissions.rep_can_start_day_with_outstanding_settlement_balance":
|
|
311
|
+
type: boolean
|
|
312
|
+
"permissions.rep_to_create_invoice_variant_batch_from_assigned_warehouse":
|
|
313
|
+
type: boolean
|
|
314
|
+
"permissions.rep_to_create_sales_order_variant_batch_assigned_main_warehouse":
|
|
315
|
+
type: boolean
|
|
316
|
+
"permissions.rep_can_create_pull_from_client_assigned_to_approval_request":
|
|
317
|
+
type: boolean
|
|
318
|
+
"permissions.rep_must_end_day_after_specific_time":
|
|
319
|
+
type: boolean
|
|
320
|
+
"permissions.rep_can_create_negative_invoice":
|
|
321
|
+
type: boolean
|
|
322
|
+
"settings.rep_must_end_day_after":
|
|
323
|
+
type: string
|
|
324
|
+
pattern: "^[0-9]{1,2}:[0-9]{2}$"
|
|
325
|
+
"settings.allowable_accuracy":
|
|
326
|
+
type: number
|
|
327
|
+
"settings.is_item_status_per_visit_limited":
|
|
328
|
+
type: boolean
|
|
329
|
+
"settings.item_status_per_visit_limit":
|
|
330
|
+
type: number
|
|
331
|
+
"settings.location_permission":
|
|
332
|
+
type: string
|
|
333
|
+
enum: ["always_allow", "while_using"]
|
|
334
|
+
"settings.activities_report_scope":
|
|
335
|
+
type: string
|
|
336
|
+
enum: ["self", "team", "company_namespace"]
|
|
337
|
+
"settings.maximum_cash_outstanding_settlement_balance_to_start_day":
|
|
338
|
+
type: number
|
|
339
|
+
"settings.maximum_check_outstanding_settlement_balance_to_start_day":
|
|
340
|
+
type: number
|
|
341
|
+
"settings.maximum_total_outstanding_settlement_balance_to_start_day":
|
|
342
|
+
type: number
|
|
343
|
+
"settings.watermark_client_name":
|
|
344
|
+
type: boolean
|
|
345
|
+
"settings.watermark_time":
|
|
346
|
+
type: boolean
|
|
347
|
+
"settings.watermark_date":
|
|
348
|
+
type: boolean
|
|
349
|
+
"settings.watermark_coordinates":
|
|
350
|
+
type: boolean
|
|
351
|
+
description: Query parameters for filtering reps
|
|
352
|
+
responses:
|
|
353
|
+
"200":
|
|
354
|
+
description: A list of reps
|
|
355
|
+
content:
|
|
356
|
+
application/json:
|
|
357
|
+
schema:
|
|
358
|
+
$ref: "#/components/schemas/RepFindResult"
|
|
359
|
+
post:
|
|
360
|
+
summary: Create a rep
|
|
361
|
+
operationId: createRep
|
|
362
|
+
requestBody:
|
|
363
|
+
required: true
|
|
364
|
+
content:
|
|
365
|
+
application/json:
|
|
366
|
+
schema:
|
|
367
|
+
$ref: "#/components/schemas/RepCreateBody"
|
|
368
|
+
responses:
|
|
369
|
+
"201":
|
|
370
|
+
description: Rep created
|
|
371
|
+
content:
|
|
372
|
+
application/json:
|
|
373
|
+
schema:
|
|
374
|
+
$ref: "#/components/schemas/RepCreateResult"
|
|
375
|
+
/rep/{id}:
|
|
376
|
+
get:
|
|
377
|
+
summary: Get a rep by ID
|
|
378
|
+
operationId: getRep
|
|
379
|
+
parameters:
|
|
380
|
+
- in: path
|
|
381
|
+
name: id
|
|
382
|
+
required: true
|
|
383
|
+
schema:
|
|
384
|
+
type: string
|
|
385
|
+
responses:
|
|
386
|
+
"200":
|
|
387
|
+
description: Rep details
|
|
388
|
+
content:
|
|
389
|
+
application/json:
|
|
390
|
+
schema:
|
|
391
|
+
$ref: "#/components/schemas/RepGetResult"
|
|
392
|
+
put:
|
|
393
|
+
summary: Update a rep
|
|
394
|
+
operationId: updateRep
|
|
395
|
+
parameters:
|
|
396
|
+
- in: path
|
|
397
|
+
name: id
|
|
398
|
+
required: true
|
|
399
|
+
schema:
|
|
400
|
+
type: string
|
|
401
|
+
requestBody:
|
|
402
|
+
required: true
|
|
403
|
+
content:
|
|
404
|
+
application/json:
|
|
405
|
+
schema:
|
|
406
|
+
$ref: "#/components/schemas/RepUpdateBody"
|
|
407
|
+
responses:
|
|
408
|
+
"200":
|
|
409
|
+
description: Rep updated
|
|
410
|
+
content:
|
|
411
|
+
application/json:
|
|
412
|
+
schema:
|
|
413
|
+
$ref: "#/components/schemas/RepUpdateResult"
|
|
414
|
+
delete:
|
|
415
|
+
summary: Remove a rep
|
|
416
|
+
operationId: removeRep
|
|
417
|
+
parameters:
|
|
418
|
+
- in: path
|
|
419
|
+
name: id
|
|
420
|
+
required: true
|
|
421
|
+
schema:
|
|
422
|
+
type: string
|
|
423
|
+
responses:
|
|
424
|
+
"200":
|
|
425
|
+
description: Rep removed
|
|
426
|
+
content:
|
|
427
|
+
application/json:
|
|
428
|
+
schema:
|
|
429
|
+
$ref: "#/components/schemas/RepRemoveResult"
|
|
430
|
+
components:
|
|
431
|
+
schemas:
|
|
432
|
+
RepFindResult:
|
|
433
|
+
type: object
|
|
434
|
+
description: Result of finding reps
|
|
435
|
+
properties:
|
|
436
|
+
data:
|
|
437
|
+
type: array
|
|
438
|
+
items:
|
|
439
|
+
$ref: "#/components/schemas/RepSchema"
|
|
440
|
+
total_result:
|
|
441
|
+
type: number
|
|
442
|
+
description: Total number of reps
|
|
443
|
+
current_count:
|
|
444
|
+
type: number
|
|
445
|
+
description: Count of reps in current page
|
|
446
|
+
total_pages:
|
|
447
|
+
type: number
|
|
448
|
+
description: Total number of pages
|
|
449
|
+
current_page:
|
|
450
|
+
type: number
|
|
451
|
+
description: Current page number
|
|
452
|
+
per_page:
|
|
453
|
+
type: number
|
|
454
|
+
description: Number of reps per page
|
|
455
|
+
first_page_url:
|
|
456
|
+
type: string
|
|
457
|
+
description: URL for the first page
|
|
458
|
+
last_page_url:
|
|
459
|
+
type: string
|
|
460
|
+
description: URL for the last page
|
|
461
|
+
next_page_url:
|
|
462
|
+
type: string
|
|
463
|
+
nullable: true
|
|
464
|
+
description: URL for the next page
|
|
465
|
+
prev_page_url:
|
|
466
|
+
type: string
|
|
467
|
+
nullable: true
|
|
468
|
+
description: URL for the previous page
|
|
469
|
+
path:
|
|
470
|
+
type: string
|
|
471
|
+
description: Base URL path
|
|
472
|
+
RepSchema:
|
|
473
|
+
type: object
|
|
474
|
+
description: Rep schema
|
|
475
|
+
properties:
|
|
476
|
+
_id:
|
|
477
|
+
type: string
|
|
478
|
+
description: Unique identifier for the rep
|
|
479
|
+
username:
|
|
480
|
+
type: string
|
|
481
|
+
description: Username of the rep
|
|
482
|
+
name:
|
|
483
|
+
type: string
|
|
484
|
+
description: Name of the rep
|
|
485
|
+
password:
|
|
486
|
+
type: string
|
|
487
|
+
description: Password for the rep account
|
|
488
|
+
device_id:
|
|
489
|
+
type: string
|
|
490
|
+
description: Device ID associated with the rep
|
|
491
|
+
linked_to_device:
|
|
492
|
+
type: boolean
|
|
493
|
+
description: Whether the rep is linked to a device
|
|
494
|
+
live_location:
|
|
495
|
+
type: boolean
|
|
496
|
+
description: Whether live location is enabled for the rep
|
|
497
|
+
phone:
|
|
498
|
+
type: string
|
|
499
|
+
description: Phone number of the rep
|
|
500
|
+
email:
|
|
501
|
+
type: string
|
|
502
|
+
description: Email of the rep
|
|
503
|
+
integration_id:
|
|
504
|
+
type: string
|
|
505
|
+
description: Integration ID for the rep
|
|
506
|
+
role:
|
|
507
|
+
type: string
|
|
508
|
+
description: Role of the rep
|
|
509
|
+
team_id:
|
|
510
|
+
type: string
|
|
511
|
+
description: ID of the team the rep belongs to
|
|
512
|
+
disabled:
|
|
513
|
+
type: boolean
|
|
514
|
+
description: Whether the rep is disabled
|
|
515
|
+
permissions:
|
|
516
|
+
type: object
|
|
517
|
+
description: Rep permissions
|
|
518
|
+
properties:
|
|
519
|
+
rep_can_add_client:
|
|
520
|
+
type: boolean
|
|
521
|
+
description: Can rep add clients
|
|
522
|
+
rep_can_edit_client:
|
|
523
|
+
type: boolean
|
|
524
|
+
description: Can rep edit clients
|
|
525
|
+
rep_can_add_calendar:
|
|
526
|
+
type: boolean
|
|
527
|
+
description: Can rep add to calendar
|
|
528
|
+
rep_can_edit_calendar:
|
|
529
|
+
type: boolean
|
|
530
|
+
description: Can rep edit calendar
|
|
531
|
+
rep_can_skip_photo_tag:
|
|
532
|
+
type: boolean
|
|
533
|
+
description: Can rep skip photo tag
|
|
534
|
+
rep_can_edit_others_calendar:
|
|
535
|
+
type: boolean
|
|
536
|
+
description: Can rep edit others calendar
|
|
537
|
+
rep_can_edit_product_price:
|
|
538
|
+
type: boolean
|
|
539
|
+
description: Can rep edit product price
|
|
540
|
+
rep_must_add_client_with_location:
|
|
541
|
+
type: boolean
|
|
542
|
+
description: Rep must add client with location
|
|
543
|
+
rep_can_access_shared_history:
|
|
544
|
+
type: boolean
|
|
545
|
+
description: Can rep access shared history
|
|
546
|
+
rep_can_edit_total_shelf_share:
|
|
547
|
+
type: boolean
|
|
548
|
+
description: Can rep edit total shelf share
|
|
549
|
+
rep_can_create_transfer:
|
|
550
|
+
type: boolean
|
|
551
|
+
description: Can rep create transfer
|
|
552
|
+
rep_can_make_call:
|
|
553
|
+
type: boolean
|
|
554
|
+
description: Can rep make call
|
|
555
|
+
rep_can_read_stock:
|
|
556
|
+
type: boolean
|
|
557
|
+
description: Can rep read stock
|
|
558
|
+
can_rep_pay_other_reps_invoices:
|
|
559
|
+
type: boolean
|
|
560
|
+
description: Can rep pay other reps invoices
|
|
561
|
+
rep_can_create_sales_order:
|
|
562
|
+
type: boolean
|
|
563
|
+
description: Can rep create sales order
|
|
564
|
+
rep_can_create_invoice:
|
|
565
|
+
type: boolean
|
|
566
|
+
description: Can rep create invoice
|
|
567
|
+
rep_can_create_transfer_load:
|
|
568
|
+
type: boolean
|
|
569
|
+
description: Can rep create transfer load
|
|
570
|
+
rep_can_create_transfer_unload:
|
|
571
|
+
type: boolean
|
|
572
|
+
description: Can rep create transfer unload
|
|
573
|
+
rep_can_create_return_invoice:
|
|
574
|
+
type: boolean
|
|
575
|
+
description: Can rep create return invoice
|
|
576
|
+
rep_can_create_partial_return_invoice:
|
|
577
|
+
type: boolean
|
|
578
|
+
description: Can rep create partial return invoice
|
|
579
|
+
rep_can_sell_zero_product_price:
|
|
580
|
+
type: boolean
|
|
581
|
+
description: Can rep sell zero product price
|
|
582
|
+
rep_can_create_sales_order_out_of_visit:
|
|
583
|
+
type: boolean
|
|
584
|
+
description: Can rep create sales order out of visit
|
|
585
|
+
rep_can_create_cash_invoice:
|
|
586
|
+
type: boolean
|
|
587
|
+
description: Can rep create cash invoice
|
|
588
|
+
rep_can_sell_above_product_price:
|
|
589
|
+
type: boolean
|
|
590
|
+
description: Can rep sell above product price
|
|
591
|
+
rep_can_sell_below_product_price:
|
|
592
|
+
type: boolean
|
|
593
|
+
description: Can rep sell below product price
|
|
594
|
+
rep_can_create_return_out_of_visit:
|
|
595
|
+
type: boolean
|
|
596
|
+
description: Can rep create return out of visit
|
|
597
|
+
rep_can_create_partial_return_out_of_visit:
|
|
598
|
+
type: boolean
|
|
599
|
+
description: Can rep create partial return out of visit
|
|
600
|
+
rep_can_skip_return_reason:
|
|
601
|
+
type: boolean
|
|
602
|
+
description: Can rep skip return reason
|
|
603
|
+
rep_can_create_invoice_out_of_visit:
|
|
604
|
+
type: boolean
|
|
605
|
+
description: Can rep create invoice out of visit
|
|
606
|
+
rep_can_create_free_payments:
|
|
607
|
+
type: boolean
|
|
608
|
+
description: Can rep create free payments
|
|
609
|
+
rep_can_partially_pay_invoice:
|
|
610
|
+
type: boolean
|
|
611
|
+
description: Can rep partially pay invoice
|
|
612
|
+
auto_close_visit_when_out_of_geo_fence:
|
|
613
|
+
type: boolean
|
|
614
|
+
description: Auto close visit when out of geo fence
|
|
615
|
+
end_visit_when_out_of_geofence:
|
|
616
|
+
type: boolean
|
|
617
|
+
description: End visit when out of geofence
|
|
618
|
+
end_visit_when_low_accuracy:
|
|
619
|
+
type: boolean
|
|
620
|
+
description: End visit when low accuracy
|
|
621
|
+
rep_can_create_workorder:
|
|
622
|
+
type: boolean
|
|
623
|
+
description: Can rep create workorder
|
|
624
|
+
rep_can_create_asset:
|
|
625
|
+
type: boolean
|
|
626
|
+
description: Can rep create asset
|
|
627
|
+
rep_can_skip_promotions:
|
|
628
|
+
type: boolean
|
|
629
|
+
description: Can rep skip promotions
|
|
630
|
+
rep_can_skip_item_status_feedback:
|
|
631
|
+
type: boolean
|
|
632
|
+
description: Can rep skip item status feedback
|
|
633
|
+
rep_can_skip_item_status_note:
|
|
634
|
+
type: boolean
|
|
635
|
+
description: Can rep skip item status note
|
|
636
|
+
rep_can_skip_item_status_type:
|
|
637
|
+
type: boolean
|
|
638
|
+
description: Can rep skip item status type
|
|
639
|
+
rep_can_end_visit_without_submitting_item_status:
|
|
640
|
+
type: boolean
|
|
641
|
+
description: Can rep end visit without submitting item status
|
|
642
|
+
rep_can_submit_multiple_item_status_products:
|
|
643
|
+
type: boolean
|
|
644
|
+
description: Can rep submit multiple item status products
|
|
645
|
+
rep_can_edit_return_product_price:
|
|
646
|
+
type: boolean
|
|
647
|
+
description: Can rep edit return product price
|
|
648
|
+
rep_can_skip_cart_calculation_until_checkout:
|
|
649
|
+
type: boolean
|
|
650
|
+
description: Can rep skip cart calculation until checkout
|
|
651
|
+
rep_can_start_day_without_gps_signal:
|
|
652
|
+
type: boolean
|
|
653
|
+
description: Can rep start day without GPS signal
|
|
654
|
+
rep_can_create_add_client_approval_request:
|
|
655
|
+
type: boolean
|
|
656
|
+
description: Can rep create add client approval request
|
|
657
|
+
rep_can_create_edit_client_details_approval_request:
|
|
658
|
+
type: boolean
|
|
659
|
+
description: Can rep create edit client details approval request
|
|
660
|
+
rep_can_create_edit_client_assigned_to_approval_request:
|
|
661
|
+
type: boolean
|
|
662
|
+
description: Can rep create edit client assigned to approval request
|
|
663
|
+
rep_can_create_edit_client_location_approval_request:
|
|
664
|
+
type: boolean
|
|
665
|
+
description: Can rep create edit client location approval request
|
|
666
|
+
rep_can_create_delete_client_approval_request:
|
|
667
|
+
type: boolean
|
|
668
|
+
description: Can rep create delete client approval request
|
|
669
|
+
rep_can_create_skip_job_at_visit_end_approval_request:
|
|
670
|
+
type: boolean
|
|
671
|
+
description: Can rep create skip job at visit end approval request
|
|
672
|
+
rep_can_create_skip_geofence_at_visit_end_approval_request:
|
|
673
|
+
type: boolean
|
|
674
|
+
description: Can rep create skip geofence at visit end approval request
|
|
675
|
+
rep_can_create_credit_invoice_for_cash_client:
|
|
676
|
+
type: boolean
|
|
677
|
+
description: Can rep create credit invoice for cash client
|
|
678
|
+
rep_can_view_client_credit_limit:
|
|
679
|
+
type: boolean
|
|
680
|
+
description: Can rep view client credit limit
|
|
681
|
+
rep_can_create_edit_client_credit_limit_approval_request:
|
|
682
|
+
type: boolean
|
|
683
|
+
description: Can rep create edit client credit limit approval request
|
|
684
|
+
rep_can_assign_workorder:
|
|
685
|
+
type: boolean
|
|
686
|
+
description: Can rep assign workorder
|
|
687
|
+
rep_can_visit_outside_route:
|
|
688
|
+
type: boolean
|
|
689
|
+
description: Can rep visit outside route
|
|
690
|
+
rep_can_edit_retail_execution_entry:
|
|
691
|
+
type: boolean
|
|
692
|
+
description: Can rep edit retail execution entry
|
|
693
|
+
rep_can_edit_form_entry:
|
|
694
|
+
type: boolean
|
|
695
|
+
description: Can rep edit form entry
|
|
696
|
+
rep_can_skip_visit_from_route_sequence:
|
|
697
|
+
type: boolean
|
|
698
|
+
description: Can rep skip visit from route sequence
|
|
699
|
+
rep_can_create_return_sales_order:
|
|
700
|
+
type: boolean
|
|
701
|
+
description: Can rep create return sales order
|
|
702
|
+
rep_can_edit_sales_order_custom_status:
|
|
703
|
+
type: boolean
|
|
704
|
+
description: Can rep edit sales order custom status
|
|
705
|
+
rep_can_edit_invoice_custom_status:
|
|
706
|
+
type: boolean
|
|
707
|
+
description: Can rep edit invoice custom status
|
|
708
|
+
rep_can_start_day_with_outstanding_settlement_balance:
|
|
709
|
+
type: boolean
|
|
710
|
+
description: Can rep start day with outstanding settlement balance
|
|
711
|
+
rep_to_create_invoice_variant_batch_from_assigned_warehouse:
|
|
712
|
+
type: boolean
|
|
713
|
+
description: Rep to create invoice variant batch from assigned warehouse
|
|
714
|
+
rep_to_create_sales_order_variant_batch_assigned_main_warehouse:
|
|
715
|
+
type: boolean
|
|
716
|
+
description: Rep to create sales order variant batch assigned main warehouse
|
|
717
|
+
rep_can_create_pull_from_client_assigned_to_approval_request:
|
|
718
|
+
type: boolean
|
|
719
|
+
description: Can rep create pull from client assigned to approval request
|
|
720
|
+
rep_must_end_day_after_specific_time:
|
|
721
|
+
type: boolean
|
|
722
|
+
description: Rep must end day after specific time
|
|
723
|
+
rep_can_create_negative_invoice:
|
|
724
|
+
type: boolean
|
|
725
|
+
description: Rep can create negative invoice
|
|
726
|
+
preferences:
|
|
727
|
+
type: object
|
|
728
|
+
description: Rep preferences
|
|
729
|
+
properties:
|
|
730
|
+
isLightModeEnabled:
|
|
731
|
+
type: boolean
|
|
732
|
+
description: Whether light mode is enabled
|
|
733
|
+
profile_pic:
|
|
734
|
+
type: string
|
|
735
|
+
description: Profile picture URL
|
|
736
|
+
teams:
|
|
737
|
+
type: array
|
|
738
|
+
items:
|
|
739
|
+
type: string
|
|
740
|
+
description: Teams assigned to the rep
|
|
741
|
+
identifier:
|
|
742
|
+
type: number
|
|
743
|
+
description: Unique identifier number for the rep
|
|
744
|
+
notification_id:
|
|
745
|
+
type: string
|
|
746
|
+
description: Notification ID
|
|
747
|
+
monthly_sales_target:
|
|
748
|
+
type: number
|
|
749
|
+
description: Monthly sales target
|
|
750
|
+
daily_target_visit:
|
|
751
|
+
type: number
|
|
752
|
+
description: Daily target visits
|
|
753
|
+
sales_type:
|
|
754
|
+
type: number
|
|
755
|
+
enum: [1, 2]
|
|
756
|
+
description: Sales type (1 or 2)
|
|
757
|
+
job_option:
|
|
758
|
+
type: number
|
|
759
|
+
enum: [0, 1, 2]
|
|
760
|
+
description: Job option (0, 1, or 2)
|
|
761
|
+
msl_sales:
|
|
762
|
+
type: array
|
|
763
|
+
items:
|
|
764
|
+
type: string
|
|
765
|
+
description: MSL sales assignments
|
|
766
|
+
job_category:
|
|
767
|
+
type: array
|
|
768
|
+
items:
|
|
769
|
+
type: string
|
|
770
|
+
description: Job categories assigned to the rep
|
|
771
|
+
assigned_warehouse:
|
|
772
|
+
type: string
|
|
773
|
+
description: Assigned warehouse ID
|
|
774
|
+
assigned_main_warehouse:
|
|
775
|
+
type: string
|
|
776
|
+
description: Assigned main warehouse ID
|
|
777
|
+
assigned_plan:
|
|
778
|
+
type: string
|
|
779
|
+
description: Assigned plan ID
|
|
780
|
+
force_online_connectivity:
|
|
781
|
+
type: boolean
|
|
782
|
+
description: Whether online connectivity is forced
|
|
783
|
+
assigned_targets:
|
|
784
|
+
type: array
|
|
785
|
+
items:
|
|
786
|
+
type: string
|
|
787
|
+
description: Assigned targets
|
|
788
|
+
lines:
|
|
789
|
+
type: array
|
|
790
|
+
items:
|
|
791
|
+
type: string
|
|
792
|
+
description: Lines assigned to the rep
|
|
793
|
+
targetResults:
|
|
794
|
+
type: object
|
|
795
|
+
description: Target results
|
|
796
|
+
properties:
|
|
797
|
+
totalPoints:
|
|
798
|
+
type: number
|
|
799
|
+
description: Total points achieved
|
|
800
|
+
targetsCount:
|
|
801
|
+
type: number
|
|
802
|
+
description: Number of targets
|
|
803
|
+
totalAchievements:
|
|
804
|
+
type: number
|
|
805
|
+
description: Total achievements
|
|
806
|
+
averageAchievements:
|
|
807
|
+
type: number
|
|
808
|
+
description: Average achievements
|
|
809
|
+
pointsCap:
|
|
810
|
+
type: number
|
|
811
|
+
description: Points cap
|
|
812
|
+
previously_assigned_clients:
|
|
813
|
+
type: array
|
|
814
|
+
items:
|
|
815
|
+
type: string
|
|
816
|
+
description: Previously assigned clients
|
|
817
|
+
freshchat_id:
|
|
818
|
+
type: string
|
|
819
|
+
description: Freshchat ID
|
|
820
|
+
is_test:
|
|
821
|
+
type: boolean
|
|
822
|
+
description: Whether this is a test rep
|
|
823
|
+
form_v2_option:
|
|
824
|
+
type: string
|
|
825
|
+
enum: ["all", "none", "assigned", "client_assigned"]
|
|
826
|
+
description: Form v2 option
|
|
827
|
+
assigned_forms_v2:
|
|
828
|
+
type: array
|
|
829
|
+
items:
|
|
830
|
+
type: string
|
|
831
|
+
description: Assigned forms v2
|
|
832
|
+
retail_execution_template_option:
|
|
833
|
+
type: string
|
|
834
|
+
enum: ["all", "client_assigned", "assigned", "none"]
|
|
835
|
+
description: Retail execution template option
|
|
836
|
+
assigned_retail_execution_templates:
|
|
837
|
+
type: array
|
|
838
|
+
items:
|
|
839
|
+
type: string
|
|
840
|
+
description: Assigned retail execution templates
|
|
841
|
+
customFields:
|
|
842
|
+
type: object
|
|
843
|
+
additionalProperties:
|
|
844
|
+
oneOf:
|
|
845
|
+
- type: boolean
|
|
846
|
+
- type: string
|
|
847
|
+
- type: number
|
|
848
|
+
description: Custom fields
|
|
849
|
+
media:
|
|
850
|
+
type: array
|
|
851
|
+
items:
|
|
852
|
+
type: string
|
|
853
|
+
description: Media files
|
|
854
|
+
cover_photo:
|
|
855
|
+
type: string
|
|
856
|
+
description: Cover photo URL
|
|
857
|
+
last_login_time:
|
|
858
|
+
type: number
|
|
859
|
+
description: Last login timestamp
|
|
860
|
+
settings:
|
|
861
|
+
type: object
|
|
862
|
+
description: Rep settings
|
|
863
|
+
properties:
|
|
864
|
+
allowable_accuracy:
|
|
865
|
+
type: number
|
|
866
|
+
description: Allowable GPS accuracy
|
|
867
|
+
is_item_status_per_visit_limited:
|
|
868
|
+
type: boolean
|
|
869
|
+
description: Whether item status per visit is limited
|
|
870
|
+
item_status_per_visit_limit:
|
|
871
|
+
type: number
|
|
872
|
+
description: Item status per visit limit
|
|
873
|
+
location_permission:
|
|
874
|
+
type: string
|
|
875
|
+
enum: ["always_allow", "while_using"]
|
|
876
|
+
description: Location permission setting
|
|
877
|
+
activities_report_scope:
|
|
878
|
+
type: string
|
|
879
|
+
enum: ["self", "team", "company_namespace"]
|
|
880
|
+
description: Activities report scope
|
|
881
|
+
maximum_cash_outstanding_settlement_balance_to_start_day:
|
|
882
|
+
type: number
|
|
883
|
+
description: Maximum cash outstanding settlement balance to start day
|
|
884
|
+
maximum_check_outstanding_settlement_balance_to_start_day:
|
|
885
|
+
type: number
|
|
886
|
+
description: Maximum check outstanding settlement balance to start day
|
|
887
|
+
maximum_total_outstanding_settlement_balance_to_start_day:
|
|
888
|
+
type: number
|
|
889
|
+
description: Maximum total outstanding settlement balance to start day
|
|
890
|
+
watermark_client_name:
|
|
891
|
+
type: boolean
|
|
892
|
+
description: Whether to watermark client name
|
|
893
|
+
watermark_time:
|
|
894
|
+
type: boolean
|
|
895
|
+
description: Whether to watermark time
|
|
896
|
+
watermark_date:
|
|
897
|
+
type: boolean
|
|
898
|
+
description: Whether to watermark date
|
|
899
|
+
watermark_coordinates:
|
|
900
|
+
type: boolean
|
|
901
|
+
description: Whether to watermark coordinates
|
|
902
|
+
rep_must_end_day_after:
|
|
903
|
+
type: string
|
|
904
|
+
pattern: "^[0-9]{1,2}:[0-9]{2}$"
|
|
905
|
+
description: Time rep must end day after (HH:MM format)
|
|
906
|
+
integration_meta:
|
|
907
|
+
type: object
|
|
908
|
+
additionalProperties: true
|
|
909
|
+
description: Integration metadata
|
|
910
|
+
company_namespace:
|
|
911
|
+
type: array
|
|
912
|
+
items:
|
|
913
|
+
type: string
|
|
914
|
+
description: Company namespaces
|
|
915
|
+
createdAt:
|
|
916
|
+
type: string
|
|
917
|
+
format: date-time
|
|
918
|
+
description: Creation timestamp
|
|
919
|
+
updatedAt:
|
|
920
|
+
type: string
|
|
921
|
+
format: date-time
|
|
922
|
+
description: Last update timestamp
|
|
923
|
+
__v:
|
|
924
|
+
type: number
|
|
925
|
+
description: Version number
|
|
926
|
+
RepCreateBody:
|
|
927
|
+
type: object
|
|
928
|
+
description: Body for creating a rep
|
|
929
|
+
required:
|
|
930
|
+
- username
|
|
931
|
+
- name
|
|
932
|
+
- password
|
|
933
|
+
- company_namespace
|
|
934
|
+
properties:
|
|
935
|
+
username:
|
|
936
|
+
type: string
|
|
937
|
+
description: Username of the rep
|
|
938
|
+
name:
|
|
939
|
+
type: string
|
|
940
|
+
description: Name of the rep
|
|
941
|
+
password:
|
|
942
|
+
type: string
|
|
943
|
+
description: Password for the rep account
|
|
944
|
+
device_id:
|
|
945
|
+
type: string
|
|
946
|
+
description: Device ID associated with the rep
|
|
947
|
+
linked_to_device:
|
|
948
|
+
type: boolean
|
|
949
|
+
description: Whether the rep is linked to a device
|
|
950
|
+
live_location:
|
|
951
|
+
type: boolean
|
|
952
|
+
description: Whether live location is enabled for the rep
|
|
953
|
+
phone:
|
|
954
|
+
type: string
|
|
955
|
+
description: Phone number of the rep
|
|
956
|
+
email:
|
|
957
|
+
type: string
|
|
958
|
+
description: Email of the rep
|
|
959
|
+
integration_id:
|
|
960
|
+
type: string
|
|
961
|
+
description: Integration ID for the rep
|
|
962
|
+
role:
|
|
963
|
+
type: string
|
|
964
|
+
description: Role of the rep
|
|
965
|
+
team_id:
|
|
966
|
+
type: string
|
|
967
|
+
description: ID of the team the rep belongs to
|
|
968
|
+
disabled:
|
|
969
|
+
type: boolean
|
|
970
|
+
description: Whether the rep is disabled
|
|
971
|
+
permissions:
|
|
972
|
+
type: object
|
|
973
|
+
description: Rep permissions
|
|
974
|
+
properties:
|
|
975
|
+
rep_can_add_client:
|
|
976
|
+
type: boolean
|
|
977
|
+
description: Can rep add clients
|
|
978
|
+
rep_can_edit_client:
|
|
979
|
+
type: boolean
|
|
980
|
+
description: Can rep edit clients
|
|
981
|
+
rep_can_skip_photo_tag:
|
|
982
|
+
type: boolean
|
|
983
|
+
description: Can rep skip photo tag
|
|
984
|
+
rep_can_edit_others_calendar:
|
|
985
|
+
type: boolean
|
|
986
|
+
description: Can rep edit others calendar
|
|
987
|
+
rep_can_edit_product_price:
|
|
988
|
+
type: boolean
|
|
989
|
+
description: Can rep edit product price
|
|
990
|
+
rep_must_add_client_with_location:
|
|
991
|
+
type: boolean
|
|
992
|
+
description: Rep must add client with location
|
|
993
|
+
rep_can_access_shared_history:
|
|
994
|
+
type: boolean
|
|
995
|
+
description: Can rep access shared history
|
|
996
|
+
rep_can_edit_total_shelf_share:
|
|
997
|
+
type: boolean
|
|
998
|
+
description: Can rep edit total shelf share
|
|
999
|
+
rep_can_create_transfer:
|
|
1000
|
+
type: boolean
|
|
1001
|
+
description: Can rep create transfer
|
|
1002
|
+
rep_can_make_call:
|
|
1003
|
+
type: boolean
|
|
1004
|
+
description: Can rep make call
|
|
1005
|
+
rep_can_read_stock:
|
|
1006
|
+
type: boolean
|
|
1007
|
+
description: Can rep read stock
|
|
1008
|
+
can_rep_pay_other_reps_invoices:
|
|
1009
|
+
type: boolean
|
|
1010
|
+
description: Can rep pay other reps invoices
|
|
1011
|
+
rep_can_create_sales_order:
|
|
1012
|
+
type: boolean
|
|
1013
|
+
description: Can rep create sales order
|
|
1014
|
+
rep_can_create_invoice:
|
|
1015
|
+
type: boolean
|
|
1016
|
+
description: Can rep create invoice
|
|
1017
|
+
rep_can_create_transfer_load:
|
|
1018
|
+
type: boolean
|
|
1019
|
+
description: Can rep create transfer load
|
|
1020
|
+
rep_can_create_transfer_unload:
|
|
1021
|
+
type: boolean
|
|
1022
|
+
description: Can rep create transfer unload
|
|
1023
|
+
rep_can_create_return_invoice:
|
|
1024
|
+
type: boolean
|
|
1025
|
+
description: Can rep create return invoice
|
|
1026
|
+
rep_can_create_partial_return_invoice:
|
|
1027
|
+
type: boolean
|
|
1028
|
+
description: Can rep create partial return invoice
|
|
1029
|
+
rep_can_sell_zero_product_price:
|
|
1030
|
+
type: boolean
|
|
1031
|
+
description: Can rep sell zero product price
|
|
1032
|
+
rep_can_create_sales_order_out_of_visit:
|
|
1033
|
+
type: boolean
|
|
1034
|
+
description: Can rep create sales order out of visit
|
|
1035
|
+
rep_can_create_cash_invoice:
|
|
1036
|
+
type: boolean
|
|
1037
|
+
description: Can rep create cash invoice
|
|
1038
|
+
rep_can_sell_above_product_price:
|
|
1039
|
+
type: boolean
|
|
1040
|
+
description: Can rep sell above product price
|
|
1041
|
+
rep_can_sell_below_product_price:
|
|
1042
|
+
type: boolean
|
|
1043
|
+
description: Can rep sell below product price
|
|
1044
|
+
rep_can_create_return_out_of_visit:
|
|
1045
|
+
type: boolean
|
|
1046
|
+
description: Can rep create return out of visit
|
|
1047
|
+
rep_can_create_partial_return_out_of_visit:
|
|
1048
|
+
type: boolean
|
|
1049
|
+
description: Can rep create partial return out of visit
|
|
1050
|
+
rep_can_skip_return_reason:
|
|
1051
|
+
type: boolean
|
|
1052
|
+
description: Can rep skip return reason
|
|
1053
|
+
rep_can_create_invoice_out_of_visit:
|
|
1054
|
+
type: boolean
|
|
1055
|
+
description: Can rep create invoice out of visit
|
|
1056
|
+
rep_can_create_free_payments:
|
|
1057
|
+
type: boolean
|
|
1058
|
+
description: Can rep create free payments
|
|
1059
|
+
rep_can_partially_pay_invoice:
|
|
1060
|
+
type: boolean
|
|
1061
|
+
description: Can rep partially pay invoice
|
|
1062
|
+
auto_close_visit_when_out_of_geo_fence:
|
|
1063
|
+
type: boolean
|
|
1064
|
+
description: Auto close visit when out of geo fence
|
|
1065
|
+
end_visit_when_out_of_geofence:
|
|
1066
|
+
type: boolean
|
|
1067
|
+
description: End visit when out of geofence
|
|
1068
|
+
end_visit_when_low_accuracy:
|
|
1069
|
+
type: boolean
|
|
1070
|
+
description: End visit when low accuracy
|
|
1071
|
+
rep_can_create_workorder:
|
|
1072
|
+
type: boolean
|
|
1073
|
+
description: Can rep create workorder
|
|
1074
|
+
rep_can_create_asset:
|
|
1075
|
+
type: boolean
|
|
1076
|
+
description: Can rep create asset
|
|
1077
|
+
rep_can_skip_promotions:
|
|
1078
|
+
type: boolean
|
|
1079
|
+
description: Can rep skip promotions
|
|
1080
|
+
rep_can_skip_item_status_feedback:
|
|
1081
|
+
type: boolean
|
|
1082
|
+
description: Can rep skip item status feedback
|
|
1083
|
+
rep_can_skip_item_status_note:
|
|
1084
|
+
type: boolean
|
|
1085
|
+
description: Can rep skip item status note
|
|
1086
|
+
rep_can_skip_item_status_type:
|
|
1087
|
+
type: boolean
|
|
1088
|
+
description: Can rep skip item status type
|
|
1089
|
+
rep_can_end_visit_without_submitting_item_status:
|
|
1090
|
+
type: boolean
|
|
1091
|
+
description: Can rep end visit without submitting item status
|
|
1092
|
+
rep_can_submit_multiple_item_status_products:
|
|
1093
|
+
type: boolean
|
|
1094
|
+
description: Can rep submit multiple item status products
|
|
1095
|
+
rep_can_edit_return_product_price:
|
|
1096
|
+
type: boolean
|
|
1097
|
+
description: Can rep edit return product price
|
|
1098
|
+
rep_can_skip_cart_calculation_until_checkout:
|
|
1099
|
+
type: boolean
|
|
1100
|
+
description: Can rep skip cart calculation until checkout
|
|
1101
|
+
rep_can_start_day_without_gps_signal:
|
|
1102
|
+
type: boolean
|
|
1103
|
+
description: Can rep start day without GPS signal
|
|
1104
|
+
rep_can_create_add_client_approval_request:
|
|
1105
|
+
type: boolean
|
|
1106
|
+
description: Can rep create add client approval request
|
|
1107
|
+
rep_can_create_edit_client_details_approval_request:
|
|
1108
|
+
type: boolean
|
|
1109
|
+
description: Can rep create edit client details approval request
|
|
1110
|
+
rep_can_create_edit_client_assigned_to_approval_request:
|
|
1111
|
+
type: boolean
|
|
1112
|
+
description: Can rep create edit client assigned to approval request
|
|
1113
|
+
rep_can_create_edit_client_location_approval_request:
|
|
1114
|
+
type: boolean
|
|
1115
|
+
description: Can rep create edit client location approval request
|
|
1116
|
+
rep_can_create_delete_client_approval_request:
|
|
1117
|
+
type: boolean
|
|
1118
|
+
description: Can rep create delete client approval request
|
|
1119
|
+
rep_can_create_skip_job_at_visit_end_approval_request:
|
|
1120
|
+
type: boolean
|
|
1121
|
+
description: Can rep create skip job at visit end approval request
|
|
1122
|
+
rep_can_create_skip_geofence_at_visit_end_approval_request:
|
|
1123
|
+
type: boolean
|
|
1124
|
+
description: Can rep create skip geofence at visit end approval request
|
|
1125
|
+
rep_can_create_credit_invoice_for_cash_client:
|
|
1126
|
+
type: boolean
|
|
1127
|
+
description: Can rep create credit invoice for cash client
|
|
1128
|
+
rep_can_view_client_credit_limit:
|
|
1129
|
+
type: boolean
|
|
1130
|
+
description: Can rep view client credit limit
|
|
1131
|
+
rep_can_create_edit_client_credit_limit_approval_request:
|
|
1132
|
+
type: boolean
|
|
1133
|
+
description: Can rep create edit client credit limit approval request
|
|
1134
|
+
rep_can_assign_workorder:
|
|
1135
|
+
type: boolean
|
|
1136
|
+
description: Can rep assign workorder
|
|
1137
|
+
rep_can_visit_outside_route:
|
|
1138
|
+
type: boolean
|
|
1139
|
+
description: Can rep visit outside route
|
|
1140
|
+
rep_can_edit_retail_execution_entry:
|
|
1141
|
+
type: boolean
|
|
1142
|
+
description: Can rep edit retail execution entry
|
|
1143
|
+
rep_can_edit_form_entry:
|
|
1144
|
+
type: boolean
|
|
1145
|
+
description: Can rep edit form entry
|
|
1146
|
+
rep_can_skip_visit_from_route_sequence:
|
|
1147
|
+
type: boolean
|
|
1148
|
+
description: Can rep skip visit from route sequence
|
|
1149
|
+
rep_can_create_return_sales_order:
|
|
1150
|
+
type: boolean
|
|
1151
|
+
description: Can rep create return sales order
|
|
1152
|
+
rep_can_edit_sales_order_custom_status:
|
|
1153
|
+
type: boolean
|
|
1154
|
+
description: Can rep edit sales order custom status
|
|
1155
|
+
rep_can_edit_invoice_custom_status:
|
|
1156
|
+
type: boolean
|
|
1157
|
+
description: Can rep edit invoice custom status
|
|
1158
|
+
rep_can_start_day_with_outstanding_settlement_balance:
|
|
1159
|
+
type: boolean
|
|
1160
|
+
description: Can rep start day with outstanding settlement balance
|
|
1161
|
+
rep_to_create_invoice_variant_batch_from_assigned_warehouse:
|
|
1162
|
+
type: boolean
|
|
1163
|
+
description: Rep to create invoice variant batch from assigned warehouse
|
|
1164
|
+
rep_to_create_sales_order_variant_batch_assigned_main_warehouse:
|
|
1165
|
+
type: boolean
|
|
1166
|
+
description: Rep to create sales order variant batch assigned main warehouse
|
|
1167
|
+
rep_can_create_pull_from_client_assigned_to_approval_request:
|
|
1168
|
+
type: boolean
|
|
1169
|
+
description: Can rep create pull from client assigned to approval request
|
|
1170
|
+
rep_must_end_day_after_specific_time:
|
|
1171
|
+
type: boolean
|
|
1172
|
+
description: Rep must end day after specific time
|
|
1173
|
+
rep_can_create_negative_invoice:
|
|
1174
|
+
type: boolean
|
|
1175
|
+
description: Rep can create negative invoice
|
|
1176
|
+
preferences:
|
|
1177
|
+
type: object
|
|
1178
|
+
description: Rep preferences
|
|
1179
|
+
properties:
|
|
1180
|
+
isLightModeEnabled:
|
|
1181
|
+
type: boolean
|
|
1182
|
+
description: Whether light mode is enabled
|
|
1183
|
+
profile_pic:
|
|
1184
|
+
type: string
|
|
1185
|
+
description: Profile picture URL
|
|
1186
|
+
teams:
|
|
1187
|
+
type: array
|
|
1188
|
+
items:
|
|
1189
|
+
type: string
|
|
1190
|
+
description: Teams assigned to the rep
|
|
1191
|
+
identifier:
|
|
1192
|
+
type: number
|
|
1193
|
+
description: Unique identifier number for the rep
|
|
1194
|
+
notification_id:
|
|
1195
|
+
type: string
|
|
1196
|
+
description: Notification ID
|
|
1197
|
+
monthly_sales_target:
|
|
1198
|
+
type: number
|
|
1199
|
+
description: Monthly sales target
|
|
1200
|
+
daily_target_visit:
|
|
1201
|
+
type: number
|
|
1202
|
+
description: Daily target visits
|
|
1203
|
+
sales_type:
|
|
1204
|
+
type: number
|
|
1205
|
+
enum: [1, 2]
|
|
1206
|
+
description: Sales type (1 or 2)
|
|
1207
|
+
job_option:
|
|
1208
|
+
type: number
|
|
1209
|
+
enum: [0, 1, 2]
|
|
1210
|
+
description: Job option (0, 1, or 2)
|
|
1211
|
+
msl_sales:
|
|
1212
|
+
type: array
|
|
1213
|
+
items:
|
|
1214
|
+
type: string
|
|
1215
|
+
description: MSL sales assignments
|
|
1216
|
+
job_category:
|
|
1217
|
+
type: array
|
|
1218
|
+
items:
|
|
1219
|
+
type: string
|
|
1220
|
+
description: Job categories assigned to the rep
|
|
1221
|
+
assigned_warehouse:
|
|
1222
|
+
type: string
|
|
1223
|
+
description: Assigned warehouse ID
|
|
1224
|
+
assigned_main_warehouse:
|
|
1225
|
+
type: string
|
|
1226
|
+
description: Assigned main warehouse ID
|
|
1227
|
+
assigned_plan:
|
|
1228
|
+
type: string
|
|
1229
|
+
description: Assigned plan ID
|
|
1230
|
+
force_online_connectivity:
|
|
1231
|
+
type: boolean
|
|
1232
|
+
description: Whether online connectivity is forced
|
|
1233
|
+
assigned_targets:
|
|
1234
|
+
type: array
|
|
1235
|
+
items:
|
|
1236
|
+
type: string
|
|
1237
|
+
description: Assigned targets
|
|
1238
|
+
lines:
|
|
1239
|
+
type: array
|
|
1240
|
+
items:
|
|
1241
|
+
type: string
|
|
1242
|
+
description: Lines assigned to the rep
|
|
1243
|
+
targetResults:
|
|
1244
|
+
type: object
|
|
1245
|
+
description: Target results
|
|
1246
|
+
properties:
|
|
1247
|
+
totalPoints:
|
|
1248
|
+
type: number
|
|
1249
|
+
description: Total points achieved
|
|
1250
|
+
targetsCount:
|
|
1251
|
+
type: number
|
|
1252
|
+
description: Number of targets
|
|
1253
|
+
totalAchievements:
|
|
1254
|
+
type: number
|
|
1255
|
+
description: Total achievements
|
|
1256
|
+
averageAchievements:
|
|
1257
|
+
type: number
|
|
1258
|
+
description: Average achievements
|
|
1259
|
+
pointsCap:
|
|
1260
|
+
type: number
|
|
1261
|
+
description: Points cap
|
|
1262
|
+
previously_assigned_clients:
|
|
1263
|
+
type: array
|
|
1264
|
+
items:
|
|
1265
|
+
type: string
|
|
1266
|
+
description: Previously assigned clients
|
|
1267
|
+
freshchat_id:
|
|
1268
|
+
type: string
|
|
1269
|
+
description: Freshchat ID
|
|
1270
|
+
is_test:
|
|
1271
|
+
type: boolean
|
|
1272
|
+
description: Whether this is a test rep
|
|
1273
|
+
form_v2_option:
|
|
1274
|
+
type: string
|
|
1275
|
+
enum: ["all", "none", "assigned", "client_assigned"]
|
|
1276
|
+
description: Form v2 option
|
|
1277
|
+
assigned_forms_v2:
|
|
1278
|
+
type: array
|
|
1279
|
+
items:
|
|
1280
|
+
type: string
|
|
1281
|
+
description: Assigned forms v2
|
|
1282
|
+
retail_execution_template_option:
|
|
1283
|
+
type: string
|
|
1284
|
+
enum: ["all", "client_assigned", "assigned", "none"]
|
|
1285
|
+
description: Retail execution template option
|
|
1286
|
+
assigned_retail_execution_templates:
|
|
1287
|
+
type: array
|
|
1288
|
+
items:
|
|
1289
|
+
type: string
|
|
1290
|
+
description: Assigned retail execution templates
|
|
1291
|
+
customFields:
|
|
1292
|
+
type: object
|
|
1293
|
+
additionalProperties:
|
|
1294
|
+
oneOf:
|
|
1295
|
+
- type: boolean
|
|
1296
|
+
- type: string
|
|
1297
|
+
- type: number
|
|
1298
|
+
description: Custom fields
|
|
1299
|
+
media:
|
|
1300
|
+
type: array
|
|
1301
|
+
items:
|
|
1302
|
+
type: string
|
|
1303
|
+
description: Media files
|
|
1304
|
+
cover_photo:
|
|
1305
|
+
type: string
|
|
1306
|
+
description: Cover photo URL
|
|
1307
|
+
last_login_time:
|
|
1308
|
+
type: number
|
|
1309
|
+
description: Last login timestamp
|
|
1310
|
+
settings:
|
|
1311
|
+
type: object
|
|
1312
|
+
description: Rep settings
|
|
1313
|
+
properties:
|
|
1314
|
+
allowable_accuracy:
|
|
1315
|
+
type: number
|
|
1316
|
+
description: Allowable GPS accuracy
|
|
1317
|
+
is_item_status_per_visit_limited:
|
|
1318
|
+
type: boolean
|
|
1319
|
+
description: Whether item status per visit is limited
|
|
1320
|
+
item_status_per_visit_limit:
|
|
1321
|
+
type: number
|
|
1322
|
+
description: Item status per visit limit
|
|
1323
|
+
location_permission:
|
|
1324
|
+
type: string
|
|
1325
|
+
enum: ["always_allow", "while_using"]
|
|
1326
|
+
description: Location permission setting
|
|
1327
|
+
activities_report_scope:
|
|
1328
|
+
type: string
|
|
1329
|
+
enum: ["self", "team", "company_namespace"]
|
|
1330
|
+
description: Activities report scope
|
|
1331
|
+
maximum_cash_outstanding_settlement_balance_to_start_day:
|
|
1332
|
+
type: number
|
|
1333
|
+
description: Maximum cash outstanding settlement balance to start day
|
|
1334
|
+
maximum_check_outstanding_settlement_balance_to_start_day:
|
|
1335
|
+
type: number
|
|
1336
|
+
description: Maximum check outstanding settlement balance to start day
|
|
1337
|
+
maximum_total_outstanding_settlement_balance_to_start_day:
|
|
1338
|
+
type: number
|
|
1339
|
+
description: Maximum total outstanding settlement balance to start day
|
|
1340
|
+
watermark_client_name:
|
|
1341
|
+
type: boolean
|
|
1342
|
+
description: Whether to watermark client name
|
|
1343
|
+
watermark_time:
|
|
1344
|
+
type: boolean
|
|
1345
|
+
description: Whether to watermark time
|
|
1346
|
+
watermark_date:
|
|
1347
|
+
type: boolean
|
|
1348
|
+
description: Whether to watermark date
|
|
1349
|
+
watermark_coordinates:
|
|
1350
|
+
type: boolean
|
|
1351
|
+
description: Whether to watermark coordinates
|
|
1352
|
+
rep_must_end_day_after:
|
|
1353
|
+
type: string
|
|
1354
|
+
pattern: "^[0-9]{1,2}:[0-9]{2}$"
|
|
1355
|
+
description: Time rep must end day after (HH:MM format)
|
|
1356
|
+
integration_meta:
|
|
1357
|
+
type: object
|
|
1358
|
+
additionalProperties: true
|
|
1359
|
+
description: Integration metadata
|
|
1360
|
+
company_namespace:
|
|
1361
|
+
type: array
|
|
1362
|
+
items:
|
|
1363
|
+
type: string
|
|
1364
|
+
description: Company namespaces
|
|
1365
|
+
RepCreateResult:
|
|
1366
|
+
$ref: "#/components/schemas/RepSchema"
|
|
1367
|
+
description: Result of creating a rep
|
|
1368
|
+
RepGetResult:
|
|
1369
|
+
$ref: "#/components/schemas/RepSchema"
|
|
1370
|
+
description: Result of getting a rep
|
|
1371
|
+
RepUpdateBody:
|
|
1372
|
+
type: object
|
|
1373
|
+
description: Body for updating a rep
|
|
1374
|
+
properties:
|
|
1375
|
+
username:
|
|
1376
|
+
type: string
|
|
1377
|
+
description: Username of the rep
|
|
1378
|
+
name:
|
|
1379
|
+
type: string
|
|
1380
|
+
description: Name of the rep
|
|
1381
|
+
password:
|
|
1382
|
+
type: string
|
|
1383
|
+
description: Password for the rep account
|
|
1384
|
+
device_id:
|
|
1385
|
+
type: string
|
|
1386
|
+
description: Device ID associated with the rep
|
|
1387
|
+
linked_to_device:
|
|
1388
|
+
type: boolean
|
|
1389
|
+
description: Whether the rep is linked to a device
|
|
1390
|
+
live_location:
|
|
1391
|
+
type: boolean
|
|
1392
|
+
description: Whether live location is enabled for the rep
|
|
1393
|
+
phone:
|
|
1394
|
+
type: string
|
|
1395
|
+
description: Phone number of the rep
|
|
1396
|
+
email:
|
|
1397
|
+
type: string
|
|
1398
|
+
description: Email of the rep
|
|
1399
|
+
integration_id:
|
|
1400
|
+
type: string
|
|
1401
|
+
description: Integration ID for the rep
|
|
1402
|
+
role:
|
|
1403
|
+
type: string
|
|
1404
|
+
description: Role of the rep
|
|
1405
|
+
team_id:
|
|
1406
|
+
type: string
|
|
1407
|
+
description: ID of the team the rep belongs to
|
|
1408
|
+
disabled:
|
|
1409
|
+
type: boolean
|
|
1410
|
+
description: Whether the rep is disabled
|
|
1411
|
+
permissions:
|
|
1412
|
+
type: object
|
|
1413
|
+
description: Rep permissions
|
|
1414
|
+
properties:
|
|
1415
|
+
rep_can_add_client:
|
|
1416
|
+
type: boolean
|
|
1417
|
+
description: Can rep add clients
|
|
1418
|
+
rep_can_edit_client:
|
|
1419
|
+
type: boolean
|
|
1420
|
+
description: Can rep edit clients
|
|
1421
|
+
rep_can_skip_photo_tag:
|
|
1422
|
+
type: boolean
|
|
1423
|
+
description: Can rep skip photo tag
|
|
1424
|
+
rep_can_edit_others_calendar:
|
|
1425
|
+
type: boolean
|
|
1426
|
+
description: Can rep edit others calendar
|
|
1427
|
+
rep_can_edit_product_price:
|
|
1428
|
+
type: boolean
|
|
1429
|
+
description: Can rep edit product price
|
|
1430
|
+
rep_must_add_client_with_location:
|
|
1431
|
+
type: boolean
|
|
1432
|
+
description: Rep must add client with location
|
|
1433
|
+
rep_can_access_shared_history:
|
|
1434
|
+
type: boolean
|
|
1435
|
+
description: Can rep access shared history
|
|
1436
|
+
rep_can_edit_total_shelf_share:
|
|
1437
|
+
type: boolean
|
|
1438
|
+
description: Can rep edit total shelf share
|
|
1439
|
+
rep_can_create_transfer:
|
|
1440
|
+
type: boolean
|
|
1441
|
+
description: Can rep create transfer
|
|
1442
|
+
rep_can_make_call:
|
|
1443
|
+
type: boolean
|
|
1444
|
+
description: Can rep make call
|
|
1445
|
+
rep_can_read_stock:
|
|
1446
|
+
type: boolean
|
|
1447
|
+
description: Can rep read stock
|
|
1448
|
+
can_rep_pay_other_reps_invoices:
|
|
1449
|
+
type: boolean
|
|
1450
|
+
description: Can rep pay other reps invoices
|
|
1451
|
+
rep_can_create_sales_order:
|
|
1452
|
+
type: boolean
|
|
1453
|
+
description: Can rep create sales order
|
|
1454
|
+
rep_can_create_invoice:
|
|
1455
|
+
type: boolean
|
|
1456
|
+
description: Can rep create invoice
|
|
1457
|
+
rep_can_create_transfer_load:
|
|
1458
|
+
type: boolean
|
|
1459
|
+
description: Can rep create transfer load
|
|
1460
|
+
rep_can_create_transfer_unload:
|
|
1461
|
+
type: boolean
|
|
1462
|
+
description: Can rep create transfer unload
|
|
1463
|
+
rep_can_create_return_invoice:
|
|
1464
|
+
type: boolean
|
|
1465
|
+
description: Can rep create return invoice
|
|
1466
|
+
rep_can_create_partial_return_invoice:
|
|
1467
|
+
type: boolean
|
|
1468
|
+
description: Can rep create partial return invoice
|
|
1469
|
+
rep_can_sell_zero_product_price:
|
|
1470
|
+
type: boolean
|
|
1471
|
+
description: Can rep sell zero product price
|
|
1472
|
+
rep_can_create_sales_order_out_of_visit:
|
|
1473
|
+
type: boolean
|
|
1474
|
+
description: Can rep create sales order out of visit
|
|
1475
|
+
rep_can_create_cash_invoice:
|
|
1476
|
+
type: boolean
|
|
1477
|
+
description: Can rep create cash invoice
|
|
1478
|
+
rep_can_sell_above_product_price:
|
|
1479
|
+
type: boolean
|
|
1480
|
+
description: Can rep sell above product price
|
|
1481
|
+
rep_can_sell_below_product_price:
|
|
1482
|
+
type: boolean
|
|
1483
|
+
description: Can rep sell below product price
|
|
1484
|
+
rep_can_create_return_out_of_visit:
|
|
1485
|
+
type: boolean
|
|
1486
|
+
description: Can rep create return out of visit
|
|
1487
|
+
rep_can_create_partial_return_out_of_visit:
|
|
1488
|
+
type: boolean
|
|
1489
|
+
description: Can rep create partial return out of visit
|
|
1490
|
+
rep_can_skip_return_reason:
|
|
1491
|
+
type: boolean
|
|
1492
|
+
description: Can rep skip return reason
|
|
1493
|
+
rep_can_create_invoice_out_of_visit:
|
|
1494
|
+
type: boolean
|
|
1495
|
+
description: Can rep create invoice out of visit
|
|
1496
|
+
rep_can_create_free_payments:
|
|
1497
|
+
type: boolean
|
|
1498
|
+
description: Can rep create free payments
|
|
1499
|
+
rep_can_partially_pay_invoice:
|
|
1500
|
+
type: boolean
|
|
1501
|
+
description: Can rep partially pay invoice
|
|
1502
|
+
auto_close_visit_when_out_of_geo_fence:
|
|
1503
|
+
type: boolean
|
|
1504
|
+
description: Auto close visit when out of geo fence
|
|
1505
|
+
end_visit_when_out_of_geofence:
|
|
1506
|
+
type: boolean
|
|
1507
|
+
description: End visit when out of geofence
|
|
1508
|
+
end_visit_when_low_accuracy:
|
|
1509
|
+
type: boolean
|
|
1510
|
+
description: End visit when low accuracy
|
|
1511
|
+
rep_can_create_workorder:
|
|
1512
|
+
type: boolean
|
|
1513
|
+
description: Can rep create workorder
|
|
1514
|
+
rep_can_create_asset:
|
|
1515
|
+
type: boolean
|
|
1516
|
+
description: Can rep create asset
|
|
1517
|
+
rep_can_skip_promotions:
|
|
1518
|
+
type: boolean
|
|
1519
|
+
description: Can rep skip promotions
|
|
1520
|
+
rep_can_skip_item_status_feedback:
|
|
1521
|
+
type: boolean
|
|
1522
|
+
description: Can rep skip item status feedback
|
|
1523
|
+
rep_can_skip_item_status_note:
|
|
1524
|
+
type: boolean
|
|
1525
|
+
description: Can rep skip item status note
|
|
1526
|
+
rep_can_skip_item_status_type:
|
|
1527
|
+
type: boolean
|
|
1528
|
+
description: Can rep skip item status type
|
|
1529
|
+
rep_can_end_visit_without_submitting_item_status:
|
|
1530
|
+
type: boolean
|
|
1531
|
+
description: Can rep end visit without submitting item status
|
|
1532
|
+
rep_can_submit_multiple_item_status_products:
|
|
1533
|
+
type: boolean
|
|
1534
|
+
description: Can rep submit multiple item status products
|
|
1535
|
+
rep_can_edit_return_product_price:
|
|
1536
|
+
type: boolean
|
|
1537
|
+
description: Can rep edit return product price
|
|
1538
|
+
rep_can_skip_cart_calculation_until_checkout:
|
|
1539
|
+
type: boolean
|
|
1540
|
+
description: Can rep skip cart calculation until checkout
|
|
1541
|
+
rep_can_start_day_without_gps_signal:
|
|
1542
|
+
type: boolean
|
|
1543
|
+
description: Can rep start day without GPS signal
|
|
1544
|
+
rep_can_create_add_client_approval_request:
|
|
1545
|
+
type: boolean
|
|
1546
|
+
description: Can rep create add client approval request
|
|
1547
|
+
rep_can_create_edit_client_details_approval_request:
|
|
1548
|
+
type: boolean
|
|
1549
|
+
description: Can rep create edit client details approval request
|
|
1550
|
+
rep_can_create_edit_client_assigned_to_approval_request:
|
|
1551
|
+
type: boolean
|
|
1552
|
+
description: Can rep create edit client assigned to approval request
|
|
1553
|
+
rep_can_create_edit_client_location_approval_request:
|
|
1554
|
+
type: boolean
|
|
1555
|
+
description: Can rep create edit client location approval request
|
|
1556
|
+
rep_can_create_delete_client_approval_request:
|
|
1557
|
+
type: boolean
|
|
1558
|
+
description: Can rep create delete client approval request
|
|
1559
|
+
rep_can_create_skip_job_at_visit_end_approval_request:
|
|
1560
|
+
type: boolean
|
|
1561
|
+
description: Can rep create skip job at visit end approval request
|
|
1562
|
+
rep_can_create_skip_geofence_at_visit_end_approval_request:
|
|
1563
|
+
type: boolean
|
|
1564
|
+
description: Can rep create skip geofence at visit end approval request
|
|
1565
|
+
rep_can_create_credit_invoice_for_cash_client:
|
|
1566
|
+
type: boolean
|
|
1567
|
+
description: Can rep create credit invoice for cash client
|
|
1568
|
+
rep_can_view_client_credit_limit:
|
|
1569
|
+
type: boolean
|
|
1570
|
+
description: Can rep view client credit limit
|
|
1571
|
+
rep_can_create_edit_client_credit_limit_approval_request:
|
|
1572
|
+
type: boolean
|
|
1573
|
+
description: Can rep create edit client credit limit approval request
|
|
1574
|
+
rep_can_assign_workorder:
|
|
1575
|
+
type: boolean
|
|
1576
|
+
description: Can rep assign workorder
|
|
1577
|
+
rep_can_visit_outside_route:
|
|
1578
|
+
type: boolean
|
|
1579
|
+
description: Can rep visit outside route
|
|
1580
|
+
rep_can_edit_retail_execution_entry:
|
|
1581
|
+
type: boolean
|
|
1582
|
+
description: Can rep edit retail execution entry
|
|
1583
|
+
rep_can_edit_form_entry:
|
|
1584
|
+
type: boolean
|
|
1585
|
+
description: Can rep edit form entry
|
|
1586
|
+
rep_can_skip_visit_from_route_sequence:
|
|
1587
|
+
type: boolean
|
|
1588
|
+
description: Can rep skip visit from route sequence
|
|
1589
|
+
rep_can_create_return_sales_order:
|
|
1590
|
+
type: boolean
|
|
1591
|
+
description: Can rep create return sales order
|
|
1592
|
+
rep_can_edit_sales_order_custom_status:
|
|
1593
|
+
type: boolean
|
|
1594
|
+
description: Can rep edit sales order custom status
|
|
1595
|
+
rep_can_edit_invoice_custom_status:
|
|
1596
|
+
type: boolean
|
|
1597
|
+
description: Can rep edit invoice custom status
|
|
1598
|
+
rep_can_start_day_with_outstanding_settlement_balance:
|
|
1599
|
+
type: boolean
|
|
1600
|
+
description: Can rep start day with outstanding settlement balance
|
|
1601
|
+
rep_to_create_invoice_variant_batch_from_assigned_warehouse:
|
|
1602
|
+
type: boolean
|
|
1603
|
+
description: Rep to create invoice variant batch from assigned warehouse
|
|
1604
|
+
rep_to_create_sales_order_variant_batch_assigned_main_warehouse:
|
|
1605
|
+
type: boolean
|
|
1606
|
+
description: Rep to create sales order variant batch assigned main warehouse
|
|
1607
|
+
rep_can_create_pull_from_client_assigned_to_approval_request:
|
|
1608
|
+
type: boolean
|
|
1609
|
+
description: Can rep create pull from client assigned to approval request
|
|
1610
|
+
rep_must_end_day_after_specific_time:
|
|
1611
|
+
type: boolean
|
|
1612
|
+
description: Rep must end day after specific time
|
|
1613
|
+
rep_can_create_negative_invoice:
|
|
1614
|
+
type: boolean
|
|
1615
|
+
description: Rep can create negative invoice
|
|
1616
|
+
preferences:
|
|
1617
|
+
type: object
|
|
1618
|
+
description: Rep preferences
|
|
1619
|
+
properties:
|
|
1620
|
+
isLightModeEnabled:
|
|
1621
|
+
type: boolean
|
|
1622
|
+
description: Whether light mode is enabled
|
|
1623
|
+
profile_pic:
|
|
1624
|
+
type: string
|
|
1625
|
+
description: Profile picture URL
|
|
1626
|
+
teams:
|
|
1627
|
+
type: array
|
|
1628
|
+
items:
|
|
1629
|
+
type: string
|
|
1630
|
+
description: Teams assigned to the rep
|
|
1631
|
+
identifier:
|
|
1632
|
+
type: number
|
|
1633
|
+
description: Unique identifier number for the rep
|
|
1634
|
+
notification_id:
|
|
1635
|
+
type: string
|
|
1636
|
+
description: Notification ID
|
|
1637
|
+
monthly_sales_target:
|
|
1638
|
+
type: number
|
|
1639
|
+
description: Monthly sales target
|
|
1640
|
+
daily_target_visit:
|
|
1641
|
+
type: number
|
|
1642
|
+
description: Daily target visits
|
|
1643
|
+
sales_type:
|
|
1644
|
+
type: number
|
|
1645
|
+
enum: [1, 2]
|
|
1646
|
+
description: Sales type (1 or 2)
|
|
1647
|
+
job_option:
|
|
1648
|
+
type: number
|
|
1649
|
+
enum: [0, 1, 2]
|
|
1650
|
+
description: Job option (0, 1, or 2)
|
|
1651
|
+
msl_sales:
|
|
1652
|
+
type: array
|
|
1653
|
+
items:
|
|
1654
|
+
type: string
|
|
1655
|
+
description: MSL sales assignments
|
|
1656
|
+
job_category:
|
|
1657
|
+
type: array
|
|
1658
|
+
items:
|
|
1659
|
+
type: string
|
|
1660
|
+
description: Job categories assigned to the rep
|
|
1661
|
+
assigned_warehouse:
|
|
1662
|
+
type: string
|
|
1663
|
+
description: Assigned warehouse ID
|
|
1664
|
+
assigned_main_warehouse:
|
|
1665
|
+
type: string
|
|
1666
|
+
description: Assigned main warehouse ID
|
|
1667
|
+
assigned_plan:
|
|
1668
|
+
type: string
|
|
1669
|
+
description: Assigned plan ID
|
|
1670
|
+
force_online_connectivity:
|
|
1671
|
+
type: boolean
|
|
1672
|
+
description: Whether online connectivity is forced
|
|
1673
|
+
assigned_targets:
|
|
1674
|
+
type: array
|
|
1675
|
+
items:
|
|
1676
|
+
type: string
|
|
1677
|
+
description: Assigned targets
|
|
1678
|
+
lines:
|
|
1679
|
+
type: array
|
|
1680
|
+
items:
|
|
1681
|
+
type: string
|
|
1682
|
+
description: Lines assigned to the rep
|
|
1683
|
+
targetResults:
|
|
1684
|
+
type: object
|
|
1685
|
+
description: Target results
|
|
1686
|
+
properties:
|
|
1687
|
+
totalPoints:
|
|
1688
|
+
type: number
|
|
1689
|
+
description: Total points achieved
|
|
1690
|
+
targetsCount:
|
|
1691
|
+
type: number
|
|
1692
|
+
description: Number of targets
|
|
1693
|
+
totalAchievements:
|
|
1694
|
+
type: number
|
|
1695
|
+
description: Total achievements
|
|
1696
|
+
averageAchievements:
|
|
1697
|
+
type: number
|
|
1698
|
+
description: Average achievements
|
|
1699
|
+
pointsCap:
|
|
1700
|
+
type: number
|
|
1701
|
+
description: Points cap
|
|
1702
|
+
previously_assigned_clients:
|
|
1703
|
+
type: array
|
|
1704
|
+
items:
|
|
1705
|
+
type: string
|
|
1706
|
+
description: Previously assigned clients
|
|
1707
|
+
freshchat_id:
|
|
1708
|
+
type: string
|
|
1709
|
+
description: Freshchat ID
|
|
1710
|
+
is_test:
|
|
1711
|
+
type: boolean
|
|
1712
|
+
description: Whether this is a test rep
|
|
1713
|
+
form_v2_option:
|
|
1714
|
+
type: string
|
|
1715
|
+
enum: ["all", "none", "assigned", "client_assigned"]
|
|
1716
|
+
description: Form v2 option
|
|
1717
|
+
assigned_forms_v2:
|
|
1718
|
+
type: array
|
|
1719
|
+
items:
|
|
1720
|
+
type: string
|
|
1721
|
+
description: Assigned forms v2
|
|
1722
|
+
retail_execution_template_option:
|
|
1723
|
+
type: string
|
|
1724
|
+
enum: ["all", "client_assigned", "assigned", "none"]
|
|
1725
|
+
description: Retail execution template option
|
|
1726
|
+
assigned_retail_execution_templates:
|
|
1727
|
+
type: array
|
|
1728
|
+
items:
|
|
1729
|
+
type: string
|
|
1730
|
+
description: Assigned retail execution templates
|
|
1731
|
+
customFields:
|
|
1732
|
+
type: object
|
|
1733
|
+
additionalProperties:
|
|
1734
|
+
oneOf:
|
|
1735
|
+
- type: boolean
|
|
1736
|
+
- type: string
|
|
1737
|
+
- type: number
|
|
1738
|
+
description: Custom fields
|
|
1739
|
+
media:
|
|
1740
|
+
type: array
|
|
1741
|
+
items:
|
|
1742
|
+
type: string
|
|
1743
|
+
description: Media files
|
|
1744
|
+
cover_photo:
|
|
1745
|
+
type: string
|
|
1746
|
+
description: Cover photo URL
|
|
1747
|
+
last_login_time:
|
|
1748
|
+
type: number
|
|
1749
|
+
description: Last login timestamp
|
|
1750
|
+
settings:
|
|
1751
|
+
type: object
|
|
1752
|
+
description: Rep settings
|
|
1753
|
+
properties:
|
|
1754
|
+
allowable_accuracy:
|
|
1755
|
+
type: number
|
|
1756
|
+
description: Allowable GPS accuracy
|
|
1757
|
+
is_item_status_per_visit_limited:
|
|
1758
|
+
type: boolean
|
|
1759
|
+
description: Whether item status per visit is limited
|
|
1760
|
+
item_status_per_visit_limit:
|
|
1761
|
+
type: number
|
|
1762
|
+
description: Item status per visit limit
|
|
1763
|
+
location_permission:
|
|
1764
|
+
type: string
|
|
1765
|
+
enum: ["always_allow", "while_using"]
|
|
1766
|
+
description: Location permission setting
|
|
1767
|
+
activities_report_scope:
|
|
1768
|
+
type: string
|
|
1769
|
+
enum: ["self", "team", "company_namespace"]
|
|
1770
|
+
description: Activities report scope
|
|
1771
|
+
maximum_cash_outstanding_settlement_balance_to_start_day:
|
|
1772
|
+
type: number
|
|
1773
|
+
description: Maximum cash outstanding settlement balance to start day
|
|
1774
|
+
maximum_check_outstanding_settlement_balance_to_start_day:
|
|
1775
|
+
type: number
|
|
1776
|
+
description: Maximum check outstanding settlement balance to start day
|
|
1777
|
+
maximum_total_outstanding_settlement_balance_to_start_day:
|
|
1778
|
+
type: number
|
|
1779
|
+
description: Maximum total outstanding settlement balance to start day
|
|
1780
|
+
watermark_client_name:
|
|
1781
|
+
type: boolean
|
|
1782
|
+
description: Whether to watermark client name
|
|
1783
|
+
watermark_time:
|
|
1784
|
+
type: boolean
|
|
1785
|
+
description: Whether to watermark time
|
|
1786
|
+
watermark_date:
|
|
1787
|
+
type: boolean
|
|
1788
|
+
description: Whether to watermark date
|
|
1789
|
+
watermark_coordinates:
|
|
1790
|
+
type: boolean
|
|
1791
|
+
description: Whether to watermark coordinates
|
|
1792
|
+
rep_must_end_day_after:
|
|
1793
|
+
type: string
|
|
1794
|
+
pattern: "^[0-9]{1,2}:[0-9]{2}$"
|
|
1795
|
+
description: Time rep must end day after (HH:MM format)
|
|
1796
|
+
integration_meta:
|
|
1797
|
+
type: object
|
|
1798
|
+
additionalProperties: true
|
|
1799
|
+
description: Integration metadata
|
|
1800
|
+
company_namespace:
|
|
1801
|
+
type: array
|
|
1802
|
+
items:
|
|
1803
|
+
type: string
|
|
1804
|
+
description: Company namespaces
|
|
1805
|
+
_id:
|
|
1806
|
+
type: string
|
|
1807
|
+
description: Unique identifier for the rep
|
|
1808
|
+
createdAt:
|
|
1809
|
+
type: string
|
|
1810
|
+
format: date-time
|
|
1811
|
+
description: Creation timestamp
|
|
1812
|
+
updatedAt:
|
|
1813
|
+
type: string
|
|
1814
|
+
format: date-time
|
|
1815
|
+
description: Last update timestamp
|
|
1816
|
+
__v:
|
|
1817
|
+
type: number
|
|
1818
|
+
description: Version number
|
|
1819
|
+
RepUpdateResult:
|
|
1820
|
+
$ref: "#/components/schemas/RepSchema"
|
|
1821
|
+
description: Result of updating a rep
|
|
1822
|
+
RepRemoveResult:
|
|
1823
|
+
$ref: "#/components/schemas/RepSchema"
|
|
1824
|
+
description: Result of removing a rep
|