-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathKSeF-common.yaml
369 lines (369 loc) · 10.7 KB
/
KSeF-common.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
openapi: 3.0.1
info:
contact:
email: [email protected]
name: Info
url: https://ksef.mf.gov.pl
description: Krajowy System e-Faktur
title: KSeF
version: 2.0.4
externalDocs:
description: Dokumentacja
url: https://www.gov.pl/web/kas/krajowy-system-e-faktur
servers:
- description: Środowisko produkcyjne
url: https://ksef.mf.gov.pl/api
variables: {}
- description: Środowisko demonstracyjne
url: https://ksef-demo.mf.gov.pl/api
variables: {}
- description: Środowisko testowe
url: https://ksef-test.mf.gov.pl/api
variables: {}
tags:
- description: Krajowy System e-Faktur
externalDocs:
description: Krajowy System e-Faktur
url: https://ksef.mf.gov.pl
name: KSeF
paths:
/common/Invoice/KSeF:
post:
description: Pobranie faktury z repozytorium KSeF na podstawie kryteriów opartych
o numer KSeF
operationId: common.invoice.ksef
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceRequestKSeF'
required: true
responses:
"200":
content:
application/octet-stream:
schema:
type: object
description: OK
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ExceptionResponse'
description: Nieprawidłowe wywołanie
"404":
content:
application/json: {}
description: Nie znaleziono wyszukiwanej treści
summary: Pobranie faktury z repozytorium KSeF - kryteria oparte o numer KSeF
tags:
- Interfejsy wspólne - pobranie faktury
/common/Status/{ReferenceNumber}:
get:
description: Sprawdzenie statusu przetwarzania wsadowego
operationId: common.status
parameters:
- in: path
name: ReferenceNumber
required: true
schema:
type: string
pattern: "(20[2-9][0-9]|2[1-9][0-9]{2}|[3-9][0-9]{3})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])-([0-9A-Z]{2})-([0-9A-F]{10})-([0-9A-F]{10})-([0-9A-F]{2})"
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/StatusResponse'
application/vnd.v3+json:
schema:
$ref: '#/components/schemas/V3_StatusResponse'
description: OK
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ExceptionResponse'
description: Nieprawidłowe wywołanie
summary: Interfejs wspólny pobrania statusu przetwarzania wsadowego
tags:
- Interfejsy wspólne - status
/common/Upo/{ReferenceNumber}/{UpoReferenceNumber}:
get:
description: Pobieranie UPO
operationId: common.upo
parameters:
- in: path
name: ReferenceNumber
required: true
schema:
type: string
pattern: "(20[2-9][0-9]|2[1-9][0-9]{2}|[3-9][0-9]{3})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])-([0-9A-Z]{2})-([0-9A-F]{10})-([0-9A-F]{10})-([0-9A-F]{2})"
- in: path
name: UpoReferenceNumber
required: true
schema:
type: string
pattern: "(20[2-9][0-9]|2[1-9][0-9]{2}|[3-9][0-9]{3})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])-([0-9A-Z]{2})-([0-9A-F]{10})-([0-9A-F]{10})-([0-9A-F]{2})"
responses:
"200":
content:
application/vnd.v3+octet-stream:
schema:
type: object
description: OK
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ExceptionResponse'
description: Nieprawidłowe wywołanie
"404":
content:
application/json: {}
description: Nie znaleziono wyszukiwanej treści
summary: Interfejs wspólny pobrania UPO
tags:
- Interfejsy wspólne - UPO
components:
schemas:
AnonymousSubjectIdentifierToCompanyType:
type: object
allOf:
- $ref: '#/components/schemas/AnonymousSubjectIdentifierToType'
- type: object
properties:
identifier:
type: string
pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}"
required:
- identifier
AnonymousSubjectIdentifierToNoneType:
type: object
allOf:
- $ref: '#/components/schemas/AnonymousSubjectIdentifierToType'
AnonymousSubjectIdentifierToOtherTaxType:
type: object
allOf:
- $ref: '#/components/schemas/AnonymousSubjectIdentifierToType'
- type: object
properties:
identifier:
type: string
maxLength: 50
minLength: 1
required:
- identifier
AnonymousSubjectIdentifierToType:
type: object
discriminator:
mapping:
none: '#/components/schemas/AnonymousSubjectIdentifierToNoneType'
onip: '#/components/schemas/AnonymousSubjectIdentifierToCompanyType'
other: '#/components/schemas/AnonymousSubjectIdentifierToOtherTaxType'
propertyName: type
properties:
type:
type: string
required:
- type
AnonymousSubjectToType:
type: object
properties:
issuedToIdentifier:
$ref: '#/components/schemas/AnonymousSubjectIdentifierToType'
issuedToName:
$ref: '#/components/schemas/SubjectNameType'
required:
- issuedToIdentifier
- issuedToName
ExceptionDetailType:
type: object
properties:
exceptionCode:
type: integer
format: int32
minimum: 0
exceptionDescription:
type: string
maxLength: 256
minLength: 1
required:
- exceptionCode
- exceptionDescription
ExceptionResponse:
type: object
properties:
exception:
$ref: '#/components/schemas/ExceptionType'
required:
- exception
ExceptionType:
type: object
properties:
exceptionDetailList:
type: array
items:
$ref: '#/components/schemas/ExceptionDetailType'
maxItems: 100
minItems: 1
referenceNumber:
type: string
pattern: "(20[2-9][0-9]|2[1-9][0-9]{2}|[3-9][0-9]{3})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])-([0-9A-Z]{2})-([0-9A-F]{10})-([0-9A-F]{10})-([0-9A-F]{2})"
serviceCode:
type: string
maxLength: 64
minLength: 1
serviceCtx:
type: string
maxLength: 64
minLength: 1
serviceName:
type: string
maxLength: 64
minLength: 1
timestamp:
type: string
format: date-time
required:
- exceptionDetailList
- serviceCode
- serviceCtx
- serviceName
- timestamp
InvoiceQueryDetailsType:
type: object
properties:
dueValue:
type: string
pattern: "(\\-)?\\d{1,10}(\\.\\d{2})?"
invoiceOryginalNumber:
type: string
maxLength: 256
minLength: 1
subjectTo:
$ref: '#/components/schemas/AnonymousSubjectToType'
required:
- dueValue
- invoiceOryginalNumber
- subjectTo
InvoiceRequestKSeF:
type: object
properties:
invoiceDetails:
$ref: '#/components/schemas/InvoiceQueryDetailsType'
ksefReferenceNumber:
type: string
pattern: "([1-9]((\\d[1-9])|([1-9]\\d))\\d{7}|M\\d{9}|[A-Z]{3}\\d{7})-(20[2-9][0-9]|2[1-9][0-9]{2}|[3-9][0-9]{3})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])-([0-9A-F]{6})-?([0-9A-F]{6})-([0-9A-F]{2})"
required:
- invoiceDetails
- ksefReferenceNumber
StatusResponse:
type: object
properties:
processingCode:
type: integer
format: int32
maximum: 999
minimum: 100
processingDescription:
type: string
maxLength: 256
minLength: 1
referenceNumber:
type: string
pattern: "(20[2-9][0-9]|2[1-9][0-9]{2}|[3-9][0-9]{3})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])-([0-9A-Z]{2})-([0-9A-F]{10})-([0-9A-F]{10})-([0-9A-F]{2})"
timestamp:
type: string
format: date-time
upo:
type: string
format: binary
required:
- processingCode
- processingDescription
- referenceNumber
- timestamp
SubjectFullNameType:
type: object
allOf:
- $ref: '#/components/schemas/SubjectNameType'
- type: object
properties:
fullName:
type: string
maxLength: 256
minLength: 1
required:
- fullName
SubjectNameType:
type: object
discriminator:
mapping:
fn: '#/components/schemas/SubjectFullNameType'
none: '#/components/schemas/SubjectNoneType'
pn: '#/components/schemas/SubjectPersonNameType'
propertyName: type
properties:
tradeName:
type: string
maxLength: 256
minLength: 1
nullable: true
type:
type: string
required:
- type
SubjectNoneType:
type: object
allOf:
- $ref: '#/components/schemas/SubjectNameType'
SubjectPersonNameType:
type: object
allOf:
- $ref: '#/components/schemas/SubjectNameType'
- type: object
properties:
firstName:
type: string
maxLength: 30
minLength: 1
surname:
type: string
maxLength: 81
minLength: 1
required:
- firstName
- surname
V3_StatusResponse:
type: object
properties:
processingCode:
type: integer
format: int32
maximum: 999
minimum: 100
processingDescription:
type: string
maxLength: 256
minLength: 1
referenceNumber:
type: string
pattern: "(20[2-9][0-9]|2[1-9][0-9]{2}|[3-9][0-9]{3})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])-([0-9A-Z]{2})-([0-9A-F]{10})-([0-9A-F]{10})-([0-9A-F]{2})"
timestamp:
type: string
format: date-time
upoReferenceNumber:
type: string
pattern: "(20[2-9][0-9]|2[1-9][0-9]{2}|[3-9][0-9]{3})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])-([0-9A-Z]{2})-([0-9A-F]{10})-([0-9A-F]{10})-([0-9A-F]{2})"
upoUrl:
type: string
maxLength: 512
minLength: 1
pattern: "http[s]?:\\/{2}([0-9a-z][0-9a-z_-]*\\.)+[0-9a-z][0-9a-z_-]*(([0-9a-zA-Z][0-9a-zA-Z_-]*\\\
.?)*\\/?)*"
required:
- processingCode
- processingDescription
- referenceNumber
- timestamp