einvoice-api/openapi.yaml at master · phstudy/einvoice-api · GitHub

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
servers:
  - url: https://api.einvoice.nat.gov.tw
    description: 電子發票應用 API 正式環境
  - url: https://wwwtest.einvoice.nat.gov.tw
    description: 電子發票應用 API 驗測環境
info:
  description: |
    電子發票 API 申請 (查詢發票):

    https://www.einvoice.nat.gov.tw/APMEMBERVAN/APIService/Registration

    電子發票應用 API 規格 1.7 版 PDF:


    https://www.einvoice.nat.gov.tw/home/DownLoad?fileName=1510206773173_0.pdf
  version: "1.7"
  title: 電子發票應用 API 規格
  contact:
    name: 財政部電子發票整合服務平台
    url: https://www.einvoice.nat.gov.tw
tags:
  - name: 查詢發票
  - name: 愛心碼
  - name: 載具發票
  - name: 載具
  - name: API 空白頁面
security:
  - ApiKeyAuth: []
paths:
  /PB2CAPIVAN/invapp/InvApp:
    post:
      tags:
        - 查詢發票
      summary: 查詢中獎發票號碼清單
      operationId: qryWinningList
      description: 依開獎期別(雙數月)取得查詢期別，中獎獎別、號碼及中獎各獎獎金金額。
      parameters:
        - $ref: '#/components/parameters/version02'
        - in: query
          name: action
          required: true
          description: API 行為(帶入範例值即可)
          schema:
            type: string
            default: QryWinningList
        - $ref: '#/components/parameters/invTerm'
        - $ref: '#/components/parameters/UUID'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QryWinningListRes'
  /PB2CAPIVAN/invapp//InvApp:
    post:
      tags:
          - 查詢發票
      summary: 查詢發票表頭
      operationId: qryInvHeader
      description: 利用紙本電子發票上的二維條碼(QR Code)或者一維條碼(BarCode)，查詢該紙本電子發票表頭資訊，其回應資訊含:發票號碼、發票開立日期、賣方名稱 及發票狀態等資訊。
      parameters:
        - $ref: '#/components/parameters/version05'
        - $ref: '#/components/parameters/type'
        - $ref: '#/components/parameters/invNum'
        - in: query
          name: action
          required: true
          description: API 行為(帶入範例值即可)
          schema:
            type: string
            default: qryInvHeader
        - in: query
          name: generation
          description: (帶入範例值即可)
          required: true
          schema:
            type: string
            enum: ['V2']
          example: 'V2'
        - $ref: '#/components/parameters/invDate'
        - $ref: '#/components/parameters/UUID'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QryInvHeaderRes'
  /PB2CAPIVAN/invapp///InvApp:
    post:
      tags:
          - 查詢發票
      summary: 查詢發票明細
      operationId: qryInvDetail
      description: 利用紙本電子發票上的二維條碼(QR Code)或者一維條碼(BarCode)，查詢該紙本電子發票消費明細資料，至多查詢 99 次。
      parameters:
        - $ref: '#/components/parameters/version05'
        - $ref: '#/components/parameters/type'
        - $ref: '#/components/parameters/invNum'
        - in: query
          name: action
          required: true
          description: API 行為(帶入範例值即可)
          schema:
            type: string
            default: qryInvDetail
        - in: query
          name: generation
          description: (帶入範例值即可)
          required: true
          schema:
            type: string
            enum: ['V2']
          example: 'V2'
        - $ref: '#/components/parameters/qryInvDetailInvTerm'
        - $ref: '#/components/parameters/invDate'
        - $ref: '#/components/parameters/encrypt'
        - $ref: '#/components/parameters/sellerID'
        - $ref: '#/components/parameters/UUID'
        - $ref: '#/components/parameters/randomNumber'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QryInvDetailRes'

  /PB2CAPIVAN/loveCodeapp/qryLoveCode:
    post:
      tags:
          - 捐贈碼
      summary: 捐贈碼查詢
      operationId: qryLoveCode
      description: 查詢目前電子發票平台已經完成註冊登記捐贈碼的受捐贈機關或團體，並回 應受捐贈機關或團體統一編號、捐贈碼、受捐贈機關或團體名稱、受捐贈機關或 團體簡稱等資訊。
      parameters:
        - $ref: '#/components/parameters/version02'
        - in: query
          name: qKey
          description: 要查詢的捐贈碼/統編之關鍵字
          required: true
          schema:
            type: string
          example: '621'
        - in: query
          name: action
          description: API 行為(帶入範例值即可)
          required: true
          schema:
            type: string
            enum: ['qryLoveCode']
          example: 'qryLoveCode'
        - $ref: '#/components/parameters/UUID'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QryLoveCodeRes'

  /PB2CAPIVAN/invServ/InvServ:
    post:
      tags:
          - 載具發票
      summary: 載具發票表頭查詢
      operationId: carrierInvChk
      description: 可依載具卡別及載具隱碼查詢載具內所持有的消費發票。目前尚不支援 icash 卡別直接查詢。
      parameters:
        - $ref: '#/components/parameters/version05'
        - $ref: '#/components/parameters/cardType'
        - $ref: '#/components/parameters/cardNo'
        - $ref: '#/components/parameters/expTimeStamp'
        - in: query
          name: action
          required: true
          description: API 行為(帶入範例值即可)
          schema:
            type: string
            default: carrierInvChk
        - $ref: '#/components/parameters/timeStamp'
        - in: query
          name: startDate
          description: 查詢起始時間 (限制開始及結束查詢時間為相同月份)
          required: true
          schema:
            type: string
            format: 日期字串 (yyyy/MM/dd)
          example: '2012/07/01'
        - in: query
          name: endDate
          description: 查詢結束時間 (限制開始及結束查詢時間為相同月份)
          required: true
          schema:
            type: string
            format: 日期字串 (yyyy/MM/dd)
          example: '2012/07/31'
        - in: query
          name: onlyWinningInv
          description: 僅回傳中獎資訊 (Y/N)
          required: true
          schema:
            type: string
            format: 特定字串(Y/ N)
          example: 'Y'
        - $ref: '#/components/parameters/uuid'
        - $ref: '#/components/parameters/cardEncrypt'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierInvChkRes'
  /PB2CAPIVAN/invServ//InvServ:
    post:
      tags:
          - 載具發票
      summary: 載具發票明細查詢
      operationId: carrierInvDetail
      description: 查詢載具內所持有的發票消費明細。目前尚不支援 icash 卡別直接查詢。
      parameters:
        - $ref: '#/components/parameters/version05'
        - $ref: '#/components/parameters/cardType'
        - $ref: '#/components/parameters/cardNo'
        - $ref: '#/components/parameters/expTimeStamp'
        - in: query
          name: action
          required: true
          description: API 行為(帶入範例值即可)
          schema:
            type: string
            default: carrierInvDetail
        - $ref: '#/components/parameters/timeStamp'
        - $ref: '#/components/parameters/invNum'
        - $ref: '#/components/parameters/invDate'
        - $ref: '#/components/parameters/uuid'
        - in: query
          name: sellerName
          description: 開立賣方名稱
          schema:
            type: string
          example: '統一超商'
        - in: query
          name: amount
          description: 金額
          schema:
            type: string
          example: '25'
        - $ref: '#/components/parameters/cardEncrypt'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierInvDetailRes'
  /PB2CAPIVAN/CarInv/Donate:
    post:
      tags:
          - 載具發票
      summary: 載具發票捐贈
      operationId: carrierInvDnt
      description: 可針對單一發票，將載具內所持有且尚未開獎之發票，指定愛心團體之統編或愛心碼後利用該功能，捐贈發票給該社福機構。
      security:
        - ApiKeyAuth: []
          SignatureAuth: []
      parameters:
        - $ref: '#/components/parameters/version01'
        - $ref: '#/components/parameters/serial'
        - $ref: '#/components/parameters/cardType'
        - $ref: '#/components/parameters/cardNo'
        - $ref: '#/components/parameters/expTimeStamp'
        - in: query
          name: action
          required: true
          schema:
            type: string
            default: carrierInvDnt
        - $ref: '#/components/parameters/timeStamp'
        - $ref: '#/components/parameters/invDate'
        - $ref: '#/components/parameters/invNum'
        - in: query
          name: npoBan
          description: 受捐贈機關或團體之統編或捐贈碼
          required: true
          schema:
            type: string
          example: '12345678'
        - $ref: '#/components/parameters/uuid'
        - $ref: '#/components/parameters/cardEncrypt'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierInvDntRes'
  /PB2CAPIVAN/Carrier/Aggregate:
    post:
      tags:
        - 載具
      summary: 手機條碼歸戶載具查詢
      operationId: qryCarrierAgg
      description: 查詢單一手機條碼目前有效的歸戶載具。
      security:
        - ApiKeyAuth: []
          SignatureAuth: []
      parameters:
        - $ref: '#/components/parameters/version10'
        - $ref: '#/components/parameters/serial'
        - in: query
          name: action
          description: API 行為(帶入範例值即可)
          required: true
          schema:
            type: string
            enum: ['qryCarrierAgg']
          example: 'qryCarrierAgg'
        - $ref: '#/components/parameters/cardType'
        - $ref: '#/components/parameters/cardNo'
        - $ref: '#/components/parameters/cardEncrypt'
        - $ref: '#/components/parameters/timeStamp'
        - $ref: '#/components/parameters/uuid'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QryCarrierAggRes'
  /ods-main/ODS371I/query:
    servers:
      - url: https://sip.einvoice.nat.gov.tw
    get:
      tags:
        - 載具
      summary: 已歸戶載具個別化主題
      operationId: ods
      description: 查詢已歸戶載具個別化主題統計資訊。
      security:
        - ApiKeyAuth: []
          SignatureAuth: []
      parameters:
        - $ref: '#/components/parameters/version10'
        - in: query
          name: barcode
          required: true
          description: 手機條碼
          schema:
            type: string
          example: '/ABC.122'
        - in: query
          name: verifyCode
          required: true
          description: 驗證碼
          schema:
            type: string
          example: '1234'
        - in: query
          name: invoiceDateS
          required: true
          description: 發票日期起 yyyyMM
          schema:
            type: string
          example: '20140101'
        - in: query
          name: invoiceDateE
          required: true
          description: 發票日期迄 yyyyMM
          schema:
            type: string
          example: '20151010'
        - in: query
          name: hsnNm
          description: 縣市(用 URLEncode)
          schema:
            type: string
          example: '臺北市'
        - in: query
          name: townNm
          description: 鄉鎮市區(用 URLEncode)
          schema:
            type: string
          example: '大安區'
        - in: query
          name: busiChiNm
          description: 商店種類(用 URLEncode)
          schema:
            type: string
          example: '百貨公司'
        - in: query
          name: cardTypeNm
          description: 載具別(用 URLEncode)
          schema:
            type: string
          example: '共通性載具'
        - in: query
          name: cardCodeNm
          description: 載具名稱(用 URLEncode)
          schema:
            type: string
          example: '手機條碼'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OdsRes'
  /PB2CAPIVAN/APIService/generalCarrierRegBlank:
    post:
      tags:
          - API 空白頁面
      summary: 手機條碼載具註冊
      operationId: generalCarrierRegBlank
      description: 手機條碼註冊功能，該功能僅提供手機條碼註冊，但相關郵件驗證開通及匯款或歸戶設定請至電子發票整合服務平台進行操作。
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/uuid'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Res'
  /PB2CAPIVAN/APIService/carrierLinkBlank:
    post:
      tags:
          - API 空白頁面
      summary: 載具歸戶(手機條碼)
      operationId: carrierLinkBlank
      description: 提供以載具卡號及驗證碼方式歸戶手機條碼功能。
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/uuid'
        - $ref: '#/components/parameters/CardCode'
        - $ref: '#/components/parameters/CardNo'
        - $ref: '#/components/parameters/VerifyCode'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Res'
  /PB2CAPIVAN/APIService/carrierBankAccBlank:
    post:
      tags:
          - API 空白頁面
      summary: 手機條碼綁定金融帳戶
      operationId: carrierBankAccBlank
      description: 手機條碼金融卡帳號設定。
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/uuid'
        - $ref: '#/components/parameters/CardCode'
        - $ref: '#/components/parameters/CardNo'
        - $ref: '#/components/parameters/VerifyCode'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Res'
  /PB2CAPIVAN/APIService/carrierInvDntBlank:
    post:
      tags:
          - API 空白頁面
      summary: 載具發票捐贈(手機條碼)
      operationId: carrierInvDntBlank
      description: 提供手機條碼及手機條碼下歸戶載具，查詢出尚可捐贈發票並可針對查詢出之發票進行捐贈。
      security:
        - ApiKeyAuth: []
      parameters:
        - $ref: '#/components/parameters/uuid'
        - $ref: '#/components/parameters/CardCode'
        - $ref: '#/components/parameters/CardNo'
        - $ref: '#/components/parameters/VerifyCode'
        - in: query
          name: DntNo
          description: 捐贈之愛心碼或統編
          required: true
          schema:
            type: string
          example: '847'
        - in: query
          name: QryYM
          description: 發票開立年月 (年月)
          required: true
          schema:
            type: string
            format: 日期字串 (yyyymm)
          example: '201303'
      responses:
        '200':
          description: 回傳値
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Res'
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: query
      name: appID
      description: 透過財政資訊中心大平台申請之軟體 ID (請參考取得應用程式帳號 (appID))
    SignatureAuth:
      type: apiKey
      in: query
      name: signature
      description: 簽名參數
  parameters:
    version01:
      name: version
      in: query
      description: 版本號碼
      required: true
      schema:
        type: number
        enum: [0.1]
      example: 0.1
    version02:
      name: version
      in: query
      description: 版本號碼
      required: true
      schema:
        type: number
        enum: [0.2]
      example: 0.2
    version03:
      name: version
      in: query
      description: 版本號碼
      required: true
      schema:
        type: number
        enum: [0.3]
      example: 0.3
    version05:
      name: version
      in: query
      description: 版本號碼
      required: true
      schema:
        type: number
        enum: [0.5]
      example: 0.5
    version10:
      name: version
      in: query
      description: 版本號碼
      required: true
      schema:
        type: number
        enum: [1.0]
      example: 1.0
    invTerm:
      name: invTerm
      in: query
      description: 使用者啟用碼
      required: true
      schema:
        type: string
        format: 日期字串 (yyyMM)
      example: 10106
    appID:
      name: appID
      in: query
      description: 透過財政資訊中心大平台申請之軟體 ID
      required: true
      schema:
        type: string
    uuid:
      name: uuid
      in: query
      description: 行動工具 Unique ID
      required: true
      schema:
        type: string
    UUID:
      name: UUID
      in: query
      description: 行動工具 Unique ID
      required: false
      schema:
        type: string
    type:
      name: type
      in: query
      description: 發票查詢時使用的條碼別 (大小寫有別)
      required: true
      schema:
        type: string
        enum: ['QRCode', 'Barcode']
      example: 'Barcode'
    invNum:
      name: invNum
      in: query
      description: 發票號碼
      required: true
      schema:
        type: string
      example: 'AB12345678'
    invDate:
      name: invDate
      in: query
      description: 發票日期
      required: true
      schema:
        type: string
        format: 日期字串 (yyyy/MM/dd)
      example: '2012/07/11'
    qryInvDetailInvTerm:
      name: invTerm
      in: query
      description: 發票期別 (發票民國年月，年分 為民國年，月份必須為雙數月) (Type 為 Barcode 時為必填)
      required: false
      schema:
        type: string
        format: 日期字串 (yyyMM)
      example: 10108
    encrypt:
      name: encrypt
      in: query
      description: 發票檢驗碼 (Type 為 QRCode 時為必填)
      required: false
      schema:
        type: string
    sellerID:
      name: sellerID
      in: query
      description: 商家統編 (Type 為 QRCode 時為必填)
      required: false
      schema:
        type: string
    randomNumber:
      name: randomNumber
      in: query
      description: 4 位隨機碼
      required: true
      schema:
        type: string
      example: '0000'
    cardEncrypt:
      name: cardEncrypt
      in: query
      description: 卡片檢驗碼 (手機條碼驗證碼)
      required: true
      schema:
        type: string
    expTimeStamp:
      name: expTimeStamp
      in: query
      description: 有效存續時間戳記
      required: true
      schema:
        type: string
      example: '2147483647'
    timeStamp:
      name: timeStamp
      in: query
      description: 時間戳記 (請參考時間戳記參數使用說明)
      required: true
      schema:
        type: integer
        format: int64
      example: 1344102065
    serial:
      name: serial
      in: query
      description: 傳送時的序號 (請參考序號參數使用說明)
      required: true
      schema:
        type: string
        format: 字串(10 位數字)
      example: '0000000001'
    cardType:
      name: cardType
      in: query
      description: 卡別 (3J0002-手機條碼; 1K0001-悠遊卡; 1H0001-一卡通; 2G0001-愛金卡)
      required: true
      schema:
        type: string
        enum: ['3J0002', '1K0001', '1H0001', '2G0001']
      example: '3J0002'
    cardNo:
      name: cardNo
      in: query
      description: 卡片隱碼
      required: true
      schema:
        type: string
      example: '/AB56P5Q'
    signature:
      in: query
      name: signature
      description: 簽名 (請參考簽名參數使用說明)
      required: true
      schema:
        type: string
    CardCode:
      in: query
      name: CardCode
      description: 卡別
      required: true
      schema:
        type: string
      example: '3J0002'
    CardNo:
      in: query
      name: CardNo
      description: 卡片隱碼
      required: true
      schema:
        type: string
      example: '/ABCDEFG'
    VerifyCode:
      in: query
      name: VerifyCode
      description: 驗證碼
      required: true
      schema:
        type: string
  schemas:
    v:
      type: string
      description: 版本號碼
      example: '0.1'
    code:
      type: string
      description: 訊息回應碼
      example: '200'
    msg:
      type: string
      description: 系統回應訊息
      example: 查詢成功
    invNum:
      type: string
      description: 發票號碼
      example: 'EV54838339'
    invDate:
      type: string
      format: 日期字串 (yyyyMMdd)
      description: 發票開立日期
      example: '20120830'
    sellerName:
      type: string
      description: '賣方名稱'
      example: '台科大門市'
    invStatus:
      type: string
      description: '發票狀態'
      example: '已確認'
    invPeriod:
      type: string
      description: '對獎發票期別 (V1.4 版本新增回應參數)'
      example: 'YYYMM(民國年雙數月)'
    sellerBan:
      type: string
      description: '賣方營業人統編'
      example: '12345678'
    sellerAddress:
      type: string
      description: '賣方營業人地址'
      nullable: true
      example: '台北市大安區基隆路四段 43 號'
    invoiceTime:
      type: string
      description: '發票開立時間 (V1.4.4 版本新增回應參數)'
      example: 'HH:mm:ss(時分秒)'
    cardNo:
      type: string
      description: '卡片(載具)隱碼'
      nullable: true
      example: '/XCCYDHQ'
    cardType:
      type: string
      description: '卡別'
      nullable: true
      example: '3J0002'
    hashSerial:
      type: string
      description: '以 Base64(HMac-SHA1(UTF8(Serial))) 後的結果'
      example: 'zJmi4y6byURiat1VmH/vZfwNibU='
    QryWinningListRes:
      type: object
      properties:
        v:
          $ref: '#/components/schemas/v'
        code:
          $ref: '#/components/schemas/code'
        msg:
          $ref: '#/components/schemas/msg'
        invoYm:
          type: string
          description: 查詢開獎期別
          example: '10106'
        superPrizeNo:
          type: string
          description: 千萬特獎號碼
          example: '29734661'
        spcPrizeNo:
          type: string
          description: 特獎號碼
          example: '99028391'
        spcPrizeNo2:
          type: string
          description: 特獎號碼 2
          nullable: true
        spcPrizeNo3:
          type: string
          description: 特獎號碼 3
          nullable: true
        firstPrizeNo1:
          type: string
          description: 頭獎號碼 1
          example: '91180939'
        firstPrizeNo2:
          type: string
          description: 頭獎號碼 2
          example: '12753377'
        firstPrizeNo3:
          type: string
          description: 頭獎號碼 3
          example: '22638178'
        firstPrizeNo4:
          type: string
          description: 頭獎號碼 4
          nullable: true
        firstPrizeNo5:
          type: string
          description: 頭獎號碼 5
          nullable: true
        firstPrizeNo6:
          type: string
          description: 頭獎號碼 6
          nullable: true
        firstPrizeNo7:
          type: string
          description: 頭獎號碼 7
          nullable: true
        firstPrizeNo8:
          type: string
          description: 頭獎號碼 8
          nullable: true
        firstPrizeNo9:
          type: string
          description: 頭獎號碼 9
          nullable: true
        firstPrizeNo10:
          type: string
          description: 頭獎號碼 10
          nullable: true
        sixthPrizeNo1:
          type: string
          description: 六獎號碼 1
          nullable: true
          example: '258'
        sixthPrizeNo2:
          type: string
          description: 六獎號碼 2
          nullable: true
          example: '066'
        sixthPrizeNo3:
          type: string
          description: 六獎號碼 3
          nullable: true
          example: '321'
        superPrizeAmt:
          type: string
          description: 千萬特獎金額
          example: '10000000'
        spcPrizeAmt:
          type: string
          description: 特獎金額
          example: '02000000'
        firstPrizeAmt:
          type: string
          description: 頭獎金額
          example: '00200000'
        secondPrizeAmt:
          type: string
          description: 二獎金額
          example: '00040000'
        thirdPrizeAmt:
          type: string
          description: 三獎金額
          example: '00010000'
        fourthPrizeAmt:
          type: string
          description: 四獎金額
          example: '00004000'
        fifthPrizeAmt:
          type: string
          description: 五獎金額
          example: '00001000'
        sixthPrizeAmt:
          type: string
          description: 六獎金額
          example: '00000200'
        sixthPrizeNo4:
          type: string
          description: 六獎號碼 4
          nullable: true
          example: '258'
        sixthPrizeNo5:
          type: string
          description: 六獎號碼 5
          nullable: true
          example: '066'
        sixthPrizeNo6:
          type: string
          description: 六獎號碼 6
          nullable: true
          example: '123'
    QryInvHeaderRes:
      type: object
      properties:
        v:
          $ref: '#/components/schemas/v'
        code:
          $ref: '#/components/schemas/code'
        msg:
          $ref: '#/components/schemas/msg'
        invNum:
          $ref: '#/components/schemas/invNum'
        invDate:
          $ref: '#/components/schemas/invDate'
        sellerName:
          $ref: '#/components/schemas/sellerName'
        invStatus:
          $ref: '#/components/schemas/invStatus'
        invPeriod:
          $ref: '#/components/schemas/invPeriod'
        sellerBan:
          $ref: '#/components/schemas/sellerBan'
        sellerAddress:
          $ref: '#/components/schemas/sellerAddress'
        invoiceTime:
          $ref: '#/components/schemas/invoiceTime'
    QryInvDetailRes:
      type: object
      properties:
        v:
          $ref: '#/components/schemas/v'
        code:
          $ref: '#/components/schemas/code'
        msg:
          $ref: '#/components/schemas/msg'
        invNum:
          $ref: '#/components/schemas/invNum'
        invDate:
          $ref: '#/components/schemas/invDate'
        sellerName:
          $ref: '#/components/schemas/sellerName'
        invStatus:
          $ref: '#/components/schemas/invStatus'
        invPeriod:
          $ref: '#/components/schemas/invPeriod'
        sellerBan:
          $ref: '#/components/schemas/sellerBan'
        sellerAddress:
          $ref: '#/components/schemas/sellerAddress'
        invoiceTime:
          $ref: '#/components/schemas/invoiceTime'
        details:
          type: array
          items:
            $ref: '#/components/schemas/qryInvDetail'
    qryInvDetail:
      type: object
      properties:
        rowNum:
          type: string
          description: '明細編號'
          example: '001'
        description:
          type: string
          description: '摩斯雞塊'
          example: '品名'
        quantity:
          type: string
          description: '數量'
          example: '1.0000'
        unitPrice:
          type: string
          description: '單價'
          example: '25.0000'
        amount:
          type: string