-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
2076 lines (2073 loc) · 66.2 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Endpoints
description: >-
Oyster uses OAuth2 to enable customers to grant access to their data to
third party applications. Customers also need to use this API to
authenticate themselves when making API requests.
version: v1
license:
name: MIT
servers:
- url: https://api.oysterhr.com
tags:
- description: >-
With the Time Off API, you can manage your team's time off requests.
You can approve or decline specific time off requests, access information
about a particular request, and get updates on all time off requests.
It also provides details on time off entitlements for each engagement
within the company
name: Time Off
- description: >-
Expenses API allows you to remotely manage expenses of your team.
Approve or decline a specific expense, get info about a specific expense
or receive real-time information about all expenses.
name: Expenses
- name: Engagements
- name: Payroll
- name: Authentication
- name: Company
- name: Departments
- name: Operations
paths:
/oauth2/token:
post:
tags:
- Authentication
summary: Create an access token
operationId: Authentication_createAccessToken
description: >
Oyster grants access to API resources based on OAuth. This means that
individual customers grant API access to Developer Apps that you create.
This applies to both customers and partners. Follow these simple steps:
<br><br> 1. [Create an Oyster account](https://app.oysterhr.com/sign_up)
or [log in](https://app.oysterhr.com/users/sign_in) to your existing
account. <br> <br> 2. Create an Oyster Developer App in the [Developer
Tab](https://app.oysterhr.com/developer) (If you can't see the developer
tab please contact us to enable it for your account). <br> Hint: If you
are a customer doing this as a one time action you don't need to specify
a functioning URL as step 3 will explain. <br> <br> 3. If you are a
customer you can simply click on the "Authorization URL" and grant
access to your own app. You will be redirected to the URL you specified
when creating the Developer App. In the URL you will see that
`?code=xxx` has been added to the URL. This is the `code` you need to
create an access token. <br> If you are a partner add "Authorization URL
to your application. The redirect_url should be a URL that goes back to
your app and you're able to programmatically retrieve the URL query
param of `?code=xxx` to then create an access token. <br> <br> 4. You
need to first request an `authorization_code` with the API request
detailed below. This will provide an `access_token` that is used as the
Bearer Token for making API requests to Oyster. Ensure that you store
the `refresh_token` for making future API requests. <br> <br> 5. If your
`access_token` has expired then request a new one using your
`refresh_token` that you have stored earlier. Ensure you store the new
`refresh_token` each time as the previous ones will expire.
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AuthenticationCreateAccessTokenRequest'
responses:
'201':
description: Create an access token to make an API request
content:
application/json:
schema:
$ref: '#/components/schemas/Token'
/v1/expenses/{id}/approve:
post:
tags:
- Expenses
summary: Approve expense
operationId: Expenses_approveExpense
security:
- bearer_auth:
- manage
description: Approves an expense.
parameters:
- description: Expense ID
name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful
'403':
description: an invalid OAuth scope
content:
application/json:
examples:
an invalid OAuth scope:
value:
error:
message: Access to this resource requires scope "manage".
schema:
$ref: '#/components/schemas/error'
'404':
description: Resource does not exist, or no permission to access resource
'422':
description: Operation cannot be performed
content:
application/json:
examples:
Operation cannot be performed:
value:
errors:
- message: Expense has been approved already
schema:
$ref: '#/components/schemas/errors'
/v1/expenses/{id}/decline:
post:
tags:
- Expenses
summary: Decline expense
operationId: Expenses_declineExpense
security:
- bearer_auth:
- manage
description: Declines an expense.
parameters:
- description: Expense ID
name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExpensesDeclineExpenseRequest'
examples:
Successful:
summary: Successful
value:
reason: exceeds budget for this period
responses:
'200':
description: Successful
'403':
description: an invalid OAuth scope
content:
application/json:
examples:
an invalid OAuth scope:
value:
error:
message: Access to this resource requires scope "manage".
schema:
$ref: '#/components/schemas/error'
'404':
description: Resource does not exist, or no permission to access resource
'422':
description: Operation cannot be performed
content:
application/json:
examples:
Operation cannot be performed:
value:
errors:
- message: Expense has been declined already
schema:
$ref: '#/components/schemas/errors'
/v1/expenses/{id}:
get:
tags:
- Expenses
summary: Retrieve an individual expense
operationId: Expenses_getById
security:
- bearer_auth:
- read
description: Returns details for an expense with a given expense ID.
parameters:
- description: Expense ID
name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful
content:
application/json:
examples:
Successful:
value:
data:
description: >-
Quia amet incidunt. Deleniti odit et. Repellendus id
harum.
expenseId: zxbhh9d8
name: Thanksgiving Volcano coffee
amount:
decimal: '631.87'
currencyCode: EUR
category: CAR
incurredOn: '2022-10-15'
submittedAt: '2022-10-15T12:34:56Z'
reviewState: UNREVIEWED
reviewedAt: null
receiptAmount:
decimal: '631.87'
currencyCode: USD
receiptUrl: null
engagement:
engagementId: SsvwPW9p
name: null
engagementType: EMPLOYMENT
source: OYSTER
schema:
$ref: '#/components/schemas/ExpensesGetByIdResponse'
'404':
description: Resource does not exist, or no permission to access resource
/v1/expenses:
post:
tags:
- Expenses
summary: Create expense
operationId: Expenses_createOperationKey
security:
- bearer_auth:
- manage
description: >-
Creates a new expense for an engagement. This is an asynchronous
operation. Returns operationKey that can be used to retrieve the
operation to know if it's successfully completed
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExpensesCreateOperationKeyRequest'
examples:
Successfully created async operation:
summary: Successfully created async operation
value:
description: ''
engagementId: Xse7pSwV
name: An expense
category: HOME_OFFICE
incurredOn: '2022-10-15'
receiptAmount:
decimal: '1.23'
currencyCode: GBP
receiptUrl: https://www.example.com/receipts/test.pdf
responses:
'202':
description: Successfully created async operation
content:
application/json:
examples:
Successfully created async operation:
value:
meta:
operationKey: 5702f2db-6f1c-4da3-9b16-414dad0271ee
schema:
$ref: '#/components/schemas/asyncResponse'
'400':
description: improperly structured JSON
content:
application/json:
examples:
improperly structured JSON:
value:
errors:
- field: engagementId
message: Engagement id is in invalid format
- field: name
message: Name must be filled
- field: incurredOn
message: Incurred on must be a date
- field: category
message: Category is in invalid format
- field: receiptUrl
message: Receipt url is in invalid format
- field: receiptAmount.decimal
message: Receipt amount decimal must be a string
- field: receiptAmount.currencyCode
message: Receipt amount currency code is in invalid format
schema:
$ref: '#/components/schemas/fieldErrors'
'403':
description: an invalid OAuth scope
content:
application/json:
examples:
an invalid OAuth scope:
value:
error:
message: Access to this resource requires scope "manage".
schema:
$ref: '#/components/schemas/error'
'422':
description: Unprocessable entity
content:
application/json:
examples:
Unprocessable entity:
value:
errors:
- message: Category must have a valid category
schema:
$ref: '#/components/schemas/fieldErrors'
/v1/company:
get:
tags:
- Company
summary: Retrieve company details
operationId: Company_detailsRetrieve
security:
- bearer_auth:
- read
description: Returns details about the connected company
responses:
'200':
description: Successful
content:
application/json:
examples:
Successful:
value:
data:
companyId: uPeGkqOp
name: company 00035 name
registrationNumber: S4866459C
addresses:
corporateAddress:
addressId: KgmrAgaO
addressLine1: 448 Bernita Locks
addressLine2: Autumn Crossing
city: New Leshastad
region: OK
countryCode: CA
postalCode: '64367'
billingAddress:
addressId: RvXZpmBP
addressLine1: 317 Isiah Passage
addressLine2: Eagle Place
city: Kerlukehaven
region: UT
countryCode: AU
postalCode: 91386-6007
schema:
$ref: '#/components/schemas/CompanyDetailsRetrieveResponse'
'401':
description: an invalid access token
content:
application/json:
examples:
an invalid access token:
value:
error:
message: The access token is invalid
schema:
$ref: '#/components/schemas/error'
/v1/departments:
get:
tags:
- Departments
summary: Retrieve all departments
operationId: Departments_getAll
security:
- bearer_auth:
- read
description: Returns a list of departments
parameters:
- name: per_page
in: query
required: false
schema:
type: integer
- name: page
in: query
required: false
schema:
type: integer
responses:
'200':
description: Successful
content:
application/json:
examples:
No departments:
value:
data: []
meta:
items: 100
count: 0
page: 1
pages: 1
firstUrl: /v1/departments?perPage=100&page=1
lastUrl: /v1/departments?perPage=100&page=1
pageUrl: /v1/departments?perPage=100&page=1
nextUrl: /v1/departments?perPage=100&page=
prevUrl: /v1/departments?perPage=100&page=
Successful:
value:
data:
- description: >-
Listicle authentic fingerstache paleo kombucha
shoreditch yr.
departmentId: V5PNwnEh
name: Health & Beauty
engagementsCount: 0
- description: >-
Kale chips slow-carb tote bag tofu portland 3 wolf
moon bespoke letterpress.
departmentId: MK0nqu2W
name: Toys
engagementsCount: 0
- description: Taxidermy meh try-hard yr echo waistcoat ramps ennui.
departmentId: f2I3ilRT
name: Outdoors & Grocery
engagementsCount: 0
- description: >-
Yolo vhs xoxo park blue bottle artisan sustainable
polaroid.
departmentId: NyEkcAoV
name: Toys & Sports
engagementsCount: 0
- description: >-
Post-ironic typewriter irony church-key food truck
cardigan.
departmentId: dTOzpd6Y
name: Outdoors
engagementsCount: 0
meta:
items: 100
count: 5
page: 1
pages: 1
firstUrl: /v1/departments?perPage=100&page=1
lastUrl: /v1/departments?perPage=100&page=1
pageUrl: /v1/departments?perPage=100&page=1
nextUrl: /v1/departments?perPage=100&page=
prevUrl: /v1/departments?perPage=100&page=
schema:
$ref: '#/components/schemas/DepartmentsGetAllResponse'
'401':
description: an invalid access token
content:
application/json:
examples:
an invalid access token:
value:
error:
message: The access token is invalid
schema:
$ref: '#/components/schemas/error'
/v1/engagements/{id}:
get:
tags:
- Engagements
summary: Retrieve an individual engagement
operationId: Engagements_getById
security:
- bearer_auth:
- read
description: Returns details for an engagement with a given engagement ID.
parameters:
- description: Engagement ID
name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful
content:
application/json:
examples:
Successful:
value:
data:
engagementId: uxiFbbaK
modifiedAt: '2022-10-15T12:34:56Z'
startDate: '2022-10-15'
engagementType: EMPLOYMENT
state: DRAFT
role: Principal Technology Planner
countryCode: CW
personalDetails:
name: Laurette Anderson
addresses:
livingAddress: null
mailingAddress: null
employment:
employmentId: uxiFbbaK
fullLegalName: null
email: null
employmentType: null
lastDayOn: null
salary:
decimal: '12345.00'
currencyCode: EUR
contract: null
benefitEnrollments: []
terminations: []
department: null
schema:
$ref: '#/components/schemas/EngagementsGetByIdResponse'
'404':
description: Resource does not exist, or no permission to access resource
/v1/engagements:
get:
tags:
- Engagements
summary: Retrieve all engagements
operationId: Engagements_getAll
security:
- bearer_auth:
- read
description: Returns a list of engagements
parameters:
- name: per_page
in: query
required: false
schema:
type: integer
- name: page
in: query
required: false
schema:
type: integer
responses:
'200':
description: Successful
content:
application/json:
examples:
No engagements:
value:
data: []
meta:
items: 100
count: 0
page: 1
pages: 1
firstUrl: /v1/engagements?perPage=100&page=1
lastUrl: /v1/engagements?perPage=100&page=1
pageUrl: /v1/engagements?perPage=100&page=1
nextUrl: /v1/engagements?perPage=100&page=
prevUrl: /v1/engagements?perPage=100&page=
Successful:
value:
data:
- engagementId: 2ug3WBT0
modifiedAt: '2022-10-15T12:34:56Z'
startDate: '2022-10-15'
engagementType: EMPLOYMENT
state: DRAFT
role: Banking Supervisor Consultant
countryCode: MF
personalDetails:
name: null
addresses:
livingAddress: null
mailingAddress: null
livingAddress: null
mailingAddress: null
employment:
employmentId: 2ug3WBT0
name: Rep Melda Stark
fullLegalName: Rep Melda Stark
email: james.treutel@mayer.test
employmentType: null
lastDayOn: null
salarySubunit: 1234500
salaryCurrencyCode: EUR
salary:
decimal: '12345.00'
currencyCode: EUR
contract: null
benefitEnrollments: []
terminations: []
department: null
usefulInfo: null
- engagementId: AVT7lRbj
modifiedAt: '2022-10-15T12:34:56Z'
startDate: '2022-10-15'
engagementType: EMPLOYMENT
state: DRAFT
role: Corporate Manufacturing Liaison Consultant
countryCode: NZ
personalDetails:
name: null
addresses:
livingAddress: null
mailingAddress: null
livingAddress: null
mailingAddress: null
employment:
employmentId: AVT7lRbj
name: Winston Breitenberg
fullLegalName: Winston Breitenberg
email: estrella.tromp@green-greenfelder.test
employmentType: null
lastDayOn: null
salarySubunit: 1234500
salaryCurrencyCode: EUR
salary:
decimal: '12345.00'
currencyCode: EUR
contract: null
benefitEnrollments: []
terminations: []
department: null
usefulInfo: null
- engagementId: yBY8ab5n
modifiedAt: '2022-10-15T12:34:56Z'
startDate: '2022-10-15'
engagementType: EMPLOYMENT
state: DRAFT
role: Education Manager Consultant
countryCode: UG
personalDetails:
name: null
addresses:
livingAddress: null
mailingAddress: null
livingAddress: null
mailingAddress: null
employment:
employmentId: yBY8ab5n
name: Delia Ward
fullLegalName: Delia Ward
email: shawn.bauch@kerluke.test
employmentType: null
lastDayOn: null
salarySubunit: 1234500
salaryCurrencyCode: EUR
salary:
decimal: '12345.00'
currencyCode: EUR
contract: null
benefitEnrollments: []
terminations: []
department: null
usefulInfo: null
- engagementId: VVlXNYcy
modifiedAt: '2022-10-15T12:34:56Z'
startDate: '2022-10-15'
engagementType: CONTRACT
state: IN_PROGRESS
role: Future Specialist Consultant
countryCode: MG
personalDetails:
name: Henry Reichert
addresses:
livingAddress: null
mailingAddress: null
livingAddress: null
mailingAddress: null
employment: null
contract:
contractId: VVlXNYcy
name: Bethanie Turcotte
email: song@wiegand-ledner.test
billingType: FIXED
taxIdNumber: null
benefitEnrollments: []
terminations: []
department: null
usefulInfo: null
- engagementId: kUhg4dS4
modifiedAt: '2022-10-15T12:34:56Z'
startDate: '2022-10-15'
engagementType: CONTRACT
state: IN_PROGRESS
role: Customer Banking Strategist Consultant
countryCode: HK
personalDetails:
name: Anibal Bins
addresses:
livingAddress: null
mailingAddress: null
livingAddress: null
mailingAddress: null
employment: null
contract:
contractId: kUhg4dS4
name: Mr. Ronnie Klocko
email: irvin.medhurst@mohr.example
billingType: FIXED
taxIdNumber: null
benefitEnrollments: []
terminations: []
department: null
meta:
items: 100
count: 5
page: 1
pages: 1
firstUrl: /v1/engagements?perPage=100&page=1
lastUrl: /v1/engagements?perPage=100&page=1
pageUrl: /v1/engagements?perPage=100&page=1
nextUrl: /v1/engagements?perPage=100&page=
prevUrl: /v1/engagements?perPage=100&page=
schema:
$ref: '#/components/schemas/EngagementsGetAllResponse'
'401':
description: an invalid access token
content:
application/json:
examples:
an invalid access token:
value:
error:
message: The access token is invalid
schema:
$ref: '#/components/schemas/error'
/v1/meta/operations/{operation_key}:
get:
tags:
- Operations
summary: Retrieve an operation
operationId: Operations_getByOperationKey
security:
- bearer_auth:
- read
description: Returns details for an operation with a given operation key.
parameters:
- description: Operation key
name: operation_key
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful
content:
application/json:
examples:
Successful:
value:
request:
method: GET
path: /resources
queryParams:
foo: bar
responseCode: 200
data:
foo: bar
bar: baz
meta:
completed: true
success: true
schema:
$ref: '#/components/schemas/OperationsGetByOperationKeyResponse'
'404':
description: Resource does not exist, or no permission to access resource
/v1/payroll/{id}:
get:
tags:
- Payroll
summary: Retrieve an individual payroll
operationId: Payroll_getById
security:
- bearer_auth:
- read
description: Returns details for a payroll with a given payroll ID.
parameters:
- description: Payroll ID
name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful
content:
application/json:
examples:
Successful:
value:
data:
payrollId: UmTDnTUV
currencyCode: USD
cutoffTimeForPayroll: '2022-10-07T05:00:00.000Z'
state: DRAFT
payrollRecordsCount: 2
records:
- engagementId: CjVBtL3E
currencyCode: EUR
monthlyPaymentsTotalAmount:
decimal: '0.00'
currencyCode: USD
allowancesTotalAmount:
decimal: '0.00'
currencyCode: USD
benefitsTotalAmount:
decimal: '0.00'
currencyCode: USD
bonusesTotalAmount:
decimal: '0.00'
currencyCode: USD
addOnsTotalAmount:
decimal: '0.00'
currencyCode: USD
taxesTotalAmount:
decimal: '0.00'
currencyCode: USD
trueUpsTotalAmount:
decimal: '0.00'
currencyCode: USD
oysterFeesTotalAmount:
decimal: '0.00'
currencyCode: USD
engagement:
name: Georgeann Hintz
cutoffMonthDay: 6
engagementType: EMPLOYMENT
- engagementId: R73L6T8L
currencyCode: EUR
monthlyPaymentsTotalAmount:
decimal: '0.00'
currencyCode: USD
allowancesTotalAmount:
decimal: '0.00'
currencyCode: USD
benefitsTotalAmount:
decimal: '0.00'
currencyCode: USD
bonusesTotalAmount:
decimal: '0.00'
currencyCode: USD
addOnsTotalAmount:
decimal: '0.00'
currencyCode: USD
taxesTotalAmount:
decimal: '0.00'
currencyCode: USD
trueUpsTotalAmount:
decimal: '0.00'
currencyCode: USD
oysterFeesTotalAmount:
decimal: '0.00'
currencyCode: USD
engagement:
name: Msgr Floyd Streich
cutoffMonthDay: 6
engagementType: EMPLOYMENT
schema:
$ref: '#/components/schemas/PayrollGetByIdResponse'
'404':
description: Resource does not exist, or no permission to access resource
/v1/payroll:
get:
tags:
- Payroll
summary: Retrieve all payroll
operationId: Payroll_getAllPayrolls
security:
- bearer_auth:
- read
description: Returns a list of payrolls
parameters:
- name: per_page
in: query
required: false
schema:
type: integer
- name: page
in: query
required: false
schema:
type: integer
- name: from
in: query
required: false
schema:
type: string
- name: to
in: query
required: false
schema:
type: string
- name: include_records
in: query
required: false
schema:
type: boolean
responses:
'200':
description: Successful
content:
application/json:
examples:
No payrolls:
value:
data: []
meta:
items: 100
count: 0
page: 1
pages: 1
firstUrl: /v1/payroll?perPage=100&page=1&from=&to=&includeRecords=
lastUrl: /v1/payroll?perPage=100&page=1&from=&to=&includeRecords=
pageUrl: /v1/payroll?perPage=100&page=1&from=&to=&includeRecords=
nextUrl: /v1/payroll?perPage=100&page=&from=&to=&includeRecords=
prevUrl: /v1/payroll?perPage=100&page=&from=&to=&includeRecords=
Successful:
value:
data:
- payrollId: abw0ovv2
currencyCode: USD
cutoffTimeForPayroll: '2022-10-07T05:00:00.000Z'
state: DRAFT
payrollRecordsCount: 2
- payrollId: ED6xssq7
currencyCode: USD
cutoffTimeForPayroll: '2022-10-07T05:00:00.000Z'
state: DRAFT
payrollRecordsCount: 2
meta:
items: 100
count: 2
page: 1
pages: 1
firstUrl: >-
/v1/payroll?perPage=100&page=1&from=2023-03&to=2023-04&includeRecords=
lastUrl: >-
/v1/payroll?perPage=100&page=1&from=2023-03&to=2023-04&includeRecords=
pageUrl: >-
/v1/payroll?perPage=100&page=1&from=2023-03&to=2023-04&includeRecords=
nextUrl: >-
/v1/payroll?perPage=100&page=&from=2023-03&to=2023-04&includeRecords=
prevUrl: >-
/v1/payroll?perPage=100&page=&from=2023-03&to=2023-04&includeRecords=
schema:
$ref: '#/components/schemas/PayrollGetAllPayrollsResponse'
'401':
description: an invalid access token
content:
application/json:
examples:
an invalid access token:
value:
error:
message: The access token is invalid
schema:
$ref: '#/components/schemas/error'
/v1/time_off/entitlements:
get:
tags:
- Time Off
summary: Retrieve entitlements
operationId: TimeOff_getEntitlements
security:
- bearer_auth:
- read
description: Returns entitlements for each engagement of the company.
parameters:
- name: per_page
in: query
required: false
schema:
type: integer
- name: page
in: query
required: false
schema:
type: integer
responses:
'200':
description: Successful
content:
application/json:
examples:
No engagements:
value:
data: []
meta:
items: 100
count: 0
page: 1
pages: 1
firstUrl: /v1/time_off/entitlements?perPage=100&page=1
lastUrl: /v1/time_off/entitlements?perPage=100&page=1
pageUrl: /v1/time_off/entitlements?perPage=100&page=1