openapi: 3.0.1 info: contact: email: info.ksef@mf.gov.pl name: Info url: https://ksef.mf.gov.pl description: Krajowy System e-Faktur title: KSeF version: 2.3.0 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: /online/Credentials/ContextGrant: post: description: Nadanie poświadczeń kontekstowych operationId: online.credentials.credentials.context.grant requestBody: content: application/json: schema: $ref: '#/components/schemas/GrantContextCredentialsRequest' required: true responses: "202": content: application/json: schema: $ref: '#/components/schemas/StatusCredentialsResponse' description: Dane zostały zapisane "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nie znaleziono danych "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Nadanie poświadczeń kontekstowych tags: - Interfejsy interaktywne - poświadczenia /online/Credentials/ContextRevoke: post: description: Odebranie poświadczeń kontekstowych operationId: online.credentials.credentials.context.revoke requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeContextCredentialsRequest' required: true responses: "202": content: application/json: schema: $ref: '#/components/schemas/StatusCredentialsResponse' description: Dane zostały zapisane "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nie znaleziono danych "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Odebranie poświadczeń kontekstowych tags: - Interfejsy interaktywne - poświadczenia /online/Credentials/GenerateToken: post: description: Generowanie tokena autoryzacyjnego operationId: online.credentials.generate.token requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateTokenRequest' required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/GenerateTokenResponse' description: Dane zostały zapisane "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nie znaleziono danych "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Generowanie tokena autoryzacyjnego tags: - Interfejsy interaktywne - poświadczenia /online/Credentials/Grant: post: description: Nadanie poświadczeń operationId: online.credentials.credentials.grant requestBody: content: application/json: schema: $ref: '#/components/schemas/GrantCredentialsRequest' required: true responses: "202": content: application/json: schema: $ref: '#/components/schemas/StatusCredentialsResponse' description: Dane zostały zapisane "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nie znaleziono danych "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Nadanie poświadczeń tags: - Interfejsy interaktywne - poświadczenia /online/Credentials/Revoke: post: description: Odebranie poświadczeń operationId: online.credentials.credentials.revoke requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeCredentialsRequest' required: true responses: "202": content: application/json: schema: $ref: '#/components/schemas/StatusCredentialsResponse' description: Dane zostały zapisane "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nie znaleziono danych "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Odebranie poświadczeń tags: - Interfejsy interaktywne - poświadczenia /online/Credentials/RevokeToken: post: description: Odebranie Usunięcie tokena autoryzacyjnego operationId: online.credentials.revoke.token requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeTokenRequest' application/vnd.v2+json: schema: $ref: '#/components/schemas/V2_RevokeTokenRequest' required: true responses: "202": content: application/json: schema: $ref: '#/components/schemas/StatusCredentialsResponse' application/vnd.v2+json: schema: $ref: '#/components/schemas/V2_RevokeTokenResponse' description: Dane zostały zapisane "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nie znaleziono danych "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Usunięcie tokena autoryzacyjnego tags: - Interfejsy interaktywne - poświadczenia /online/Credentials/Status/{CredentialsElementReferenceNumber}: get: description: Sprawdzenie statusu poświadczeń operationId: online.credentials.credentials.status parameters: - in: path name: CredentialsElementReferenceNumber 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/StatusCredentialsResponse' description: Poświadczenie wykonane prawidłowo "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Sprawdzenie statusu poświadczeń tags: - Interfejsy interaktywne - poświadczenia /online/Invoice/Get/{KSeFReferenceNumber}: get: description: Pobranie faktury operationId: online.invoice.invoice.get parameters: - in: path name: KSeFReferenceNumber required: true schema: 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})" responses: "200": content: application/octet-stream: schema: type: object description: OK "400": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.invoice.invoice.get timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.invoice.invoice.get timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Pobranie faktury tags: - Interfejsy interaktywne - faktury /online/Invoice/Scam/Cancel: post: description: Wycofanie faktury scamowej operationId: online.invoice.scam.invoice.cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelScamInvoiceRequest' required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/ScamInvoiceResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Wycofanie faktury scamowej tags: - Interfejsy interaktywne - faktury /online/Invoice/Scam/Report: post: description: Zgłoszenie faktury scamowej operationId: online.invoice.scam.invoice.report requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportScamInvoiceRequest' required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/ScamInvoiceResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Zgłoszenie faktury scamowej tags: - Interfejsy interaktywne - faktury /online/Invoice/Scam/{KSeFReferenceNumber}: get: description: Pobranie zgłoszenia nadużycia faktury operationId: online.invoice.scam.invoice.get parameters: - in: path name: KSeFReferenceNumber required: true schema: 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})" responses: "200": content: application/json: schema: $ref: '#/components/schemas/ScamInvoiceStatusResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Pobranie zgłoszenia nadużycia faktury tags: - Interfejsy interaktywne - faktury /online/Invoice/Send: put: description: 'Wysyłka faktury ' operationId: online.invoice.invoice.send requestBody: content: application/json: examples: request example: description: Przykład żądania summary: Przykład żądania value: invoiceHash: hashSHA: algorithm: SHA-256 encoding: Base64 value: ndeJt2MSJXAPbidtqM8Hnq7c2iIa7qY/y/dgkJUaQT4= fileSize: 2135 invoicePayload: type: encrypted encryptedInvoiceHash: hashSHA: algorithm: SHA-256 encoding: Base64 value: CpecTP+QmTAbzC4i1rlJ0VKVZwJSXp/cKxkkvdElFG0= fileSize: 2144 encryptedInvoiceBody: RJ1H3kOesCQHUkcpTi7GTbIQkF0IMdKuUFGrduK+471oGc/HjH3td7M/PXVdoTPDBWIY8oIMrwNbGXEpSBo0muK+iAtt/XOQCsEBiXw1lO0O8YVd62AScttHcx4I9hOlKGSFj4/f8wkuOfM5D7Uoh3vsB0wktx0GvNNAWNM6F9XJ5LRjnIOFGy9hWoWDT2YccFtgxBSmiQD6GS0qm4KnQzVebV6ICPrmaN08d1WdYBod3JEFCA8rFNBN4e617apjvUiLO7IV/vNp5zTps59/NW9DddoiUnYR/AubKwSD93ztcsCM8rcN3XzMnYdJ3rNdg9e8n4UhAMc8DcvuHW8GY9EGcbaVDPaFSlEAJj5ubpbpqOM6Xb1XfeXLlGRn7WLHDhPDyGh+aIKc4a94pXKRzoo6Vc7j8fzrCrIr6TgEr6OmIlfaSS9QBmgn2PyzruC1ORDwgLdWdGLpZz9ic4pGj1rJPxchL5TfJzOunYqCUEt7VMW1V0H4/7cK48HctvHPBKrhu99RxPY7vddGeE2l9o8yPAjFlgYa5z4AkQPH3m3YBW+1WNl57nhlC/R5sv59BnG1W/p/OtFA3PkyNRZNzKh9u74n/1/fWy1jWcMnIuZHnqJdr6MvUBr9w3AL1sSpyv8t7v7nQvlvjFKSHeqi6QFr2umW1DOdwSerttRii571xLLONEpwChzgEMCL0G/o5p8vtD93Gaat7LvY6sxeOR8QJ5AJlif5ViguHsvlTMEnAN9F1O2h3eozkCfrm3Fh9dIrLOOOMOAWLmq8jhHSEp1gUc8RRnYqKFgagSwn8f2kzMGOSlFAY1Wz0ODaZlTKINXtCoDznjdqJ72PP3MPAB7PCw7TJbXsT9RsbfyCX9K0oTEAIe8VQj1rJ//GJ3Uugav2b5eTvMATlAzzLMdkTWoiE/LPZsoBqbq0wJZbVmcInXYZ7eI7x7FGbNO638EWfV146sUOhO6JMAKwBiKU0gMqnE+AgaNBqKve0reVdEUWs2pX2iLaXhLObbuY+ADS8odED1mz0dx4d2bPy9H9uK0WiFLTQU014oP2juYwi4JRln0lbLTYu2+R4R5J/fL1kgkH2Vd8i0wZPZKv+OyrYzT+K1vWB/kbSExw2vuxD4OYXEItiCBN4+rJh57S6hS/7kN1b2X42TiqQhgmh8pDHsjlFwjYns7laxn71VaBDoyBaU3CZj8OJrDwZPP87ZGd5GIukBandjV4/uVSVvuNlsMsfHm7zI8+b2skQpwbtbL8zEYkfqYyh2s/+Aak9wAcPl523QilLaZ89/lRUvXJhjuiHAco5Bxiod9B8jUjvZoaEZu9bNNUuEbuXDPhC8zOqisnTADyVbxQlQo64ZOb0iGbsDzK77TGiAOrYjQM9nXDMCB5QgmQ47jgVB/yt3S+lb6E+k14GwP39LKt+A5Icgl8Ztji28NT7buz8BhQyeTENcafosOkI9xiWh3ZvGqLUG0/pv926bLRLipIBUY4vqRqtAF0fQKyswqI0C6XbCBri1Kb4pv1QEC69h3N7ZlhiiAtJkZ3i1Bjj6H4Qrqw7uvA/ULVkn4Rm35aYwIP/jxf4grNGZt+A28JeXKAT1P4eqRnNYa62uSnVBel1KZJIU9Ql1Zxss7ZtGkBNS/1nlH4/I+BAYBV0zkI86Ib/ZdD4eSHnlEkCbJqtWjW3YfAFGwCcnSqlPWVtmNP+hYuCbGKGXiCmg5oyiJkvxrBH7fvWmPftnrN3pn0SDPm7stO0ogI0ksFfaxzJ+2oc5ckMUYgHYPG56A4tETOQzLlRjWTGlrzsSwkh050K8Ev57vHJ0AxckW9ynlfGBnzV4wAFm91yWhewOzOTaEtTeUJrsP9xoruGQPkglmseujG43Fj4uA76v/X4iZfr4BAHvuAYKOo3GTQK2r6ZYGZSqTskiO0hdBUJxjK4x8OEqMs8Q78WGTZQdEo87/dOwGS4HoBYeETZ5GtAR27LlyLNepQ9TKkaWdhmQ3UF4F5DFX1Sll+d5KLGLJEaGecWuTPEkV5Uaj4mVLogWwFNiaW2XLXi9cIBO+mPIuVOdF+/88xJO1d0UhU3Gksgxu0xm4B1SM0d4uElSnGdL7ClhPbfOHPgFiPudNXqP8A0zEle5l/VR8zIbCFZfJl4UI5xOMjzjQm7yE9ZHgftGEAY2mb74CvxyzHnsfHTGz7YO6oapZFSNBmfQqiWjp27tWpsTT7HkO+/Q44QcFcA2MqGfMjit9cpEdeMdvSwxSMD9AM2lPx1CqF4ZkT2nKvD61Vu+KGg+E/fn9+P00XrQKlzEVrVvHoPq4Uj7K4ll5sG3tFbfKqX9NrjslzO8czVPZlOth4KeGAqxe5XFFZ2fs7rZg9OOjmURFC6dUMUFnZuKxmCsz51LD12l/iPmMLPxUrY8md1FKZNBJ/8SjbxvIk6U6PlEG10+iIPCjcYHmvHz8ORY+AaUfc+5P1XVyJdphX2RyDtyYFNxoJaJ/iZ5O0O/C5ihtv1BH8urtzfBR9tjT9F540CWuQwJPbx8e7VZP9GeMR6wxE20IIHAm3azhtpILjLRSmaCOreMciKt9TRfV7IOmuPOWKdNMV5yO15+kMBOyZTA91f4INpwSsGbUL7mJQL6oW3dMCOdY2OJglDlLs+QZusbiw38lEvNlWruAGQNDqkvOF2srLSkRYklS4+Q1FZKk+E2z8ncvLdsxLCDad2yfq/d+YtBAS6ws5WIaWCsOK4A2uCICQZg0rQ0510pzghsYLYEmBuAiRGbvTbR8UHBankK9m2h3IOijD9wc6Wfov/67zCcTjbz6KJ9OI/3SdI+2+ZU4W+BPni1FtL/wlKJZUcR3Pcq90eLYh2XMridD0djXwQRA= schema: $ref: '#/components/schemas/SendInvoiceRequest' required: true responses: "202": content: application/json: examples: response example: description: Przykład poprawnej odpowiedzi summary: Przykład poprawnej odpowiedzi value: timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF processingCode: 100 processingDescription: Proces został zarejestrowany. elementReferenceNumber: 20211001-EE-FFFFFFFFFF-FFFFFFFFFF-FF schema: $ref: '#/components/schemas/SendInvoiceResponse' description: Pomyślnie wysłano fakturę "400": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.invoice.invoice.send timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.invoice.invoice.send timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Wysyłka faktury tags: - Interfejsy interaktywne - faktury /online/Invoice/Status/{InvoiceElementReferenceNumber}: get: description: Sprawdzenie statusu wysłanej faktury operationId: online.invoice.invoice.status parameters: - description: |- Obsługiwane wartości: 'v35' 'v36' Brak nagłówka daje domyślną 35 znakową długość zwracanego numeru KSeF dla faktur/faktury w usłudze. in: header name: ksef-number-variant schema: type: string - in: path name: InvoiceElementReferenceNumber 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: examples: response example: description: Przykład poprawnej odpowiedzi summary: Przykład poprawnej odpowiedzi value: timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF processingCode: 200 processingDescription: Zakończenie etapu finalizacji i zakończenia procesu elementReferenceNumber: 20211001-EE-FFFFFFFFFF-FFFFFFFFFF-FF invoiceStatus: invoiceNumber: INV_1111111111_2222222222_4727711098527000 ksefReferenceNumber: 1111111111-20211001-FFFFFF-FFFFFF-FF acquisitionTimestamp: 2021-10-01T12:13:14.999Z schema: $ref: '#/components/schemas/StatusInvoiceResponse' description: OK "400": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.invoice.invoice.status timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.invoice.invoice.status timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Sprawdzenie statusu wysłanej faktury tags: - Interfejsy interaktywne - faktury /online/Invoice/Visibility/Hide: post: description: Ukrywanie wybranej faktury operationId: online.invoice.invoice.hide requestBody: content: application/json: schema: $ref: '#/components/schemas/HideInvoiceRequest' required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/VisibilityInvoiceResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Ukrywanie wybranej faktury tags: - Interfejsy interaktywne - faktury /online/Invoice/Visibility/Show: post: description: Anulowanie ukrycia wybranej faktury operationId: online.invoice.invoice.show requestBody: content: application/json: schema: $ref: '#/components/schemas/ShowInvoiceRequest' required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/VisibilityInvoiceResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Anulowanie ukrycia wybranej faktury tags: - Interfejsy interaktywne - faktury /online/Payment/Identifier/GetPaymentIdentifiers/{KSeFReferenceNumber}: get: description: Pobranie listy identyfikatorów płatności dla faktury operationId: online.payment.payment.identifier.get.payment.identifiers parameters: - in: path name: KSeFReferenceNumber required: true schema: type: string - in: query name: PageSize required: true schema: type: integer format: int32 maximum: 100 minimum: 10 - in: query name: PageOffset required: true schema: type: integer format: int32 maximum: 100 minimum: 0 responses: "200": content: application/json: schema: $ref: '#/components/schemas/GetPaymentIdentifiersByKSeFNumberResponse' description: Pobranie listy identyfikatorów płatności dla faktury "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Pobranie listy identyfikatorów płatności dla faktury tags: - Interfejsy interaktywne - płatności /online/Payment/Identifier/GetReferenceNumbers/{PaymentIdentifier}: get: description: Pobranie listy faktur dla identyfikatora płatności operationId: online.payment.payment.identifier.get.reference.numbers parameters: - in: path name: PaymentIdentifier required: true schema: type: string - in: query name: PageSize required: true schema: type: integer format: int32 maximum: 100 minimum: 10 - in: query name: PageOffset required: true schema: type: integer format: int32 maximum: 100 minimum: 0 responses: "200": content: application/json: schema: $ref: '#/components/schemas/GetPaymentIdentifierReferenceNumbersResponse' description: Pobrano faktury oznaczone identyfikatorem płatności "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Pobranie listy faktur dla identyfikatora płatności tags: - Interfejsy interaktywne - płatności /online/Payment/Identifier/Request: post: description: Wygenerowanie identyfikatora płatności operationId: online.payment.payment.identifier.request requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestPaymentIdentifierRequest' required: true responses: "201": content: application/json: schema: $ref: '#/components/schemas/RequestPaymentIdentifierResponse' description: Wygenerowano identyfikator płatności "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Wygenerowanie identyfikatora płatności tags: - Interfejsy interaktywne - płatności /online/Query/Credential/Context/Sync: get: description: Zapytanie o poświadczenia nadane przez jednostkę nadrzędną operationId: online.query.query.context.credentials parameters: - description: Identyfikator kontekstu in: query name: contextNip schema: type: string - description: Identyfikator nadajacego uprawnienia in: query name: sourceIdentifier schema: type: string - description: Identyfikator uprawnionego in: query name: targetIdentifier schema: type: string responses: "200": content: application/json: schema: $ref: '#/components/schemas/QuerySyncCredentialsResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Zapytanie o poświadczenia nadane przez jednostkę nadrzędną tags: - Interfejsy interaktywne - zapytania /online/Query/Credential/Sync: post: description: Zapytanie o poświadczenia operationId: online.query.query.credentials requestBody: content: application/json: schema: $ref: '#/components/schemas/QuerySyncCredentialsRequest' required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/QuerySyncCredentialsResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Zapytanie o poświadczenia tags: - Interfejsy interaktywne - zapytania /online/Query/Invoice/Async/Fetch/{QueryElementReferenceNumber}/{PartElementReferenceNumber}: get: description: Pobranie wyników zapytania o faktury operationId: online.query.query.invoice.fetch parameters: - in: path name: QueryElementReferenceNumber 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: PartElementReferenceNumber 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/octet-stream: schema: type: object description: OK "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Pobranie wyników zapytania o faktury tags: - Interfejsy interaktywne - zapytania /online/Query/Invoice/Async/Init: post: description: Inicjalizacja zapytania o faktury operationId: online.query.query.invoice.init parameters: - description: |- Obsługiwane wartości: 'v35' 'v36' Brak nagłówka daje domyślną 35 znakową długość zwracanego numeru KSeF dla faktur/faktury w usłudze. in: header name: ksef-number-variant schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryInvoiceRequest' application/vnd.v2+json: schema: $ref: '#/components/schemas/V2_QueryInvoiceRequest' required: true responses: "202": content: application/json: schema: $ref: '#/components/schemas/QueryInvoiceAsyncInitResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Inicjalizacja zapytania o faktury tags: - Interfejsy interaktywne - zapytania /online/Query/Invoice/Async/Status/{QueryElementReferenceNumber}: get: description: Sprawdzenie statusu zapytania o faktury operationId: online.query.query.invoice.status parameters: - in: path name: QueryElementReferenceNumber 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/QueryInvoiceAsyncStatusResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp "404": content: application/json: {} description: Nie znaleziono wyszukiwanej treści security: - SessionToken: [] summary: Sprawdzenie statusu zapytania o faktury tags: - Interfejsy interaktywne - zapytania /online/Query/Invoice/Sync: post: description: Zapytanie o faktury operationId: online.query.query.invoice parameters: - description: |- Obsługiwane wartości: 'v35' 'v36' Brak nagłówka daje domyślną 35 znakową długość zwracanego numeru KSeF dla faktur/faktury w usłudze. in: header name: ksef-number-variant schema: type: string - in: query name: PageSize required: true schema: type: integer format: int32 maximum: 100 minimum: 10 - in: query name: PageOffset required: true schema: type: integer format: int32 maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryInvoiceRequest' application/vnd.v2+json: schema: $ref: '#/components/schemas/V2_QueryInvoiceRequest' required: true responses: "200": content: application/json: schema: $ref: '#/components/schemas/QueryInvoiceSyncResponse' description: OK "400": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie "401": content: application/json: schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Zapytanie o faktury tags: - Interfejsy interaktywne - zapytania /online/Session/AuthorisationChallenge: post: description: Inicjalizacja mechanizmu uwierzytelnienia i autoryzacji. operationId: online.session.authorisation.challenge requestBody: content: application/json: examples: request example: description: Przykład żądania summary: Przykład żądania value: contextIdentifier: type: onip identifier: "1111111111" schema: $ref: '#/components/schemas/AuthorisationChallengeRequest' required: true responses: "201": content: application/json: examples: response example: description: Przykład poprawnej odpowiedzi summary: Przykład poprawnej odpowiedzi value: timestamp: 2021-10-01T12:13:14Z challenge: 20211001-CR-FFFFFFFFFF-FFFFFFFFFF-FF schema: $ref: '#/components/schemas/AuthorisationChallengeResponse' description: Inicjalizacja sesji interaktywnej poprawna "400": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.session.authorisation.challenge timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie summary: Inicjalizacja mechanizmu uwierzytelnienia i autoryzacji tags: - Interfejsy interaktywne - sesja /online/Session/GenerateInternalIdentifier/{inputDigitsSequence}: get: description: Wygenerowanie identyfikatora wewnetrznego na podstawie nip i 4 cyfr operationId: online.session.internal.identifier.generate parameters: - in: path name: inputDigitsSequence required: true schema: type: string pattern: "[0-9]{4}" responses: "200": content: application/json: examples: response example: description: Przykład poprawnej odpowiedzi summary: Przykład poprawnej odpowiedzi value: timestamp: 2021-10-01T12:13:14.999Z internalIdentifier: 2366841886-80251 schema: $ref: '#/components/schemas/InternalIdentifierGeneratedResponse' description: Wygenerowany identyfikator "400": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.session.internal.identifier.generate timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Błędne dane wejsściowe "401": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.session.internal.identifier.generate timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Wygenerowanie identyfikatora wewnetrznego tags: - Interfejsy interaktywne - sesja /online/Session/InitSigned: post: description: Inicjalizacja sesji interaktywnej. Podpisany dokument http://ksef.mf.gov.pl/schema/gtw/svc/online/auth/request/2021/10/01/0001/InitSessionSignedRequest externalDocs: description: Przykład żądania url: document/InitSessionSignedRequestExample/1.0 operationId: online.session.session.signed.init requestBody: content: application/octet-stream: schema: type: string format: binary required: true responses: "201": content: application/json: examples: response example: description: Przykład poprawnej odpowiedzi summary: Przykład poprawnej odpowiedzi value: timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF sessionToken: token: 161140207201d82aa59bbe17f57c347b7e3e313b69a36756a35a5f31c9f9df5f context: contextIdentifier: type: onip identifier: "1111111111" contextName: type: fn tradeName: null fullName: CN_1111111111 credentialsRoleList: - type: standard_plain roleType: owner roleDescription: system schema: $ref: '#/components/schemas/InitSessionResponse' application/vnd.v2+json: examples: response example: description: Przykład poprawnej odpowiedzi summary: Przykład poprawnej odpowiedzi value: timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF sessionToken: token: 161140207201d82aa59bbe17f57c347b7e3e313b69a36756a35a5f31c9f9df5f context: contextIdentifier: type: onip identifier: "1111111111" contextName: type: fn tradeName: null fullName: CN_1111111111 credentialsRoleList: - type: standard_plain roleType: owner roleDescription: system schema: $ref: '#/components/schemas/V2_InitSessionResponse' description: Inicjalizacja sesji interaktywnej poprawna "400": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.session.session.signed.init timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie summary: "Inicjalizacja sesji, wskazanie kontekstu, uwierzytelnienie i autoryzacja" tags: - Interfejsy interaktywne - sesja /online/Session/InitToken: post: description: Inicjalizacja sesji interaktywnej. Zaszyfrowany kluczem publicznym KSeF dokument http://ksef.mf.gov.pl/schema/gtw/svc/online/auth/request/2021/10/01/0001/InitSessionTokenRequest externalDocs: description: Przykład żądania url: document/InitSessionTokenRequestExample/1.0 operationId: online.session.session.token.init requestBody: content: application/octet-stream: schema: type: string format: binary required: true responses: "201": content: application/json: examples: response example: description: Przykład poprawnej odpowiedzi summary: Przykład poprawnej odpowiedzi value: timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF sessionToken: token: 161140207201d82aa59bbe17f57c347b7e3e313b69a36756a35a5f31c9f9df5f context: contextIdentifier: type: onip identifier: "1111111111" contextName: type: fn tradeName: null fullName: CN_1111111111 credentialsRoleList: - type: standard_plain roleType: owner roleDescription: system schema: $ref: '#/components/schemas/InitSessionResponse' application/vnd.v2+json: examples: response example: description: Przykład poprawnej odpowiedzi summary: Przykład poprawnej odpowiedzi value: timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF sessionToken: token: 161140207201d82aa59bbe17f57c347b7e3e313b69a36756a35a5f31c9f9df5f context: contextIdentifier: type: onip identifier: "1111111111" contextName: type: fn tradeName: null fullName: CN_1111111111 credentialsRoleList: - type: standard_plain roleType: owner roleDescription: system schema: $ref: '#/components/schemas/V2_InitSessionResponse' description: Inicjalizacja sesji interaktywnej poprawna "400": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.session.session.token.init timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieprawidłowe wywołanie summary: "Inicjalizacja sesji, wskazanie kontekstu, uwierzytelnienie i autoryzacja" tags: - Interfejsy interaktywne - sesja /online/Session/Status: get: description: Sprawdzenie statusu obecnego przetwarzania interaktywnego operationId: online.session.session.status.plain parameters: - description: |- Obsługiwane wartości: 'v35' 'v36' Brak nagłówka daje domyślną 35 znakową długość zwracanego numeru KSeF dla faktur/faktury w usłudze. in: header name: ksef-number-variant schema: type: string - in: query name: PageSize schema: type: integer format: int32 default: 10 maximum: 100 minimum: 10 - in: query name: PageOffset schema: type: integer format: int32 default: 0 maximum: 1000000 minimum: 0 - in: query name: IncludeDetails schema: type: boolean default: true responses: "200": content: application/json: examples: response example: description: Przykład poprawnej odpowiedzi summary: Przykład poprawnej odpowiedzi value: timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF numberOfElements: 0 pageSize: 20 pageOffset: 0 processingCode: 200 processingDescription: Zakończenie etapu finalizacji i zakończenia procesu invoiceStatusList: [] schema: $ref: '#/components/schemas/SessionStatusResponse' description: Sprawdzanie statusu sesji zakończone poprawnie "400": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.session.session.status.plain timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nie znaleziono danych "401": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.session.session.status.plain timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Sprawdzenie statusu aktywnej sesji interaktywnej tags: - Interfejsy interaktywne - sesja /online/Session/Status/{ReferenceNumber}: get: description: Sprawdzenie statusu przetwarzania na podstawie numeru referencyjnego operationId: online.session.session.status.reference.number parameters: - description: |- Obsługiwane wartości: 'v35' 'v36' Brak nagłówka daje domyślną 35 znakową długość zwracanego numeru KSeF dla faktur/faktury w usłudze. in: header name: ksef-number-variant schema: type: string - 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: query name: PageSize schema: type: integer format: int32 default: 10 maximum: 100 minimum: 10 - in: query name: PageOffset schema: type: integer format: int32 default: 0 maximum: 1000000 minimum: 0 - in: query name: IncludeDetails schema: type: boolean default: true responses: "200": content: application/json: examples: response example: description: Przykład poprawnej odpowiedzi summary: Przykład poprawnej odpowiedzi value: timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF numberOfElements: 0 pageSize: 20 pageOffset: 0 processingCode: 200 processingDescription: Zakończenie etapu finalizacji i zakończenia procesu invoiceStatusList: [] schema: $ref: '#/components/schemas/SessionStatusResponse' description: Sprawdzanie statusu sesji zakończone poprawnie "400": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.session.session.status.reference.number timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nie znaleziono danych "401": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.session.session.status.reference.number timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Sprawdzenie statusu sesji ogólnej tags: - Interfejsy interaktywne - sesja /online/Session/Terminate: get: description: Wymuszenie zamknięcia aktywnej sesji interaktywnej operationId: online.session.session.terminate.plain responses: "200": content: application/json: examples: response example: description: Przykład poprawnej odpowiedzi summary: Przykład poprawnej odpowiedzi value: timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF processingCode: 350 processingDescription: Sesja interaktywna zakończona. Komunikacja zamknięta. schema: $ref: '#/components/schemas/TerminateSessionResponse' description: Sesja zakończona "400": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.session.session.terminate.plain timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nie znaleziono danych "401": content: application/json: examples: response example: description: Przykład błędnej odpowiedzi summary: Przykład błędnej odpowiedzi value: exception: serviceCtx: srvDVAKA serviceCode: 20211001-EX-FFFFFFFFFF-FFFFFFFFFF-FF serviceName: online.session.session.terminate.plain timestamp: 2021-10-01T12:13:14.999Z referenceNumber: 20211001-SE-FFFFFFFFFF-FFFFFFFFFF-FF exceptionDetailList: - exceptionCode: 12345 exceptionDescription: Opis błędu. schema: $ref: '#/components/schemas/ExceptionResponse' description: Nieautoryzowany dostęp security: - SessionToken: [] summary: Wymuszenie zamknięcia aktywnej sesji tags: - Interfejsy interaktywne - sesja components: schemas: AuthenticationIdentifierType: type: object properties: identifier: type: string type: type: string enum: - onip - fingerprint - nip - pesel required: - identifier - type AuthorisationChallengeRequest: type: object properties: contextIdentifier: $ref: '#/components/schemas/SubjectIdentifierByType' required: - contextIdentifier AuthorisationChallengeResponse: type: object properties: challenge: 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 required: - challenge - timestamp CancelScamInvoiceRequest: type: object properties: scamReportCancelation: $ref: '#/components/schemas/CancelScamInvoiceType' CancelScamInvoiceType: type: object properties: 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})" reportCancelationReason: type: string maxLength: 1024 minLength: 1 required: - ksefReferenceNumber - reportCancelationReason CredentialsBaseTypeObjectObject: type: object discriminator: mapping: list_context: '#/components/schemas/CredentialsContextType' list_plain: '#/components/schemas/CredentialsPlainType' list_token: '#/components/schemas/CredentialsTokenType' single_parent: '#/components/schemas/CredentialsParentType' propertyName: type properties: credentialsRoleList: type: array items: type: object uniqueItems: true identifier: type: object type: type: string required: - type CredentialsContextType: type: object allOf: - $ref: '#/components/schemas/CredentialsBaseTypeObjectObject' - type: object properties: credentialsRoleList: type: array items: $ref: '#/components/schemas/CredentialsRoleResponseStandardContextDetailsType' uniqueItems: true identifier: $ref: '#/components/schemas/CredentialsIdentifierResponseType' CredentialsIdentifierRequestIndividualCertificateFingerprintType: type: object allOf: - $ref: '#/components/schemas/CredentialsIdentifierRequestType' - type: object properties: identifier: type: string pattern: "[0-9A-F]{64}" required: - identifier CredentialsIdentifierRequestIndividualNipType: type: object allOf: - $ref: '#/components/schemas/CredentialsIdentifierRequestType' - type: object properties: identifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}" required: - identifier CredentialsIdentifierRequestIndividualPeselType: type: object allOf: - $ref: '#/components/schemas/CredentialsIdentifierRequestType' - type: object properties: identifier: type: string pattern: "[0-9]{4}[0-3][0-9]{6}" required: - identifier CredentialsIdentifierRequestIndividualType: type: object discriminator: mapping: fingerprint: '#/components/schemas/CredentialsIdentifierRequestIndividualCertificateFingerprintType' nip: '#/components/schemas/CredentialsIdentifierRequestIndividualNipType' pesel: '#/components/schemas/CredentialsIdentifierRequestIndividualPeselType' propertyName: type properties: identifier: type: string type: type: string required: - type CredentialsIdentifierRequestInstitutionalNipType: type: object allOf: - $ref: '#/components/schemas/CredentialsIdentifierRequestType' - type: object properties: identifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}" required: - identifier CredentialsIdentifierRequestInstitutionalType: type: object discriminator: mapping: int: '#/components/schemas/CredentialsIdentifierRequestInternalType' onip: '#/components/schemas/CredentialsIdentifierRequestInstitutionalNipType' propertyName: type properties: identifier: type: string type: type: string required: - type CredentialsIdentifierRequestInternalType: type: object allOf: - $ref: '#/components/schemas/CredentialsIdentifierRequestInstitutionalType' - type: object properties: identifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}-\\d{5}" required: - identifier CredentialsIdentifierRequestType: type: object discriminator: mapping: fingerprint: '#/components/schemas/CredentialsIdentifierRequestIndividualCertificateFingerprintType' nip: '#/components/schemas/CredentialsIdentifierRequestIndividualNipType' onip: '#/components/schemas/CredentialsIdentifierRequestInstitutionalNipType' pesel: '#/components/schemas/CredentialsIdentifierRequestIndividualPeselType' propertyName: type properties: identifier: type: string type: type: string required: - type CredentialsIdentifierResponseAuthorisationTokenType: type: object allOf: - $ref: '#/components/schemas/CredentialsIdentifierResponseType' - type: object properties: identifier: 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})" required: - identifier CredentialsIdentifierResponseIndividualCertificateFingerprintType: type: object allOf: - $ref: '#/components/schemas/CredentialsIdentifierResponseType' - type: object properties: identifier: type: string pattern: "[0-9A-F]{64}" required: - identifier CredentialsIdentifierResponseIndividualNipType: type: object allOf: - $ref: '#/components/schemas/CredentialsIdentifierResponseType' - type: object properties: identifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}" required: - identifier CredentialsIdentifierResponseIndividualPeselType: type: object allOf: - $ref: '#/components/schemas/CredentialsIdentifierResponseType' - type: object properties: identifier: type: string pattern: "[0-9]{4}[0-3][0-9]{6}" required: - identifier CredentialsIdentifierResponseInstitutionalNipType: type: object properties: identifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}" required: - identifier CredentialsIdentifierResponseInternalIdentifierType: type: object allOf: - $ref: '#/components/schemas/CredentialsIdentifierResponseType' - type: object properties: identifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}-\\d{5}" required: - identifier CredentialsIdentifierResponseSystemType: type: object allOf: - $ref: '#/components/schemas/CredentialsIdentifierResponseType' - type: object properties: identifier: type: string maxLength: 64 minLength: 1 required: - identifier CredentialsIdentifierResponseType: type: object discriminator: mapping: fingerprint: '#/components/schemas/CredentialsIdentifierResponseIndividualCertificateFingerprintType' int: '#/components/schemas/CredentialsIdentifierResponseInternalIdentifierType' nip: '#/components/schemas/CredentialsIdentifierResponseIndividualNipType' onip: '#/components/schemas/CredentialsIdentifierResponseInstitutionalNipType' pesel: '#/components/schemas/CredentialsIdentifierResponseIndividualPeselType' system: '#/components/schemas/CredentialsIdentifierResponseSystemType' token: '#/components/schemas/CredentialsIdentifierResponseAuthorisationTokenType' propertyName: type properties: identifier: type: string type: type: string required: - type CredentialsParentType: type: object allOf: - $ref: '#/components/schemas/CredentialsBaseTypeObjectObject' - type: object properties: credentialsRole: $ref: '#/components/schemas/CredentialsRoleResponseStandardPlainType' credentialsRoleList: type: array items: $ref: '#/components/schemas/CredentialsRoleResponseStandardPlainType' uniqueItems: true identifier: $ref: '#/components/schemas/CredentialsIdentifierResponseType' CredentialsPlainType: type: object properties: credentialsRoleList: type: array items: $ref: '#/components/schemas/CredentialsRoleResponseStandardDetailsType' uniqueItems: true identifier: $ref: '#/components/schemas/CredentialsIdentifierResponseType' CredentialsRoleRequestContextBaseType: type: object properties: roleType: type: string enum: - credentials_manage required: - roleType CredentialsRoleRequestContextDescribedType: type: object properties: roleDescription: type: string maxLength: 256 minLength: 5 roleType: type: string enum: - credentials_manage required: - roleDescription - roleType CredentialsRoleRequestStandardBaseType: type: object properties: roleType: type: string enum: - introspection - invoice_read - invoice_write - payment_confirmation_write - credentials_read - credentials_manage - self_invoicing - tax_representative - enforcement_operations - subunit_manage required: - roleType CredentialsRoleRequestStandardDescribedType: type: object properties: roleDescription: type: string maxLength: 256 minLength: 5 roleType: type: string enum: - introspection - invoice_read - invoice_write - payment_confirmation_write - credentials_read - credentials_manage - self_invoicing - tax_representative - enforcement_operations - subunit_manage required: - roleDescription - roleType CredentialsRoleRequestTokenType: type: object properties: roleDescription: type: string maxLength: 256 minLength: 5 roleType: type: string enum: - invoice_read - invoice_write - payment_confirmation_write - credentials_read - credentials_manage - enforcement_operations required: - roleDescription - roleType CredentialsRoleResponseBaseTypeObject: type: object discriminator: mapping: context: '#/components/schemas/CredentialsRoleResponseStandardContextDetailsType' granted: '#/components/schemas/CredentialsRoleResponseGrantedForInstitutionType' standard_details: '#/components/schemas/CredentialsRoleResponseStandardDetailsType' standard_plain: '#/components/schemas/CredentialsRoleResponseStandardPlainType' token: '#/components/schemas/CredentialsRoleResponseTokenType' propertyName: type properties: roleDescription: type: string roleType: type: object startTimestamp: type: string format: date-time type: type: string required: - startTimestamp - type CredentialsRoleResponseGrantedForInstitutionType: type: object allOf: - $ref: '#/components/schemas/CredentialsRoleResponseBaseTypeObject' - type: object properties: roleGrantorIdentifier: $ref: '#/components/schemas/CredentialsIdentifierResponseInstitutionalNipType' roleType: type: string enum: - invoice_read - invoice_write - payment_confirmation_write - self_invoicing - tax_representative - court_bailiff - enforcement_authority - local_government_unit - local_government_sub_unit - vat_group_unit - vat_group_sub_unit required: - startTimestamp CredentialsRoleResponseStandardContextDetailsType: type: object allOf: - $ref: '#/components/schemas/CredentialsRoleResponseBaseTypeObject' - type: object properties: contextIdentifier: $ref: '#/components/schemas/CredentialsIdentifierResponseType' credentialsAssignmentType: type: string enum: - system - user roleType: type: string enum: - owner - introspection - invoice_read - invoice_write - payment_confirmation_write - credentials_read - credentials_manage - self_invoicing - tax_representative - enforcement_operations - court_bailiff - enforcement_authority - subunit_manage - local_government_unit - local_government_sub_unit - vat_group_unit - vat_group_sub_unit sourceIdentifier: $ref: '#/components/schemas/CredentialsIdentifierResponseType' targetIdentifier: $ref: '#/components/schemas/CredentialsIdentifierResponseType' required: - startTimestamp CredentialsRoleResponseStandardDetailsType: type: object allOf: - $ref: '#/components/schemas/CredentialsRoleResponseBaseTypeObject' - type: object properties: credentialsAssignmentType: type: string enum: - system - user roleAssigningAuthorIdentifier: $ref: '#/components/schemas/CredentialsIdentifierResponseType' roleType: type: string enum: - owner - introspection - invoice_read - invoice_write - payment_confirmation_write - credentials_read - credentials_manage - self_invoicing - tax_representative - enforcement_operations - court_bailiff - enforcement_authority - subunit_manage - local_government_unit - local_government_sub_unit - vat_group_unit - vat_group_sub_unit required: - startTimestamp CredentialsRoleResponseStandardPlainType: type: object allOf: - $ref: '#/components/schemas/CredentialsRoleResponseBaseTypeObject' - type: object properties: roleType: type: string enum: - owner - introspection - invoice_read - invoice_write - payment_confirmation_write - credentials_read - credentials_manage - self_invoicing - tax_representative - enforcement_operations - court_bailiff - enforcement_authority - subunit_manage - local_government_unit - local_government_sub_unit - vat_group_unit - vat_group_sub_unit required: - startTimestamp CredentialsRoleResponseTokenType: type: object allOf: - $ref: '#/components/schemas/CredentialsRoleResponseBaseTypeObject' - type: object properties: roleType: type: string enum: - invoice_read - invoice_write - payment_confirmation_write - credentials_read - credentials_manage - enforcement_operations required: - startTimestamp CredentialsTokenType: type: object allOf: - $ref: '#/components/schemas/CredentialsBaseTypeObjectObject' - type: object properties: credentialsRoleList: type: array items: $ref: '#/components/schemas/CredentialsRoleResponseTokenType' uniqueItems: true description: type: string identifier: $ref: '#/components/schemas/CredentialsIdentifierResponseAuthorisationTokenType' lastUseTimestamp: type: string format: date-time parent: $ref: '#/components/schemas/CredentialsPlainType' registrationTimestamp: type: string format: date-time status: type: integer format: int32 required: - lastUseTimestamp - registrationTimestamp 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 File1MBHashType: type: object properties: fileSize: type: integer format: int32 maximum: 1048576 minimum: 1 hashSHA: $ref: '#/components/schemas/HashSHAType' required: - fileSize - hashSHA File2MBHashType: type: object properties: fileSize: type: integer format: int32 maximum: 2097152 minimum: 1 hashSHA: $ref: '#/components/schemas/HashSHAType' required: - fileSize - hashSHA FileUnlimitedHashType: type: object properties: fileSize: type: integer format: int32 minimum: 1 hashSHA: $ref: '#/components/schemas/HashSHAType' required: - fileSize - hashSHA GenerateTokenRequest: type: object properties: generateToken: $ref: '#/components/schemas/GenerateTokenRequestType' required: - generateToken GenerateTokenRequestType: type: object properties: credentialsRoleList: type: array items: $ref: '#/components/schemas/CredentialsRoleRequestTokenType' maxItems: 6 minItems: 1 uniqueItems: true description: type: string maxLength: 256 minLength: 5 required: - credentialsRoleList - description GenerateTokenResponse: type: object properties: authorisationToken: type: string pattern: "[0-9A-F]{64}" elementReferenceNumber: 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})" 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 required: - authorisationToken - elementReferenceNumber - processingCode - processingDescription - referenceNumber - timestamp GetPaymentIdentifierReferenceNumbersResponse: type: object properties: ksefReferenceNumberList: type: array items: type: string maxItems: 10000 minItems: 1 uniqueItems: true numberOfElements: type: integer format: int64 minimum: 0 pageOffset: type: integer format: int32 maximum: 100 minimum: 0 pageSize: type: integer format: int32 maximum: 100 minimum: 10 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 required: - ksefReferenceNumberList - numberOfElements - pageOffset - pageSize - referenceNumber - timestamp GetPaymentIdentifiersByKSeFNumberResponse: type: object properties: numberOfElements: type: integer format: int64 minimum: 0 pageOffset: type: integer format: int32 maximum: 100 minimum: 0 pageSize: type: integer format: int32 maximum: 100 minimum: 10 paymentIdentifiersList: type: array items: $ref: '#/components/schemas/PaymentIdentifierType' uniqueItems: true 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 required: - numberOfElements - pageOffset - pageSize - paymentIdentifiersList - referenceNumber - timestamp GrantContextCredentialsRequest: type: object properties: grantContextCredentials: $ref: '#/components/schemas/GrantContextCredentialsRequestType' required: - grantContextCredentials GrantContextCredentialsRequestType: type: object properties: contextIdentifier: $ref: '#/components/schemas/CredentialsIdentifierRequestInstitutionalType' credentialsIdentifier: $ref: '#/components/schemas/CredentialsIdentifierRequestIndividualType' credentialsRole: $ref: '#/components/schemas/CredentialsRoleRequestContextDescribedType' required: - contextIdentifier - credentialsIdentifier - credentialsRole GrantCredentialsRequest: type: object properties: grantCredentials: $ref: '#/components/schemas/GrantCredentialsRequestType' required: - grantCredentials GrantCredentialsRequestType: type: object properties: credentialsIdentifier: $ref: '#/components/schemas/CredentialsIdentifierRequestType' credentialsRoleList: type: array items: $ref: '#/components/schemas/CredentialsRoleRequestStandardDescribedType' maxItems: 10 minItems: 1 uniqueItems: true required: - credentialsIdentifier - credentialsRoleList HashSHAType: type: object properties: algorithm: type: string pattern: SHA-256 encoding: type: string pattern: Base64 value: type: string format: binary maxLength: 44 minLength: 44 required: - algorithm - encoding - value HideInvoiceRequest: type: object properties: invoiceHideRequest: $ref: '#/components/schemas/HideInvoiceRequestType' required: - invoiceHideRequest HideInvoiceRequestType: type: object properties: hidingReason: type: string maxLength: 256 minLength: 1 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: - hidingReason - ksefReferenceNumber InitSessionResponse: type: object deprecated: true properties: 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})" sessionToken: $ref: '#/components/schemas/InitialisedSessionType' timestamp: type: string format: date-time required: - referenceNumber - sessionToken - timestamp InitialisedSessionType: type: object properties: context: $ref: '#/components/schemas/SessionContextType' token: type: string maxLength: 64 minLength: 64 required: - context - token InternalIdentifierGeneratedResponse: type: object properties: internalIdentifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}-\\d{5}" timestamp: type: string format: date-time required: - internalIdentifier - timestamp InvoiceDivisionPlainPartType: type: object properties: partExpiration: type: string format: date-time partName: type: string maxLength: 100 minLength: 1 partNumber: type: integer format: int32 minimum: 0 partRangeFrom: type: string format: date-time partRangeTo: type: string format: date-time partReferenceNumber: 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})" plainPartHash: $ref: '#/components/schemas/FileUnlimitedHashType' required: - partExpiration - partName - partNumber - partRangeFrom - partRangeTo - partReferenceNumber - plainPartHash InvoiceHeaderType: type: object properties: acquisitionTimestamp: type: string format: date-time currency: type: string pattern: "[A-Z]{3}" faP17Annotation: type: boolean gross: type: string pattern: "(\\-)?\\d{1,10}(\\.\\d{2})?" hidden: type: boolean hidingTime: type: string format: date-time invoiceHash: $ref: '#/components/schemas/FileUnlimitedHashType' invoiceReferenceNumber: type: string maxLength: 256 minLength: 1 invoiceType: type: string enum: - VAT - KOR - ZAL - ROZ - UPR - KOR_ZAL - KOR_ROZ invoicingDate: type: string format: date 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})" net: type: string pattern: "(\\-)?\\d{1,10}(\\.\\d{2})?" schemaVersion: type: string subjectBy: $ref: '#/components/schemas/SubjectByType' subjectByK: $ref: '#/components/schemas/SubjectByType' subjectTo: $ref: '#/components/schemas/SubjectToType' subjectToKList: type: array items: $ref: '#/components/schemas/SubjectToType' maxItems: 100 minItems: 1 subjectsAuthorizedList: type: array items: $ref: '#/components/schemas/SubjectAuthorizedType' maxItems: 1 minItems: 1 subjectsOtherList: type: array items: $ref: '#/components/schemas/SubjectOtherType' maxItems: 100 minItems: 1 vat: type: string pattern: "(\\-)?\\d{1,10}(\\.\\d{2})?" required: - acquisitionTimestamp - currency - faP17Annotation - gross - hidden - invoiceHash - invoiceReferenceNumber - invoiceType - invoicingDate - ksefReferenceNumber - net - subjectBy - subjectTo - vat InvoicePayloadEncryptedType: type: object allOf: - $ref: '#/components/schemas/InvoicePayloadType' - type: object properties: encryptedInvoiceBody: type: string format: binary encryptedInvoiceHash: $ref: '#/components/schemas/File2MBHashType' required: - encryptedInvoiceBody - encryptedInvoiceHash InvoicePayloadPlainType: type: object allOf: - $ref: '#/components/schemas/InvoicePayloadType' - type: object properties: invoiceBody: type: string format: binary required: - invoiceBody InvoicePayloadType: type: object discriminator: mapping: encrypted: '#/components/schemas/InvoicePayloadEncryptedType' plain: '#/components/schemas/InvoicePayloadPlainType' propertyName: type properties: type: type: string required: - type InvoiceStatusType: type: object properties: acquisitionTimestamp: type: string format: date-time invoiceNumber: type: string maxLength: 256 minLength: 1 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]{12})-([0-9A-F]{2})" PaymentIdentifierType: type: object properties: createdAt: type: string format: date-time paymentIdentifier: type: string pattern: "([1-9]((\\d[1-9])|([1-9]\\d))\\d{7}|M\\d{9}|[A-Z]{3}\\d{7})-([0-9A-Z]{2})(20[2-9][0-9]|2[1-9][0-9]{2}|[3-9][0-9]{3})(0[1-9]|1[0-2])-([0-9A-F]{12})-([0-9A-F]{2})" required: - createdAt - paymentIdentifier QueryCriteriaCredentialsAllType: type: object allOf: - $ref: '#/components/schemas/QueryCriteriaCredentialsType' - type: object properties: queryCredentialsScopeResultType: type: string enum: - current queryCredentialsTypeResultType: type: string enum: - all - standard - token required: - queryCredentialsScopeResultType - queryCredentialsTypeResultType QueryCriteriaCredentialsIdType: type: object allOf: - $ref: '#/components/schemas/QueryCriteriaCredentialsType' - type: object properties: credentialsIdentifier: $ref: '#/components/schemas/CredentialsIdentifierRequestType' queryCredentialsScopeResultType: type: string enum: - current queryCredentialsTypeResultType: type: string enum: - all - standard - token required: - credentialsIdentifier - queryCredentialsScopeResultType - queryCredentialsTypeResultType QueryCriteriaCredentialsType: type: object discriminator: mapping: list_all: '#/components/schemas/QueryCriteriaCredentialsAllType' list_id: '#/components/schemas/QueryCriteriaCredentialsIdType' propertyName: type properties: type: type: string required: - type QueryCriteriaInvoiceDetailType: type: object allOf: - $ref: '#/components/schemas/QueryCriteriaInvoiceType' - type: object properties: amountFrom: type: number amountTo: type: number amountType: type: string enum: - brutto - netto - vat currencyCodes: type: array items: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - IMP - INR - IQD - IRR - ISK - JEP - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XUA - XXX - YER - ZAR - ZMW - ZWL uniqueItems: true faP17Annotation: type: boolean invoiceNumber: type: string maxLength: 256 minLength: 1 invoiceTypes: type: array items: type: string enum: - VAT - KOR - ZAL - ROZ - UPR - KOR_ZAL - KOR_ROZ uniqueItems: true invoicingDateFrom: type: string format: date-time description: yyyy-MM-dd'T'HH:mm:ss | minimum date range is 2022-01-01 invoicingDateTo: type: string format: date-time description: "yyyy-MM-dd'T'HH:mm:ss | maximum date range is current time\ \ (+ max 6 hours), the difference between date field and #invoicingDateFrom\ \ cannot be greater than 24 months, date field cannot be before #invoicingDateFrom" 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})" subjectBy: $ref: '#/components/schemas/SubjectByType' subjectTo: $ref: '#/components/schemas/SubjectToType' required: - invoicingDateFrom - invoicingDateTo - subjectType QueryCriteriaInvoiceIncrementalType: type: object allOf: - $ref: '#/components/schemas/QueryCriteriaInvoiceType' - type: object properties: acquisitionTimestampThresholdFrom: type: string format: date-time description: yyyy-MM-dd'T'HH:mm:ss | minimum date range is 2022-01-01 acquisitionTimestampThresholdTo: type: string format: date-time description: "yyyy-MM-dd'T'HH:mm:ss | maximum date range is current time\ \ (+ max 6 hours), the difference between date field and #acquisitionTimestampThresholdFrom\ \ cannot be greater than 24 months, date field cannot be before #acquisitionTimestampThresholdFrom" required: - acquisitionTimestampThresholdFrom - acquisitionTimestampThresholdTo - subjectType QueryCriteriaInvoiceRangeType: type: object allOf: - $ref: '#/components/schemas/QueryCriteriaInvoiceType' - type: object properties: invoicingDateFrom: type: string format: date-time description: yyyy-MM-dd'T'HH:mm:ss | minimum date range is 2022-01-01 invoicingDateTo: type: string format: date-time description: "yyyy-MM-dd'T'HH:mm:ss | maximum date range is current time\ \ (+ max 6 hours), the difference between date field and #invoicingDateFrom\ \ cannot be greater than 24 months, date field cannot be before #invoicingDateFrom" required: - invoicingDateFrom - invoicingDateTo - subjectType QueryCriteriaInvoiceType: type: object discriminator: mapping: detail: '#/components/schemas/QueryCriteriaInvoiceDetailType' incremental: '#/components/schemas/QueryCriteriaInvoiceIncrementalType' range: '#/components/schemas/QueryCriteriaInvoiceRangeType' propertyName: type properties: hidingDateFrom: type: string format: date-time description: yyyy-MM-dd'T'HH:mm:ss hidingDateTo: type: string format: date-time description: yyyy-MM-dd'T'HH:mm:ss isHidden: type: boolean subjectType: type: string enum: - subject1 - subject2 - subject3 - subjectAuthorized type: type: string required: - subjectType - type QueryInvoiceAsyncInitResponse: type: object properties: elementReferenceNumber: 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})" 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 required: - elementReferenceNumber - processingCode - processingDescription - referenceNumber - timestamp QueryInvoiceAsyncStatusResponse: type: object properties: elementReferenceNumber: 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})" numberOfElements: type: integer format: int64 minimum: 0 numberOfParts: type: integer format: int32 minimum: 0 partList: type: array items: $ref: '#/components/schemas/InvoiceDivisionPlainPartType' maxItems: 200 minItems: 0 uniqueItems: true 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 required: - elementReferenceNumber - processingCode - processingDescription - referenceNumber - timestamp QueryInvoiceRequest: type: object deprecated: true properties: queryCriteria: $ref: '#/components/schemas/QueryCriteriaInvoiceType' required: - queryCriteria QueryInvoiceSyncResponse: type: object properties: invoiceHeaderList: type: array items: $ref: '#/components/schemas/InvoiceHeaderType' maxItems: 100 minItems: 0 uniqueItems: true numberOfElements: type: integer format: int64 minimum: 0 pageOffset: type: integer format: int32 maximum: 100 minimum: 0 pageSize: type: integer format: int32 maximum: 100 minimum: 10 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 required: - invoiceHeaderList - numberOfElements - pageOffset - pageSize - referenceNumber - timestamp QuerySyncCredentialsRequest: type: object properties: queryCriteria: $ref: '#/components/schemas/QueryCriteriaCredentialsType' required: - queryCriteria QuerySyncCredentialsResponse: type: object properties: credentialsList: type: array items: $ref: '#/components/schemas/CredentialsBaseTypeObjectObject' maxItems: 1000 minItems: 0 uniqueItems: true 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 required: - credentialsList - referenceNumber - timestamp ReportScamInvoiceRequest: type: object properties: scamReport: $ref: '#/components/schemas/ReportScamInvoiceType' ReportScamInvoiceType: type: object properties: 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})" reportReason: type: string maxLength: 1024 minLength: 1 required: - ksefReferenceNumber - reportReason RequestPaymentIdentifierRequest: type: object properties: ksefReferenceNumberList: type: array items: type: string maxItems: 10000 minItems: 2 uniqueItems: true required: - ksefReferenceNumberList RequestPaymentIdentifierResponse: type: object properties: paymentIdentifier: 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})" 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 required: - paymentIdentifier - referenceNumber - timestamp RevokeContextCredentialsRequest: type: object properties: revokeContextCredentials: $ref: '#/components/schemas/RevokeContextCredentialsRequestType' required: - revokeContextCredentials RevokeContextCredentialsRequestType: type: object properties: contextIdentifier: $ref: '#/components/schemas/CredentialsIdentifierRequestInstitutionalType' credentialsIdentifier: $ref: '#/components/schemas/CredentialsIdentifierRequestIndividualType' credentialsRole: $ref: '#/components/schemas/CredentialsRoleRequestContextBaseType' required: - contextIdentifier - credentialsIdentifier - credentialsRole RevokeCredentialsRequest: type: object properties: revokeCredentials: $ref: '#/components/schemas/RevokeCredentialsRequestType' required: - revokeCredentials RevokeCredentialsRequestType: type: object properties: credentialsIdentifier: $ref: '#/components/schemas/CredentialsIdentifierRequestType' credentialsRoleList: type: array items: $ref: '#/components/schemas/CredentialsRoleRequestStandardBaseType' maxItems: 10 minItems: 1 uniqueItems: true required: - credentialsIdentifier - credentialsRoleList RevokeTokenRequest: type: object deprecated: true properties: revokeToken: $ref: '#/components/schemas/RevokeTokenRequestType' required: - revokeToken RevokeTokenRequestType: type: object properties: sourceTokenIdentifier: $ref: '#/components/schemas/CredentialsIdentifierRequestType' tokenNumber: type: string maxLength: 256 minLength: 1 required: - sourceTokenIdentifier - tokenNumber ScamInvoiceResponse: type: object properties: cancelationReason: type: string maxLength: 1024 minLength: 1 cancelationTimestamp: type: string canceled: type: boolean 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})" processingDescription: type: string reportReason: type: string maxLength: 1024 minLength: 1 reportTimestamp: type: string subjectBy: $ref: '#/components/schemas/SubjectByType' required: - canceled - ksefReferenceNumber - processingDescription - reportReason - reportTimestamp ScamInvoiceStatusResponse: type: object properties: activeScamReport: type: boolean 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: - activeScamReport - ksefReferenceNumber SendInvoiceRequest: type: object properties: invoiceHash: $ref: '#/components/schemas/File1MBHashType' invoicePayload: $ref: '#/components/schemas/InvoicePayloadType' required: - invoiceHash - invoicePayload SendInvoiceResponse: type: object properties: elementReferenceNumber: 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})" 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 required: - elementReferenceNumber - processingCode - processingDescription - referenceNumber - timestamp SessionContextType: type: object properties: contextIdentifier: $ref: '#/components/schemas/SubjectIdentifierByType' contextName: $ref: '#/components/schemas/SubjectCompleteNameType' credentialsRoleList: type: array items: $ref: '#/components/schemas/CredentialsRoleResponseBaseTypeObject' maxItems: 1000 minItems: 1 uniqueItems: true required: - contextIdentifier - credentialsRoleList SessionInvoiceStatusType: type: object properties: acquisitionTimestamp: type: string format: date-time elementReferenceNumber: 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})" invoiceNumber: type: string maxLength: 256 minLength: 1 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]{12})-([0-9A-F]{2})" processingCode: type: integer format: int32 maximum: 999 minimum: 100 processingDescription: type: string maxLength: 256 minLength: 1 required: - elementReferenceNumber - processingCode - processingDescription SessionStatusResponse: type: object properties: creationTimestamp: type: string format: date-time entityType: type: string maxLength: 256 minLength: 1 invoiceStatusList: type: array items: $ref: '#/components/schemas/SessionInvoiceStatusType' lastUpdateTimestamp: type: string format: date-time numberOfElements: type: integer format: int64 minimum: 0 pageOffset: type: integer format: int32 maximum: 100 minimum: 0 pageSize: type: integer format: int32 maximum: 100 minimum: 10 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 required: - creationTimestamp - entityType - lastUpdateTimestamp - processingCode - processingDescription - referenceNumber - timestamp ShowInvoiceRequest: type: object properties: invoiceHideCancelationRequest: $ref: '#/components/schemas/ShowInvoiceRequestType' required: - invoiceHideCancelationRequest ShowInvoiceRequestType: type: object properties: hidingCancelationReason: type: string maxLength: 256 minLength: 1 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: - hidingCancelationReason - ksefReferenceNumber StatusCredentialsResponse: type: object properties: elementReferenceNumber: 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})" 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 required: - elementReferenceNumber - processingCode - processingDescription - referenceNumber - timestamp StatusInvoiceResponse: type: object properties: elementReferenceNumber: 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})" invoiceStatus: $ref: '#/components/schemas/InvoiceStatusType' 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 required: - elementReferenceNumber - invoiceStatus - processingCode - processingDescription - referenceNumber - timestamp SubjectAuthorizedType: type: object properties: issuedToIdentifier: $ref: '#/components/schemas/SubjectIdentifierToType' issuedToName: $ref: '#/components/schemas/SubjectNameType' subjectAuthorizedType: type: string enum: - enforcement_authority - court_bailiff - tax_representative required: - issuedToIdentifier - subjectAuthorizedType SubjectByType: type: object properties: issuedByIdentifier: $ref: '#/components/schemas/SubjectIdentifierByType' issuedByName: $ref: '#/components/schemas/SubjectNameType' required: - issuedByIdentifier - issuedByName SubjectCompleteNameType: type: object properties: fullName: type: string maxLength: 256 minLength: 1 required: - fullName SubjectFullNameType: type: object allOf: - $ref: '#/components/schemas/SubjectNameType' - type: object properties: fullName: type: string maxLength: 256 minLength: 1 required: - fullName SubjectIdentifierByCompanyType: type: object allOf: - $ref: '#/components/schemas/SubjectIdentifierByType' - type: object properties: identifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}" required: - identifier SubjectIdentifierByType: type: object discriminator: mapping: int: '#/components/schemas/SubjectIdentifierInternalType' onip: '#/components/schemas/SubjectIdentifierByCompanyType' propertyName: type properties: type: type: string required: - type SubjectIdentifierInternalType: type: object allOf: - $ref: '#/components/schemas/SubjectIdentifierByType' - type: object properties: identifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}-\\d{5}" required: - identifier SubjectIdentifierOtherToCompanyType: type: object allOf: - $ref: '#/components/schemas/SubjectIdentifierOtherToType' - type: object properties: identifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}" required: - identifier SubjectIdentifierOtherToInternalType: type: object allOf: - $ref: '#/components/schemas/SubjectIdentifierOtherToType' - type: object properties: identifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}-\\d{5}" required: - identifier SubjectIdentifierOtherToNoneType: type: object allOf: - $ref: '#/components/schemas/SubjectIdentifierOtherToType' SubjectIdentifierOtherToNrIdType: type: object allOf: - $ref: '#/components/schemas/SubjectIdentifierOtherToType' - type: object properties: identifier: type: string maxLength: 50 minLength: 1 required: - identifier SubjectIdentifierOtherToType: type: object discriminator: mapping: int: '#/components/schemas/SubjectIdentifierOtherToInternalType' none: '#/components/schemas/SubjectIdentifierOtherToNoneType' nrId: '#/components/schemas/SubjectIdentifierOtherToNrIdType' onip: '#/components/schemas/SubjectIdentifierOtherToCompanyType' vatUE: '#/components/schemas/SubjectIdentifierOtherToVatUeType' propertyName: type properties: type: type: string required: - type SubjectIdentifierOtherToVatUeType: type: object allOf: - $ref: '#/components/schemas/SubjectIdentifierOtherToType' - type: object properties: identifier: type: string maxLength: 50 minLength: 1 required: - identifier SubjectIdentifierToCompanyType: type: object allOf: - $ref: '#/components/schemas/SubjectIdentifierToType' - type: object properties: identifier: type: string pattern: "[1-9]((\\d[1-9])|([1-9]\\d))\\d{7}" required: - identifier SubjectIdentifierToNoneType: type: object allOf: - $ref: '#/components/schemas/SubjectIdentifierToType' SubjectIdentifierToOtherType: type: object allOf: - $ref: '#/components/schemas/SubjectIdentifierToType' - type: object properties: identifier: type: string maxLength: 50 minLength: 1 required: - identifier SubjectIdentifierToType: type: object discriminator: mapping: none: '#/components/schemas/SubjectIdentifierToNoneType' onip: '#/components/schemas/SubjectIdentifierToCompanyType' other: '#/components/schemas/SubjectIdentifierToOtherType' vatUE: '#/components/schemas/SubjectIdentifierToVatUeType' propertyName: type properties: type: type: string required: - type SubjectIdentifierToVatUeType: type: object allOf: - $ref: '#/components/schemas/SubjectIdentifierToType' - type: object properties: identifier: type: string maxLength: 50 minLength: 1 required: - identifier 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' SubjectOtherType: type: object properties: issuedToIdentifier: $ref: '#/components/schemas/SubjectIdentifierOtherToType' issuedToName: $ref: '#/components/schemas/SubjectNameType' subjectOtherType: type: string enum: - factor - recipient - original_subject - additional_purchaser - invoice_issuer - payer - other required: - issuedToIdentifier - subjectOtherType 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 SubjectToType: type: object properties: issuedToIdentifier: $ref: '#/components/schemas/SubjectIdentifierToType' issuedToName: $ref: '#/components/schemas/SubjectNameType' required: - issuedToIdentifier TerminateSessionResponse: 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 required: - processingCode - processingDescription - referenceNumber - timestamp V2_CredentialsRoleGrantedForInstitutionInheritanceType: type: object properties: granteeIdentifier: $ref: '#/components/schemas/CredentialsIdentifierResponseInstitutionalNipType' roleDescription: type: string roleType: type: string enum: - invoice_read - invoice_write - payment_confirmation_write V2_CredentialsRoleResponseBaseTypeObject: type: object discriminator: mapping: direct: '#/components/schemas/V2_CredentialsRoleResponseGrantedForIndividualDirectType' granted: '#/components/schemas/V2_CredentialsRoleResponseGrantedByInstitutionType' inherited: '#/components/schemas/V2_CredentialsRoleResponseGrantedForIndividualInheritedType' token: '#/components/schemas/V2_CredentialsRoleResponseGrantedForIndividualTokenType' propertyName: type properties: roleDescription: type: string roleType: type: object type: type: string required: - type V2_CredentialsRoleResponseGrantedByInstitutionType: type: object allOf: - $ref: '#/components/schemas/V2_CredentialsRoleResponseBaseTypeObject' - type: object properties: roleGrantorIdentifier: $ref: '#/components/schemas/CredentialsIdentifierResponseInstitutionalNipType' roleType: type: string enum: - invoice_read - invoice_write - payment_confirmation_write - self_invoicing - tax_representative - court_bailiff - enforcement_authority - local_government_unit - local_government_sub_unit - vat_group_unit - vat_group_sub_unit V2_CredentialsRoleResponseGrantedForIndividualDirectType: type: object allOf: - $ref: '#/components/schemas/V2_CredentialsRoleResponseBaseTypeObject' - type: object properties: roleType: type: string enum: - owner - introspection - invoice_read - invoice_write - payment_confirmation_write - credentials_read - credentials_manage - enforcement_operations - subunit_manage V2_CredentialsRoleResponseGrantedForIndividualInheritedType: type: object allOf: - $ref: '#/components/schemas/V2_CredentialsRoleResponseBaseTypeObject' - type: object properties: parent: $ref: '#/components/schemas/V2_CredentialsRoleGrantedForInstitutionInheritanceType' roleType: type: string enum: - invoice_read - invoice_write - payment_confirmation_write V2_CredentialsRoleResponseGrantedForIndividualTokenType: type: object allOf: - $ref: '#/components/schemas/V2_CredentialsRoleResponseBaseTypeObject' - type: object properties: roleType: type: string enum: - invoice_read - invoice_write - payment_confirmation_write - credentials_read - credentials_manage - enforcement_operations V2_InitSessionResponse: type: object properties: authenticationIdentifiers: type: array items: $ref: '#/components/schemas/AuthenticationIdentifierType' 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})" sessionToken: $ref: '#/components/schemas/V2_InitialisedSessionType' timestamp: type: string format: date-time required: - referenceNumber - sessionToken - timestamp V2_InitialisedSessionType: type: object properties: context: $ref: '#/components/schemas/V2_SessionContextType' token: type: string maxLength: 64 minLength: 64 required: - context - token V2_QueryCriteriaInvoiceDetailType: type: object allOf: - $ref: '#/components/schemas/V2_QueryCriteriaInvoiceType' - type: object properties: amountFrom: type: number amountTo: type: number amountType: type: string enum: - brutto - netto - vat currencyCodes: type: array items: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - IMP - INR - IQD - IRR - ISK - JEP - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XUA - XXX - YER - ZAR - ZMW - ZWL uniqueItems: true faP17Annotation: type: boolean invoiceNumber: type: string maxLength: 256 minLength: 1 invoiceTypes: type: array items: type: string enum: - VAT - KOR - ZAL - ROZ - UPR - KOR_ZAL - KOR_ROZ uniqueItems: true invoicingDateFrom: type: string format: date-time description: yyyy-MM-dd'T'HH:mm:ss | minimum date range is 2022-01-01 invoicingDateTo: type: string format: date-time description: "yyyy-MM-dd'T'HH:mm:ss | maximum date range is current time\ \ (+ max 6 hours), the difference between date field and #invoicingDateFrom\ \ cannot be greater than 24 months, date field cannot be before #invoicingDateFrom" 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})" subjectBy: $ref: '#/components/schemas/V2_SubjectByQueryType' subjectTo: $ref: '#/components/schemas/V2_SubjectToQueryType' required: - invoicingDateFrom - invoicingDateTo - subjectType V2_QueryCriteriaInvoiceIncrementalType: type: object allOf: - $ref: '#/components/schemas/V2_QueryCriteriaInvoiceType' - type: object properties: acquisitionTimestampThresholdFrom: type: string format: date-time description: yyyy-MM-dd'T'HH:mm:ss | minimum date range is 2022-01-01 acquisitionTimestampThresholdTo: type: string format: date-time description: "yyyy-MM-dd'T'HH:mm:ss | maximum date range is current time\ \ (+ max 6 hours), the difference between date field and #acquisitionTimestampThresholdFrom\ \ cannot be greater than 24 months, date field cannot be before #acquisitionTimestampThresholdFrom" required: - acquisitionTimestampThresholdFrom - acquisitionTimestampThresholdTo - subjectType V2_QueryCriteriaInvoiceRangeType: type: object allOf: - $ref: '#/components/schemas/V2_QueryCriteriaInvoiceType' - type: object properties: invoicingDateFrom: type: string format: date-time description: yyyy-MM-dd'T'HH:mm:ss | minimum date range is 2022-01-01 invoicingDateTo: type: string format: date-time description: "yyyy-MM-dd'T'HH:mm:ss | maximum date range is current time\ \ (+ max 6 hours), the difference between date field and #invoicingDateFrom\ \ cannot be greater than 24 months, date field cannot be before #invoicingDateFrom" required: - invoicingDateFrom - invoicingDateTo - subjectType V2_QueryCriteriaInvoiceType: type: object discriminator: mapping: detail: '#/components/schemas/V2_QueryCriteriaInvoiceDetailType' incremental: '#/components/schemas/V2_QueryCriteriaInvoiceIncrementalType' range: '#/components/schemas/V2_QueryCriteriaInvoiceRangeType' propertyName: type properties: hidingDateFrom: type: string format: date-time description: yyyy-MM-dd'T'HH:mm:ss hidingDateTo: type: string format: date-time description: yyyy-MM-dd'T'HH:mm:ss isHidden: type: boolean subjectType: type: string enum: - subject1 - subject2 - subject3 - subjectAuthorized type: type: string required: - subjectType - type V2_QueryInvoiceRequest: type: object properties: queryCriteria: $ref: '#/components/schemas/V2_QueryCriteriaInvoiceType' required: - queryCriteria V2_RevokeTokenRequest: type: object properties: revokeToken: $ref: '#/components/schemas/V2_RevokeTokenRequestType' required: - revokeToken V2_RevokeTokenRequestType: type: object properties: tokenNumber: 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})" required: - tokenNumber V2_RevokeTokenResponse: type: object properties: elementReferenceNumber: 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})" 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 required: - processingCode - processingDescription - referenceNumber - timestamp V2_SessionContextType: type: object properties: contextIdentifier: $ref: '#/components/schemas/SubjectIdentifierByType' contextName: $ref: '#/components/schemas/SubjectCompleteNameType' credentialsRoleList: type: array items: $ref: '#/components/schemas/V2_CredentialsRoleResponseBaseTypeObject' maxItems: 1000 minItems: 1 uniqueItems: true required: - contextIdentifier - credentialsRoleList V2_SubjectByQueryType: type: object properties: issuedByIdentifier: $ref: '#/components/schemas/SubjectIdentifierByType' issuedByName: $ref: '#/components/schemas/SubjectNameType' required: - issuedByIdentifier V2_SubjectToQueryType: type: object properties: issuedToIdentifier: $ref: '#/components/schemas/SubjectIdentifierToType' issuedToName: $ref: '#/components/schemas/SubjectNameType' required: - issuedToIdentifier VisibilityInvoiceResponse: type: object properties: cancelationReason: type: string cancelationTimestamp: type: string format: date-time canceled: type: boolean hidingReason: type: string hidingTimestamp: type: string format: date-time ksefReferenceNumber: type: string required: - cancelationTimestamp - hidingReason - hidingTimestamp - ksefReferenceNumber securitySchemes: SessionToken: description: Token in: header name: SessionToken type: apiKey