-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
6539 lines (6539 loc) · 224 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.0
info:
title: Partner API
description: A Semi-Private API to let third parties communicate with PayFit
version: 1.0.0
x-konfig-ignore:
object-with-no-properties: true
servers:
- description: The PayFit API production server
url: https://partner-api.payfit.com
tags:
- name: Company
- name: Contract
- name: Collaborator
paths:
/companies/{companyId}:
get:
tags:
- Company
summary: Get Company
operationId: GET_company
security:
- partner-api-oauth: []
description: Returns the basic information of the company.
parameters:
- description: The id of the company
in: path
name: companyId
schema:
type: string
required: true
responses:
'200':
description: The fetched company
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyResponse'
examples:
company:
summary: An example of company
value:
id: '123456789'
name: Awesome company
country: GB
nbActiveContracts: 12
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompany400Response'
examples:
error:
summary: An example of an error message
value:
code: 400
error: Bad request
details: Field "id" is required.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompany401Response'
examples:
error:
summary: An example of an error message
value:
code: 401
error: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompany403Response'
examples:
error:
summary: An example of an error message
value:
code: 403
error: Forbidden action
details: Missing scope "contracts:read".
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompany404Response'
examples:
error:
summary: An example of an error message
value:
code: 404
error: Ressource not found
details: The provided id is wrong
/companies/{companyId}/accounting:
get:
tags:
- Company
summary: Get accounting data
operationId: GET_companyAccounting
security:
- partner-api-oauth:
- accounting:read
description: >-
Returns accounting of the company for a given month. The data is
structured as CSV.
parameters:
- description: The id of the company
in: path
name: companyId
schema:
type: string
required: true
- description: >-
The month to fetch the data for. This must be in the format YYYYMM,
January being the month "01".
in: query
name: date
schema:
type: string
pattern: ^2\d{3}(0[1-9]|1[0-2])$
required: true
example: 202212
responses:
'200':
description: The accounting file
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/GetCompanyAccountingResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyAccounting400Response'
examples:
error:
summary: An example of an error message
value:
code: 400
error: Bad request
details: Field "id" is required.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyAccounting401Response'
examples:
error:
summary: An example of an error message
value:
code: 401
error: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyAccounting403Response'
examples:
error:
summary: An example of an error message
value:
code: 403
error: Forbidden action
details: Missing scope "contracts:read".
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyAccounting404Response'
examples:
error:
summary: An example of an error message
value:
code: 404
error: Ressource not found
details: The provided id is wrong
/companies/{companyId}/accounting-v2:
get:
tags:
- Company
summary: Get accounting v2 data
operationId: GET_companyAccountingV2
security:
- partner-api-oauth:
- accounting:read
description: >
WARNING: this endpoint is in beta and is subject to changes. We
discourage its usage in production for now. Only available for FR and
UK. Returns accounting data of the company for a given month. For French
companies, the data returned is the same than the one in the automatic
accounting exports, so the company accounting exports have to be
configured properly in order to get details by analytical code, and by
employee. For UK companies, the data returned is the same than the one
in the automatic payroll journals, so the company payroll journals have
to be configured properly in order to get details by employee or by cost
center.
parameters:
- description: The id of the company
in: path
name: companyId
schema:
type: string
required: true
- description: >-
The month to fetch the data for. This must be in the format YYYYMM,
January being the month "01".
in: query
name: date
schema:
type: string
pattern: ^2\d{3}(0[1-9]|1[0-2])$
required: true
example: 202212
responses:
'200':
description: The accounting JSON of the company for a given month
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyAccountingV2Response'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyAccountingV2400Response'
examples:
error:
summary: An example of an error message
value:
code: 400
error: Bad request
details: Field "id" is required.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyAccountingV2401Response'
examples:
error:
summary: An example of an error message
value:
code: 401
error: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyAccountingV2403Response'
examples:
error:
summary: An example of an error message
value:
code: 403
error: Forbidden action
details: Missing scope "contracts:read".
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyAccountingV2404Response'
examples:
error:
summary: An example of an error message
value:
code: 404
error: Ressource not found
details: The provided id is wrong
/companies/{companyId}/payroll-status:
get:
tags:
- Company
summary: Get Payroll Status
operationId: GET_companyPayrollStatus
security:
- partner-api-oauth: []
description: Returns the payroll status on a given pay period.
parameters:
- description: The id of the company
in: path
name: companyId
schema:
type: string
required: true
- description: >-
The month to fetch the data for. This must be in the format YYYYMM,
January being the month "01".
in: query
name: date
schema:
type: string
pattern: ^2\d{3}(0[1-9]|1[0-2])$
required: true
example: 202212
responses:
'200':
description: The payroll status
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyPayrollStatusResponse'
examples:
payrollStatusCompleted:
summary: An example of payroll status completed
value:
status: completed
executionEndDate: '2022-09-22T11:56:24.221Z'
payrollStatusNotCompleted:
summary: An example of payroll status not completed
value:
status: not_completed
executionEndDate: null
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyPayrollStatus400Response'
examples:
error:
summary: An example of an error message
value:
code: 400
error: Bad request
details: Field "id" is required.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyPayrollStatus401Response'
examples:
error:
summary: An example of an error message
value:
code: 401
error: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyPayrollStatus403Response'
examples:
error:
summary: An example of an error message
value:
code: 403
error: Forbidden action
details: Missing scope "contracts:read".
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/GetCompanyPayrollStatus404Response'
examples:
error:
summary: An example of an error message
value:
code: 404
error: Ressource not found
details: The provided id is wrong
/companies/{companyId}/health-insurance-contracts:
get:
tags:
- Company
summary: List all Health Insurance contracts
operationId: GET_healthInsuranceContracts
security:
- partner-api-oauth:
- health-insurance:affiliation:read
description: Returns all Health Insurance contracts.
parameters:
- description: The id of the company
in: path
name: companyId
schema:
type: string
required: true
responses:
'200':
description: The health insurance contracts for a given company
content:
application/json:
schema:
$ref: '#/components/schemas/GetHealthInsuranceContractsResponse'
examples:
healthInsuranceContracts:
summary: An example of health insurance contracts
value:
contracts:
- idContrat: 09977c3c-0ec0-417f-a871-f0e4fe02ed7d
refContrat: PCC123456789
codePopulation: '15'
codeOption: '20'
affiliatedContractIds:
- 646ce15522ce2fd46c8ff724
- 646ce15522ce2fd46c8ff725
modeCalculCotisation: '1'
baseDeCotisation: '3'
tauxCotisationPatronale: 0.001
tauxCotisationSalariale: 0.001
- idContrat: ea958903-63c9-46a1-9934-4912f6147da3
refContrat: XXX123456789
codePopulation: '6'
codeOption: '14'
affiliatedContractIds:
- 646ce15522ce2fd46c8ff724
- 646ce15522ce2fd46c8ff725
modeCalculCotisation: '2'
baseDeCotisation: '1'
tauxCotisationPatronale: 0.003
tauxCotisationSalariale: 0.002
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/GetHealthInsuranceContracts400Response'
examples:
error:
summary: An example of an error message
value:
code: 400
error: Bad request
details: Field "id" is required.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/GetHealthInsuranceContracts401Response'
examples:
error:
summary: An example of an error message
value:
code: 401
error: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/GetHealthInsuranceContracts403Response'
examples:
error:
summary: An example of an error message
value:
code: 403
error: Forbidden action
details: Missing scope "contracts:read".
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/GetHealthInsuranceContracts404Response'
examples:
error:
summary: An example of an error message
value:
code: 404
error: Ressource not found
details: The provided id is wrong
/companies/{companyId}/provident-fund-contracts:
get:
tags:
- Company
summary: List all Provident Fund contracts
operationId: GET_providentFundContracts
security:
- partner-api-oauth:
- health-insurance:affiliation:read
description: Returns all Provident Fund contracts.
parameters:
- description: The id of the company
in: path
name: companyId
schema:
type: string
required: true
responses:
'200':
description: The provident fund contracts for a given company
content:
application/json:
schema:
$ref: '#/components/schemas/GetProvidentFundContractsResponse'
examples:
providentFundContracts:
summary: An example of provident fund contracts
value:
contracts:
- idContrat: 09977c3c-0ec0-417f-a871-f0e4fe02ed7d
refContrat: PCC123456789
codePopulation: '15'
codeOption: '20'
affiliatedContractIds:
- 646ce15522ce2fd46c8ff724
- 646ce15522ce2fd46c8ff725
modeCalculCotisation: '1'
baseDeCotisation: '3'
- idContrat: ea958903-63c9-46a1-9934-4912f6147da3
refContrat: XXX123456789
codePopulation: '6'
codeOption: '14'
affiliatedContractIds:
- 646ce15522ce2fd46c8ff724
- 646ce15522ce2fd46c8ff725
modeCalculCotisation: '2'
baseDeCotisation: '1'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/GetProvidentFundContracts400Response'
examples:
error:
summary: An example of an error message
value:
code: 400
error: Bad request
details: Field "id" is required.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/GetProvidentFundContracts401Response'
examples:
error:
summary: An example of an error message
value:
code: 401
error: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/GetProvidentFundContracts403Response'
examples:
error:
summary: An example of an error message
value:
code: 403
error: Forbidden action
details: Missing scope "contracts:read".
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/GetProvidentFundContracts404Response'
examples:
error:
summary: An example of an error message
value:
code: 404
error: Ressource not found
details: The provided id is wrong
/companies-fr/{companyId}:
get:
tags:
- Company
summary: Get Company (FR)
operationId: Company_getBasicInfoFr
security:
- partner-api-oauth: []
description: Returns the basic information of the company with french specific data.
parameters:
- description: The id of the company
in: path
name: companyId
schema:
type: string
required: true
responses:
'200':
description: The french fetched company
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGetBasicInfoFrResponse'
examples:
companyFr:
summary: An example of french company
value:
id: '1234567899'
name: Awesome company
country: FR
nbActiveContracts: 12
siret: 362 521 879 00034
siren: 362 521 879
address: 1 RUE DE SAINT PETERSBOURG
city: PARIS
postalCode: '75018'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGetBasicInfoFr400Response'
examples:
error:
summary: An example of an error message
value:
code: 400
error: Bad request
details: Field "id" is required.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGetBasicInfoFr401Response'
examples:
error:
summary: An example of an error message
value:
code: 401
error: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGetBasicInfoFr403Response'
examples:
error:
summary: An example of an error message
value:
code: 403
error: Forbidden action
details: Missing scope "contracts:read".
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGetBasicInfoFr404Response'
examples:
error:
summary: An example of an error message
value:
code: 404
error: Ressource not found
details: The provided id is wrong
/companies/{companyId}/contracts:
get:
tags:
- Contract
summary: List all Contracts
operationId: GET_contracts
security:
- partner-api-oauth:
- contracts:read
description: Returns all Contracts. This list is paginated.
parameters:
- description: The id of the company
in: path
name: companyId
schema:
type: string
required: true
- description: The encoded pagination token
in: query
name: nextPageToken
required: false
schema:
title: nextPageToken
type: string
additionalProperties: false
- description: >-
Allows to define the maximum number of items to fetch at once. (Max:
50, Default: 10)
in: query
name: maxResults
required: false
schema:
title: maxResults
type: string
additionalProperties: false
default: '10'
responses:
'200':
description: All active, pending and last year archived contracts
content:
application/json:
schema:
$ref: '#/components/schemas/GetContractsResponse'
examples:
contracts:
summary: An example of contracts
value:
meta:
nextPageToken: eyJsaW1pdCI6NTAsIm9mZnNldCI6NTB9
count: 2
contracts:
- summary: An example of Alice's contract fr
firstName: Alice
lastName: Dupond
birthName: Martin
birthDate: '1987-04-14'
managerContractId: 5b59e7b282ddef55f860d324
value:
- summary: An example of Alice's contract
statutConventionnelDsn: '04'
natureContratDsn: '08'
motifRuptureDeContratDsn: null
idcc: '0413'
healthInsuranceContractIds:
- fcaacba9-e790-4cfb-8663-c8531b239d36
providentFundContractIds:
- fcaacba9-e790-4cfb-8663-c8531b239d37
value:
contractId: 5b59e7b282ddef55f860d322
companyId: 5b59e7b182ddef55f860d311
collaboratorId: 6fe3a703-89f5-414d-8190-88f0d80435a3
jobName: Designer
startDate: '2018-07-12'
endDate: null
probationEndDate: null
status: ACTIVE
standardWeeklyHours: 35
fullTimeEquivalent: 1
isFullTime: true
- summary: An example of Bob's contract fr
firstName: Bob
lastName: Martin
birthName: Dupond
birthDate: '1990-01-01'
managerContractId: null
value:
- summary: An example of Bob's contract
statutConventionnelDsn: '01'
natureContratDsn: '10'
motifRuptureDeContratDsn: '998'
idcc: '0413'
healthInsuranceContractIds:
- fcaacba9-e790-4cfb-8663-c8531b239d36
providentFundContractIds:
- fcaacba9-e790-4cfb-8663-c8531b239d37
value:
contractId: 5b59e7b282ddef55f860d325
companyId: 5b59e7b182ddef55f860d311
collaboratorId: 6fe3a703-89f5-414d-8190-88f0d80435a3
jobName: Architect
startDate: '2017-12-21'
status: ACTIVE
endDate: '2020-07-06'
probationEndDate: '2020-07-06'
standardWeeklyHours: null
fullTimeEquivalent: null
isFullTime: null
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/GetContracts400Response'
examples:
error:
summary: An example of an error message
value:
code: 400
error: Bad request
details: Field "id" is required.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/GetContracts401Response'
examples:
error:
summary: An example of an error message
value:
code: 401
error: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/GetContracts403Response'
examples:
error:
summary: An example of an error message
value:
code: 403
error: Forbidden action
details: Missing scope "contracts:read".
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/GetContracts404Response'
examples:
error:
summary: An example of an error message
value:
code: 404
error: Ressource not found
details: The provided id is wrong
/companies/{companyId}/contracts/time:
get:
tags:
- Contract
summary: List all Worked Time by contract
operationId: Contract_listWorkedTimeByPayPeriod
security:
- partner-api-oauth:
- time:read
description: >-
Returns the worked time for every contract for the given pay period.
This list is paginated.
parameters:
- description: The id of the company
in: path
name: companyId
schema:
type: string
required: true
- description: The encoded pagination token
in: query
name: nextPageToken
required: false
schema:
title: nextPageToken
type: string
additionalProperties: false
- description: >-
Allows to define the maximum number of items to fetch at once. (Max:
50, Default: 10)
in: query
name: maxResults
required: false
schema:
title: maxResults
type: string
additionalProperties: false
default: '10'
- description: >-
The month to fetch the data for. This must be in the format YYYYMM,
January being the month "01".
in: query
name: date
schema:
type: string
pattern: ^2\d{3}(0[1-9]|1[0-2])$
required: true
example: 202212
responses:
'200':
description: >-
Returns the worked time for every contract for the given pay period.
Note : this endpoint is only available for French companies for now.
content:
application/json:
schema:
$ref: '#/components/schemas/ContractListWorkedTimeByPayPeriodResponse'
examples:
contracts:
value:
meta:
nextPageToken: eyJsaW1pdCI6NTAsIm9mZnNldCI6NTB9
count: 2
contracts:
- contractId: 5b59e7b282ddef55f860d322
effectiveWorkedTime: 22
payedWorkedTime: 22
workTimeUnit: days
- contractId: 5b59e7b282ddef55f860d325
effectiveWorkedTime: 130
payedWorkedTime: 140
workTimeUnit: hours
'400':
description: Bad Request
content:
application/json:
schema:
$ref: >-
#/components/schemas/ContractListWorkedTimeByPayPeriod400Response
examples:
error:
summary: An example of an error message
value:
code: 400
error: Bad request
details: Field "id" is required.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: >-
#/components/schemas/ContractListWorkedTimeByPayPeriod401Response
examples:
error:
summary: An example of an error message
value:
code: 401
error: Unauthorized
'403':
description: Forbidden
content:
application/json:
schema:
$ref: >-
#/components/schemas/ContractListWorkedTimeByPayPeriod403Response
examples:
error:
summary: An example of an error message
value:
code: 403
error: Forbidden action
details: Missing scope "contracts:read".
'404':
description: Not Found
content:
application/json:
schema:
$ref: >-
#/components/schemas/ContractListWorkedTimeByPayPeriod404Response
examples:
error:
summary: An example of an error message
value:
code: 404
error: Ressource not found
details: The provided id is wrong
/companies/{companyId}/contracts/{contractId}:
get:
tags:
- Contract
summary: Get a contract
operationId: GET_contract
security:
- partner-api-oauth:
- contracts:read
description: Returns a contract information by ID.
parameters:
- description: The id of the company
in: path
name: companyId
schema:
type: string
required: true
- description: The id of the contract
in: path
name: contractId
schema:
type: string
required: true
responses:
'200':
description: Detail of a contract by ID
content:
application/json:
schema:
$ref: '#/components/schemas/GetContractResponse'
examples:
aliceContract:
summary: An example of Alice's contract
value:
contractId: 5b59e7b282ddef55f860d322
companyId: 5b59e7b182ddef55f860d311
collaboratorId: 6fe3a703-89f5-414d-8190-88f0d80435a3
jobName: Designer
startDate: '2018-07-12'
endDate: null
probationEndDate: null
status: ACTIVE
standardWeeklyHours: 35
fullTimeEquivalent: 1
isFullTime: true
bobContract:
summary: An example of Bob's contract
value:
contractId: 5b59e7b282ddef55f860d325
companyId: 5b59e7b182ddef55f860d311
collaboratorId: 6fe3a703-89f5-414d-8190-88f0d80435a3
jobName: Architect
startDate: '2017-12-21'
status: ACTIVE