Dokumentacja obiektów GraphQL Symfonia KSeF API
W związku z wprowadzeniem przez Ministerstwo Finansów Krajowego Systemu e-Faktur (KSeF), umożliwiającego m.in. wystawianie i udostępnianie faktur ustrukturyzowanych w formacie xml, firma Symfonia Sp. Z o.o. udostępnia podmiotom zewnętrznym API pozwalające na komunikację z Ministerstwem Finansów. Cała komunikacja z systemem, od wysyłki wsadowej do operacji interaktywnych opiera się o kontekst podatnika. Poniższa dokumentacja zawiera poszczególne elementy struktury API wraz z wyjaśnieniem ich znaczenia.
License
Warunki użytkowania programów w chmurze
API Endpoints
# Staging:
https://app.demo.symfonia.pl/graphql2
# Produkcja:
https://app.symfonia.pl/graphql2
Headers
# Klucz API wygenerowany w aplikacji z uprawnieniami nadanymi dla danej firmy
Symfonia-Api-Key: <KLUCZ_API>
# Email użytkownika używany do weryfikacji uprawnień i wykonania operacji
Symfonia-Api-Email: <EMAIL_UŻYTKOWNIKA>
# Kontekst zapytania. Wartość należy ustalić oparciu o query MyEnvironments
environmentId: COMPANY_ID lub TENANT_ID
Version
2
Wersjonowanie API
Nowa wersja obiektu przyjmowanego, bądź zwracanego, może zostać dodana w przypadku konieczności obsługi dodatkowych pól obowiązkowych. Dodanie nowych pól nieobowiązkowych może nie powodować konieczności powstania nowej wersji obiektu. Jedna wersja mutacji lub query może obsługiwać więcej niż jedną wersję schemy KSeF Ministerstwa Finansów, jeśli przekazywane dane pozwolą na prawidłowe przetworzenie żądania.
Kontakt z API Support
Prosimy o posłużenie się formularzem na stronie https://ebok.symfonia.pl/Home/Login
Graph QL dokumentacja
API stosuje język zapytań GraphQL. Szczegółowa dokumentacja znajduje się pod adresem GraphQL.org
Przykłady w formacie kolekcji PostMan dostępne są do pobrania pod linkiem: Kolekcja przykładów PostMan
Środowiska KSeF
Firma wewnątrz organizacji może zostać oznaczona jako DEMO. To oznaczenie wpływa na rodzaj połączenia Symfonia KSeF z KSeF Ministerstwa finansów.
Dla środowiska Staging znaczenie jest następujące:
DEMO - nawiązuje połączenie do ksef-test.mf.gov.pl
PROD - nawiązuje połączenie do ksef-demo.mf.gov.pl
Dla środowiska Produkcyjnego znaczenie jest następujące:
DEMO - nawiązuje połączenie do ksef-demo.mf.gov.pl
PROD - nawiązuje połączenie do ksef.mf.gov.pl
Kontekst pracy
API wymaga podania kontekstu pracy w nagłówku każdego żądania. Kontekst organizacji pozwala na operacje na poziomie organizacji, np. listowanie firm wewnątrz organizacji, sprawdzanie statystyk organizacji. Kontekst firmy pozwala wykonywać operacje w kontekście firmy np. listowanie faktur, dodawanie faktur, wysyłka faktur.
Wartość EnvironmentId należy uzyskać z query MyEnvironments
.
Przykład wywołania query MyEnvironments
query MyEnvironments {
MyEnvironments {
Environments {
...EnvironmentViewModelFragment
}
}
}
fragment EnvironmentViewModelFragment on EnvironmentViewModel{
EnvironmentId
Type
Status
Company {
TenantId
Identifier
IdentifierType
IsDemo
}
}
Przykład odpowiedzi:
{
"data": {
"MyEnvironments": {
"Environments": [
{
"EnvironmentId": "cb8bb1ff-a47e-476c-bb11-9f89e9901c2d",
"Type": "COMPANY",
"Status": "ACTIVE",
"Company": {
"TenantId": "a3d1070d-f5d6-4cf7-a401-4e168755e17e",
"Identifier": "1111111111",
"IdentifierType": "NIP",
"IsDemo": true
}
},
{
"EnvironmentId": "a3d1070d-f5d6-4cf7-a401-4e168755e17e",
"Type": "TENANT",
"Status": "ACTIVE",
"Company": null
}
]
}
}
}
Queries
CompanyStatistics
Response
Returns a GetCompanyStatisticsResponse!
Arguments
Name | Description |
---|---|
SearchText - String
|
Szukany tekst |
take - Long
|
Liczba rekordów do pobrania |
skip - Long
|
Liczba rekordów od początku, która ma zostać pominięta |
TenantIdFilter - UUID
|
ID organizacji |
order - ItemsOrderInput
|
Kolejność |
Example
Query
query CompanyStatistics(
$SearchText: String,
$take: Long,
$skip: Long,
$TenantIdFilter: UUID,
$order: ItemsOrderInput
) {
CompanyStatistics(
SearchText: $SearchText,
take: $take,
skip: $skip,
TenantIdFilter: $TenantIdFilter,
order: $order
) {
TenantAssignments {
...TenantAssignmentViewModelFragment
}
TotalTenantsCount
TotalCompanysCount
}
}
Variables
{
"SearchText": "abc123",
"take": {},
"skip": {},
"TenantIdFilter": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"order": ItemsOrderInput
}
Response
{
"data": {
"CompanyStatistics": {
"TenantAssignments": [TenantAssignmentViewModel],
"TotalTenantsCount": {},
"TotalCompanysCount": {}
}
}
}
GetCurrentSchemaVersion
Response
Returns a GetCurrentSchemaVersionResponse!
Example
Query
query GetCurrentSchemaVersion {
GetCurrentSchemaVersion {
SchemaVersion
}
}
Response
{"data": {"GetCurrentSchemaVersion": {"SchemaVersion": ["V12648"]}}}
GetEArchiveNotifications
Response
Returns a GetEArchiveNotificationsResponse!
Example
Query
query GetEArchiveNotifications {
GetEArchiveNotifications {
Notifications
}
}
Response
{"data": {"GetEArchiveNotifications": {"Notifications": ["NONE"]}}}
GetInvoiceFileContentActionGroup
Description
Zwraca zbiorczy dokument ZIP z fakturami PDF, zgodnymi ze schematem obowiązującym w KSeF Ministerstwa Finansów.
EnvironmentId: COMPANY
Response
Returns a GetInvoiceFileContentActionGroupType!
Example
Query
query GetInvoiceFileContentActionGroup(
$InvoiceIds: [UUID!]!,
$Token: String
) {
GetInvoiceFileContentActionGroup(
InvoiceIds: $InvoiceIds,
Token: $Token
) {
ZipName
ZipContent
MimeType
}
}
Variables
{
"InvoiceIds": [
"ce164f8f-a876-437c-a391-7fbb0e829ec4"
],
"Token": "xyz789"
}
Response
{
"data": {
"GetInvoiceFileContentActionGroup": {
"ZipName": "abc123",
"ZipContent": "abc123",
"MimeType": "abc123"
}
}
}
GetInvoiceFileContentSingle
Description
Zwraca dokument PDF faktury zgodny ze schematem obowiązującym w KSeF Ministerstwa Finansów.
EnvironmentId: COMPANY
Response
Returns a GetInvoiceFileContentSingleType!
Example
Query
query GetInvoiceFileContentSingle(
$InvoiceId: UUID!,
$Token: String
) {
GetInvoiceFileContentSingle(
InvoiceId: $InvoiceId,
Token: $Token
) {
PdfName
PdfContent
HtmlContent
MimeType
}
}
Variables
{
"InvoiceId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"Token": "abc123"
}
Response
{
"data": {
"GetInvoiceFileContentSingle": {
"PdfName": "xyz789",
"PdfContent": "abc123",
"HtmlContent": "xyz789",
"MimeType": "abc123"
}
}
}
GetInvoices
Response
Returns a GetInvoicesSegment!
Arguments
Name | Description |
---|---|
FiltersFields - FiltersFieldsInput!
|
Filtry |
SearchText - String
|
Szukany tekst |
take - Long!
|
Liczba rekordów do pobrania |
skip - Long!
|
Liczba rekordów od początku, która ma zostać pominięta |
order - ItemsOrderInput
|
Kolejność |
Example
Query
query GetInvoices(
$FiltersFields: FiltersFieldsInput!,
$SearchText: String,
$take: Long!,
$skip: Long!,
$order: ItemsOrderInput
) {
GetInvoices(
FiltersFields: $FiltersFields,
SearchText: $SearchText,
take: $take,
skip: $skip,
order: $order
) {
Items {
...InvoiceDtoFragment
}
TotalCount
FilteredCount
}
}
Variables
{
"FiltersFields": FiltersFieldsInput,
"SearchText": "abc123",
"take": {},
"skip": {},
"order": ItemsOrderInput
}
Response
{
"data": {
"GetInvoices": {
"Items": [InvoiceDto],
"TotalCount": {},
"FilteredCount": {}
}
}
}
GetInvoicesExtended
Response
Returns a GetInvoicesExtendedSegment!
Arguments
Name | Description |
---|---|
FiltersFields - ExtendedFiltersFieldsInput!
|
Filtry |
take - Long!
|
Liczba rekordów do pobrania |
skip - Long!
|
Liczba rekordów od początku, która ma zostać pominięta |
order - ItemsOrderInput
|
Kolejność |
Example
Query
query GetInvoicesExtended(
$FiltersFields: ExtendedFiltersFieldsInput!,
$take: Long!,
$skip: Long!,
$order: ItemsOrderInput
) {
GetInvoicesExtended(
FiltersFields: $FiltersFields,
take: $take,
skip: $skip,
order: $order
) {
Items {
...InvoiceDtoFragment
}
TotalCount
FilteredCount
}
}
Variables
{
"FiltersFields": ExtendedFiltersFieldsInput,
"take": {},
"skip": {},
"order": ItemsOrderInput
}
Response
{
"data": {
"GetInvoicesExtended": {
"Items": [InvoiceDto],
"TotalCount": {},
"FilteredCount": {}
}
}
}
GetKSeFInvoiceDTO
Example
Query
query GetKSeFInvoiceDTO($InvoiceId: UUID!) {
GetKSeFInvoiceDTO(InvoiceId: $InvoiceId) {
WersjaDTO
Sprzedawca {
...PodmiotFragment
}
Nabywca {
...PodmiotFragment
}
TrzeciPodmiot {
...TrzeciPodmiotFragment
}
PodmiotUpowazniony {
...PodmiotUpowaznionyFragment
}
Naglowek {
...NaglowekFragment
}
Adnotacje {
...AdnotacjeFragment
}
Korekta {
...KorektaFragment
}
PodsumowanieVat {
...PodsumowanieVatFragment
}
Wiersze {
...WierszFragment
}
Rozliczenie {
...RozliczenieFragment
}
Platnosc {
...PlatnoscFragment
}
WarunkiTransakcji {
...WarunkiTransakcjiFragment
}
Zamowienie {
...ZamowienieFragment
}
Stopka {
...StopkaFragment
}
}
}
Variables
{
"InvoiceId": "ce164f8f-a876-437c-a391-7fbb0e829ec4"
}
Response
{
"data": {
"GetKSeFInvoiceDTO": {
"WersjaDTO": "abc123",
"Sprzedawca": Podmiot,
"Nabywca": Podmiot,
"TrzeciPodmiot": [TrzeciPodmiot],
"PodmiotUpowazniony": PodmiotUpowazniony,
"Naglowek": Naglowek,
"Adnotacje": Adnotacje,
"Korekta": Korekta,
"PodsumowanieVat": [PodsumowanieVat],
"Wiersze": [Wiersz],
"Rozliczenie": Rozliczenie,
"Platnosc": Platnosc,
"WarunkiTransakcji": WarunkiTransakcji,
"Zamowienie": Zamowienie,
"Stopka": Stopka
}
}
}
GetKSeFInvoiceDTOV2
Response
Returns a FakturaV2!
Arguments
Name | Description |
---|---|
InvoiceId - UUID!
|
Id faktury |
Example
Query
query GetKSeFInvoiceDTOV2($InvoiceId: UUID!) {
GetKSeFInvoiceDTOV2(InvoiceId: $InvoiceId) {
WersjaDTO
Sprzedawca {
...PodmiotV2Fragment
}
Nabywca {
...PodmiotV2Fragment
}
TrzeciPodmiot {
...TrzeciPodmiotV2Fragment
}
PodmiotUpowazniony {
...PodmiotUpowaznionyV2Fragment
}
Naglowek {
...NaglowekV2Fragment
}
Adnotacje {
...AdnotacjeV2Fragment
}
Korekta {
...KorektaV2Fragment
}
PodsumowanieVat {
...PodsumowanieVatFragment
}
Wiersze {
...WierszV2Fragment
}
Rozliczenie {
...RozliczenieFragment
}
Platnosc {
...PlatnoscV2Fragment
}
WarunkiTransakcji {
...WarunkiTransakcjiV2Fragment
}
Zamowienie {
...ZamowienieV2Fragment
}
Stopka {
...StopkaV2Fragment
}
}
}
Variables
{
"InvoiceId": "ce164f8f-a876-437c-a391-7fbb0e829ec4"
}
Response
{
"data": {
"GetKSeFInvoiceDTOV2": {
"WersjaDTO": "xyz789",
"Sprzedawca": PodmiotV2,
"Nabywca": PodmiotV2,
"TrzeciPodmiot": [TrzeciPodmiotV2],
"PodmiotUpowazniony": PodmiotUpowaznionyV2,
"Naglowek": NaglowekV2,
"Adnotacje": AdnotacjeV2,
"Korekta": KorektaV2,
"PodsumowanieVat": [PodsumowanieVat],
"Wiersze": [WierszV2],
"Rozliczenie": Rozliczenie,
"Platnosc": PlatnoscV2,
"WarunkiTransakcji": WarunkiTransakcjiV2,
"Zamowienie": ZamowienieV2,
"Stopka": StopkaV2
}
}
}
GetKSeFInvoiceXML
Description
Zwraca dokument XML faktury zgodny ze schematem obowiązującym w KSeF Ministerstwa Finansów.
EnvironmentId: COMPANY
Response
Returns an KSeFInvoiceXMLType!
Arguments
Name | Description |
---|---|
InvoiceId - UUID!
|
Id faktury |
Example
Query
query GetKSeFInvoiceXML($InvoiceId: UUID!) {
GetKSeFInvoiceXML(InvoiceId: $InvoiceId) {
Content
FileName
}
}
Variables
{
"InvoiceId": "ce164f8f-a876-437c-a391-7fbb0e829ec4"
}
Response
{
"data": {
"GetKSeFInvoiceXML": {
"Content": "xyz789",
"FileName": "abc123"
}
}
}
GetListInvoices
Response
Returns a ListInvoicesResponseType!
Arguments
Name | Description |
---|---|
FiltersFields - FilterFieldsInput!
|
Filtry |
Example
Query
query GetListInvoices($FiltersFields: FilterFieldsInput!) {
GetListInvoices(FiltersFields: $FiltersFields) {
Items {
...InvoiceFragment
}
}
}
Variables
{"FiltersFields": FilterFieldsInput}
Response
{"data": {"GetListInvoices": {"Items": [Invoice]}}}
GetMissedWebsocketSubscriptions
Description
Uruchamia ponowne wysłanie nieprzeczytanych notyfikacji websocket-owych.
EnvironmentId: COMPANY
Response
Returns a GetMissedWebsocketSubscriptionsResponse!
Example
Query
query GetMissedWebsocketSubscriptions {
GetMissedWebsocketSubscriptions {
Success
}
}
Response
{"data": {"GetMissedWebsocketSubscriptions": {"Success": true}}}
GetPackageStatistic
Response
Returns a GetPackageStatisticSegment!
Arguments
Name | Description |
---|---|
TenantId - UUID!
|
Id organizacji |
Example
Query
query GetPackageStatistic($TenantId: UUID!) {
GetPackageStatistic(TenantId: $TenantId) {
Items {
...PackageFragment
}
Status
CurrentInvoicesCount
CurrentStorageCount
SerialNumber
SubscriptionNumber
CustomerNumber
Email
DateTo
}
}
Variables
{
"TenantId": "ce164f8f-a876-437c-a391-7fbb0e829ec4"
}
Response
{
"data": {
"GetPackageStatistic": {
"Items": [Package],
"Status": "INACTIVE",
"CurrentInvoicesCount": 987,
"CurrentStorageCount": Decimal,
"SerialNumber": "xyz789",
"SubscriptionNumber": "xyz789",
"CustomerNumber": "abc123",
"Email": "xyz789",
"DateTo": "2007-12-03"
}
}
}
GetPermissionsKSeF
Description
Zwraca informacje o uprawnieniach bieżącego użytkownika w KSeF Ministerstwa Finansów. Jeżeli połączenie z KSeF Ministerstwa Finansów zakończy się niepowodzeniem, zwracane są ostatnie zapisane w systemie uprawnienia dla tego użytkownika, a flaga FromKSeF przyjmuje wartość false.
EnvironmentId: COMPANY
Response
Returns an GetPermissionsKSeFResponseType!
Arguments
Name | Description |
---|---|
SearchText - String
|
Szukany tekst |
take - Long
|
Liczba rekordów do pobrania |
skip - Long
|
Liczba rekordów od początku, która ma zostać pominięta |
order - ItemsOrderInput
|
Kolejność |
CredentialFiltersFields - CredentialFiltersFieldsInput
|
Filtr uprawnień |
fromKSeF - Boolean
|
Określa czy dane mają być pobrane z KSeF Ministerstwa Finansów, czy z cache |
Example
Query
query GetPermissionsKSeF(
$SearchText: String,
$take: Long,
$skip: Long,
$order: ItemsOrderInput,
$CredentialFiltersFields: CredentialFiltersFieldsInput,
$fromKSeF: Boolean
) {
GetPermissionsKSeF(
SearchText: $SearchText,
take: $take,
skip: $skip,
order: $order,
CredentialFiltersFields: $CredentialFiltersFields,
fromKSeF: $fromKSeF
) {
FromKsef
LastUpdated
Credentials {
...CredentialFragment
}
TotalCount
FilteredCount
}
}
Variables
{
"SearchText": "abc123",
"take": {},
"skip": {},
"order": ItemsOrderInput,
"CredentialFiltersFields": CredentialFiltersFieldsInput,
"fromKSeF": false
}
Response
{
"data": {
"GetPermissionsKSeF": {
"FromKsef": true,
"LastUpdated": "2007-12-03T10:15:30Z",
"Credentials": [Credential],
"TotalCount": {},
"FilteredCount": {}
}
}
}
GetUPO
Description
Pobiera Urzędowe Potwierdzenie Odbioru dla podanej listy faktur w formacie PDF lub XML. Pobieranie może nastąpić tylko wtedy, kiedy sesja z KSeF Ministerstwa Finansów jest zamknięta, podczas otwartej sesji nie można pobrać UPO.
EnvironmentId: COMPANY
Response
Returns an UPOType!
Arguments
Name | Description |
---|---|
InvoiceIds - [UUID!]!
|
Lista Id faktur |
UpoFileType - UpoFileType!
|
Format pliku |
Example
Query
query GetUPO(
$InvoiceIds: [UUID!]!,
$UpoFileType: UpoFileType!
) {
GetUPO(
InvoiceIds: $InvoiceIds,
UpoFileType: $UpoFileType
) {
FileName
FileContent
MimeType
MissingInvoices {
...MissedInvoiceFragment
}
RequestedInvoices
ReturnedInvoices
}
}
Variables
{
"InvoiceIds": [
"ce164f8f-a876-437c-a391-7fbb0e829ec4"
],
"UpoFileType": "PDF"
}
Response
{
"data": {
"GetUPO": {
"FileName": "abc123",
"FileContent": "abc123",
"MimeType": "xyz789",
"MissingInvoices": [MissedInvoice],
"RequestedInvoices": [
"ce164f8f-a876-437c-a391-7fbb0e829ec4"
],
"ReturnedInvoices": [
"ce164f8f-a876-437c-a391-7fbb0e829ec4"
]
}
}
}
GetUserKSeFRequestForCredentials
Description
Zwraca informacje o procesowaniu uprawnień bieżącego użytkownika w KSeF Ministerstwa Finansów.
EnvironmentId: COMPANY
Response
Arguments
Name | Description |
---|---|
SearchText - String
|
Szukany tekst |
take - Long
|
Liczba rekordów do pobrania |
skip - Long
|
Liczba rekordów od początku, która ma zostać pominięta |
order - ItemsOrderInput
|
Kolejność |
CredentialFiltersFields - RequestedCredentialFiltersFieldsInput
|
Filtr uprawnień |
Example
Query
query GetUserKSeFRequestForCredentials(
$SearchText: String,
$take: Long,
$skip: Long,
$order: ItemsOrderInput,
$CredentialFiltersFields: RequestedCredentialFiltersFieldsInput
) {
GetUserKSeFRequestForCredentials(
SearchText: $SearchText,
take: $take,
skip: $skip,
order: $order,
CredentialFiltersFields: $CredentialFiltersFields
) {
RequestedCredentials {
...RequestedCredentialFragment
}
TotalCount
FilteredCount
}
}
Variables
{
"SearchText": "xyz789",
"take": {},
"skip": {},
"order": ItemsOrderInput,
"CredentialFiltersFields": RequestedCredentialFiltersFieldsInput
}
Response
{
"data": {
"GetUserKSeFRequestForCredentials": {
"RequestedCredentials": [RequestedCredential],
"TotalCount": {},
"FilteredCount": {}
}
}
}
GetWebsocketNotificationModel
Description
Zwraca wynik operacji dla konkretnej notyfikacji WebSocket-owej. Wymaga podania ID notyfikacji.
EnvironmentId: COMPANY
Response
Returns a GetWebsocketNotificationModelResponse!
Arguments
Name | Description |
---|---|
notificationId - UUID!
|
Id notyfikacji |
Example
Query
query GetWebsocketNotificationModel($notificationId: UUID!) {
GetWebsocketNotificationModel(notificationId: $notificationId) {
UserId
CompanyId
ErrorType
ErrorContent {
...KeyValuePairOfStringAndStringFragment
}
Message
Type
NotificationId
Timestamp
Visited
HasDownloadableContent
ResponseJson
State
SimultaneousRunType
}
}
Variables
{
"notificationId": "ce164f8f-a876-437c-a391-7fbb0e829ec4"
}
Response
{
"data": {
"GetWebsocketNotificationModel": {
"UserId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"CompanyId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"ErrorType": "SYSTEM",
"ErrorContent": [KeyValuePairOfStringAndString],
"Message": "abc123",
"Type": "AUTHORIZE_IN_KSEF",
"NotificationId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"Timestamp": "2007-12-03T10:15:30Z",
"Visited": true,
"HasDownloadableContent": false,
"ResponseJson": "xyz789",
"State": "ENQUEUED",
"SimultaneousRunType": "SEQUENTIAL"
}
}
}
GetWebsocketNotificationModelExtended
Description
Zwraca wynik operacji dla konkretnej notyfikacji WebSocket-owej. Wymaga podania ID notyfikacji.
EnvironmentId: COMPANY
Response
Arguments
Name | Description |
---|---|
notificationId - UUID!
|
Id notyfikacji |
Example
Query
query GetWebsocketNotificationModelExtended($notificationId: UUID!) {
GetWebsocketNotificationModelExtended(notificationId: $notificationId) {
UserId
CompanyId
ErrorType
ErrorContent {
...KeyValuePairOfStringAndStringFragment
}
Message
Type
NotificationId
Timestamp
Visited
HasDownloadableContent
ResponseJson
ResponseModel {
...ResponseModelFragment
}
State
SimultaneousRunType
}
}
Variables
{
"notificationId": "ce164f8f-a876-437c-a391-7fbb0e829ec4"
}
Response
{
"data": {
"GetWebsocketNotificationModelExtended": {
"UserId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"CompanyId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"ErrorType": "SYSTEM",
"ErrorContent": [KeyValuePairOfStringAndString],
"Message": "abc123",
"Type": "AUTHORIZE_IN_KSEF",
"NotificationId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"Timestamp": "2007-12-03T10:15:30Z",
"Visited": false,
"HasDownloadableContent": false,
"ResponseJson": "abc123",
"ResponseModel": ResponseModel,
"State": "ENQUEUED",
"SimultaneousRunType": "SEQUENTIAL"
}
}
}
GetWebsocketNotificationsList
Response
Returns a GetWebsocketNotificationResponse!
Arguments
Name | Description |
---|---|
notificationStateType - WebsocketNotificationStateType!
|
Status subskrypcji |
Example
Query
query GetWebsocketNotificationsList($notificationStateType: WebsocketNotificationStateType!) {
GetWebsocketNotificationsList(notificationStateType: $notificationStateType) {
WebsocketNotification {
...WebsocketNotificationModelFragment
}
}
}
Variables
{"notificationStateType": "ALL"}
Response
{
"data": {
"GetWebsocketNotificationsList": {
"WebsocketNotification": [
WebsocketNotificationModel
]
}
}
}
KSeFSessionInfo
Response
Returns an KSeFSessionStatusResponseType!
Example
Query
query KSeFSessionInfo {
KSeFSessionInfo {
Active
ExpirationTime
}
}
Response
{
"data": {
"KSeFSessionInfo": {
"Active": false,
"ExpirationTime": "2007-12-03T10:15:30Z"
}
}
}
MyEnvironments
Description
Pobiera listę wszystkich dostępnych środowisk dla bieżącego użytkownika.
EnvironmentId: NONE
- nagłówek EnvironmentId nie jest wymagany
Response
Returns a MyEnvironmentsViewModelResponse!
Example
Query
query MyEnvironments {
MyEnvironments {
Environments {
...EnvironmentViewModelFragment
}
}
}
Response
{
"data": {
"MyEnvironments": {
"Environments": [EnvironmentViewModel]
}
}
}
SubscribeDownloadInvoicesFromKSeF
Description
Zlecenie pobrania faktur z KSeF poprzez subskrypcję WebSocket. Wynik zapytania należy sprawdzić poprzez query GetWebsocketNotificationModel
.
EnvironmentId: COMPANY
Response
Returns an SubscribeDownloadInvoicesFromKSeFResponse!
Arguments
Name | Description |
---|---|
internalEnabled - Boolean!
|
Pobieranie faktur sprzedażowych |
internal - DateTimeRangeInput
|
Daty wystawienia w KSeF dla faktur sprzedażowych |
externalEnabled - Boolean!
|
Pobieranie faktur zakupowych |
external - DateTimeRangeInput
|
Daty wystawienia w KSeF dla faktur zakupowych |
Example
Query
query SubscribeDownloadInvoicesFromKSeF(
$internalEnabled: Boolean!,
$internal: DateTimeRangeInput,
$externalEnabled: Boolean!,
$external: DateTimeRangeInput
) {
SubscribeDownloadInvoicesFromKSeF(
internalEnabled: $internalEnabled,
internal: $internal,
externalEnabled: $externalEnabled,
external: $external
) {
NotificationModel {
...WebsocketNotificationModelFragment
}
Result
}
}
Variables
{
"internalEnabled": true,
"internal": DateTimeRangeInput,
"externalEnabled": false,
"external": DateTimeRangeInput
}
Response
{
"data": {
"SubscribeDownloadInvoicesFromKSeF": {
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
}
}
SubscribeGetUpo
Description
Zlecenie pobrania UPO z KSeF. Pobiera Urzędowe Potwierdzenie Odbioru dla podanej listy faktur w formacie PDF lub XML. Pobieranie może nastąpić tylko wtedy, kiedy sesja z KSeF jest zamknięta. Po zleceniu pobrania UPO system zaczeka na zakończenie działań w bieżącej sesji KSeF i pobierze UPO. Wynik zapytania należy sprawdzić poprzez query GetWebsocketNotificationModel
.
EnvironmentId: COMPANY
Response
Returns a SubscribeGetUpoResponse!
Arguments
Name | Description |
---|---|
InvoiceIds - [UUID!]!
|
Lista Id faktur |
UpoFileType - UpoFileType!
|
Format pliku |
Example
Query
query SubscribeGetUpo(
$InvoiceIds: [UUID!]!,
$UpoFileType: UpoFileType!
) {
SubscribeGetUpo(
InvoiceIds: $InvoiceIds,
UpoFileType: $UpoFileType
) {
NotificationModel {
...WebsocketNotificationModelFragment
}
Result
}
}
Variables
{
"InvoiceIds": [
"ce164f8f-a876-437c-a391-7fbb0e829ec4"
],
"UpoFileType": "PDF"
}
Response
{
"data": {
"SubscribeGetUpo": {
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
}
}
Mutations
AuthorizeInKSeF
Description
Uwierzytelnienie bieżącego użytkownika w KSeF Ministerstwa Finansów za pomocą podpisu w serwisie KSeF Ministerstwa Finansów. Akceptuje podpisane żądanie uzyskane z metody GenerateInitRequestToLogin. Wynik zapytania należy sprawdzić poprzez query GetWebsocketNotificationModel
.
EnvironmentId: COMPANY
Response
Returns a StandardWebsocketResponse!
Arguments
Name | Description |
---|---|
InitSessionRequestSigned - String!
|
Numer inicjalizacji sesji interaktywnej |
Example
Query
mutation AuthorizeInKSeF($InitSessionRequestSigned: String!) {
AuthorizeInKSeF(InitSessionRequestSigned: $InitSessionRequestSigned) {
NotificationModel {
...WebsocketNotificationModelFragment
}
Result
}
}
Variables
{"InitSessionRequestSigned": "xyz789"}
Response
{
"data": {
"AuthorizeInKSeF": {
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
}
}
AuthorizeInKSeFWithToken
Description
Uwierzytelnienie bieżącego użytkownika w KSeF Ministerstwa Finansów za pomocą tokena wygenerowanego w serwisie KSeF Ministerstwa Finansów. Wynik zapytania należy sprawdzić poprzez query GetWebsocketNotificationModel
.
EnvironmentId: COMPANY
Response
Returns an AuthorizeInKSeFWithTokenResponse!
Arguments
Name | Description |
---|---|
Token - String!
|
Token wygenerowany w KSeF |
Example
Query
mutation AuthorizeInKSeFWithToken($Token: String!) {
AuthorizeInKSeFWithToken(Token: $Token) {
NotificationModel {
...WebsocketNotificationModelFragment
}
Result
}
}
Variables
{"Token": "abc123"}
Response
{
"data": {
"AuthorizeInKSeFWithToken": {
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
}
}
DeleteInvoices
Description
Metoda służąca do usuwania faktur z Symfonia KSeF. Wynik zapytania należy sprawdzić poprzez query GetWebsocketNotificationModel
.
EnvironmentId: COMPANY
Response
Returns a DeleteInvoicesResponse!
Arguments
Name | Description |
---|---|
invoiceIds - [UUID!]!
|
Lista ID faktur |
Example
Query
mutation DeleteInvoices($invoiceIds: [UUID!]!) {
DeleteInvoices(invoiceIds: $invoiceIds) {
NotificationModel {
...WebsocketNotificationModelFragment
}
Result
}
}
Variables
{
"invoiceIds": [
"ce164f8f-a876-437c-a391-7fbb0e829ec4"
]
}
Response
{
"data": {
"DeleteInvoices": {
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
}
}
GenerateInitRequestToLogin
Response
Returns a String!
Example
Query
mutation GenerateInitRequestToLogin {
GenerateInitRequestToLogin
}
Response
{
"data": {
"GenerateInitRequestToLogin": "xyz789"
}
}
KSeFAutoFetchingInvoices
Description
Inicjuje serwis automatycznego pobierania faktur z KSeF Ministerstwa Finansów w kontekście firmy. Serwis pracuje w nocy, jest uruchamiany raz dziennie.
EnvironmentId: COMPANY
Response
Returns a KSeFAutoFetchingInvoicesResponseType!
Arguments
Name | Description |
---|---|
Status - CompanyKsefServicesStatusEnum!
|
Ustawienie statusu serwisu |
InternalEnabled - Boolean!
|
Pobieranie faktur sprzedażowych |
ExternalEnabled - Boolean!
|
Pobieranie faktur zakupowych |
Type - KSeFAutomaticOperationType!
|
Tryb działania serwisu (określona godzina lub interwał) |
Minutes - Int!
|
Wartość w minutach |
DownloadLimitDate - DateTime
|
Faktury wcześniejsze niż ustawiona data nie będą pobierane |
Example
Query
mutation KSeFAutoFetchingInvoices(
$Status: CompanyKsefServicesStatusEnum!,
$InternalEnabled: Boolean!,
$ExternalEnabled: Boolean!,
$Type: KSeFAutomaticOperationType!,
$Minutes: Int!,
$DownloadLimitDate: DateTime
) {
KSeFAutoFetchingInvoices(
Status: $Status,
InternalEnabled: $InternalEnabled,
ExternalEnabled: $ExternalEnabled,
Type: $Type,
Minutes: $Minutes,
DownloadLimitDate: $DownloadLimitDate
) {
Success
}
}
Variables
{
"Status": "INACTIVE",
"InternalEnabled": true,
"ExternalEnabled": false,
"Type": "TIME",
"Minutes": 987,
"DownloadLimitDate": "2007-12-03T10:15:30Z"
}
Response
{"data": {"KSeFAutoFetchingInvoices": {"Success": true}}}
KSeFAutoSendingInvoices
Description
Inicjuje serwis automatycznego wysyłania faktur do KSeF Ministerstwa Finansów w kontekście firmy.
EnvironmentId: COMPANY
Response
Returns a KSeFAutoSendingInvoicesResponseType!
Arguments
Name | Description |
---|---|
Status - CompanyKsefServicesStatusEnum!
|
Ustawienie statusu serwisu |
type - KSeFAutomaticOperationType!
|
Tryb działania serwisu (określona godzina lub interwał) |
minutes - Int!
|
Wartość w minutach |
Example
Query
mutation KSeFAutoSendingInvoices(
$Status: CompanyKsefServicesStatusEnum!,
$type: KSeFAutomaticOperationType!,
$minutes: Int!
) {
KSeFAutoSendingInvoices(
Status: $Status,
type: $type,
minutes: $minutes
) {
Success
}
}
Variables
{"Status": "INACTIVE", "type": "TIME", "minutes": 123}
Response
{"data": {"KSeFAutoSendingInvoices": {"Success": true}}}
MultipleSendToKSeF
Description
Zlecenie wysłania istniejących w Symfonia KSeF faktur do KSeF Ministerstwa Finansów. Wynik zapytania należy sprawdzić poprzez query GetWebsocketNotificationModel
.
EnvironmentId: COMPANY
Response
Returns an MultipleSendToKSeFResponseType!
Arguments
Name | Description |
---|---|
InvoiceIds - [UUID!]!
|
Id faktury |
Example
Query
mutation MultipleSendToKSeF($InvoiceIds: [UUID!]!) {
MultipleSendToKSeF(InvoiceIds: $InvoiceIds) {
NotificationModel {
...WebsocketNotificationModelFragment
}
Result
}
}
Variables
{
"InvoiceIds": [
"ce164f8f-a876-437c-a391-7fbb0e829ec4"
]
}
Response
{
"data": {
"MultipleSendToKSeF": {
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
}
}
PublishInvoices
Description
Wysłanie wybranych faktur do Symfonia Finanse i Księgowość za pomocą szyny danych.
EnvironmentId: COMPANY
Response
Returns a PublishInvoicesResponse!
Arguments
Name | Description |
---|---|
InvoiceIds - [UUID!]!
|
List Id faktur |
Example
Query
mutation PublishInvoices($InvoiceIds: [UUID!]!) {
PublishInvoices(InvoiceIds: $InvoiceIds) {
Sent
Failed
}
}
Variables
{
"InvoiceIds": [
"ce164f8f-a876-437c-a391-7fbb0e829ec4"
]
}
Response
{"data": {"PublishInvoices": {"Sent": 987, "Failed": 987}}}
RemoveAuthorizationInKSeF
Description
Usuwa uwierzytelnienie w KSeF Ministerstwa Finansów uprzednio dokonane za pomocą sesji interaktywnej (Szafir). Wynik zapytania należy sprawdzić poprzez query GetWebsocketNotificationModel
.
EnvironmentId: COMPANY
Response
Returns a StandardWebsocketResponse!
Arguments
Name | Description |
---|---|
InitSessionRequestSigned - String!
|
Numer inicjalizacji sesji interaktywnej |
Example
Query
mutation RemoveAuthorizationInKSeF($InitSessionRequestSigned: String!) {
RemoveAuthorizationInKSeF(InitSessionRequestSigned: $InitSessionRequestSigned) {
NotificationModel {
...WebsocketNotificationModelFragment
}
Result
}
}
Variables
{"InitSessionRequestSigned": "abc123"}
Response
{
"data": {
"RemoveAuthorizationInKSeF": {
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
}
}
RemoveAuthorizationWithExternalTokenInKSeF
Description
Usuwa uwierzytelnienie w KSeF Ministerstwa Finansów uprzednio dokonane za pomocą zewnętrznego tokena (AuthorizeInKSeFWithToken). Wynik zapytania należy sprawdzić poprzez query GetWebsocketNotificationModel
.
EnvironmentId: COMPANY
Response
Returns a RemoveAuthorizationExternalResult!
Example
Query
mutation RemoveAuthorizationWithExternalTokenInKSeF {
RemoveAuthorizationWithExternalTokenInKSeF {
NotificationModel {
...WebsocketNotificationModelFragment
}
Result
}
}
Response
{
"data": {
"RemoveAuthorizationWithExternalTokenInKSeF": {
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
}
}
RemoveEArchiveNotifications
Response
Returns a RemoveEArchiveNotificationsResponse!
Arguments
Name | Description |
---|---|
EArchiveNotificationType - EArchiveNotificationType!
|
Typ notyfikacji |
Example
Query
mutation RemoveEArchiveNotifications($EArchiveNotificationType: EArchiveNotificationType!) {
RemoveEArchiveNotifications(EArchiveNotificationType: $EArchiveNotificationType) {
Success
}
}
Variables
{"EArchiveNotificationType": "AUTHORIZATION_OF_COMPANY_SUCCEEDED"}
Response
{"data": {"RemoveEArchiveNotifications": {"Success": true}}}
SendToEArchive
Description
Wysłanie faktury do systemu Symfonia KSeF oraz jeżeli parametr WyslijDoKsef ma wartość true, do KSeF Ministerstwa Finansów.
EnvironmentId: COMPANY
Response
Returns a SendToEArchiveResponseType!
Arguments
Name | Description |
---|---|
Faktura - FakturaInput!
|
Obiekt Faktura |
WyslijDoKsef - Boolean!
|
Zlecenie wysłania faktury do KSeF |
Example
Query
mutation SendToEArchive(
$Faktura: FakturaInput!,
$WyslijDoKsef: Boolean!
) {
SendToEArchive(
Faktura: $Faktura,
WyslijDoKsef: $WyslijDoKsef
) {
Numer
}
}
Variables
{"Faktura": FakturaInput, "WyslijDoKsef": false}
Response
{
"data": {
"SendToEArchive": {
"Numer": "ce164f8f-a876-437c-a391-7fbb0e829ec4"
}
}
}
SendToEArchiveBatchV2
Description
Wysłanie listy faktur w wersji V2 do systemu Symfonia KSeF oraz jeżeli parametr WyslijDoKsef ma wartość true, do KSeF Ministerstwa Finansów.
EnvironmentId: COMPANY
Response
Returns a SendToEArchiveBatchV2ResponseType!
Arguments
Name | Description |
---|---|
Faktury - [FakturaV2Input!]!
|
Obiekt listy faktur |
WyslijDoKsef - Boolean!
|
Zlecenie wysłania listy faktur do KSeF |
Example
Query
mutation SendToEArchiveBatchV2(
$Faktury: [FakturaV2Input!]!,
$WyslijDoKsef: Boolean!
) {
SendToEArchiveBatchV2(
Faktury: $Faktury,
WyslijDoKsef: $WyslijDoKsef
) {
SuccessItems {
...BatchResponseItemFragment
}
ErrorItems {
...BatchResponseItemFragment
}
}
}
Variables
{"Faktury": [FakturaV2Input], "WyslijDoKsef": true}
Response
{
"data": {
"SendToEArchiveBatchV2": {
"SuccessItems": [BatchResponseItem],
"ErrorItems": [BatchResponseItem]
}
}
}
SendToEArchiveV2
Description
Wysłanie faktury w wersji V2 do systemu Symfonia KSeF oraz jeżeli parametr WyslijDoKsef ma wartość true, do KSeF Ministerstwa Finansów.
EnvironmentId: COMPANY
Response
Returns a SendToEArchiveV2ResponseType!
Arguments
Name | Description |
---|---|
Faktura - FakturaV2Input!
|
Obiekt Faktura |
WyslijDoKsef - Boolean!
|
Zlecenie wysłania faktury do KSeF |
Example
Query
mutation SendToEArchiveV2(
$Faktura: FakturaV2Input!,
$WyslijDoKsef: Boolean!
) {
SendToEArchiveV2(
Faktura: $Faktura,
WyslijDoKsef: $WyslijDoKsef
) {
Numer
}
}
Variables
{"Faktura": FakturaV2Input, "WyslijDoKsef": true}
Response
{
"data": {
"SendToEArchiveV2": {
"Numer": "ce164f8f-a876-437c-a391-7fbb0e829ec4"
}
}
}
SetEArchiveNotifications
Response
Returns a SetEArchiveNotificationsResponse!
Arguments
Name | Description |
---|---|
EArchiveNotificationType - EArchiveNotificationType!
|
Typ notyfikacji |
Example
Query
mutation SetEArchiveNotifications($EArchiveNotificationType: EArchiveNotificationType!) {
SetEArchiveNotifications(EArchiveNotificationType: $EArchiveNotificationType) {
Success
}
}
Variables
{"EArchiveNotificationType": "NONE"}
Response
{"data": {"SetEArchiveNotifications": {"Success": false}}}
SetWebsocketNotificationAcknowledge
Response
Returns a SetWebsocketNotificationAcknowledgeType!
Arguments
Name | Description |
---|---|
NotificationIds - [UUID!]!
|
Lista identyfikatorów wiadomości |
Example
Query
mutation SetWebsocketNotificationAcknowledge($NotificationIds: [UUID!]!) {
SetWebsocketNotificationAcknowledge(NotificationIds: $NotificationIds) {
Success
}
}
Variables
{
"NotificationIds": [
"ce164f8f-a876-437c-a391-7fbb0e829ec4"
]
}
Response
{"data": {"SetWebsocketNotificationAcknowledge": {"Success": false}}}
SubscribeGrantPermissionsInKSeF
Description
Nadaje uprawnienia w KSeF Ministerstwa Finansów dla podanego identyfikatora. Aby nadać uprawnienia w KSeF Ministerstwa Finansów, użytkownik musi być uwierzytelniony w KSeF Ministerstwa Finansów oraz posiadać uprawnienia do zarządzania uprawnieniami. Wynik zapytania należy sprawdzić poprzez query GetWebsocketNotificationModel
.
EnvironmentId: COMPANY
Response
Returns an SubscribeGrantPermissionsInKSeFResponse!
Arguments
Name | Description |
---|---|
IsNew - Boolean!
|
Określa, czy są to nowo nadawane uprawnienia czy aktualizacja istniejących |
Name - String
|
Nazwa uprawnień w KSeF Ministerstwa Finansów |
Identifier - String
|
Numer identyfikacji ewidencyjnej/podatkowej |
IdentifierType - IdentifierType!
|
Typ numeru identyfikacyjnego |
CredentialsInvoiceRead - Boolean!
|
Uprawnienie do pobierania faktur z KSeF Ministerstwa Finansów |
CredentialsInvoiceWrite - Boolean!
|
Uprawnienie do wysyłania faktur do KSeF Ministerstwa Finansów |
CredentialsRead - Boolean!
|
Uprawnienie do odczytu uprawnień z KSeF Ministerstwa Finansów |
CredentialsManage - Boolean!
|
Uprawnienie do zarządzania uprawnieniami w KSeF Ministerstwa Finansów |
CredentialsSelfInvoicing - Boolean!
|
Uprawnienie do samofakturowania w KSeF Ministerstwa Finansów |
NipType - KSeFIdentifierType
|
Typ identyfikatora NIP |
Example
Query
mutation SubscribeGrantPermissionsInKSeF(
$IsNew: Boolean!,
$Name: String,
$Identifier: String,
$IdentifierType: IdentifierType!,
$CredentialsInvoiceRead: Boolean!,
$CredentialsInvoiceWrite: Boolean!,
$CredentialsRead: Boolean!,
$CredentialsManage: Boolean!,
$CredentialsSelfInvoicing: Boolean!,
$NipType: KSeFIdentifierType
) {
SubscribeGrantPermissionsInKSeF(
IsNew: $IsNew,
Name: $Name,
Identifier: $Identifier,
IdentifierType: $IdentifierType,
CredentialsInvoiceRead: $CredentialsInvoiceRead,
CredentialsInvoiceWrite: $CredentialsInvoiceWrite,
CredentialsRead: $CredentialsRead,
CredentialsManage: $CredentialsManage,
CredentialsSelfInvoicing: $CredentialsSelfInvoicing,
NipType: $NipType
) {
NotificationModel {
...WebsocketNotificationModelFragment
}
Result
}
}
Variables
{
"IsNew": false,
"Name": "xyz789",
"Identifier": "xyz789",
"IdentifierType": "NIP",
"CredentialsInvoiceRead": true,
"CredentialsInvoiceWrite": false,
"CredentialsRead": true,
"CredentialsManage": false,
"CredentialsSelfInvoicing": true,
"NipType": "INSTITUTIONAL_NIP"
}
Response
{
"data": {
"SubscribeGrantPermissionsInKSeF": {
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
}
}
TerminateKSeFSession
Description
Zamyka bieżącą sesję w KSeF Ministerstwa Finansów. Wynik zapytania należy sprawdzić poprzez query GetWebsocketNotificationModel
.
EnvironmentId: COMPANY
Response
Returns an TerminateKSeFSessionResponse!
Example
Query
mutation TerminateKSeFSession {
TerminateKSeFSession {
NotificationModel {
...WebsocketNotificationModelFragment
}
Result
}
}
Response
{
"data": {
"TerminateKSeFSession": {
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
}
}
UploadInvoices
Description
Wczytanie faktur w formacie XML do systemu Symfonia KSeF. Wynik zapytania należy sprawdzić poprzez query GetWebsocketNotificationModel
.
EnvironmentId: COMPANY
Response
Returns an UploadInvoicesResponse!
Arguments
Name | Description |
---|---|
invoices - [UploadItemInput!]!
|
Lista faktur |
Example
Query
mutation UploadInvoices($invoices: [UploadItemInput!]!) {
UploadInvoices(invoices: $invoices) {
NotificationModel {
...WebsocketNotificationModelFragment
}
Result
}
}
Variables
{"invoices": [UploadItemInput]}
Response
{
"data": {
"UploadInvoices": {
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
}
}
Types
Address
Description
Dane adresowe firmy
Example
{
"AddressLine": "xyz789",
"ZipCode": "xyz789",
"City": "xyz789",
"State": "xyz789",
"Country": "abc123"
}
AddressFilterInput
Description
Dane adresowe firmy
Fields
Input Field | Description |
---|---|
and - [AddressFilterInput!]
|
|
or - [AddressFilterInput!]
|
|
AddressLine - StringOperationFilterInput
|
Adres |
ZipCode - StringOperationFilterInput
|
Kod pocztowy |
City - StringOperationFilterInput
|
Miasto |
State - StringOperationFilterInput
|
Województwo |
Country - StringOperationFilterInput
|
Kraj |
Example
{
"and": [AddressFilterInput],
"or": [AddressFilterInput],
"AddressLine": StringOperationFilterInput,
"ZipCode": StringOperationFilterInput,
"City": StringOperationFilterInput,
"State": StringOperationFilterInput,
"Country": StringOperationFilterInput
}
AddressInput
Description
Dane adresowe firmy
Example
{
"AddressLine": "xyz789",
"ZipCode": "xyz789",
"City": "xyz789",
"State": "xyz789",
"Country": "xyz789"
}
Adnotacje
Description
Adnotacje do faktury
Fields
Field Name | Description |
---|---|
MetodaKasowa - Boolean!
|
W przypadku dostawy towarów lub świadczenia usług, w odniesieniu do których obowiązek podatkowy powstaje zgodnie z art. 19a ust. 5 pkt 1 lub art. 21 ust. 1 ustawy |
Samofakturowanie - Boolean!
|
W przypadku faktur, o których mowa w art. 106d ust. 1 ustawy |
OdwrotneObciazenie - Boolean!
|
Odwrotne obciążenie polega na przerzuceniu obowiązku rozliczania podatku VAT ze sprzedawcy na nabywcę. Listę towarów dla transakcji krajowych, co do których ma zastosowanie procedura odwrotnego obciążenia, zawiera załącznik nr 11 do ustawy o VAT. Natomiast lista usług objętych procedurą odwrotnego obciążenia została umieszczona w załączniku nr 14 do ustawy. |
PodzielonaPlatnosc - Boolean!
|
W przypadku faktur, w których kwota należności ogółem przekracza kwotę 15 000 zł lub jej równowartość wyrażoną w walucie obcej, obejmujących dokonaną na rzecz podatnika dostawę towarów lub świadczenie usług, o których mowa w załączniku nr 15 do ustawy - wyrazy "mechanizm podzielonej płatności", przy czym do przeliczania na PLN kwot wyrażonych w walucie obcej stosuje się zasady przeliczania kwot, stosowane w celu określenia podstawy opodatkowania |
ZwolnieniaPodmiotowe - Boolean!
|
W przypadku dostawy towarów lub świadczenia usług zwolnionych od podatku na podstawie art. 43 ust. 1, art. 113 ust. 1 i 9 albo przepisów wydanych na podstawie art. 82 ust. 3 ustawy lub na podstawie innych przepisów |
PowodZwolnienia - TPowodZwolnienia
|
Powód zwolnienia z podatku |
SrodekTrwaly - Boolean!
|
Czy jest to środek trwały |
SrodekTrwalyInfo - TSrodekTrwaly
|
Informacja o środku trwałym |
ProceduraUproszczona - Boolean!
|
W przypadku faktur wystawianych w procedurze uproszczonej przez drugiego w kolejności podatnika, o którym mowa w art. 135 ust. 1 pkt 4 lit. b i c oraz ust. 2, zawierającej adnotację, o której mowa w art. 136 ust. 1 pkt 1 i stwierdzenie, o którym mowa w art. 136 ust. 1 pkt 2 ustawy |
ProceduraMarzy - Boolean!
|
W przypadku wystąpienia procedur marży, o których mowa w art. 119 lub 120 ustawy |
Marza - TMarza
|
Procedura marży |
Example
{
"MetodaKasowa": true,
"Samofakturowanie": false,
"OdwrotneObciazenie": false,
"PodzielonaPlatnosc": false,
"ZwolnieniaPodmiotowe": false,
"PowodZwolnienia": TPowodZwolnienia,
"SrodekTrwaly": false,
"SrodekTrwalyInfo": TSrodekTrwaly,
"ProceduraUproszczona": true,
"ProceduraMarzy": false,
"Marza": TMarza
}
AdnotacjeInput
Description
Adnotacje do faktury
Fields
Input Field | Description |
---|---|
MetodaKasowa - Boolean!
|
W przypadku dostawy towarów lub świadczenia usług, w odniesieniu do których obowiązek podatkowy powstaje zgodnie z art. 19a ust. 5 pkt 1 lub art. 21 ust. 1 ustawy |
Samofakturowanie - Boolean!
|
W przypadku faktur, o których mowa w art. 106d ust. 1 ustawy |
OdwrotneObciazenie - Boolean!
|
Odwrotne obciążenie polega na przerzuceniu obowiązku rozliczania podatku VAT ze sprzedawcy na nabywcę. Listę towarów dla transakcji krajowych, co do których ma zastosowanie procedura odwrotnego obciążenia, zawiera załącznik nr 11 do ustawy o VAT. Natomiast lista usług objętych procedurą odwrotnego obciążenia została umieszczona w załączniku nr 14 do ustawy. |
PodzielonaPlatnosc - Boolean!
|
W przypadku faktur, w których kwota należności ogółem przekracza kwotę 15 000 zł lub jej równowartość wyrażoną w walucie obcej, obejmujących dokonaną na rzecz podatnika dostawę towarów lub świadczenie usług, o których mowa w załączniku nr 15 do ustawy - wyrazy "mechanizm podzielonej płatności", przy czym do przeliczania na PLN kwot wyrażonych w walucie obcej stosuje się zasady przeliczania kwot, stosowane w celu określenia podstawy opodatkowania |
ZwolnieniaPodmiotowe - Boolean!
|
W przypadku dostawy towarów lub świadczenia usług zwolnionych od podatku na podstawie art. 43 ust. 1, art. 113 ust. 1 i 9 albo przepisów wydanych na podstawie art. 82 ust. 3 ustawy lub na podstawie innych przepisów |
PowodZwolnienia - TPowodZwolnieniaInput
|
Powód zwolnienia z podatku |
SrodekTrwaly - Boolean!
|
Czy jest to środek trwały |
SrodekTrwalyInfo - TSrodekTrwalyInput
|
Informacja o środku trwałym |
ProceduraUproszczona - Boolean!
|
W przypadku faktur wystawianych w procedurze uproszczonej przez drugiego w kolejności podatnika, o którym mowa w art. 135 ust. 1 pkt 4 lit. b i c oraz ust. 2, zawierającej adnotację, o której mowa w art. 136 ust. 1 pkt 1 i stwierdzenie, o którym mowa w art. 136 ust. 1 pkt 2 ustawy |
ProceduraMarzy - Boolean!
|
W przypadku wystąpienia procedur marży, o których mowa w art. 119 lub 120 ustawy |
Marza - TMarzaInput
|
Procedura marży |
Example
{
"MetodaKasowa": true,
"Samofakturowanie": false,
"OdwrotneObciazenie": true,
"PodzielonaPlatnosc": false,
"ZwolnieniaPodmiotowe": false,
"PowodZwolnienia": TPowodZwolnieniaInput,
"SrodekTrwaly": false,
"SrodekTrwalyInfo": TSrodekTrwalyInput,
"ProceduraUproszczona": false,
"ProceduraMarzy": false,
"Marza": TMarzaInput
}
AdnotacjeV2
Description
Adnotacje do faktury
Fields
Field Name | Description |
---|---|
MetodaKasowa - Boolean!
|
W przypadku dostawy towarów lub świadczenia usług, w odniesieniu do których obowiązek podatkowy powstaje zgodnie z art. 19a ust. 5 pkt 1 lub art. 21 ust. 1 ustawy |
Samofakturowanie - Boolean!
|
W przypadku faktur, o których mowa w art. 106d ust. 1 ustawy |
OdwrotneObciazenie - Boolean!
|
Odwrotne obciążenie polega na przerzuceniu obowiązku rozliczania podatku VAT ze sprzedawcy na nabywcę. Listę towarów dla transakcji krajowych, co do których ma zastosowanie procedura odwrotnego obciążenia, zawiera załącznik nr 11 do ustawy o VAT. Natomiast lista usług objętych procedurą odwrotnego obciążenia została umieszczona w załączniku nr 14 do ustawy. |
PodzielonaPlatnosc - Boolean!
|
W przypadku faktur, w których kwota należności ogółem przekracza kwotę 15 000 zł lub jej równowartość wyrażoną w walucie obcej, obejmujących dokonaną na rzecz podatnika dostawę towarów lub świadczenie usług, o których mowa w załączniku nr 15 do ustawy - wyrazy "mechanizm podzielonej płatności", przy czym do przeliczania na PLN kwot wyrażonych w walucie obcej stosuje się zasady przeliczania kwot, stosowane w celu określenia podstawy opodatkowania |
ZwolnieniaPodmiotowe - Boolean!
|
W przypadku dostawy towarów lub świadczenia usług zwolnionych od podatku na podstawie art. 43 ust. 1, art. 113 ust. 1 i 9 albo przepisów wydanych na podstawie art. 82 ust. 3 ustawy lub na podstawie innych przepisów |
PowodZwolnienia - TPowodZwolnieniaV2
|
Powód zwolnienia z podatku |
NoweSrodkiTransportu - DostawaNowychSrodkowTransportuV2
|
Informacja o środku trwałym |
ProceduraUproszczona - Boolean!
|
W przypadku faktur wystawianych w procedurze uproszczonej przez drugiego w kolejności podatnika, o którym mowa w art. 135 ust. 1 pkt 4 lit. b i c oraz ust. 2, zawierającej adnotację, o której mowa w art. 136 ust. 1 pkt 1 i stwierdzenie, o którym mowa w art. 136 ust. 1 pkt 2 ustawy |
ProceduraMarzy - Boolean!
|
W przypadku wystąpienia procedur marży, o których mowa w art. 119 lub 120 ustawy |
Marza - TMarzaV2
|
Procedura marży |
Example
{
"MetodaKasowa": false,
"Samofakturowanie": true,
"OdwrotneObciazenie": true,
"PodzielonaPlatnosc": true,
"ZwolnieniaPodmiotowe": false,
"PowodZwolnienia": TPowodZwolnieniaV2,
"NoweSrodkiTransportu": DostawaNowychSrodkowTransportuV2,
"ProceduraUproszczona": false,
"ProceduraMarzy": false,
"Marza": TMarzaV2
}
AdnotacjeV2Input
Description
Adnotacje do faktury
Fields
Input Field | Description |
---|---|
MetodaKasowa - Boolean!
|
W przypadku dostawy towarów lub świadczenia usług, w odniesieniu do których obowiązek podatkowy powstaje zgodnie z art. 19a ust. 5 pkt 1 lub art. 21 ust. 1 ustawy |
Samofakturowanie - Boolean!
|
W przypadku faktur, o których mowa w art. 106d ust. 1 ustawy |
OdwrotneObciazenie - Boolean!
|
Odwrotne obciążenie polega na przerzuceniu obowiązku rozliczania podatku VAT ze sprzedawcy na nabywcę. Listę towarów dla transakcji krajowych, co do których ma zastosowanie procedura odwrotnego obciążenia, zawiera załącznik nr 11 do ustawy o VAT. Natomiast lista usług objętych procedurą odwrotnego obciążenia została umieszczona w załączniku nr 14 do ustawy. |
PodzielonaPlatnosc - Boolean!
|
W przypadku faktur, w których kwota należności ogółem przekracza kwotę 15 000 zł lub jej równowartość wyrażoną w walucie obcej, obejmujących dokonaną na rzecz podatnika dostawę towarów lub świadczenie usług, o których mowa w załączniku nr 15 do ustawy - wyrazy "mechanizm podzielonej płatności", przy czym do przeliczania na PLN kwot wyrażonych w walucie obcej stosuje się zasady przeliczania kwot, stosowane w celu określenia podstawy opodatkowania |
ZwolnieniaPodmiotowe - Boolean!
|
W przypadku dostawy towarów lub świadczenia usług zwolnionych od podatku na podstawie art. 43 ust. 1, art. 113 ust. 1 i 9 albo przepisów wydanych na podstawie art. 82 ust. 3 ustawy lub na podstawie innych przepisów |
PowodZwolnienia - TPowodZwolnieniaV2Input
|
Powód zwolnienia z podatku |
NoweSrodkiTransportu - DostawaNowychSrodkowTransportuV2Input
|
Informacja o środku trwałym |
ProceduraUproszczona - Boolean!
|
W przypadku faktur wystawianych w procedurze uproszczonej przez drugiego w kolejności podatnika, o którym mowa w art. 135 ust. 1 pkt 4 lit. b i c oraz ust. 2, zawierającej adnotację, o której mowa w art. 136 ust. 1 pkt 1 i stwierdzenie, o którym mowa w art. 136 ust. 1 pkt 2 ustawy |
ProceduraMarzy - Boolean!
|
W przypadku wystąpienia procedur marży, o których mowa w art. 119 lub 120 ustawy |
Marza - TMarzaV2Input
|
Procedura marży |
Example
{
"MetodaKasowa": true,
"Samofakturowanie": true,
"OdwrotneObciazenie": true,
"PodzielonaPlatnosc": false,
"ZwolnieniaPodmiotowe": false,
"PowodZwolnienia": TPowodZwolnieniaV2Input,
"NoweSrodkiTransportu": DostawaNowychSrodkowTransportuV2Input,
"ProceduraUproszczona": false,
"ProceduraMarzy": false,
"Marza": TMarzaV2Input
}
Adres
Description
Dane adresowe podmiotów wyszczególnionych na fakturze
Fields
Field Name | Description |
---|---|
KodKraju - KodKraju
|
Kod kraju |
Wojewodztwo - String
|
Województwo |
Powiat - String
|
Powiat |
Gmina - String
|
Gmina |
Ulica - String
|
Ulica |
NrDomu - String
|
Numer domu |
NrLokalu - String
|
Numer lokalu |
Miejscowosc - String
|
Miejscowość |
KodPocztowy - String
|
Kod pocztowy |
Poczta - String
|
Poczta |
GLN - String
|
Globalny numer lokalizacyjny |
Example
{
"KodKraju": "PL",
"Wojewodztwo": "abc123",
"Powiat": "abc123",
"Gmina": "xyz789",
"Ulica": "xyz789",
"NrDomu": "abc123",
"NrLokalu": "xyz789",
"Miejscowosc": "xyz789",
"KodPocztowy": "abc123",
"Poczta": "xyz789",
"GLN": "xyz789"
}
AdresInput
Description
Dane adresowe podmiotów wyszczególnionych na fakturze
Fields
Input Field | Description |
---|---|
KodKraju - KodKraju
|
Kod kraju |
Wojewodztwo - String
|
Województwo |
Powiat - String
|
Powiat |
Gmina - String
|
Gmina |
Ulica - String
|
Ulica |
NrDomu - String
|
Numer domu |
NrLokalu - String
|
Numer lokalu |
Miejscowosc - String
|
Miejscowość |
KodPocztowy - String
|
Kod pocztowy |
Poczta - String
|
Poczta |
GLN - String
|
Globalny numer lokalizacyjny |
Example
{
"KodKraju": "PL",
"Wojewodztwo": "xyz789",
"Powiat": "abc123",
"Gmina": "xyz789",
"Ulica": "xyz789",
"NrDomu": "abc123",
"NrLokalu": "xyz789",
"Miejscowosc": "abc123",
"KodPocztowy": "xyz789",
"Poczta": "xyz789",
"GLN": "abc123"
}
AdresV2
Description
Dane adresowe podmiotów wyszczególnionych na fakturze
Fields
Field Name | Description |
---|---|
KodKraju - KodKraju
|
Kod kraju |
AdresL1 - String
|
Adres [Address]. Typ znakowy ograniczony do 512 znaków. Minimum length: 1. Maximum length: 512. |
AdresL2 - String
|
Adres [Address]. Typ znakowy ograniczony do 512 znaków. Minimum length: 1. Maximum length: 512. |
GLN - String
|
Globalny numer lokalizacyjny |
Example
{
"KodKraju": "PL",
"AdresL1": "abc123",
"AdresL2": "abc123",
"GLN": "xyz789"
}
AdresV2Input
Description
Dane adresowe podmiotów wyszczególnionych na fakturze
Fields
Input Field | Description |
---|---|
KodKraju - KodKraju
|
Kod kraju |
AdresL1 - String
|
Adres [Address]. Typ znakowy ograniczony do 512 znaków. Minimum length: 1. Maximum length: 512. |
AdresL2 - String
|
Adres [Address]. Typ znakowy ograniczony do 512 znaków. Minimum length: 1. Maximum length: 512. |
GLN - String
|
Globalny numer lokalizacyjny |
Example
{
"KodKraju": "PL",
"AdresL1": "abc123",
"AdresL2": "xyz789",
"GLN": "abc123"
}
AttachmentFilterInput
Description
Reprezentuje załącznik, czyli dokument przypisany do faktury z serwisu FileHub
Fields
Input Field | Description |
---|---|
and - [AttachmentFilterInput!]
|
|
or - [AttachmentFilterInput!]
|
|
Id - UuidOperationFilterInput
|
Id załącznika |
CompanyId - UuidOperationFilterInput
|
Id firmy |
CreatedBy - UuidOperationFilterInput
|
Guid użytkownika tworzącego załącznik |
ModifiedBy - UuidOperationFilterInput
|
Guid użytkownika ostatnio modyfikującego załącznik |
FileName - StringOperationFilterInput
|
Nazwa pliku |
CreatedAt - DateTimeOperationFilterInput
|
Data utworzenia |
ModifiedAt - DateTimeOperationFilterInput
|
Data modyfikacji |
IsPublic - BooleanOperationFilterInput
|
True - jeśli załącznik jest publiczny |
Size - LongOperationFilterInput
|
Rozmiar załącznika |
InvoiceId - UuidOperationFilterInput
|
ID faktury nadany przez Symfonia KSeF |
Example
{
"and": [AttachmentFilterInput],
"or": [AttachmentFilterInput],
"Id": UuidOperationFilterInput,
"CompanyId": UuidOperationFilterInput,
"CreatedBy": UuidOperationFilterInput,
"ModifiedBy": UuidOperationFilterInput,
"FileName": StringOperationFilterInput,
"CreatedAt": DateTimeOperationFilterInput,
"ModifiedAt": DateTimeOperationFilterInput,
"IsPublic": BooleanOperationFilterInput,
"Size": LongOperationFilterInput,
"InvoiceId": UuidOperationFilterInput
}
AuthorizeInKSeFWithTokenResponse
Fields
Field Name | Description |
---|---|
NotificationModel - WebsocketNotificationModel
|
Treść notyfikacji |
Result - SubscriptionStateEnum!
|
Stan operacji |
Example
{
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
BatchResponseItem
Description
Pojedynczy rekord faktury z pakietu
Fields
Field Name | Description |
---|---|
InvoiceId - UUID
|
ID faktury nadany przez Symfonia KSeF |
InvoiceNumber - String
|
Numer faktury |
RecipientNip - String
|
Nip nabywcy |
InvoicingDate - DateTime!
|
Data wystawienia |
SentToKSeF - Boolean!
|
True - jeżeli faktura została od razu wysłana do KSeF |
Errors - [String]
|
Lista błędów |
Example
{
"InvoiceId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"InvoiceNumber": "abc123",
"RecipientNip": "abc123",
"InvoicingDate": "2007-12-03T10:15:30Z",
"SentToKSeF": true,
"Errors": ["abc123"]
}
Boolean
Description
The Boolean
scalar type represents true
or false
.
BooleanOperationFilterInput
Company
Description
Firma zarządzana przez organizację
Fields
Field Name | Description |
---|---|
Name - String!
|
Nazwa firmy |
Identifier - String
|
Numer identyfikacji ewidencyjnej/podatkowej |
IdentifierType - IdentifierType!
|
Typ numeru identyfikacyjnego |
VatNumberUE - String
|
Numer VAT UE |
Tenant - TenantResponse
|
Organizacja, do której należy firma |
TenantId - UUID!
|
Id organizacji, do której należy firma |
RoleAssignments - [RoleAssignment]
|
Lista ról przypisanych do firmy |
IsDemo - Boolean!
|
Określa czy firma działa w trybie Demo (połączenie z https://ksef-demo.mf.gov.pl/) |
Address - Address
|
Dane adresowe firmy |
IsMainCompany - Boolean!
|
Czy firma główna w organizacji |
NIP - String
|
To pole niedługo zostanie usunięte |
Id - UUID!
|
Unikalny Id rekordu |
CreatedAt - DateTime
|
Data utworzenia rekordu |
CreatedBy - String
|
E-mail użytkownika, który utworzył rekord |
ModifiedAt - DateTime
|
Data modyfikacji rekordu |
ModifiedBy - String
|
E-mail użytkownika, który zmodyfikował rekord |
Example
{
"Name": "xyz789",
"Identifier": "abc123",
"IdentifierType": "NIP",
"VatNumberUE": "abc123",
"Tenant": TenantResponse,
"TenantId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"RoleAssignments": [RoleAssignment],
"IsDemo": false,
"Address": Address,
"IsMainCompany": false,
"NIP": "abc123",
"Id": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"CreatedAt": "2007-12-03T10:15:30Z",
"CreatedBy": "abc123",
"ModifiedAt": "2007-12-03T10:15:30Z",
"ModifiedBy": "abc123"
}
CompanyAssignmentViewModel
Description
Statystyka firmy
Fields
Field Name | Description |
---|---|
CompanyId - UUID!
|
Id firmy |
CompanyName - String
|
Nazwa firmy |
RoleName - String
|
Nazwa roli |
PurchaseInvoicesCount - Long!
|
Liczba faktur zakupowych |
SalesInvoicesCount - Long!
|
Liczba faktur sprzedażowych |
Identifier - String
|
Numer identyfikacji ewidencyjnej/podatkowej |
IdentifierType - IdentifierType!
|
Typ numeru identyfikacyjnego |
IsDemo - Boolean!
|
Określa czy firma działa w trybie Demo (połączenie z https://ksef-demo.mf.gov.pl/) |
Example
{
"CompanyId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"CompanyName": "abc123",
"RoleName": "xyz789",
"PurchaseInvoicesCount": {},
"SalesInvoicesCount": {},
"Identifier": "abc123",
"IdentifierType": "NIP",
"IsDemo": true
}
CompanyFilterInput
Description
Firma zarządzana przez organizację
Fields
Input Field | Description |
---|---|
and - [CompanyFilterInput!]
|
|
or - [CompanyFilterInput!]
|
|
Name - StringOperationFilterInput
|
Nazwa firmy |
Identifier - StringOperationFilterInput
|
Numer identyfikacji ewidencyjnej/podatkowej |
IdentifierType - IdentifierTypeOperationFilterInput
|
Typ numeru identyfikacyjnego |
VatNumberUE - StringOperationFilterInput
|
Numer VAT UE |
Tenant - TenantFilterInput
|
Organizacja, do której należy firma |
TenantId - UuidOperationFilterInput
|
Id organizacji, do której należy firma |
RoleAssignments - ListFilterInputTypeOfRoleAssignmentFilterInput
|
Lista ról przypisanych do firmy |
IsDemo - BooleanOperationFilterInput
|
Określa czy firma działa w trybie Demo (połączenie z https://ksef-demo.mf.gov.pl/) |
Address - AddressFilterInput
|
Dane adresowe firmy |
IsMainCompany - BooleanOperationFilterInput
|
Czy firma główna w organizacji |
NIP - StringOperationFilterInput
|
To pole niedługo zostanie usunięte |
Id - UuidOperationFilterInput
|
Unikalny Id rekordu |
CreatedAt - DateTimeOperationFilterInput
|
Data utworzenia rekordu |
CreatedBy - StringOperationFilterInput
|
E-mail użytkownika, który utworzył rekord |
ModifiedAt - DateTimeOperationFilterInput
|
Data modyfikacji rekordu |
ModifiedBy - StringOperationFilterInput
|
E-mail użytkownika, który zmodyfikował rekord |
Example
{
"and": [CompanyFilterInput],
"or": [CompanyFilterInput],
"Name": StringOperationFilterInput,
"Identifier": StringOperationFilterInput,
"IdentifierType": IdentifierTypeOperationFilterInput,
"VatNumberUE": StringOperationFilterInput,
"Tenant": TenantFilterInput,
"TenantId": UuidOperationFilterInput,
"RoleAssignments": ListFilterInputTypeOfRoleAssignmentFilterInput,
"IsDemo": BooleanOperationFilterInput,
"Address": AddressFilterInput,
"IsMainCompany": BooleanOperationFilterInput,
"NIP": StringOperationFilterInput,
"Id": UuidOperationFilterInput,
"CreatedAt": DateTimeOperationFilterInput,
"CreatedBy": StringOperationFilterInput,
"ModifiedAt": DateTimeOperationFilterInput,
"ModifiedBy": StringOperationFilterInput
}
CompanyInfo
Fields
Field Name | Description |
---|---|
Id - UUID!
|
|
Name - String
|
|
Identifier - String
|
|
IdentifierType - IdentifierType!
|
|
IsDemo - Boolean!
|
Example
{
"Id": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"Name": "xyz789",
"Identifier": "xyz789",
"IdentifierType": "NIP",
"IsDemo": true
}
CompanyKsefServicesStatusEnum
Description
Stan serwisu realizującego zadania w KSeF
Values
Enum Value | Description |
---|---|
|
Nieaktywny |
|
Aktywny |
Example
"INACTIVE"
CreateCompanyRequest
Description
Firma zarządzana przez organizację
Fields
Input Field | Description |
---|---|
TenantId - UUID!
|
Id organizacji, do której należy firma |
Name - String!
|
Nazwa firmy |
Identifier - String
|
Numer identyfikacji ewidencyjnej/podatkowej |
IdentifierType - IdentifierType!
|
Typ numeru identyfikacyjnego |
VatNumberUE - String
|
Numer VAT UE |
Tenant - TenantInput
|
Organizacja, do której należy firma |
RoleAssignments - [RoleAssignmentInput]
|
Lista ról przypisanych do firmy |
IsDemo - Boolean!
|
Określa czy firma działa w trybie Demo (połączenie z https://ksef-demo.mf.gov.pl/) |
Address - AddressInput
|
Dane adresowe firmy |
NIP - String
|
To pole niedługo zostanie usunięte |
Example
{
"TenantId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"Name": "xyz789",
"Identifier": "xyz789",
"IdentifierType": "NIP",
"VatNumberUE": "abc123",
"Tenant": TenantInput,
"RoleAssignments": [RoleAssignmentInput],
"IsDemo": true,
"Address": AddressInput,
"NIP": "abc123"
}
CreateRoleRequest
Description
Rola
Fields
Input Field | Description |
---|---|
Name - String
|
Nazwa roli |
Example
{"Name": "abc123"}
CreateUserRequest
Description
Użytkownik organizacji
Fields
Input Field | Description |
---|---|
Email - String!
|
Adres email użytkownika |
FirstName - String!
|
Imię użytkownika |
LastName - String!
|
Nazwisko użytkownika |
PhoneNumber - String
|
Numer telefonu użytkownika |
CloudConsent - Boolean
|
Warunki użytkowania Programu w chmurze https://materialy.symfonia.pl/publiczne/a8ca55 (obowiązkowe) |
PersonalDataConsent - Boolean
|
Zgoda na przetwarzanie danych osobowych w celach marketingowych Symfonii. (obowiązkowe) |
PrivacyPolicyConsent - Boolean
|
Akceptacja polityki prywatności (obowiązkowe) |
CompanyRepresentationConsent - Boolean
|
Oświadczenie o upoważnienie do działania w imieniu reprezentowanego podmiotu: "Oświadczam, że jestem uprawniony/-a do działania w imieniu i ze skutkiem dla podmiotu, który reprezentuję." (obowiązkowe) |
MarketingEndDeviceConsent - Boolean
|
Zgoda na używanie telekomunikacyjnych urządzeń końcowych do kontaktów marketingowych |
MarketingPhoneConsent - Boolean
|
Zgoda na używanie telefonu do kontaktów marketingowych |
NewsletterConsent - Boolean
|
Zgoda na otrzymywanie newslettera |
MarketingEmailConsent - Boolean
|
Zgoda na wykorzystanie e-mail do celów marketingowych |
PersonalDataForPartnersConsent - Boolean
|
Zgoda na przetwarzanie danych osobowych w celach marketingowych przez Partnerów Symfonii. |
Tenant - TenantInput
|
Organizacja |
TenantId - UUID!
|
Id organizacji |
RoleAssignments - [RoleAssignmentInput]
|
Przypisane role |
Example
{
"Email": "xyz789",
"FirstName": "abc123",
"LastName": "abc123",
"PhoneNumber": "abc123",
"CloudConsent": true,
"PersonalDataConsent": false,
"PrivacyPolicyConsent": true,
"CompanyRepresentationConsent": true,
"MarketingEndDeviceConsent": true,
"MarketingPhoneConsent": false,
"NewsletterConsent": true,
"MarketingEmailConsent": false,
"PersonalDataForPartnersConsent": false,
"Tenant": TenantInput,
"TenantId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"RoleAssignments": [RoleAssignmentInput]
}
Credential
Description
Obiekt uprawnień w KSeF
Fields
Field Name | Description |
---|---|
Identifier - String!
|
Numer identyfikacji ewidencyjnej/podatkowej firmy, do której użytkownik ma uprawnienia w KSeF |
IdentifierType - IdentifierType!
|
Typ numeru identyfikacyjnego |
CredentialsInvoiceRead - Boolean!
|
Uprawnienie do odbierania faktur |
CredentialsInvoiceWrite - Boolean!
|
Uprawnienie do wysyłki faktur |
CredentialsRead - Boolean!
|
Uprawnienie do odczytu uprawnień |
CredentialsManage - Boolean!
|
Uprawnienie do nadawania uprawnień |
CredentialsSelfInvoicing - Boolean!
|
Uprawnienie do samofakturowania |
Example
{
"Identifier": "xyz789",
"IdentifierType": "NIP",
"CredentialsInvoiceRead": false,
"CredentialsInvoiceWrite": true,
"CredentialsRead": true,
"CredentialsManage": true,
"CredentialsSelfInvoicing": true
}
CredentialFiltersFieldsInput
Description
Filtr uprawnień
Fields
Input Field | Description |
---|---|
Identifiers - [String!]
|
Lista numerów identyfikacji ewidencyjnej/podatkowej |
CredentialsInvoiceRead - Boolean
|
Uprawnienie do odbierania faktur |
CredentialsInvoiceWrite - Boolean
|
Uprawnienie do wysyłki faktur |
CredentialsRead - Boolean
|
Uprawnienie do odczytu uprawnień |
CredentialsManage - Boolean
|
Uprawnienie do nadawania uprawnień |
CredentialsSelfInvoicing - Boolean
|
Uprawnienie do samofakturowania |
Example
{
"Identifiers": ["xyz789"],
"CredentialsInvoiceRead": true,
"CredentialsInvoiceWrite": true,
"CredentialsRead": false,
"CredentialsManage": true,
"CredentialsSelfInvoicing": false
}
DaneFaKorygowanej
Description
Dane dotyczące faktury korygowanej
Example
{
"DataWystFaKorygowanej": "2007-12-03T10:15:30Z",
"NrFaKorygowanej": "xyz789",
"NrKSeFFaKorygowanej": "abc123"
}
DaneFaKorygowanejInput
Description
Dane dotyczące faktury korygowanej
Example
{
"DataWystFaKorygowanej": "2007-12-03T10:15:30Z",
"NrFaKorygowanej": "abc123",
"NrKSeFFaKorygowanej": "abc123"
}
Date
Description
The Date
scalar represents an ISO-8601 compliant date type.
Example
"2007-12-03"
DateOperationFilterInput
Example
{
"eq": "2007-12-03",
"neq": "2007-12-03",
"in": ["2007-12-03"],
"nin": ["2007-12-03"],
"gt": "2007-12-03",
"ngt": "2007-12-03",
"gte": "2007-12-03",
"ngte": "2007-12-03",
"lt": "2007-12-03",
"nlt": "2007-12-03",
"lte": "2007-12-03",
"nlte": "2007-12-03"
}
DateRangeSchemaModelInput
DateTime
Description
The DateTime
scalar represents an ISO-8601 compliant date time type.
Example
"2007-12-03T10:15:30Z"
DateTimeOperationFilterInput
Example
{
"eq": "2007-12-03T10:15:30Z",
"neq": "2007-12-03T10:15:30Z",
"in": ["2007-12-03T10:15:30Z"],
"nin": ["2007-12-03T10:15:30Z"],
"gt": "2007-12-03T10:15:30Z",
"ngt": "2007-12-03T10:15:30Z",
"gte": "2007-12-03T10:15:30Z",
"ngte": "2007-12-03T10:15:30Z",
"lt": "2007-12-03T10:15:30Z",
"nlt": "2007-12-03T10:15:30Z",
"lte": "2007-12-03T10:15:30Z",
"nlte": "2007-12-03T10:15:30Z"
}
DateTimeRange
DateTimeRangeInput
Decimal
Description
The built-in Decimal
scalar type.
Example
Decimal
DecimalOperationFilterInput
Example
{
"eq": Decimal,
"neq": Decimal,
"in": [Decimal],
"nin": [Decimal],
"gt": Decimal,
"ngt": Decimal,
"gte": Decimal,
"ngte": Decimal,
"lt": Decimal,
"nlt": Decimal,
"lte": Decimal,
"nlte": Decimal
}
DeleteInvoicesResponse
Fields
Field Name | Description |
---|---|
NotificationModel - WebsocketNotificationModel
|
Treść notyfikacji |
Result - SubscriptionStateEnum!
|
Stan operacji |
Example
{
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
DesktopStatus
Description
Status połączenia między aplikacjami
Values
Enum Value | Description |
---|---|
|
Nie połączono |
|
Tworzona jest infrastruktura do komunikacji No longer supported |
|
Oczekiwanie na podłączenie agenta |
|
Połączono |
Example
"NOT_CONNECTED"
DesktopStatusOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - DesktopStatus
|
|
neq - DesktopStatus
|
|
in - [DesktopStatus!]
|
|
nin - [DesktopStatus!]
|
Example
{
"eq": "NOT_CONNECTED",
"neq": "NOT_CONNECTED",
"in": ["NOT_CONNECTED"],
"nin": ["NOT_CONNECTED"]
}
DodatkowyOpisPolaV2
Description
Pola przeznaczone dla wykazywania dodatkowych danych na fakturze, w tym wymaganych przepisami prawa, dla których nie przewidziano innych pól/elementów
Fields
Field Name | Description |
---|---|
NrWiersza - String
|
Numer wiersza podany w polu NrWierszaFa lub NrWierszaZam, jeśli informacja odnosi się wyłącznie do danej pozycji faktury. Liczby naturalne większe od zera. Minimum exclusive value: 0. |
Klucz - String
|
Klucz. Typ znakowy ograniczony do 256 znaków. Minimum length: 1. Maximum length: 256. |
Wartosc - String
|
Wartość. Typ znakowy ograniczony do 256 znaków. Minimum length: 1. Maximum length: 256. |
Example
{
"NrWiersza": "xyz789",
"Klucz": "abc123",
"Wartosc": "xyz789"
}
DodatkowyOpisPolaV2Input
Description
Pola przeznaczone dla wykazywania dodatkowych danych na fakturze, w tym wymaganych przepisami prawa, dla których nie przewidziano innych pól/elementów
Fields
Input Field | Description |
---|---|
NrWiersza - String
|
Numer wiersza podany w polu NrWierszaFa lub NrWierszaZam, jeśli informacja odnosi się wyłącznie do danej pozycji faktury. Liczby naturalne większe od zera. Minimum exclusive value: 0. |
Klucz - String
|
Klucz. Typ znakowy ograniczony do 256 znaków. Minimum length: 1. Maximum length: 256. |
Wartosc - String
|
Wartość. Typ znakowy ograniczony do 256 znaków. Minimum length: 1. Maximum length: 256. |
Example
{
"NrWiersza": "xyz789",
"Klucz": "abc123",
"Wartosc": "xyz789"
}
DostawaNowychSrodkowTransportuV2
Description
Środki trwałe - transport
Fields
Field Name | Description |
---|---|
DostawaNowegoSrodkaTransportu - Boolean!
|
Znacznik wewnątrzwspólnotowej dostawy nowych środków transportu |
WywozNowegSrodkaTransportu - Boolean!
|
Dotyczy dokumentu wywozu Nowego Środka Transportu z terytorium kraju. Jeśli występuje obowiązek, o którym mowa w art. 42 ust. 5 ustawy, należy podać wartość "1", w przeciwnym przypadku - wartość "2" |
NoweSrodkiTransportu - [TNowySrodekTransportuV2!]
|
Lista Nowych środków transportu |
Example
{
"DostawaNowegoSrodkaTransportu": true,
"WywozNowegSrodkaTransportu": true,
"NoweSrodkiTransportu": [TNowySrodekTransportuV2]
}
DostawaNowychSrodkowTransportuV2Input
Description
Środki trwałe - transport
Fields
Input Field | Description |
---|---|
DostawaNowegoSrodkaTransportu - Boolean!
|
Znacznik wewnątrzwspólnotowej dostawy nowych środków transportu |
WywozNowegSrodkaTransportu - Boolean!
|
Dotyczy dokumentu wywozu Nowego Środka Transportu z terytorium kraju. Jeśli występuje obowiązek, o którym mowa w art. 42 ust. 5 ustawy, należy podać wartość "1", w przeciwnym przypadku - wartość "2" |
NoweSrodkiTransportu - [TNowySrodekTransportuV2Input!]
|
Lista Nowych środków transportu |
Example
{
"DostawaNowegoSrodkaTransportu": false,
"WywozNowegSrodkaTransportu": false,
"NoweSrodkiTransportu": [TNowySrodekTransportuV2Input]
}
DownloadInvoiceItemMessage
Description
Informacja o fakturze
Fields
Field Name | Description |
---|---|
kSeFNumber - String
|
Numer faktury w KSeF |
kSeFDate - DateTime!
|
Data nadania numeru KSeF |
errorMessage - String
|
Opis błędu |
invoiceBound - InvoiceBound
|
Typ faktury |
Example
{
"kSeFNumber": "xyz789",
"kSeFDate": "2007-12-03T10:15:30Z",
"errorMessage": "xyz789",
"invoiceBound": "INTERNAL"
}
DownloadStateUserMessage
Description
Stan procesu pobierania faktur
Values
Enum Value | Description |
---|---|
|
Oczekuje na możliwość wysłania zapytania do KSeF |
|
W trakcie pobierania faktur (xml) |
Example
"PENDING"
EArchiveNotificationType
Description
Typ notyfikacji e-mail
Values
Enum Value | Description |
---|---|
|
Wyłączone |
|
Autoryzacja użytkownika w KSeF zakończone sukcesem |
|
Autoryzacja użytkownika w KSeF zakończone błędem |
|
Pomyślne pobranie UPO |
|
Pomyślne pobranie faktury z KSeF |
|
Edytowano uprawnienia w KSeF |
|
Wysłano faktury do KSeF |
|
Nieudane automatyczne pobranie faktur z KSeF |
|
Automatyczne rozłączenie Użytkownika z KSeF |
Example
"NONE"
EnvironmentStatus
Description
Status środowiska
Values
Enum Value | Description |
---|---|
|
Oczekujący na zatwierdzenie |
|
Nieaktywny |
|
Aktywny |
|
Usunięty |
|
Do usunięcia Do usunięcia |
Example
"PENDING_APPROVAL"
EnvironmentType
Description
Typ środowiska
Values
Enum Value | Description |
---|---|
|
Niewymagane środowisko |
|
Admin / BOK |
|
Organizacja |
|
Firma |
Example
COMPANY
EnvironmentViewModel
Description
Właściwości środowiska
Fields
Field Name | Description |
---|---|
EnvironmentId - UUID!
|
Id środowiska |
Name - String
|
Nazwa środowiska |
Type - EnvironmentType!
|
Typ środowiska |
Status - EnvironmentStatus!
|
Status |
Tenant - TenantResponse
|
Organizacja |
IsDemo - Boolean!
|
Określa, czy instancja środowiska jest wersją Demo |
Company - Company
|
Firma |
Example
{
"EnvironmentId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"Name": "abc123",
"Type": "COMPANY",
"Status": "PENDING_APPROVAL",
"Tenant": TenantResponse,
"IsDemo": false,
"Company": Company
}
EnvironmentWithUser
Description
Środowisko wraz z danymi użytkownika
Fields
Field Name | Description |
---|---|
User - UserInfo
|
Informacje dot. użytkownika |
Id - UUID!
|
Id środowiska |
IsActive - Boolean!
|
Czy środowisko jest aktywne |
Type - EnvironmentType!
|
Typ środowiska |
Company - CompanyInfo
|
Informacje dot. firmy |
Tenant - TenantInfo
|
Informacje dot. organizacji |
Example
{
"User": UserInfo,
"Id": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"IsActive": true,
"Type": "COMPANY",
"Company": CompanyInfo,
"Tenant": TenantInfo
}
ExtendedFiltersFieldsInput
Fields
Input Field | Description |
---|---|
CreatedAfterInvoiceId - UUID
|
Filtrowanie od daty utworzenia id faktury |
CreatedAfter - DateTime
|
Filtrowanie od daty utworzenia faktury |
ModifiedAfter - DateTime
|
Filtrowanie od daty modyfikacji faktury |
Foreign - Boolean
|
Tylko faktury zakupowe |
Downloaded - Boolean
|
Tylko faktury, które mają status "Pobrane z KSeF" |
ToDownload - Boolean
|
Tylko faktury, które mają status "Do pobrania z KSeF" |
Own - Boolean
|
Tylko faktury sprzedażowe |
Sent - Boolean
|
Tylko faktury, które mają status "Wysłane do KSeF" |
ToSend - Boolean
|
Tylko faktury, które mają status "Do wysłania do KSeF" |
ReadyForPosting - Boolean
|
Tylko faktury w statusie "Do dekretacji" |
ToAccept - Boolean
|
Tylko faktury z dekretami w statusie "Do akceptacji" |
Numbers - [String!]
|
Filtrowanie po numerach faktur |
DownloadedBy - [SymfoniaSystem!]
|
Filtrowanie po systemach, które pobrały fakturę |
DocumentTypes - [RodzajFaktury!]
|
Filtrowanie po rodzajach faktur |
IssuerNames - [String!]
|
Filtrowanie po nazwach sprzedawców |
IssuerNips - [String!]
|
Filtrowanie po numerach NIP sprzedawców |
RecipientNames - [String!]
|
Filtrowanie po nazwach odbiorców |
RecipientNips - [String!]
|
Filtrowanie po numerach NIP odbiorców |
GrossValue - NumberRangeSchemaModelOfDecimalInput
|
Zakres kwoty brutto faktur |
NetValue - NumberRangeSchemaModelOfDecimalInput
|
Zakres kwoty netto faktur |
VatValue - NumberRangeSchemaModelOfDecimalInput
|
Zakres kwoty podatku vat faktur |
DateOfIssue - DateRangeSchemaModelInput
|
Zakres dat wystawienia faktur |
KsefDate - DateRangeSchemaModelInput
|
Zakres dat faktur wysłanych do KSeF |
KsefNumbers - [String!]
|
Filtrowanie po liście numerów nadanych fakturom w KSeF |
KSeFStatuses - [KSeFStatus!]
|
Filtrowanie po statusach faktur w KSeF |
InvoicePostingStatuses - [InvoicePostingStatus!]
|
Filtrowanie po statusach dekretacji |
RegistrationNumbers - [String!]
|
Filtrowanie po numerach ewidencyjnych |
InvoiceIds - [UUID!]
|
Filtrowanie po liście id faktur w Symfonia KSeF |
Example
{
"CreatedAfterInvoiceId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"CreatedAfter": "2007-12-03T10:15:30Z",
"ModifiedAfter": "2007-12-03T10:15:30Z",
"Foreign": false,
"Downloaded": false,
"ToDownload": false,
"Own": false,
"Sent": true,
"ToSend": false,
"ReadyForPosting": false,
"ToAccept": true,
"Numbers": ["xyz789"],
"DownloadedBy": ["UNDEFINED"],
"DocumentTypes": ["VAT"],
"IssuerNames": ["xyz789"],
"IssuerNips": ["xyz789"],
"RecipientNames": ["xyz789"],
"RecipientNips": ["xyz789"],
"GrossValue": NumberRangeSchemaModelOfDecimalInput,
"NetValue": NumberRangeSchemaModelOfDecimalInput,
"VatValue": NumberRangeSchemaModelOfDecimalInput,
"DateOfIssue": DateRangeSchemaModelInput,
"KsefDate": DateRangeSchemaModelInput,
"KsefNumbers": ["abc123"],
"KSeFStatuses": ["NOT_SENT"],
"InvoicePostingStatuses": ["DECREE_SENT"],
"RegistrationNumbers": ["abc123"],
"InvoiceIds": [
"ce164f8f-a876-437c-a391-7fbb0e829ec4"
]
}
Faktura
Description
Obiekt faktury w wersji domenowej Symfonii dla schematu V11089
Fields
Field Name | Description |
---|---|
WersjaDTO - String
|
Wykorzystana wersja DTO Nazewnictwo zgodnie ze standardem : V1, V2, V3, itd. |
Sprzedawca - Podmiot!
|
Sprzedawca |
Nabywca - Podmiot!
|
Nabywca |
TrzeciPodmiot - [TrzeciPodmiot!]
|
Lista podmiotów trzecich (nieobowiązkowe) |
PodmiotUpowazniony - PodmiotUpowazniony
|
Podmiot upoważniony (nieobowiązkowe) |
Naglowek - Naglowek!
|
Nagłówek |
Adnotacje - Adnotacje!
|
Inne adnotacje na fakturze |
Korekta - Korekta
|
Korekta, obowiązkowa, gdy typ faktury to: KOR, KOR_ZAL lub KOR_ROZ |
PodsumowanieVat - [PodsumowanieVat!]!
|
Podsumowanie VAT |
Wiersze - [Wiersz!]!
|
Lista wierszy faktury |
Rozliczenie - Rozliczenie
|
Dodatkowe rozliczenia na fakturze (nieobowiązkowe) |
Platnosc - Platnosc
|
Płatność (nieobowiązkowe) |
WarunkiTransakcji - WarunkiTransakcji
|
Warunki transakcji (nieobowiązkowe) |
Zamowienie - Zamowienie
|
Zamówienie lub umowa, o których mowa w art. 106f ust. 1 pkt 4 ustawy (dla faktur zaliczkowych) w walucie, w której wystawiono fakturę zaliczkową. W przypadku faktury korygującej fakturę zaliczkową należy prezentować różnice wynikające z korekty poszczególnych pozycji zamówienia lub umowy lub storna poszczególnych korygowanych pozycji zamówienia lub umowy i prawidłowe wartości korygowanych pozycji jako osobne wiersze, jeśli korekta dotyczy wartości zamówienia. W przypadku faktur korygujących faktury zaliczkowe, jeśli korekta nie dotyczy wartości zamówienia i jednocześnie zmienia wysokość podstawy opodatkowania lub podatku, należy wprowadzić zapis stornujący dany wiersz wg stanu przed korektą i zapis przywracający wartość zamówienia w celu potwierdzenia braku zmiany jego wartości |
Stopka - Stopka
|
Numery podmiotu lub grupy podmiotów w innych rejestrach i bazach danych (nieobowiązkowe) |
Example
{
"WersjaDTO": "xyz789",
"Sprzedawca": Podmiot,
"Nabywca": Podmiot,
"TrzeciPodmiot": [TrzeciPodmiot],
"PodmiotUpowazniony": PodmiotUpowazniony,
"Naglowek": Naglowek,
"Adnotacje": Adnotacje,
"Korekta": Korekta,
"PodsumowanieVat": [PodsumowanieVat],
"Wiersze": [Wiersz],
"Rozliczenie": Rozliczenie,
"Platnosc": Platnosc,
"WarunkiTransakcji": WarunkiTransakcji,
"Zamowienie": Zamowienie,
"Stopka": Stopka
}
FakturaInput
Description
Obiekt faktury w wersji domenowej Symfonii dla schematu V11089
Fields
Input Field | Description |
---|---|
WersjaDTO - String
|
Wykorzystana wersja DTO Nazewnictwo zgodnie ze standardem : V1, V2, V3, itd. |
Sprzedawca - PodmiotInput!
|
Sprzedawca |
Nabywca - PodmiotInput!
|
Nabywca |
TrzeciPodmiot - [TrzeciPodmiotInput!]
|
Lista podmiotów trzecich (nieobowiązkowe) |
PodmiotUpowazniony - PodmiotUpowaznionyInput
|
Podmiot upoważniony (nieobowiązkowe) |
Naglowek - NaglowekInput!
|
Nagłówek |
Adnotacje - AdnotacjeInput!
|
Inne adnotacje na fakturze |
Korekta - KorektaInput
|
Korekta, obowiązkowa, gdy typ faktury to: KOR, KOR_ZAL lub KOR_ROZ |
PodsumowanieVat - [PodsumowanieVatInput!]!
|
Podsumowanie VAT |
Wiersze - [WierszInput!]!
|
Lista wierszy faktury |
Rozliczenie - RozliczenieInput
|
Dodatkowe rozliczenia na fakturze (nieobowiązkowe) |
Platnosc - PlatnoscInput
|
Płatność (nieobowiązkowe) |
WarunkiTransakcji - WarunkiTransakcjiInput
|
Warunki transakcji (nieobowiązkowe) |
Zamowienie - ZamowienieInput
|
Zamówienie lub umowa, o których mowa w art. 106f ust. 1 pkt 4 ustawy (dla faktur zaliczkowych) w walucie, w której wystawiono fakturę zaliczkową. W przypadku faktury korygującej fakturę zaliczkową należy prezentować różnice wynikające z korekty poszczególnych pozycji zamówienia lub umowy lub storna poszczególnych korygowanych pozycji zamówienia lub umowy i prawidłowe wartości korygowanych pozycji jako osobne wiersze, jeśli korekta dotyczy wartości zamówienia. W przypadku faktur korygujących faktury zaliczkowe, jeśli korekta nie dotyczy wartości zamówienia i jednocześnie zmienia wysokość podstawy opodatkowania lub podatku, należy wprowadzić zapis stornujący dany wiersz wg stanu przed korektą i zapis przywracający wartość zamówienia w celu potwierdzenia braku zmiany jego wartości |
Stopka - StopkaInput
|
Numery podmiotu lub grupy podmiotów w innych rejestrach i bazach danych (nieobowiązkowe) |
Example
{
"WersjaDTO": "xyz789",
"Sprzedawca": PodmiotInput,
"Nabywca": PodmiotInput,
"TrzeciPodmiot": [TrzeciPodmiotInput],
"PodmiotUpowazniony": PodmiotUpowaznionyInput,
"Naglowek": NaglowekInput,
"Adnotacje": AdnotacjeInput,
"Korekta": KorektaInput,
"PodsumowanieVat": [PodsumowanieVatInput],
"Wiersze": [WierszInput],
"Rozliczenie": RozliczenieInput,
"Platnosc": PlatnoscInput,
"WarunkiTransakcji": WarunkiTransakcjiInput,
"Zamowienie": ZamowienieInput,
"Stopka": StopkaInput
}
FakturaV2
Description
Obiekt faktury w wersji domenowej Symfonii dla schematu V12648
Fields
Field Name | Description |
---|---|
WersjaDTO - String
|
Wykorzystana wersja DTO Nazewnictwo zgodnie ze standardem : V1, V2, V3, itd. |
Sprzedawca - PodmiotV2!
|
Sprzedawca |
Nabywca - PodmiotV2!
|
Nabywca |
TrzeciPodmiot - [TrzeciPodmiotV2!]
|
Lista podmiotów trzecich (nieobowiązkowe) |
PodmiotUpowazniony - PodmiotUpowaznionyV2
|
Podmiot upoważniony (nieobowiązkowe) |
Naglowek - NaglowekV2!
|
Nagłówek |
Adnotacje - AdnotacjeV2!
|
Inne adnotacje na fakturze |
Korekta - KorektaV2
|
Korekta, obowiązkowa gdy typ faktury to: KOR, KOR_ZAL lub KOR_ROZ |
PodsumowanieVat - [PodsumowanieVat!]!
|
Podsumowanie VAT |
Wiersze - [WierszV2!]!
|
Lista wierszy faktury |
Rozliczenie - Rozliczenie
|
Dodatkowe rozliczenia na fakturze (nieobowiązkowe) |
Platnosc - PlatnoscV2
|
Płatność (nieobowiązkowe) |
WarunkiTransakcji - WarunkiTransakcjiV2
|
Warunki transakcji (nieobowiązkowe) |
Zamowienie - ZamowienieV2
|
Zamówienie lub umowa, o których mowa w art. 106f ust. 1 pkt 4 ustawy (dla faktur zaliczkowych) w walucie, w której wystawiono fakturę zaliczkową. W przypadku faktury korygującej fakturę zaliczkową należy prezentować różnice wynikające z korekty poszczególnych pozycji zamówienia lub umowy lub storna poszczególnych korygowanych pozycji zamówienia lub umowy i prawidłowe wartości korygowanych pozycji jako osobne wiersze jeśli korekta dotyczy wartości zamówienia. W przypadku faktur korygujących faktury zaliczkowe, jeśli korekta nie dotyczy wartości zamówienia i jednocześnie zmienia wysokość podstawy opodatkowania lub podatku, należy wprowadzić zapis stornujący dany wiersz wg stanu przed korektą i zapis przywracający wartość zamówienia w celu potwierdzenia braku zmiany jego wartości |
Stopka - StopkaV2
|
Numery podmiotu lub grupy podmiotów w innych rejestrach i bazach danych (nieobowiązkowe) |
Example
{
"WersjaDTO": "abc123",
"Sprzedawca": PodmiotV2,
"Nabywca": PodmiotV2,
"TrzeciPodmiot": [TrzeciPodmiotV2],
"PodmiotUpowazniony": PodmiotUpowaznionyV2,
"Naglowek": NaglowekV2,
"Adnotacje": AdnotacjeV2,
"Korekta": KorektaV2,
"PodsumowanieVat": [PodsumowanieVat],
"Wiersze": [WierszV2],
"Rozliczenie": Rozliczenie,
"Platnosc": PlatnoscV2,
"WarunkiTransakcji": WarunkiTransakcjiV2,
"Zamowienie": ZamowienieV2,
"Stopka": StopkaV2
}
FakturaV2Input
Description
Obiekt faktury w wersji domenowej Symfonii dla schematu V12648
Fields
Input Field | Description |
---|---|
WersjaDTO - String
|
Wykorzystana wersja DTO Nazewnictwo zgodnie ze standardem : V1, V2, V3, itd. |
Sprzedawca - PodmiotV2Input!
|
Sprzedawca |
Nabywca - PodmiotV2Input!
|
Nabywca |
TrzeciPodmiot - [TrzeciPodmiotV2Input!]
|
Lista podmiotów trzecich (nieobowiązkowe) |
PodmiotUpowazniony - PodmiotUpowaznionyV2Input
|
Podmiot upoważniony (nieobowiązkowe) |
Naglowek - NaglowekV2Input!
|
Nagłówek |
Adnotacje - AdnotacjeV2Input!
|
Inne adnotacje na fakturze |
Korekta - KorektaV2Input
|
Korekta, obowiązkowa gdy typ faktury to: KOR, KOR_ZAL lub KOR_ROZ |
PodsumowanieVat - [PodsumowanieVatInput!]!
|
Podsumowanie VAT |
Wiersze - [WierszV2Input!]!
|
Lista wierszy faktury |
Rozliczenie - RozliczenieInput
|
Dodatkowe rozliczenia na fakturze (nieobowiązkowe) |
Platnosc - PlatnoscV2Input
|
Płatność (nieobowiązkowe) |
WarunkiTransakcji - WarunkiTransakcjiV2Input
|
Warunki transakcji (nieobowiązkowe) |
Zamowienie - ZamowienieV2Input
|
Zamówienie lub umowa, o których mowa w art. 106f ust. 1 pkt 4 ustawy (dla faktur zaliczkowych) w walucie, w której wystawiono fakturę zaliczkową. W przypadku faktury korygującej fakturę zaliczkową należy prezentować różnice wynikające z korekty poszczególnych pozycji zamówienia lub umowy lub storna poszczególnych korygowanych pozycji zamówienia lub umowy i prawidłowe wartości korygowanych pozycji jako osobne wiersze jeśli korekta dotyczy wartości zamówienia. W przypadku faktur korygujących faktury zaliczkowe, jeśli korekta nie dotyczy wartości zamówienia i jednocześnie zmienia wysokość podstawy opodatkowania lub podatku, należy wprowadzić zapis stornujący dany wiersz wg stanu przed korektą i zapis przywracający wartość zamówienia w celu potwierdzenia braku zmiany jego wartości |
Stopka - StopkaV2Input
|
Numery podmiotu lub grupy podmiotów w innych rejestrach i bazach danych (nieobowiązkowe) |
Example
{
"WersjaDTO": "xyz789",
"Sprzedawca": PodmiotV2Input,
"Nabywca": PodmiotV2Input,
"TrzeciPodmiot": [TrzeciPodmiotV2Input],
"PodmiotUpowazniony": PodmiotUpowaznionyV2Input,
"Naglowek": NaglowekV2Input,
"Adnotacje": AdnotacjeV2Input,
"Korekta": KorektaV2Input,
"PodsumowanieVat": [PodsumowanieVatInput],
"Wiersze": [WierszV2Input],
"Rozliczenie": RozliczenieInput,
"Platnosc": PlatnoscV2Input,
"WarunkiTransakcji": WarunkiTransakcjiV2Input,
"Zamowienie": ZamowienieV2Input,
"Stopka": StopkaV2Input
}
FakturaZaliczkowaV2
Description
Element Faktura zaliczkowa
Fields
Field Name | Description |
---|---|
NrKSeFZN - Boolean
|
Znacznik faktury zaliczkowej wystawionej poza KSeF |
NrFaZaliczkowej - String
|
Numer faktury zaliczkowej wystawionej poza KSeF. Pole obowiązkowe dla faktury wystawianej po wydaniu towaru lub wykonaniu usługi, o której mowa w art. 106f ust. 3 ustawy i ostatniej z faktur, o której mowa w art. 106f ust. 4 ustawy. Typ znakowy ograniczony do 256 znaków. Minimum length: 1. Maximum length: 256. |
NrKSeFFaZaliczkowej - String
|
Numer identyfikujący fakturę zaliczkową w KSeF. Pole obowiązkowe w przypadku, gdy faktura zaliczkowa była wystawiona za pomocą KSeF. Numer identyfikujący fakturę w Krajowym Systemie e-Faktur (KSeF). Pattern: (1-9\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}). |
Example
{
"NrKSeFZN": true,
"NrFaZaliczkowej": "abc123",
"NrKSeFFaZaliczkowej": "abc123"
}
FakturaZaliczkowaV2Input
Description
Element Faktura zaliczkowa
Fields
Input Field | Description |
---|---|
NrKSeFZN - Boolean
|
Znacznik faktury zaliczkowej wystawionej poza KSeF |
NrFaZaliczkowej - String
|
Numer faktury zaliczkowej wystawionej poza KSeF. Pole obowiązkowe dla faktury wystawianej po wydaniu towaru lub wykonaniu usługi, o której mowa w art. 106f ust. 3 ustawy i ostatniej z faktur, o której mowa w art. 106f ust. 4 ustawy. Typ znakowy ograniczony do 256 znaków. Minimum length: 1. Maximum length: 256. |
NrKSeFFaZaliczkowej - String
|
Numer identyfikujący fakturę zaliczkową w KSeF. Pole obowiązkowe w przypadku, gdy faktura zaliczkowa była wystawiona za pomocą KSeF. Numer identyfikujący fakturę w Krajowym Systemie e-Faktur (KSeF). Pattern: (1-9\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}). |
Example
{
"NrKSeFZN": false,
"NrFaZaliczkowej": "xyz789",
"NrKSeFFaZaliczkowej": "abc123"
}
FilterFieldsInput
Description
Filtr faktur
Fields
Input Field | Description |
---|---|
CompanyId - UUID
|
Id firmy |
Number - String
|
Numer faktury |
DocumentType - RodzajFaktury
|
Rodzaj faktury |
DateOfIssue - DateRangeSchemaModelInput
|
Data wystawienia faktury |
DestinationSystem - String
|
System docelowy |
FileName - String
|
Nazwa pliku XML faktury |
InvoiceBound - InvoiceBound
|
Rodzaj faktury powiązanej |
IssuerName - String
|
Nazwa sprzedawcy |
IssuerNip - String
|
Numer NIP sprzedawcy |
RecipientName - String
|
Nazwa nabywcy |
RecipientNip - String
|
Numer NIP nabywcy |
GrossValue - Decimal
|
Wartość faktury brutto |
KsefDate - DateRangeSchemaModelInput
|
Data wysłania do KSeF |
KsefNumber - String
|
Numer nadany fakturze przez KSeF |
KSeFSessionReferenceNumber - String
|
Numer referencyjny sesji w KSeF podczas wysyłania faktury |
KSeFElementReferenceNumber - String
|
Numer referencyjny elementu w KSeF podczas wysyłania faktury |
Downloaded - SymfoniaSystem
|
Kod systemu Symfonii, który pobrał fakturę z Symfonia KSeF |
KSeFStatus - KSeFStatus
|
Status dokumentu w systemie KSeF |
KSeFStatusErrorDescription - String
|
Opis błędu nadany przez system KSeF, o ile wystąpił |
Owner - String
|
Adres email użytkownika, który zlecił wysyłkę faktury do KSeF |
Example
{
"CompanyId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"Number": "xyz789",
"DocumentType": "VAT",
"DateOfIssue": DateRangeSchemaModelInput,
"DestinationSystem": "abc123",
"FileName": "xyz789",
"InvoiceBound": "INTERNAL",
"IssuerName": "abc123",
"IssuerNip": "abc123",
"RecipientName": "abc123",
"RecipientNip": "abc123",
"GrossValue": Decimal,
"KsefDate": DateRangeSchemaModelInput,
"KsefNumber": "abc123",
"KSeFSessionReferenceNumber": "abc123",
"KSeFElementReferenceNumber": "abc123",
"Downloaded": "UNDEFINED",
"KSeFStatus": "NOT_SENT",
"KSeFStatusErrorDescription": "abc123",
"Owner": "xyz789"
}
FiltersFieldsInput
Fields
Input Field | Description |
---|---|
Foreign - Boolean!
|
Tylko faktury zakupowe |
Downloaded - Boolean!
|
Tylko faktury, które mają status "Pobrane z KSeF" |
ToDownload - Boolean!
|
Tylko faktury, które mają status "Do pobrania z KSeF" |
Own - Boolean!
|
Tylko faktury sprzedażowe |
Sent - Boolean!
|
Tylko faktury, które mają status "Wysłane do KSeF" |
ToSend - Boolean!
|
Tylko faktury, które mają status "Do wysłania do KSeF" |
Numbers - [String!]
|
Filtrowanie po numerach faktur |
DownloadedBy - [SymfoniaSystem!]
|
Filtrowanie po systemach, które pobrały fakturę |
DocumentTypes - [RodzajFaktury!]
|
Filtrowanie po rodzajach faktur |
IssuerNames - [String!]
|
Filtrowanie po nazwach sprzedawców |
IssuerNips - [String!]
|
Filtrowanie po numerach NIP sprzedawców |
RecipientNames - [String!]
|
Filtrowanie po nazwach odbiorców |
RecipientNips - [String!]
|
Filtrowanie po numerach NIP odbiorców |
GrossValue - NumberRangeSchemaModelOfDecimalInput
|
Zakres kwoty brutto faktur |
NetValue - NumberRangeSchemaModelOfDecimalInput
|
Zakres kwoty netto faktur |
VatValue - NumberRangeSchemaModelOfDecimalInput
|
Zakres kwoty podatku vat faktur |
DateOfIssue - DateRangeSchemaModelInput
|
Zakres dat wystawienia faktur |
KsefDate - DateRangeSchemaModelInput
|
Zakres dat faktur wysłanych do KSeF |
KsefNumbers - [String!]
|
Filtrowanie po liście numerów nadanych fakturom w KSeF |
KSeFStatuses - [KSeFStatus!]
|
Filtrowanie po statusach faktur w KSeF |
ReadyForPosting - Boolean!
|
Tylko faktury w statusie "Do dekretacji" |
ToAccept - Boolean!
|
Tylko faktury z dekretami w statusie "Do akceptacji" |
InvoicePostingStatuses - [InvoicePostingStatus!]
|
Filtrowanie po statusach dekretacji |
RegistrationNumbers - [String!]
|
Filtrowanie po numerach ewidencyjnych |
InvoiceIds - [UUID!]
|
Filtrowanie po liście id faktur w Symfonia KSeF |
Example
{
"Foreign": true,
"Downloaded": false,
"ToDownload": false,
"Own": true,
"Sent": true,
"ToSend": false,
"Numbers": ["xyz789"],
"DownloadedBy": ["UNDEFINED"],
"DocumentTypes": ["VAT"],
"IssuerNames": ["abc123"],
"IssuerNips": ["abc123"],
"RecipientNames": ["xyz789"],
"RecipientNips": ["abc123"],
"GrossValue": NumberRangeSchemaModelOfDecimalInput,
"NetValue": NumberRangeSchemaModelOfDecimalInput,
"VatValue": NumberRangeSchemaModelOfDecimalInput,
"DateOfIssue": DateRangeSchemaModelInput,
"KsefDate": DateRangeSchemaModelInput,
"KsefNumbers": ["xyz789"],
"KSeFStatuses": ["NOT_SENT"],
"ReadyForPosting": true,
"ToAccept": false,
"InvoicePostingStatuses": ["DECREE_SENT"],
"RegistrationNumbers": ["xyz789"],
"InvoiceIds": [
"ce164f8f-a876-437c-a391-7fbb0e829ec4"
]
}
FormaPlatnosci
Description
Formy płatności na fakturze
Values
Enum Value | Description |
---|---|
|
gotówka |
|
karta |
|
bon |
|
czek |
|
kredyt |
|
przelew |
|
mobilna |
Example
"GOTOWKA"
GTU
Description
Kody GTU
Values
Enum Value | Description |
---|---|
|
Dostawa towarów, o których mowa w § 10 ust. 3 pkt 1 lit. a rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Dostawa towarów, o których mowa w § 10 ust. 3 pkt 1 lit. b rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Dostawa towarów, o których mowa w § 10 ust. 3 pkt 1 lit. c rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Dostawa towarów, o których mowa w § 10 ust. 3 pkt 1 lit. d rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Dostawa towarów, o których mowa w § 10 ust. 3 pkt 1 lit. e rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Dostawa towarów, o których mowa w § 10 ust. 3 pkt 1 lit. f rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Dostawa towarów, o których mowa w § 10 ust. 3 pkt 1 lit. g rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Dostawa towarów, o których mowa w § 10 ust. 3 pkt 1 lit. h rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Dostawa towarów, o których mowa w § 10 ust. 3 pkt 1 lit. i rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Dostawa towarów, o których mowa w § 10 ust. 3 pkt 1 lit. j rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Świadczenie usług, o których mowa w § 10 ust. 3 pkt 2 lit. a rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Świadczenie usług, o których mowa w § 10 ust. 3 pkt 2 lit. b rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
|
Świadczenie usług, o których mowa w § 10 ust. 3 pkt 2 lit. c rozporządzenia w sprawie szczegółowego zakresu danych zawartych w deklaracjach podatkowych i w ewidencji w zakresie podatku od towarów i usług |
Example
"GTU_01"
GetCompanyStatisticsResponse
Description
Dane zawierające statystyki faktur we wszystkich firmach w organizacji
Fields
Field Name | Description |
---|---|
TenantAssignments - [TenantAssignmentViewModel]
|
Organizacje |
TotalTenantsCount - Long!
|
Liczba organizacji do których przypisany jest bieżący użytkownik |
TotalCompanysCount - Long!
|
Liczba firm w bieżącej organizacji |
Example
{
"TenantAssignments": [TenantAssignmentViewModel],
"TotalTenantsCount": {},
"TotalCompanysCount": {}
}
GetCurrentSchemaVersionResponse
Description
Wynik operacji pobrania aktualnych wersji schemy faktury KSeF Ministerstwa Finansów
Fields
Field Name | Description |
---|---|
SchemaVersion - [KsefXsdVersion!]
|
Lista aktualnych wersji schemy KSeF |
Example
{"SchemaVersion": ["V12648"]}
GetEArchiveNotificationsResponse
Description
Wynik operacji pobrania listy obsługiwanych typów notyfikacji e-mailowych
Fields
Field Name | Description |
---|---|
Notifications - [EArchiveNotificationType!]
|
Lista typów notyfikacji e-mailowych |
Example
{"Notifications": ["NONE"]}
GetInvoiceFileContentActionGroupType
GetInvoiceFileContentSingleType
Description
Faktura w formacie HTML oraz PDF
Example
{
"PdfName": "xyz789",
"PdfContent": "xyz789",
"HtmlContent": "xyz789",
"MimeType": "xyz789"
}
GetInvoicesExtendedSegment
Fields
Field Name | Description |
---|---|
Items - [InvoiceDto!]
|
Lista znalezionych obiektów faktur |
TotalCount - Long
|
Ilość znalezionych obiektów faktur z podziałem na zakupowe / sprzedażowe oraz wysłane / do wysłania |
FilteredCount - Long
|
Ilość znalezionych obiektów faktów wg. zadanych filtrów z puli TotalCount |
Example
{
"Items": [InvoiceDto],
"TotalCount": {},
"FilteredCount": {}
}
GetInvoicesSegment
Fields
Field Name | Description |
---|---|
Items - [InvoiceDto!]
|
Lista znalezionych obiektów faktur |
TotalCount - Long
|
Ilość znalezionych obiektów faktur z podziałem na zakupowe / sprzedażowe oraz wysłane / do wysłania |
FilteredCount - Long
|
Ilość znalezionych obiektów faktur wg zadanych filtrów z puli TotalCount |
Example
{
"Items": [InvoiceDto],
"TotalCount": {},
"FilteredCount": {}
}
GetMissedWebsocketSubscriptionsResponse
Description
Status operacji
Fields
Field Name | Description |
---|---|
Success - Boolean!
|
true - jeżeli proces uruchomiono pomyślnie |
Example
{"Success": true}
GetPackageStatisticSegment
Description
Dane zawierające statystyki pakietów w organizacji
Fields
Field Name | Description |
---|---|
Items - [Package!]!
|
Lista pakietów w ramach subskrypcji |
Status - SubscriptionStatus
|
Status subskrypcji |
CurrentInvoicesCount - Int
|
Liczba wykonanych operacji na fakturach w organizacji |
CurrentStorageCount - Decimal
|
Ilość zajętego miejsca przez faktury w organizacji |
SerialNumber - String
|
Numer seryjny subskrypcji |
SubscriptionNumber - String
|
Numer subskrypcji |
CustomerNumber - String
|
Numer klienta |
Email - String
|
Adres email administratora zamawiającego subskrypcję |
DateTo - Date!
|
Data obowiązywania subskrypcji |
Example
{
"Items": [Package],
"Status": "INACTIVE",
"CurrentInvoicesCount": 123,
"CurrentStorageCount": Decimal,
"SerialNumber": "xyz789",
"SubscriptionNumber": "abc123",
"CustomerNumber": "abc123",
"Email": "abc123",
"DateTo": "2007-12-03"
}
GetPermissionsKSeFResponseType
Fields
Field Name | Description |
---|---|
FromKsef - Boolean!
|
True - dane pobrane z KSeF, false - dane z cache |
LastUpdated - DateTime
|
Ostatnia aktualizacja danych z cache |
Credentials - [Credential!]!
|
Lista uprawnień |
TotalCount - Long!
|
Suma rekordów |
FilteredCount - Long!
|
Liczba pobranych rekordów |
Example
{
"FromKsef": true,
"LastUpdated": "2007-12-03T10:15:30Z",
"Credentials": [Credential],
"TotalCount": {},
"FilteredCount": {}
}
GetUserKSeFRequestForCredentialsResponseType
Fields
Field Name | Description |
---|---|
RequestedCredentials - [RequestedCredential!]!
|
Lista procesowanych uprawnień |
TotalCount - Long!
|
Suma rekordów |
FilteredCount - Long!
|
Liczba pobranych rekordów |
Example
{
"RequestedCredentials": [RequestedCredential],
"TotalCount": {},
"FilteredCount": {}
}
GetWebsocketNotificationModelExtendedResponse
Description
Model odpowiedzi WebSocket
Fields
Field Name | Description |
---|---|
UserId - UUID!
|
Identyfikator użytkownika |
CompanyId - UUID!
|
Id firmy której notyfikacja dotyczy |
ErrorType - WebsocketErrorType
|
Typ błędu |
ErrorContent - [KeyValuePairOfStringAndString!]
|
Detale błędu |
Message - String
|
Treść wiadomości |
Type - WebsocketNotificationType!
|
Typ notyfikacji |
NotificationId - UUID!
|
Id notyfikacji |
Timestamp - DateTime!
|
Znacznik czasu notyfikacji |
Visited - Boolean!
|
Znacznik odczytania notyfikacji |
HasDownloadableContent - Boolean!
|
Czy notyfikacja zawiera treść do pobrania |
ResponseJson - String
|
Obiekt odpowiedzi w formacie JSON |
ResponseModel - ResponseModel
|
Obiekt odpowiedzi |
State - SubscriptionStateEnum!
|
Status notyfikacji |
SimultaneousRunType - WebsocketSimultaneousRunType!
|
Typ uruchomienia zadania |
Example
{
"UserId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"CompanyId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"ErrorType": "SYSTEM",
"ErrorContent": [KeyValuePairOfStringAndString],
"Message": "abc123",
"Type": "AUTHORIZE_IN_KSEF",
"NotificationId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"Timestamp": "2007-12-03T10:15:30Z",
"Visited": false,
"HasDownloadableContent": true,
"ResponseJson": "xyz789",
"ResponseModel": ResponseModel,
"State": "ENQUEUED",
"SimultaneousRunType": "SEQUENTIAL"
}
GetWebsocketNotificationModelResponse
Description
Model odpowiedzi WebSocket
Fields
Field Name | Description |
---|---|
UserId - UUID!
|
Identyfikator użytkownika |
CompanyId - UUID!
|
Id firmy której notyfikacja dotyczy |
ErrorType - WebsocketErrorType
|
Typ błędu |
ErrorContent - [KeyValuePairOfStringAndString!]
|
Detale błędu |
Message - String
|
Treść wiadomości |
Type - WebsocketNotificationType!
|
Typ notyfikacji |
NotificationId - UUID!
|
Id notyfikacji |
Timestamp - DateTime!
|
Znacznik czasu notyfikacji |
Visited - Boolean!
|
Znacznik odczytania notyfikacji |
HasDownloadableContent - Boolean!
|
Czy notyfikacja zawiera treść do pobrania |
ResponseJson - String
|
Obiekt odpowiedzi w formacie JSON |
State - SubscriptionStateEnum!
|
Status notyfikacji |
SimultaneousRunType - WebsocketSimultaneousRunType!
|
Typ uruchomienia zadania |
Example
{
"UserId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"CompanyId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"ErrorType": "SYSTEM",
"ErrorContent": [KeyValuePairOfStringAndString],
"Message": "xyz789",
"Type": "AUTHORIZE_IN_KSEF",
"NotificationId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"Timestamp": "2007-12-03T10:15:30Z",
"Visited": false,
"HasDownloadableContent": true,
"ResponseJson": "abc123",
"State": "ENQUEUED",
"SimultaneousRunType": "SEQUENTIAL"
}
GetWebsocketNotificationResponse
Description
Status operacji
Fields
Field Name | Description |
---|---|
WebsocketNotification - [WebsocketNotificationModel]
|
Lista powiadomień zadanego typu |
Example
{"WebsocketNotification": [WebsocketNotificationModel]}
IdentifierType
Description
Numer identyfikacji ewidencyjnej/podatkowej
Values
Enum Value | Description |
---|---|
|
Numer NIP |
|
Numer PESEL |
Example
"NIP"
IdentifierTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - IdentifierType
|
|
neq - IdentifierType
|
|
in - [IdentifierType!]
|
|
nin - [IdentifierType!]
|
Example
{"eq": "NIP", "neq": "NIP", "in": ["NIP"], "nin": ["NIP"]}
Int
Description
The Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
IntOperationFilterInput
Example
{
"eq": 987,
"neq": 123,
"in": [987],
"nin": [987],
"gt": 987,
"ngt": 123,
"gte": 123,
"ngte": 987,
"lt": 123,
"nlt": 123,
"lte": 987,
"nlte": 987
}
Invoice
Description
Rekord faktury
Fields
Field Name | Description |
---|---|
CompanyId - UUID!
|
Id firmy |
Number - String
|
Numer faktury |
DocumentType - RodzajFaktury!
|
Rodzaj faktury |
DateOfIssue - DateTime!
|
Data wystawienia |
ShortDateOfIssue - Date!
|
Skrócona data wystawienia |
DestinationSystem - String
|
System docelowy |
FileName - String
|
Nazwa pliku XML zawierająca fakturę w schemacie obsługiwanym przez KSeF |
FileSize - Long!
|
Rozmiar pliku XML w bajtach |
InvoiceBound - InvoiceBound!
|
Rodzaj faktury powiązanej |
IssuerName - String
|
Nazwa sprzedawcy |
IssuerNip - String
|
Numer NIP sprzedawcy |
RecipientName - String
|
Nazwa nabywcy |
RecipientNip - String
|
Numer NIP nabywcy |
NetValue - Decimal
|
Wartość faktury netto |
VatValue - Decimal
|
Wartość VAT faktury |
GrossValue - Decimal!
|
Wartość faktury brutto |
KsefDate - DateTime
|
Data wysłania do KSeF |
ShortKsefDate - Date
|
Skrócona data wysłania do KSeF |
KsefNumber - String
|
Numer nadany fakturze przez KSeF |
KSeFSessionReferenceNumber - String
|
Numer referencyjny sesji w KSeF podczas wysyłania faktury |
KSeFElementReferenceNumber - String
|
Numer referencyjny elementu w KSeF podczas wysyłania faktury |
Downloaded - SymfoniaSystem
|
Kod systemu Symfonii, który pobrał fakturę z Symfonia KSeF |
KSeFStatus - KSeFStatus!
|
Status dokumentu w systemie KSeF |
KSeFStatusErrorDescription - String
|
Opis błędu nadany przez system KSeF, o ile wystąpił |
Owner - String
|
Adres e-mail użytkownika, który zlecił wysyłkę faktury do KSeF |
KSeFAuthUser - String
|
W przypadku, kiedy Owner w momencie wysyłania faktury nie jest autoryzowany w KSeF, zostanie podjęta próba wysłania faktury za pomocą autoryzacji innego użytkownika, który posiada odpowiednie uprawnienia w KSeF do obsługi danej firmy, o ile taki użytkownik istnieje |
InvoicePostingStatus - InvoicePostingStatus!
|
Status dekretacji faktury. |
RegistrationNumber - String
|
Numer ewidencyjny faktury. Otrzymywany po wysłaniu faktury do Systemu Symfonia FK |
SchemaVersion - KsefXsdVersion!
|
Wersja schematu faktury KSeF |
PageCount - Int!
|
Liczba stron faktury OCR, w pozostałych przypadkach: 1 |
IsDecreeAccepted - Boolean!
|
Czy dekret faktury jest zaakceptowany |
AttachmentsCount - Int!
|
Liczba załączników podpiętych pod fakturę |
AttachmentsSize - Long!
|
Rozmiar załączników w bajtach |
Id - UUID!
|
Unikalny Id rekordu |
CreatedAt - DateTime
|
Data utworzenia rekordu |
CreatedBy - String
|
E-mail użytkownika, który utworzył rekord |
ModifiedAt - DateTime
|
Data modyfikacji rekordu |
ModifiedBy - String
|
E-mail użytkownika, który zmodyfikował rekord |
Example
{
"CompanyId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"Number": "abc123",
"DocumentType": "VAT",
"DateOfIssue": "2007-12-03T10:15:30Z",
"ShortDateOfIssue": "2007-12-03",
"DestinationSystem": "abc123",
"FileName": "xyz789",
"FileSize": {},
"InvoiceBound": "INTERNAL",
"IssuerName": "abc123",
"IssuerNip": "xyz789",
"RecipientName": "xyz789",
"RecipientNip": "abc123",
"NetValue": Decimal,
"VatValue": Decimal,
"GrossValue": Decimal,
"KsefDate": "2007-12-03T10:15:30Z",
"ShortKsefDate": "2007-12-03",
"KsefNumber": "xyz789",
"KSeFSessionReferenceNumber": "xyz789",
"KSeFElementReferenceNumber": "abc123",
"Downloaded": "UNDEFINED",
"KSeFStatus": "NOT_SENT",
"KSeFStatusErrorDescription": "xyz789",
"Owner": "abc123",
"KSeFAuthUser": "xyz789",
"InvoicePostingStatus": "DECREE_SENT",
"RegistrationNumber": "xyz789",
"SchemaVersion": "V12648",
"PageCount": 123,
"IsDecreeAccepted": false,
"AttachmentsCount": 987,
"AttachmentsSize": {},
"Id": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"CreatedAt": "2007-12-03T10:15:30Z",
"CreatedBy": "abc123",
"ModifiedAt": "2007-12-03T10:15:30Z",
"ModifiedBy": "abc123"
}
InvoiceBound
Description
Rodzaj faktury powiązanej
Values
Enum Value | Description |
---|---|
|
Faktura sprzedażowa |
|
Faktura zakupowa |
Example
"INTERNAL"
InvoiceBoundOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - InvoiceBound
|
|
neq - InvoiceBound
|
|
in - [InvoiceBound!]
|
|
nin - [InvoiceBound!]
|
Example
{"eq": "INTERNAL", "neq": "INTERNAL", "in": ["INTERNAL"], "nin": ["INTERNAL"]}
InvoiceDto
Fields
Field Name | Description |
---|---|
CompanyId - UUID!
|
Id firmy |
Number - String
|
Numer faktury |
DocumentType - RodzajFaktury!
|
Rodzaj faktury |
DateOfIssue - DateTime!
|
Data wystawienia |
DestinationSystem - String
|
System docelowy |
FileName - String
|
Nazwa pliku XML zawierająca fakturę w schemacie obsługiwanym przez KSeF |
InvoiceBound - InvoiceBound!
|
Rodzaj faktury powiązanej |
IssuerName - String
|
Nazwa sprzedawcy |
IssuerNip - String
|
Numer NIP sprzedawcy |
RecipientName - String
|
Nazwa nabywcy |
RecipientNip - String
|
Numer NIP nabywcy |
GrossValue - Decimal!
|
Wartość faktury brutto |
NetValue - Decimal!
|
Wartość faktury netto |
VatValue - Decimal!
|
Wartość podatku vat |
KsefDate - DateTime
|
Data wysłania do KSeF |
KsefNumber - String
|
Numer nadany fakturze przez KSeF |
Downloaded - SymfoniaSystem
|
Kod systemu Symfonii, który pobrał fakturę z Symfonia KSeF |
KSeFStatus - KSeFStatus!
|
Status dokumentu w systemie KSeF |
KSeFStatusErrorDescription - String
|
Opis błędu nadany przez system KSeF, o ile wystąpił |
InvoicePostingStatus - InvoicePostingStatus!
|
Status dekretacji faktury |
IsDecreeAccepted - Boolean!
|
Informacja na temat akceptacji dekretacji faktury |
AttachmentsCount - Int!
|
Liczba załączników dla faktury |
RegistrationNumber - String
|
Numer ewidencyjny faktury. Otrzymywany po wysłaniu faktury do Systemu Symfonia FK |
CanDownloadUpo - Boolean!
|
Określa czy dla tej faktury można pobrać UPO |
SchemaVersion - KsefXsdVersion!
|
Wersja schematu faktury KSeF |
WhiteListStatus - WhiteListStatusDtoModel
|
Wynik sprawdzenia rachunków bankowych kontrahenta na białej liście |
Id - UUID!
|
Unikalny Id rekordu |
CreatedAt - DateTime
|
Data utworzenia rekordu |
CreatedBy - String
|
Email użytkownika, który utworzył rekord |
ModifiedAt - DateTime
|
Data modyfikacji rekordu |
ModifiedBy - String
|
Email użytkownika, który zmodyfikował rekord |
Example
{
"CompanyId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"Number": "xyz789",
"DocumentType": "VAT",
"DateOfIssue": "2007-12-03T10:15:30Z",
"DestinationSystem": "xyz789",
"FileName": "xyz789",
"InvoiceBound": "INTERNAL",
"IssuerName": "abc123",
"IssuerNip": "xyz789",
"RecipientName": "abc123",
"RecipientNip": "xyz789",
"GrossValue": Decimal,
"NetValue": Decimal,
"VatValue": Decimal,
"KsefDate": "2007-12-03T10:15:30Z",
"KsefNumber": "xyz789",
"Downloaded": "UNDEFINED",
"KSeFStatus": "NOT_SENT",
"KSeFStatusErrorDescription": "xyz789",
"InvoicePostingStatus": "DECREE_SENT",
"IsDecreeAccepted": true,
"AttachmentsCount": 123,
"RegistrationNumber": "abc123",
"CanDownloadUpo": false,
"SchemaVersion": "V12648",
"WhiteListStatus": WhiteListStatusDtoModel,
"Id": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"CreatedAt": "2007-12-03T10:15:30Z",
"CreatedBy": "xyz789",
"ModifiedAt": "2007-12-03T10:15:30Z",
"ModifiedBy": "abc123"
}
InvoiceFilterInput
Description
Rekord faktury
Fields
Input Field | Description |
---|---|
and - [InvoiceFilterInput!]
|
|
or - [InvoiceFilterInput!]
|
|
CompanyId - UuidOperationFilterInput
|
Id firmy |
Number - StringOperationFilterInput
|
Numer faktury |
DocumentType - RodzajFakturyOperationFilterInput
|
Rodzaj faktury |
DateOfIssue - DateTimeOperationFilterInput
|
Data wystawienia |
ShortDateOfIssue - DateOperationFilterInput
|
Skrócona data wystawienia |
DestinationSystem - StringOperationFilterInput
|
System docelowy |
FileName - StringOperationFilterInput
|
Nazwa pliku XML zawierająca fakturę w schemacie obsługiwanym przez KSeF |
FileSize - LongOperationFilterInput
|
Rozmiar pliku XML w bajtach |
InvoiceBound - InvoiceBoundOperationFilterInput
|
Rodzaj faktury powiązanej |
IssuerName - StringOperationFilterInput
|
Nazwa sprzedawcy |
IssuerNip - StringOperationFilterInput
|
Numer NIP sprzedawcy |
RecipientName - StringOperationFilterInput
|
Nazwa nabywcy |
RecipientNip - StringOperationFilterInput
|
Numer NIP nabywcy |
NetValue - DecimalOperationFilterInput
|
Wartość faktury netto |
VatValue - DecimalOperationFilterInput
|
Wartość VAT faktury |
GrossValue - DecimalOperationFilterInput
|
Wartość faktury brutto |
KsefDate - DateTimeOperationFilterInput
|
Data wysłania do KSeF |
ShortKsefDate - DateOperationFilterInput
|
Skrócona data wysłania do KSeF |
KsefNumber - StringOperationFilterInput
|
Numer nadany fakturze przez KSeF |
KSeFSessionReferenceNumber - StringOperationFilterInput
|
Numer referencyjny sesji w KSeF podczas wysyłania faktury |
KSeFElementReferenceNumber - StringOperationFilterInput
|
Numer referencyjny elementu w KSeF podczas wysyłania faktury |
Downloaded - NullableOfSymfoniaSystemOperationFilterInput
|
Kod systemu Symfonii, który pobrał fakturę z Symfonia KSeF |
KSeFStatus - KSeFStatusOperationFilterInput
|
Status dokumentu w systemie KSeF |
KSeFStatusErrorDescription - StringOperationFilterInput
|
Opis błędu nadany przez system KSeF, o ile wystąpił |
Owner - StringOperationFilterInput
|
Adres e-mail użytkownika, który zlecił wysyłkę faktury do KSeF |
KSeFAuthUser - StringOperationFilterInput
|
W przypadku, kiedy Owner w momencie wysyłania faktury nie jest autoryzowany w KSeF, zostanie podjęta próba wysłania faktury za pomocą autoryzacji innego użytkownika, który posiada odpowiednie uprawnienia w KSeF do obsługi danej firmy, o ile taki użytkownik istnieje |
RegistrationNumber - StringOperationFilterInput
|
Numer ewidencyjny faktury. Otrzymywany po wysłaniu faktury do Systemu Symfonia FK |
SchemaVersion - KsefXsdVersionOperationFilterInput
|
Wersja schematu faktury KSeF |
PageCount - IntOperationFilterInput
|
Liczba stron faktury OCR, w pozostałych przypadkach: 1 |
IsDecreeAccepted - BooleanOperationFilterInput
|
Czy dekret faktury jest zaakceptowany |
AttachmentsCount - IntOperationFilterInput
|
Liczba załączników podpiętych pod fakturę |
AttachmentsSize - LongOperationFilterInput
|
Rozmiar załączników w bajtach |
Id - UuidOperationFilterInput
|
Unikalny Id rekordu |
CreatedAt - DateTimeOperationFilterInput
|
Data utworzenia rekordu |
CreatedBy - StringOperationFilterInput
|
E-mail użytkownika, który utworzył rekord |
ModifiedAt - DateTimeOperationFilterInput
|
Data modyfikacji rekordu |
ModifiedBy - StringOperationFilterInput
|
E-mail użytkownika, który zmodyfikował rekord |
Example
{
"and": [InvoiceFilterInput],
"or": [InvoiceFilterInput],
"CompanyId": UuidOperationFilterInput,
"Number": StringOperationFilterInput,
"DocumentType": RodzajFakturyOperationFilterInput,
"DateOfIssue": DateTimeOperationFilterInput,
"ShortDateOfIssue": DateOperationFilterInput,
"DestinationSystem": StringOperationFilterInput,
"FileName": StringOperationFilterInput,
"FileSize": LongOperationFilterInput,
"InvoiceBound": InvoiceBoundOperationFilterInput,
"IssuerName": StringOperationFilterInput,
"IssuerNip": StringOperationFilterInput,
"RecipientName": StringOperationFilterInput,
"RecipientNip": StringOperationFilterInput,
"NetValue": DecimalOperationFilterInput,
"VatValue": DecimalOperationFilterInput,
"GrossValue": DecimalOperationFilterInput,
"KsefDate": DateTimeOperationFilterInput,
"ShortKsefDate": DateOperationFilterInput,
"KsefNumber": StringOperationFilterInput,
"KSeFSessionReferenceNumber": StringOperationFilterInput,
"KSeFElementReferenceNumber": StringOperationFilterInput,
"Downloaded": NullableOfSymfoniaSystemOperationFilterInput,
"KSeFStatus": KSeFStatusOperationFilterInput,
"KSeFStatusErrorDescription": StringOperationFilterInput,
"Owner": StringOperationFilterInput,
"KSeFAuthUser": StringOperationFilterInput,
"RegistrationNumber": StringOperationFilterInput,
"SchemaVersion": KsefXsdVersionOperationFilterInput,
"PageCount": IntOperationFilterInput,
"IsDecreeAccepted": BooleanOperationFilterInput,
"AttachmentsCount": IntOperationFilterInput,
"AttachmentsSize": LongOperationFilterInput,
"Id": UuidOperationFilterInput,
"CreatedAt": DateTimeOperationFilterInput,
"CreatedBy": StringOperationFilterInput,
"ModifiedAt": DateTimeOperationFilterInput,
"ModifiedBy": StringOperationFilterInput
}
InvoiceNonRemovableReason
Description
Powód, dla którego faktura nie może zostać usunięta.
Values
Enum Value | Description |
---|---|
|
Wartość domyślna. |
|
Dokument nie jest dodany przez aktualnego użytkownika. |
|
Dokument nie jest plikiem typu: OCR. |
|
Dokument posiada status w KSeF wykluczający usunięcie. |
|
Dokument został przesłany do systemów zewnętrznych. |
|
Błąd podczas usuwania dokumentu. |
|
Dokument o podanym GUID nie został odnaleziony. |
Example
"NONE"
InvoicePostingStatus
Description
Status zadekretowania faktury
Values
Enum Value | Description |
---|---|
|
Wartość techniczna, nieprzeznaczona do użytku |
|
Do dekretacji |
|
W trakcie |
|
Zadekretowano |
|
Wysyłanie do FK |
|
Pobrano do FK |
|
Częściowa dekretacja |
|
Do ponownej dekretacji |
|
Brak |
Example
DECREE_SENT
ItemsOrderInput
Description
Kolejność wyświetlania
Fields
Input Field | Description |
---|---|
FieldName - String
|
Nazwa pola |
Direction - OrderDirection
|
Kolejność |
Example
{"FieldName": "abc123", "Direction": "ASC"}
KSeFAuthResult
Description
Status autoryzacji użytkownika w KSeF
Values
Enum Value | Description |
---|---|
|
Brak autoryzacji |
|
Użytkownik zautoryzowany (Szafir) |
|
Użytkownik zautoryzowany zewnętrznym tokenem |
|
Rozpoczęty proces autoryzacji |
Example
"NOT_AUTHORIZED"
KSeFAutoFetchingInvoicesResponseType
Description
Wynik operacji
Fields
Field Name | Description |
---|---|
Success - Boolean!
|
true - serwis aktywny |
Example
{"Success": true}
KSeFAutoSendingInvoicesResponseType
Description
Wynik operacji
Fields
Field Name | Description |
---|---|
Success - Boolean!
|
true - serwis aktywny |
Example
{"Success": false}
KSeFAutomaticOperationType
Description
Typ automatycznego wysyłania faktur
Values
Enum Value | Description |
---|---|
|
Określona godzina |
|
Interwał czasowy |
Example
"TIME"
KSeFCredentialState
KSeFIdentifierType
Description
Typ identyfikatora podmiotu w KSeF Ministerstwa Finans�w
Values
Enum Value | Description |
---|---|
|
Identyfikator instytucjonalny NIP (onip) |
|
Identyfikator indywidualny NIP (nip) |
|
Identyfikator indywidualny PESEL (pesel) |
|
Odcisk palca certyfikatu (fingerprint) |
|
Identyfikator instytucjonalny wewn�trzny (int) |
|
Token autoryzacyjny |
Example
"INSTITUTIONAL_NIP"
KSeFInvoiceXMLType
KSeFRequestForCredentialResultType
Description
Wynik operacji modyfikacji uprawnień
Values
Enum Value | Description |
---|---|
|
Nie wykonano żadnej operacji |
|
Odebranie uprawnień |
|
Nadanir uprawnień |
|
Edycja uprawnień |
Example
"NONE"
KSeFRequestForCredentialType
Description
Typ żądania dotyczącego uprawnień
Values
Enum Value | Description |
---|---|
|
Wartość serwisowa |
|
Odwołanie uprawnienia |
|
Nadanie uprawnienia |
Example
GRANT
KSeFRequestForCredentialsProcessingStatus
Description
Etapy procesu przetwarzania poświadczeń
Values
Enum Value | Description |
---|---|
|
Weryfikacja poprawności i spójności danych |
|
Poprawne zakończenie procesu |
|
Autoryzacja procesu |
|
Weryfikacja wyników podprocesu uwierzytelniania |
|
Przetwarzanie poświadczeń |
|
Finalizacja i zakończenie procesu |
|
Błąd weryfikacji poprawności i spójności danych |
|
Błąd Autoryzacja procesu |
|
Błąd weryfikacji wyników podprocesu uwierzytelniania |
|
Błąd weryfikacji wyników podprocesu uwierzytelniania |
|
Błąd przetwarzania poświadczeń |
|
Błąd finalizacja i zakończenia procesu |
Example
"SANITY_CHECK"
KSeFSessionStatusResponseType
KSeFSignedType
Description
Sposób autoryzacji w KSeF MF
Values
Enum Value | Description |
---|---|
|
Autoryzacja podpisem |
|
Autoryzacja tokenem |
Example
"SESSION_SIGNED"
KSeFStatus
Description
Status faktur w KSeF
Values
Enum Value | Description |
---|---|
|
Nie wysłana |
|
W trakcie wysyłki |
|
Przetwarzana |
|
Zaakceptowana |
|
Odrzucona |
|
Błąd |
|
Faktura OCR, nie podlega wysyłce do KSeF |
|
Przerwane sprawdzanie statusu faktur (brak autoryzacji) |
|
Przerwane wysyłanie faktur (brak autoryzacji) |
Example
"NOT_SENT"
KSeFStatusOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - KSeFStatus
|
|
neq - KSeFStatus
|
|
in - [KSeFStatus!]
|
|
nin - [KSeFStatus!]
|
Example
{"eq": "NOT_SENT", "neq": "NOT_SENT", "in": ["NOT_SENT"], "nin": ["NOT_SENT"]}
KeyValuePairOfStringAndString
KeyValuePairOfStringAndStringInput
KodKraju
Description
Kody krajów używane w danych adresowych podmiotu na fakturze
Values
Enum Value | Description |
---|---|
|
AFGANISTAN |
|
ALAND ISLANDS |
|
ALBANIA |
|
ALGIERIA |
|
ANDORA |
|
ANGOLA |
|
ANGUILLA |
|
ANTARKTYDA |
|
ANTIGUA I BARBUDA |
|
ANTYLE HOLENDERSKIE |
|
ARABIA SAUDYJSKA |
|
ARGENTYNA |
|
ARMENIA |
|
ARUBA |
|
AUSTRALIA |
|
AUSTRIA |
|
AZERBEJDŻAN |
|
BAHAMY |
|
BAHRAJN |
|
BANGLADESZ |
|
BARBADOS |
|
BELGIA |
|
BELIZE |
|
BENIN |
|
BERMUDY |
|
BHUTAN |
|
BIAŁORUŚ |
|
BOLIWIA |
|
BONAIRE, SINT EUSTATIUS I SABA |
|
BOŚNIA I HERCEGOWINA |
|
BOTSWANA |
|
BRAZYLIA |
|
BRUNEI DARUSSALAM |
|
BRYTYJSKIE TERYTORIUM OCEANU INDYJSKIEGO |
|
BUŁGARIA |
|
BURKINA FASO |
|
BURUNDI |
|
CEUTA |
|
CHILE |
|
CHINY |
|
CHORWACJA |
|
CURAÇAO |
|
CYPR |
|
CZAD |
|
CZARNOGÓRA |
|
DANIA |
|
DOMINIKA |
|
DOMINIKANA |
|
DŻIBUTI |
|
EGIPT |
|
EKWADOR |
|
ERYTREA |
|
ESTONIA |
|
ETIOPIA |
|
FALKLANDY |
|
FIDŻI REPUBLIKA |
|
FILIPINY |
|
FINLANDIA |
|
FRANCJA |
|
FRANCUSKIE TERYTORIUM POŁUDNIOWE |
|
GABON |
|
GAMBIA |
|
GHANA |
|
GIBRALTAR |
|
GRECJA |
|
GRENADA |
|
GRENLANDIA |
|
GRUZJA |
|
GUAM |
|
GUERNSEY |
|
GUJANA |
|
GUJANA FRANCUSKA |
|
GWADELUPA |
|
GWATEMALA |
|
GWINEA |
|
GWINEA RÓWNIKOWA |
|
GWINEA-BISSAU |
|
HAITI |
|
HISZPANIA |
|
HONDURAS |
|
HONGKONG |
|
INDIE |
|
INDONEZJA |
|
IRAK |
|
IRAN |
|
IRLANDIA |
|
ISLANDIA |
|
IZRAEL |
|
JAMAJKA |
|
JAPONIA |
|
JEMEN |
|
JERSEY |
|
JORDANIA |
|
KAJMANY |
|
KAMBODŻA |
|
KAMERUN |
|
KANADA |
|
KATAR |
|
KAZACHSTAN |
|
KENIA |
|
KIRGISTAN |
|
KIRIBATI |
|
KOLUMBIA |
|
KOMORY |
|
KONGO |
|
KONGO, REPUBLIKA DEMOKRATYCZNA |
|
KOREAŃSKA REPUBLIKA LUDOWO-DEMOKRATYCZNA |
|
KOSOWO |
|
KOSTARYKA |
|
KUBA |
|
KUWEJT |
|
LAOS |
|
LESOTHO |
|
LIBAN |
|
LIBERIA |
|
LIBIA |
|
LIECHTENSTEIN |
|
LITWA |
|
ŁOTWA |
|
LUKSEMBURG |
|
MACEDONIA |
|
MADAGASKAR |
|
MAJOTTA |
|
MAKAU |
|
MALAWI |
|
MALEDIWY |
|
MALEZJA |
|
MALI |
|
MALTA |
|
MARIANY PÓŁNOCNE |
|
MAROKO |
|
MARTYNIKA |
|
MAURETANIA |
|
MAURITIUS |
|
MEKSYK |
|
MELILLA |
|
MIKRONEZJA |
|
MINOR |
|
MOŁDOWA |
|
MONAKO |
|
MONGOLIA |
|
MONTSERRAT |
|
MOZAMBIK |
|
MYANMAR (BURMA) |
|
NAMIBIA |
|
NAURU |
|
NEPAL |
|
NIDERLANDY (HOLANDIA) |
|
NIEMCY |
|
NIGER |
|
NIGERIA |
|
NIKARAGUA |
|
NIUE |
|
NORFOLK |
|
NORWEGIA |
|
NOWA KALEDONIA |
|
NOWA ZELANDIA |
|
OKUPOWANE TERYTORIUM PALESTYNY |
|
OMAN |
|
PAKISTAN |
|
PALAU |
|
PANAMA |
|
PAPUA NOWA GWINEA |
|
PARAGWAJ |
|
PERU |
|
PITCAIRN |
|
POLINEZJA FRANCUSKA |
|
POLSKA |
|
POŁUDNIOWA GEORGIA I POŁUD.WYSPY SANDWICH |
|
PORTUGALIA |
|
PORTORYKO |
|
REP.ŚRODKOWOAFRYKAŃSKA |
|
REPUBLIKA CZESKA |
|
REPUBLIKA KOREI |
|
REPUBLIKA POŁUDNIOWEJ AFRYKI |
|
REUNION |
|
ROSJA |
|
RUMUNIA |
|
RWANDA |
|
SAHARA ZACHODNIA |
|
SAINT BARTHELEMY |
|
SAINT KITTS I NEVIS |
|
SAINT LUCIA |
|
SAINT MARTIN |
|
SAINT VINCENT I GRENADYNY |
|
SALWADOR |
|
SAMOA |
|
SAMOA AMERYKAŃSKIE |
|
SAN MARINO |
|
SENEGAL |
|
SERBIA |
|
SESZELE |
|
SIERRA LEONE |
|
SINGAPUR |
|
SŁOWACJA |
|
SŁOWENIA |
|
SOMALIA |
|
SRI LANKA |
|
SAINT PIERRE I MIQUELON |
|
STANY ZJEDNOCZONE AMERYKI |
|
SUAZI |
|
SUDAN |
|
SUDAN POŁUDNIOWY |
|
SURINAM |
|
SVALBARD I JAN MAYEN |
|
ŚWIĘTA HELENA |
|
SYRIA |
|
SZWAJCARIA |
|
SZWECJA |
|
TADŻYKISTAN |
|
TAJLANDIA |
|
TAJWAN |
|
TANZANIA |
|
TOGO |
|
TOKELAU |
|
TONGA |
|
TRYNIDAD I TOBAGO |
|
TUNEZJA |
|
TURCJA |
|
TURKMENISTAN |
|
TUVALU |
|
UGANDA |
|
UKRAINA |
|
URUGWAJ |
|
UZBEKISTAN |
|
VANUATU |
|
WALLIS I FUTUNA |
|
WATYKAN |
|
WĘGRY |
|
WENEZUELA |
|
WIELKA BRYTANIA |
|
WIETNAM |
|
WŁOCHY |
|
WSCHODNI TIMOR |
|
WYBRZEŻE KOŚCI SŁONIOWEJ |
|
WYSPA BOUVETA |
|
WYSPA BOŻEGO NARODZENIA |
|
WYSPA MAN |
|
WYSPA SINT MAARTEN (CZĘŚĆ HOLENDERSKA WYSPY) |
|
WYSPY COOKA |
|
WYSPY DZIEWICZE-USA |
|
WYSPY DZIEWICZE-W.B. |
|
WYSPY HEARD I MCDONALD |
|
WYSPY KOKOSOWE (KEELINGA) |
|
WYSPY MARSHALLA |
|
WYSPY OWCZE |
|
WYSPY SALOMONA |
|
WYSPY ŚWIĘTEGO TOMASZA I KSIĄŻĘCA |
|
WYSPY TURKS I CAICOS |
|
ZAMBIA |
|
ZIELONY PRZYLĄDEK |
|
ZIMBABWE |
|
ZJEDNOCZONE EMIRATY ARABSKIE |
|
ZJEDNOCZONE KRÓLESTWO (IRLANDIA PÓŁNOCNA) |
Example
PL
KodWaluty
Description
Słownik kodów krajów
Values
Enum Value | Description |
---|---|
|
DIRHAM ZEA |
|
AFGANI |
|
LEK |
|
DRAM |
|
GULDEN ANTYLI HOLENDERSKICH |
|
KWANZA |
|
PESO ARGENTYŃSKIE |
|
DOLAR AUSTRALIJSKI |
|
GULDEN ARUBAŃSKI |
|
MANAT AZERBEJDŻAŃSKI |
|
MARKA ZAMIENNA |
|
DOLAR BARBADOSKI |
|
TAKA |
|
LEW |
|
DINAR BAHRAJSKI |
|
FRANK BURUNDYJSKI |
|
DOLAR BERMUDZKI |
|
DOLAR BRUNEJSKI |
|
BOLIWIANO |
|
BOLIWIANO MVDOL |
|
REAL |
|
DOLAR BAHAMSKI |
|
NGULTRUM |
|
PULA |
|
RUBEL BIAŁORUSKI |
|
DOLAR BELIZEŃSKI |
|
DOLAR KANADYJSKI |
|
FRANK KONGIJSKI |
|
FRANK SZWAJCARSKI VIR EURO |
|
FRANK SZWAJCARSKI |
|
FRANK SZWAJCARSKI VIR FRANK |
|
JEDNOSTKA ROZLICZENIOWA CHILIJSKA |
|
PESO CHILIJSKIE |
|
YUAN RENMINBI |
|
PESO KOLUMBIJSKIE |
|
UNIDAD DE VALOR REAL KOLUMBILSKIE |
|
COLON KOSTARYKAŃSKI |
|
PESO WYMIENIALNE |
|
PESO KUBAŃSKIE |
|
ESCUDO REPUBLIKI ZIELONEGO PRZYLĄDKA |
|
KORONA CZESKA |
|
FRANK DŻIBUTI |
|
KORONA DUŃSKA |
|
PESO DOMINIKAŃSKIE |
|
DINAR ALGIERSKI |
|
FUNT EGIPSKI |
|
NAKFA |
|
BIRR |
|
EURO |
|
DOLAR FIDŻI |
|
FUNT FALKLANDZKI |
|
FUNT SZTERLING |
|
LARI |
|
FUNT GUERNSEY |
|
GHANA CEDI |
|
FUNT GIBRALTARSKI |
|
DALASI |
|
FRANK GWINEJSKI |
|
QUETZAL |
|
DOLAR GUJAŃSKI |
|
DOLAR HONGKONGU |
|
LEMPIRA |
|
KUNA |
|
GOURDE |
|
FORINT |
|
RUPIA INDONEZYJSKA |
|
SZEKEL |
|
FUNT MANX |
|
RUPIA INDYJSKA |
|
DINAR IRACKI |
|
RIAL IRAŃSKI |
|
KORONA ISLANDZKA |
|
FUNT JERSEY |
|
DOLAR JAMAJSKI |
|
DINAR JORDAŃSKI |
|
JEN |
|
SZYLING KENIJSKI |
|
SOM |
|
RIEL |
|
FRANK KOMORÓW |
|
WON PÓŁNOCNOKOREAŃSKI |
|
WON POŁUDNIOWOKOREAŃSKI |
|
DINAR KUWEJCKI |
|
DOLAR KAJMAŃSKI |
|
TENGE |
|
KIP |
|
FUNT LIBAŃSKI |
|
RUPIA LANKIJSKA |
|
DOLAR LIBERYJSKI |
|
LOTI |
|
DINAR LIBIJSKI |
|
DIRHAM MAROKAŃSKI |
|
LEJ MOŁDAWII |
|
ARIARY |
|
DENAR |
|
KYAT |
|
TUGRIK |
|
PATACA |
|
OUGUIYA |
|
RUPIA MAURITIUSU |
|
RUPIA MALEDIWSKA |
|
KWACHA MALAWIJSKA |
|
PESO MEKSYKAŃSKIE |
|
UNIDAD DE INVERSION (UDI) MEKSYKAŃSKIE |
|
RINGGIT |
|
METICAL |
|
DOLAR NAMIBIJSKI |
|
NAIRA |
|
CORDOBA ORO |
|
KORONA NORWESKA |
|
RUPIA NEPALSKA |
|
DOLAR NOWOZELANDZKI |
|
RIAL OMAŃSKI |
|
BALBOA |
|
SOL |
|
KINA |
|
PESO FILIPIŃSKIE |
|
RUPIA PAKISTAŃSKA |
|
ZŁOTY |
|
GUARANI |
|
RIAL KATARSKI |
|
LEJ RUMUŃSKI |
|
DINAR SERBSKI |
|
RUBEL ROSYJSKI |
|
FRANK RWANDYJSKI |
|
RIAL SAUDYJSKI |
|
DOLAR WYSP SALOMONA |
|
RUPIA SESZELSKA |
|
FUNT SUDAŃSKI |
|
KORONA SZWEDZKA |
|
DOLAR SINGAPURSKI |
|
FUNT ŚWIĘTEJ HELENY (ŚWIĘTA HELENA I WYSPA WNIEBOWSTĄPIENIA) |
|
LEONE |
|
SZYLING SOMALIJSKI |
|
DOLAR SURINAMSKI |
|
FUNT POŁUDNIOWOSUDAŃSKI |
|
DOBRA |
|
COLON SALWADORSKI (SV1) |
|
FUNT SYRYJSKI |
|
LILANGENI |
|
BAT |
|
SOMONI |
|
MANAT TURKMEŃSKI |
|
DINAR TUNEZYJSKI |
|
PAANGA |
|
LIRA TURECKA |
|
DOLAR TRYNIDADU I TOBAGO |
|
NOWY DOLAR TAJWAŃSKI |
|
SZYLING TANZAŃSKI |
|
HRYWNA |
|
SZYLING UGANDYJSKI |
|
DOLAR AMERYKAŃSKI |
|
DOLAR AMERYKAŃSKI (NEXT DAY) |
|
PESO EN UNIDADES INDEXADAS URUGWAJSKIE |
|
PESO URUGWAJSKIE |
|
PESO EN UNIDADES INDEXADAS URUGWAJSKIE |
|
SUM |
|
BOLIWAR SOBERANO |
|
DONG |
|
VATU |
|
TALA |
|
FRANK CFA (BEAC) |
|
SREBRO |
|
ZŁOTO |
|
BOND MARKETS UNIT EUROPEAN COMPOSITE UNIT (EURCO) |
|
BOND MARKETS UNIT EUROPEAN MONETARY UNIT (E.M.U.-6) |
|
BOND MARKETS UNIT EUROPEAN UNIT OF ACCOUNT 9 (E.U.A.-9) |
|
BOND MARKETS UNIT EUROPEAN UNIT OF ACCOUNT 17 (E.U.A.-17) |
|
DOLAR WSCHODNIOKARAIBSKI |
|
SDR MIĘDZYNARODOWY FUNDUSZ WALUTOWY |
|
FRANK CFA (BCEAO) |
|
PALLAD |
|
FRANK CFP |
|
PLATYNA |
|
SUCRE SISTEMA UNITARIO DE COMPENSACION REGIONAL DE PAGOS SUCRE |
|
ADB UNIT OF ACCOUNT MEMBER COUNTRIES OF THE AFRICAN DEVELOPMENT BANK GROUP |
|
BRAK WALUTY |
|
RIAL JEMEŃSKI |
|
RAND |
|
KWACHA ZAMBIJSKA |
|
DOLAR ZIMBABWE |
Example
PLN
Korekta
Description
Korekta do faktury, obowiązkowa dla typów faktury KOR, KOR_ZAL lub KOR_ROZ
Fields
Field Name | Description |
---|---|
PrzyczynaKorekty - String
|
Przyczyna korekty dla faktur korygujących |
TypKorekty - TypKorekty
|
Typ skutku korekty w ewidencji |
FaKorygowana - [DaneFaKorygowanej!]!
|
Lista faktur korygowanych |
OkresFaKorygowanej - String
|
Dla faktury korygującej, o której mowa w art. 106j ust. 3 ustawy - okres, do którego odnosi się udzielany opust lub obniżka, w przypadku gdy podatnik udziela opustu lub obniżki ceny w odniesieniu do dostaw towarów lub usług dokonanych lub świadczonych na rzecz jednego odbiorcy w danym okresie |
NrFaKorygowany - String
|
Poprawny numer faktury korygowanej w przypadku, gdy przyczyną korekty jest błędny numer faktury korygowanej. W polu NrFaKorygowanej należy wówczas wskazać ten błędny numer |
Sprzedawca - Podmiot
|
Sprzedawca |
Nabywca - Podmiot
|
Nabywca |
Example
{
"PrzyczynaKorekty": "xyz789",
"TypKorekty": "TYP1",
"FaKorygowana": [DaneFaKorygowanej],
"OkresFaKorygowanej": "abc123",
"NrFaKorygowany": "xyz789",
"Sprzedawca": Podmiot,
"Nabywca": Podmiot
}
KorektaInput
Description
Korekta do faktury, obowiązkowa dla typów faktury KOR, KOR_ZAL lub KOR_ROZ
Fields
Input Field | Description |
---|---|
PrzyczynaKorekty - String
|
Przyczyna korekty dla faktur korygujących |
TypKorekty - TypKorekty
|
Typ skutku korekty w ewidencji |
FaKorygowana - [DaneFaKorygowanejInput!]!
|
Lista faktur korygowanych |
OkresFaKorygowanej - String
|
Dla faktury korygującej, o której mowa w art. 106j ust. 3 ustawy - okres, do którego odnosi się udzielany opust lub obniżka, w przypadku gdy podatnik udziela opustu lub obniżki ceny w odniesieniu do dostaw towarów lub usług dokonanych lub świadczonych na rzecz jednego odbiorcy w danym okresie |
NrFaKorygowany - String
|
Poprawny numer faktury korygowanej w przypadku, gdy przyczyną korekty jest błędny numer faktury korygowanej. W polu NrFaKorygowanej należy wówczas wskazać ten błędny numer |
Sprzedawca - PodmiotInput
|
Sprzedawca |
Nabywca - PodmiotInput
|
Nabywca |
Example
{
"PrzyczynaKorekty": "xyz789",
"TypKorekty": "TYP1",
"FaKorygowana": [DaneFaKorygowanejInput],
"OkresFaKorygowanej": "xyz789",
"NrFaKorygowany": "abc123",
"Sprzedawca": PodmiotInput,
"Nabywca": PodmiotInput
}
KorektaV2
Description
Obiekt Korekty
Fields
Field Name | Description |
---|---|
Sprzedawca - PodmiotV2
|
Sprzedawca |
Nabywca - PodmiotV2
|
Nabywca |
KursWalutyKorektyFakturyZaliczkowej - Decimal
|
Kurs waluty stosowany do wyliczenia kwoty podatku w przypadkach, o których mowa w Dziale VI ustawy przed korektą. Typ wykorzystywany do określenia ilości. Wartość numeryczna 22 znaki max, w tym 6 po przecinku. Total number of digits: 22. Total number of digits in fraction: 6. Pattern: -?([1-9]\d{0,15}|0)(.\d{1,6})?. |
KwotaPrzedKorektaFakturyZaliczkowej - Decimal
|
W przypadku korekt faktur zaliczkowych, kwota zapłaty przed korektą. W przypadku korekt faktur, o których mowa w art. 106f ust. 3 ustawy, kwota pozostała do zapłaty przed korektą. Wartość numeryczna 18 znaków max, w tym 2 znaki po przecinku. Total number of digits: 18. Total number of digits in fraction: 2. Pattern: -?([1-9]\d{0,15}|0)(.\d{1,2})?. |
PrzyczynaKorekty - String
|
Przyczyna korekty dla faktur korygujących |
TypKorekty - TypKorekty
|
Typ skutku korekty w ewidencji |
FaKorygowana - [DaneFaKorygowanej!]!
|
Lista faktur korygowanych |
OkresFaKorygowanej - String
|
Dla faktury korygującej, o której mowa w art. 106j ust. 3 ustawy - okres, do którego odnosi się udzielany opust lub obniżka, w przypadku gdy podatnik udziela opustu lub obniżki ceny w odniesieniu do dostaw towarów lub usług dokonanych lub świadczonych na rzecz jednego odbiorcy w danym okresie |
NrFaKorygowany - String
|
Poprawny numer faktury korygowanej w przypadku, gdy przyczyną korekty jest błędny numer faktury korygowanej. W polu NrFaKorygowanej należy wówczas wskazać ten błędny numer |
Example
{
"Sprzedawca": PodmiotV2,
"Nabywca": PodmiotV2,
"KursWalutyKorektyFakturyZaliczkowej": Decimal,
"KwotaPrzedKorektaFakturyZaliczkowej": Decimal,
"PrzyczynaKorekty": "abc123",
"TypKorekty": "TYP1",
"FaKorygowana": [DaneFaKorygowanej],
"OkresFaKorygowanej": "xyz789",
"NrFaKorygowany": "xyz789"
}
KorektaV2Input
Description
Obiekt Korekty
Fields
Input Field | Description |
---|---|
Sprzedawca - PodmiotV2Input
|
Sprzedawca |
Nabywca - PodmiotV2Input
|
Nabywca |
KursWalutyKorektyFakturyZaliczkowej - Decimal
|
Kurs waluty stosowany do wyliczenia kwoty podatku w przypadkach, o których mowa w Dziale VI ustawy przed korektą. Typ wykorzystywany do określenia ilości. Wartość numeryczna 22 znaki max, w tym 6 po przecinku. Total number of digits: 22. Total number of digits in fraction: 6. Pattern: -?([1-9]\d{0,15}|0)(.\d{1,6})?. |
KwotaPrzedKorektaFakturyZaliczkowej - Decimal
|
W przypadku korekt faktur zaliczkowych, kwota zapłaty przed korektą. W przypadku korekt faktur, o których mowa w art. 106f ust. 3 ustawy, kwota pozostała do zapłaty przed korektą. Wartość numeryczna 18 znaków max, w tym 2 znaki po przecinku. Total number of digits: 18. Total number of digits in fraction: 2. Pattern: -?([1-9]\d{0,15}|0)(.\d{1,2})?. |
PrzyczynaKorekty - String
|
Przyczyna korekty dla faktur korygujących |
TypKorekty - TypKorekty
|
Typ skutku korekty w ewidencji |
FaKorygowana - [DaneFaKorygowanejInput!]!
|
Lista faktur korygowanych |
OkresFaKorygowanej - String
|
Dla faktury korygującej, o której mowa w art. 106j ust. 3 ustawy - okres, do którego odnosi się udzielany opust lub obniżka, w przypadku gdy podatnik udziela opustu lub obniżki ceny w odniesieniu do dostaw towarów lub usług dokonanych lub świadczonych na rzecz jednego odbiorcy w danym okresie |
NrFaKorygowany - String
|
Poprawny numer faktury korygowanej w przypadku, gdy przyczyną korekty jest błędny numer faktury korygowanej. W polu NrFaKorygowanej należy wówczas wskazać ten błędny numer |
Example
{
"Sprzedawca": PodmiotV2Input,
"Nabywca": PodmiotV2Input,
"KursWalutyKorektyFakturyZaliczkowej": Decimal,
"KwotaPrzedKorektaFakturyZaliczkowej": Decimal,
"PrzyczynaKorekty": "xyz789",
"TypKorekty": "TYP1",
"FaKorygowana": [DaneFaKorygowanejInput],
"OkresFaKorygowanej": "abc123",
"NrFaKorygowany": "xyz789"
}
KsefXsdVersion
Description
Contains Ksef invoice versions.
Values
Enum Value | Description |
---|---|
|
Wartość serwisowa |
|
Wersja FA(1) |
|
Wersja FA(2) |
Example
V12648
KsefXsdVersionOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - KsefXsdVersion
|
|
neq - KsefXsdVersion
|
|
in - [KsefXsdVersion!]
|
|
nin - [KsefXsdVersion!]
|
Example
{"eq": "V12648", "neq": "V12648", "in": ["V12648"], "nin": ["V12648"]}
Ladunek
Description
Rodzaje ładunku
Values
Enum Value | Description |
---|---|
|
Bańka |
|
Beczka |
|
Butla |
|
Karton |
|
Kanister |
|
Klatka |
|
Kontener |
|
Kosz/koszyk |
|
Łubianka |
|
Opakowanie zbiorcze |
|
Paczka |
|
Pakiet |
|
Paleta |
|
Pojemnik |
|
Pojemnik do ładunków masowych stałych |
|
Pojemnik do ładunków masowych w postaci płynnej |
|
Pudełko |
|
Puszka |
|
Skrzynia |
|
Worek |
Example
"BANKA"
ListFilterInputTypeOfCompanyFilterInput
Fields
Input Field | Description |
---|---|
all - CompanyFilterInput
|
|
none - CompanyFilterInput
|
|
some - CompanyFilterInput
|
|
any - Boolean
|
Example
{
"all": CompanyFilterInput,
"none": CompanyFilterInput,
"some": CompanyFilterInput,
"any": false
}
ListFilterInputTypeOfRoleAssignmentFilterInput
Fields
Input Field | Description |
---|---|
all - RoleAssignmentFilterInput
|
|
none - RoleAssignmentFilterInput
|
|
some - RoleAssignmentFilterInput
|
|
any - Boolean
|
Example
{
"all": RoleAssignmentFilterInput,
"none": RoleAssignmentFilterInput,
"some": RoleAssignmentFilterInput,
"any": false
}
ListFilterInputTypeOfUserFilterInput
Fields
Input Field | Description |
---|---|
all - UserFilterInput
|
|
none - UserFilterInput
|
|
some - UserFilterInput
|
|
any - Boolean
|
Example
{
"all": UserFilterInput,
"none": UserFilterInput,
"some": UserFilterInput,
"any": true
}
ListInvoicesResponseType
Description
Wynik operacji pobrania listy faktur
Fields
Field Name | Description |
---|---|
Items - [Invoice!]
|
Lista faktur |
Example
{"Items": [Invoice]}
Long
Description
The Long
scalar type represents non-fractional signed whole 64-bit numeric values. Long can represent values between -(2^63) and 2^63 - 1.
Example
{}
LongOperationFilterInput
Example
{
"eq": {},
"neq": {},
"in": [{}],
"nin": [{}],
"gt": {},
"ngt": {},
"gte": {},
"ngte": {},
"lt": {},
"nlt": {},
"lte": {},
"nlte": {}
}
MissedInvoice
Description
Informacja o brakującej fakturze
Fields
Field Name | Description |
---|---|
InvoiceId - UUID!
|
Id faktury |
InvoiceNumber - String
|
Numer faktury |
Reason - UpoMissingInvoiceReason!
|
Powód dla którego UPO nie zostało pobrane |
Example
{
"InvoiceId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"InvoiceNumber": "abc123",
"Reason": "NOT_EXISTS"
}
MissedInvoices
Description
Rekord brakującej faktury
Fields
Field Name | Description |
---|---|
invoiceId - UUID!
|
Id faktury |
invoiceNumber - String
|
Numer faktury |
reason - UpoMissingInvoiceReason!
|
Powód braku |
Example
{
"invoiceId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"invoiceNumber": "xyz789",
"reason": "NOT_EXISTS"
}
MultipleSendToKSeFResponseType
Fields
Field Name | Description |
---|---|
NotificationModel - WebsocketNotificationModel
|
Treść notyfikacji |
Result - SubscriptionStateEnum!
|
Stan operacji |
Example
{
"NotificationModel": WebsocketNotificationModel,
"Result": "ENQUEUED"
}
MyEnvironmentsViewModelResponse
Description
Właściwości środowisk dla bieżącego użytkownika
Fields
Field Name | Description |
---|---|
Environments - [EnvironmentViewModel]
|
Lista właściwości środowisk |
Example
{"Environments": [EnvironmentViewModel]}
Naglowek
Description
Nagłówek faktury
Fields
Field Name | Description |
---|---|
RodzajFaktury - RodzajFaktury
|
Rodzaj faktury |
DataWystawienia - DateTime!
|
Data wystawienia, z zastrzeżeniem art. 106na ust. 1 ustawy |
DataDostawy - DateTime
|
Data dokonania lub zakończenia dostawy towarów lub wykonania usługi lub data otrzymania zapłaty, o której mowa w art. 106b ust. 1 pkt 4 ustawy, o ile taka data jest określona i różni się od daty wystawienia faktury. Pole wypełnia się w przypadku, gdy dla wszystkich pozycji faktury data jest wspólna |
KodWaluty - KodWaluty
|
Trzyliterowy kod waluty (ISO-4217) w przypadkach, o których mowa w art. 31a ustawy |
MiejsceWystaw - String
|
Miejsce wystawienia faktury |
Numer - String
|
Kolejny numer faktury, nadany w ramach jednej lub więcej serii, który w sposób jednoznaczny identyfikuje fakturę |
WZ - [String!]
|
Numery dokumentów magazynowych WZ (wydanie na zewnątrz) związane z fakturą |
KwotaBrutto - Decimal!
|
Kwota należności ogółem. W przypadku faktur zaliczkowych kwota zapłaty dokumentowana fakturą. W przypadku faktur, o których mowa w art. 106f ust. 3 ustawy kwota pozostała do zapłaty. W przypadku faktur korygujących korekta kwoty wynikającej z faktury korygowanej. W przypadku, o którym mowa w art. 106j ust. 3 ustawy korekta kwot wynikających z faktur korygowanych. |
FP - Boolean!
|
Faktura do paragonu |
TP - Boolean!
|
Istniejące powiązania między nabywcą a dokonującym dostawy towarów lub usługodawcą |
DodatkowyOpis - [KeyValuePairOfStringAndString!]
|
Pola rezerwowe przeznaczone dla wykazywania dodatkowych informacji na fakturze, w tym wymaganych przepisami prawa, dla których nie przewidziano innych pól/elementów |
NrFaZaliczkowej - [String!]
|
Pole obowiązkowe dla faktury wystawianej po wydaniu towaru lub wykonaniu usługi, o której mowa w art. 106f ust. 3 i ostatniej z faktur, o której mowa w art. 106f ust. 4 ustawy |
Example
{
"RodzajFaktury": "VAT",
"DataWystawienia": "2007-12-03T10:15:30Z",
"DataDostawy": "2007-12-03T10:15:30Z",
"KodWaluty": "PLN",
"MiejsceWystaw": "xyz789",
"Numer": "xyz789",
"WZ": ["xyz789"],
"KwotaBrutto": Decimal,
"FP": true,
"TP": true,
"DodatkowyOpis": [KeyValuePairOfStringAndString],
"NrFaZaliczkowej": ["abc123"]
}
NaglowekInput
Description
Nagłówek faktury
Fields
Input Field | Description |
---|---|
RodzajFaktury - RodzajFaktury
|
Rodzaj faktury |
DataWystawienia - DateTime!
|
Data wystawienia, z zastrzeżeniem art. 106na ust. 1 ustawy |
DataDostawy - DateTime
|
Data dokonania lub zakończenia dostawy towarów lub wykonania usługi lub data otrzymania zapłaty, o której mowa w art. 106b ust. 1 pkt 4 ustawy, o ile taka data jest określona i różni się od daty wystawienia faktury. Pole wypełnia się w przypadku, gdy dla wszystkich pozycji faktury data jest wspólna |
KodWaluty - KodWaluty
|
Trzyliterowy kod waluty (ISO-4217) w przypadkach, o których mowa w art. 31a ustawy |
MiejsceWystaw - String
|
Miejsce wystawienia faktury |
Numer - String
|
Kolejny numer faktury, nadany w ramach jednej lub więcej serii, który w sposób jednoznaczny identyfikuje fakturę |
WZ - [String!]
|
Numery dokumentów magazynowych WZ (wydanie na zewnątrz) związane z fakturą |
KwotaBrutto - Decimal!
|
Kwota należności ogółem. W przypadku faktur zaliczkowych kwota zapłaty dokumentowana fakturą. W przypadku faktur, o których mowa w art. 106f ust. 3 ustawy kwota pozostała do zapłaty. W przypadku faktur korygujących korekta kwoty wynikającej z faktury korygowanej. W przypadku, o którym mowa w art. 106j ust. 3 ustawy korekta kwot wynikających z faktur korygowanych. |
FP - Boolean!
|
Faktura do paragonu |
TP - Boolean!
|
Istniejące powiązania między nabywcą a dokonującym dostawy towarów lub usługodawcą |
DodatkowyOpis - [KeyValuePairOfStringAndStringInput!]
|
Pola rezerwowe przeznaczone dla wykazywania dodatkowych informacji na fakturze, w tym wymaganych przepisami prawa, dla których nie przewidziano innych pól/elementów |
NrFaZaliczkowej - [String!]
|
Pole obowiązkowe dla faktury wystawianej po wydaniu towaru lub wykonaniu usługi, o której mowa w art. 106f ust. 3 i ostatniej z faktur, o której mowa w art. 106f ust. 4 ustawy |
Example
{
"RodzajFaktury": "VAT",
"DataWystawienia": "2007-12-03T10:15:30Z",
"DataDostawy": "2007-12-03T10:15:30Z",
"KodWaluty": "PLN",
"MiejsceWystaw": "abc123",
"Numer": "xyz789",
"WZ": ["abc123"],
"KwotaBrutto": Decimal,
"FP": true,
"TP": true,
"DodatkowyOpis": [KeyValuePairOfStringAndStringInput],
"NrFaZaliczkowej": ["abc123"]
}
NaglowekV2
Description
Nagłówek faktury
Fields
Field Name | Description |
---|---|
RodzajFaktury - RodzajFaktury
|
Rodzaj faktury |
DataWystawienia - DateTime!
|
Data wystawienia, z zastrzeżeniem art. 106na ust. 1 ustawy |
DataDostawy - DateTime
|
Data dokonania lub zakończenia dostawy towarów lub wykonania usługi lub data otrzymania zapłaty, o której mowa w art. 106b ust. 1 pkt 4 ustawy, o ile taka data jest określona i różni się od daty wystawienia faktury. Pole wypełnia się w przypadku, gdy dla wszystkich pozycji faktury data jest wspólna |
KodWaluty - KodWaluty
|
Trzyliterowy kod waluty (ISO-4217) w przypadkach, o których mowa w art. 31a ustawy |
MiejsceWystaw - String
|
Miejsce wystawienia faktury |
Numer - String
|
Kolejny numer faktury, nadany w ramach jednej lub więcej serii, który w sposób jednoznaczny identyfikuje fakturę |
WZ - [String!]
|
Numery dokumentów magazynowych WZ (wydanie na zewnątrz) związane z fakturą |
KwotaBrutto - Decimal!
|
Kwota należności ogółem. W przypadku faktur zaliczkowych kwota zapłaty dokumentowana fakturą. W przypadku faktur, o których mowa w art. 106f ust. 3 ustawy kwota pozostała do zapłaty. W przypadku faktur korygujących korekta kwoty wynikającej z faktury korygowanej. W przypadku, o którym mowa w art. 106j ust. 3 ustawy korekta kwot wynikających z faktur korygowanych. |
KwotaNetto - Decimal
|
Suma wartości sprzedaży netto ze stawką podstawową - aktualnie 23% albo 22%. W przypadku faktur zaliczkowych, kwota zaliczki netto. W przypadku faktur korygujących, kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy |
KwotaVat - Decimal
|
Kwota podatku od sumy wartości sprzedaży netto objętej stawką podstawową - aktualnie 23% albo 22%. W przypadku faktur zaliczkowych, kwota podatku wyliczona według wzoru, o którym mowa w art. 106f ust. 1 pkt 3 ustawy. W przypadku faktur korygujących, kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy |
FP - Boolean!
|
Faktura do paragonu |
TP - Boolean!
|
Istniejące powiązania między nabywcą a dokonującym dostawy towarów lub usługodawcą |
DodatkowyOpis - [DodatkowyOpisPolaV2!]
|
Pola rezerwowe przeznaczone dla wykazywania dodatkowych informacji na fakturze, w tym wymaganych przepisami prawa, dla których nie przewidziano innych pól/elementów |
FakturaZaliczkowa - [FakturaZaliczkowaV2!]
|
Numery faktur zaliczkowych lub ich numery KSeF, jeśli zostały wystawione z użyciem KSeF |
KursWalutyZaliczka - Decimal
|
Kurs waluty stosowany do wyliczenia kwoty podatku w przypadkach, o których mowa w przepisach Działu VI ustawy na fakturach, o których mowa w art. 106b ust. 1 pkt 4 ustawy Typ wykorzystywany do określenia ilości. Wartość numeryczna 22 znaki max, w tym 6 po przecinku Total number of digits: 22. Total number of digits in fraction: 6. Pattern: -?([1-9]\d{0,15}|0)(.\d{1,6})?. |
OkresFaktury - ZakresDatV2
|
Okres, którego dotyczy faktura w przypadkach, o których mowa w art. 19a ust. 3 zdanie pierwsze i ust. 4 oraz ust. 5 pkt 4 ustawy |
ZwrotAkcyzy - Boolean
|
Informacja dodatkowa niezbędna dla rolników ubiegających się o zwrot podatku akcyzowego zawartego w cenie oleju napędowego |
ZaliczkaCzesciowa - [ZaliczkaCzesciowaV2!]
|
Dane dla przypadków faktur dokumentujących otrzymanie więcej niż jednej płatności, o której mowa w art. 106b ust. 1 pkt 4 ustawy. W przypadku, gdy faktura, o której mowa w art. 106f ust. 3 ustawy dokumentuje jednocześnie otrzymanie części zapłaty przed dokonaniem czynności, różnica kwoty w polu P_15 i sumy poszczególnych pól P_15Z stanowi kwotę pozostałą ponad płatności otrzymane przed wykonaniem czynności udokumentowanej fakturą |
Example
{
"RodzajFaktury": "VAT",
"DataWystawienia": "2007-12-03T10:15:30Z",
"DataDostawy": "2007-12-03T10:15:30Z",
"KodWaluty": "PLN",
"MiejsceWystaw": "xyz789",
"Numer": "abc123",
"WZ": ["abc123"],
"KwotaBrutto": Decimal,
"KwotaNetto": Decimal,
"KwotaVat": Decimal,
"FP": true,
"TP": true,
"DodatkowyOpis": [DodatkowyOpisPolaV2],
"FakturaZaliczkowa": [FakturaZaliczkowaV2],
"KursWalutyZaliczka": Decimal,
"OkresFaktury": ZakresDatV2,
"ZwrotAkcyzy": true,
"ZaliczkaCzesciowa": [ZaliczkaCzesciowaV2]
}
NaglowekV2Input
Description
Nagłówek faktury
Fields
Input Field | Description |
---|---|
RodzajFaktury - RodzajFaktury
|
Rodzaj faktury |
DataWystawienia - DateTime!
|
Data wystawienia, z zastrzeżeniem art. 106na ust. 1 ustawy |
DataDostawy - DateTime
|
Data dokonania lub zakończenia dostawy towarów lub wykonania usługi lub data otrzymania zapłaty, o której mowa w art. 106b ust. 1 pkt 4 ustawy, o ile taka data jest określona i różni się od daty wystawienia faktury. Pole wypełnia się w przypadku, gdy dla wszystkich pozycji faktury data jest wspólna |
KodWaluty - KodWaluty
|
Trzyliterowy kod waluty (ISO-4217) w przypadkach, o których mowa w art. 31a ustawy |
MiejsceWystaw - String
|
Miejsce wystawienia faktury |
Numer - String
|
Kolejny numer faktury, nadany w ramach jednej lub więcej serii, który w sposób jednoznaczny identyfikuje fakturę |
WZ - [String!]
|
Numery dokumentów magazynowych WZ (wydanie na zewnątrz) związane z fakturą |
KwotaBrutto - Decimal!
|
Kwota należności ogółem. W przypadku faktur zaliczkowych kwota zapłaty dokumentowana fakturą. W przypadku faktur, o których mowa w art. 106f ust. 3 ustawy kwota pozostała do zapłaty. W przypadku faktur korygujących korekta kwoty wynikającej z faktury korygowanej. W przypadku, o którym mowa w art. 106j ust. 3 ustawy korekta kwot wynikających z faktur korygowanych. |
KwotaNetto - Decimal
|
Suma wartości sprzedaży netto ze stawką podstawową - aktualnie 23% albo 22%. W przypadku faktur zaliczkowych, kwota zaliczki netto. W przypadku faktur korygujących, kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy |
KwotaVat - Decimal
|
Kwota podatku od sumy wartości sprzedaży netto objętej stawką podstawową - aktualnie 23% albo 22%. W przypadku faktur zaliczkowych, kwota podatku wyliczona według wzoru, o którym mowa w art. 106f ust. 1 pkt 3 ustawy. W przypadku faktur korygujących, kwota różnicy, o której mowa w art. 106j ust. 2 pkt 5 ustawy |
FP - Boolean!
|
Faktura do paragonu |
TP - Boolean!
|
Istniejące powiązania między nabywcą a dokonującym dostawy towarów lub usługodawcą |
DodatkowyOpis - [DodatkowyOpisPolaV2Input!]
|
Pola rezerwowe przeznaczone dla wykazywania dodatkowych informacji na fakturze, w tym wymaganych przepisami prawa, dla których nie przewidziano innych pól/elementów |
FakturaZaliczkowa - [FakturaZaliczkowaV2Input!]
|
Numery faktur zaliczkowych lub ich numery KSeF, jeśli zostały wystawione z użyciem KSeF |
KursWalutyZaliczka - Decimal
|
Kurs waluty stosowany do wyliczenia kwoty podatku w przypadkach, o których mowa w przepisach Działu VI ustawy na fakturach, o których mowa w art. 106b ust. 1 pkt 4 ustawy Typ wykorzystywany do określenia ilości. Wartość numeryczna 22 znaki max, w tym 6 po przecinku Total number of digits: 22. Total number of digits in fraction: 6. Pattern: -?([1-9]\d{0,15}|0)(.\d{1,6})?. |
OkresFaktury - ZakresDatV2Input
|
Okres, którego dotyczy faktura w przypadkach, o których mowa w art. 19a ust. 3 zdanie pierwsze i ust. 4 oraz ust. 5 pkt 4 ustawy |
ZwrotAkcyzy - Boolean
|
Informacja dodatkowa niezbędna dla rolników ubiegających się o zwrot podatku akcyzowego zawartego w cenie oleju napędowego |
ZaliczkaCzesciowa - [ZaliczkaCzesciowaV2Input!]
|
Dane dla przypadków faktur dokumentujących otrzymanie więcej niż jednej płatności, o której mowa w art. 106b ust. 1 pkt 4 ustawy. W przypadku, gdy faktura, o której mowa w art. 106f ust. 3 ustawy dokumentuje jednocześnie otrzymanie części zapłaty przed dokonaniem czynności, różnica kwoty w polu P_15 i sumy poszczególnych pól P_15Z stanowi kwotę pozostałą ponad płatności otrzymane przed wykonaniem czynności udokumentowanej fakturą |
Example
{
"RodzajFaktury": "VAT",
"DataWystawienia": "2007-12-03T10:15:30Z",
"DataDostawy": "2007-12-03T10:15:30Z",
"KodWaluty": "PLN",
"MiejsceWystaw": "xyz789",
"Numer": "abc123",
"WZ": ["abc123"],
"KwotaBrutto": Decimal,
"KwotaNetto": Decimal,
"KwotaVat": Decimal,
"FP": true,
"TP": false,
"DodatkowyOpis": [DodatkowyOpisPolaV2Input],
"FakturaZaliczkowa": [FakturaZaliczkowaV2Input],
"KursWalutyZaliczka": Decimal,
"OkresFaktury": ZakresDatV2Input,
"ZwrotAkcyzy": true,
"ZaliczkaCzesciowa": [ZaliczkaCzesciowaV2Input]
}
NotEligibleDeleteInvoices
Fields
Field Name | Description |
---|---|
invoiceId - UUID!
|
|
invoiceNumber - String
|
|
invoiceDate - DateTime
|
|
reason - InvoiceNonRemovableReason!
|
Example
{
"invoiceId": "ce164f8f-a876-437c-a391-7fbb0e829ec4",
"invoiceNumber": "xyz789",
"invoiceDate": "2007-12-03T10:15:30Z",
"reason": "NONE"
}
NullableOfSymfoniaSystemOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - SymfoniaSystem
|
|
neq - SymfoniaSystem
|
|
in - [SymfoniaSystem]
|
|
nin - [SymfoniaSystem]
|
Example
{
"eq": "UNDEFINED",
"neq": "UNDEFINED",
"in": ["UNDEFINED"],
"nin": ["UNDEFINED"]
}