Devapo KSeF Integrator REST API

API and SDK Documentation

Version: 1.4.0

API Devapo KSeF Integrator stanowi kompleksowe rozwiązanie do integracji z polskim Krajowym Systemem e-Faktur (KSeF). Umożliwia ono automatyzację kluczowych procesów związanych z fakturowaniem elektronicznym, w tym:

Faktury Sprzedażowe: Bezpieczne tworzenie, walidowanie i wysyłanie faktur do KSeF, zarówno pojedynczo, jak i w trybie masowym. Zarządzanie wersjami roboczymi (draftami) i obsługa korekt.
Faktury Kosztowe: Automatyczne pobieranie faktur kosztowych z KSeF, ich kategoryzacja na podstawie zdefiniowanych reguł biznesowych oraz dystrybucja poprzez konfigurowalne kanały powiadomień.
Załączniki: Zarządzanie cyfrową teczką dokumentów, umożliwiającą dołączanie i przechowywanie dowolnych plików (np. PDF, JPG) w powiązaniu z fakturami z KSeF.
Personalizacja: Dostosowywanie wizualizacji faktur oraz konfiguracja zaawansowanych reguł i powiadomień.

API zostało zaprojektowane zgodnie z zasadami REST, wykorzystuje standardowe kody odpowiedzi HTTP i uwierzytelnianie za pomocą klucza API. Wszystkie dane wymieniane są w formacie JSON.

Attachment

deleteAttachmentAttachmentId

delete attachment

Trwale usuwa plik załącznika oraz jego powiązanie z fakturą. Operacja jest nieodwracalna.

/attachment/{attachmentId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/attachment/{attachmentId}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AttachmentApi apiInstance = new AttachmentApi();
        UUID attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) załącznika.

        try {
            apiInstance.deleteAttachmentAttachmentId(attachmentId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#deleteAttachmentAttachmentId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID attachmentId = new UUID(); // UUID | Identyfikator (UUID) załącznika.

try {
    final result = await api_instance.deleteAttachmentAttachmentId(attachmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteAttachmentAttachmentId: $e\n');
}

import org.openapitools.client.api.AttachmentApi;

public class AttachmentApiExample {
    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        UUID attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) załącznika.

        try {
            apiInstance.deleteAttachmentAttachmentId(attachmentId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#deleteAttachmentAttachmentId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
AttachmentApi *apiInstance = [[AttachmentApi alloc] init];
UUID *attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identyfikator (UUID) załącznika. (default to null)

// delete attachment
[apiInstance deleteAttachmentAttachmentIdWith:attachmentId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.AttachmentApi()
var attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identyfikator (UUID) załącznika.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAttachmentAttachmentId(attachmentId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteAttachmentAttachmentIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new AttachmentApi();
            var attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identyfikator (UUID) załącznika. (default to null)

            try {
                // delete attachment
                apiInstance.deleteAttachmentAttachmentId(attachmentId);
            } catch (Exception e) {
                Debug.Print("Exception when calling AttachmentApi.deleteAttachmentAttachmentId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AttachmentApi();
$attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) załącznika.

try {
    $api_instance->deleteAttachmentAttachmentId($attachmentId);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->deleteAttachmentAttachmentId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AttachmentApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AttachmentApi->new();
my $attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identyfikator (UUID) załącznika.

eval {
    $api_instance->deleteAttachmentAttachmentId(attachmentId => $attachmentId);
};
if ($@) {
    warn "Exception when calling AttachmentApi->deleteAttachmentAttachmentId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AttachmentApi()
attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identyfikator (UUID) załącznika. (default to null)

try:
    # delete attachment
    api_instance.delete_attachment_attachment_id(attachmentId)
except ApiException as e:
    print("Exception when calling AttachmentApi->deleteAttachmentAttachmentId: %s\n" % e)

extern crate AttachmentApi;

pub fn main() {
    let attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = AttachmentApi::Context::default();
    let result = client.deleteAttachmentAttachmentId(attachmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
attachmentId*	UUID (uuid) Identyfikator (UUID) załącznika. Required

Responses

Schema

Schema

getAttachmentAttachmentId

get attachment content

Pobiera (download) plik załącznika na podstawie jego identyfikatora.

/attachment/{attachmentId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/octet-stream,application/json" \
 "https://ksef.devapo.app/api/rest/v1/attachment/{attachmentId}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AttachmentApi;

import java.io.File;
import java.util.*;

public class AttachmentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AttachmentApi apiInstance = new AttachmentApi();
        UUID attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) załącznika.

        try {
            File result = apiInstance.getAttachmentAttachmentId(attachmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#getAttachmentAttachmentId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID attachmentId = new UUID(); // UUID | Identyfikator (UUID) załącznika.

try {
    final result = await api_instance.getAttachmentAttachmentId(attachmentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAttachmentAttachmentId: $e\n');
}

import org.openapitools.client.api.AttachmentApi;

public class AttachmentApiExample {
    public static void main(String[] args) {
        AttachmentApi apiInstance = new AttachmentApi();
        UUID attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) załącznika.

        try {
            File result = apiInstance.getAttachmentAttachmentId(attachmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentApi#getAttachmentAttachmentId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
AttachmentApi *apiInstance = [[AttachmentApi alloc] init];
UUID *attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identyfikator (UUID) załącznika. (default to null)

// get attachment content
[apiInstance getAttachmentAttachmentIdWith:attachmentId
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.AttachmentApi()
var attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identyfikator (UUID) załącznika.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAttachmentAttachmentId(attachmentId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAttachmentAttachmentIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new AttachmentApi();
            var attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identyfikator (UUID) załącznika. (default to null)

            try {
                // get attachment content
                File result = apiInstance.getAttachmentAttachmentId(attachmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AttachmentApi.getAttachmentAttachmentId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AttachmentApi();
$attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) załącznika.

try {
    $result = $api_instance->getAttachmentAttachmentId($attachmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentApi->getAttachmentAttachmentId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AttachmentApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AttachmentApi->new();
my $attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identyfikator (UUID) załącznika.

eval {
    my $result = $api_instance->getAttachmentAttachmentId(attachmentId => $attachmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AttachmentApi->getAttachmentAttachmentId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AttachmentApi()
attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identyfikator (UUID) załącznika. (default to null)

try:
    # get attachment content
    api_response = api_instance.get_attachment_attachment_id(attachmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttachmentApi->getAttachmentAttachmentId: %s\n" % e)

extern crate AttachmentApi;

pub fn main() {
    let attachmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = AttachmentApi::Context::default();
    let result = client.getAttachmentAttachmentId(attachmentId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
attachmentId*	UUID (uuid) Identyfikator (UUID) załącznika. Required

Responses

Schema

Schema

Schema

Draft

deleteDraftInvoiceDraftId

delete draft

Trwale usuwa wersję roboczą faktury. Operacja jest nieodwracalna i możliwa tylko dla draftów, które nie zostały jeszcze wysłane do KSeF.

/draft/{draftInvoiceId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/draft/{draftInvoiceId}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DraftApi;

import java.io.File;
import java.util.*;

public class DraftApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

        try {
            apiInstance.deleteDraftInvoiceDraftId(draftInvoiceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#deleteDraftInvoiceDraftId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID draftInvoiceId = new UUID(); // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

try {
    final result = await api_instance.deleteDraftInvoiceDraftId(draftInvoiceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteDraftInvoiceDraftId: $e\n');
}

import org.openapitools.client.api.DraftApi;

public class DraftApiExample {
    public static void main(String[] args) {
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

        try {
            apiInstance.deleteDraftInvoiceDraftId(draftInvoiceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#deleteDraftInvoiceDraftId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DraftApi *apiInstance = [[DraftApi alloc] init];
UUID *draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

// delete draft
[apiInstance deleteDraftInvoiceDraftIdWith:draftInvoiceId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.DraftApi()
var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // {UUID} Techniczny identyfikator (UUID) wersji roboczej faktury.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDraftInvoiceDraftId(draftInvoiceId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteDraftInvoiceDraftIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DraftApi();
            var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851;  // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

            try {
                // delete draft
                apiInstance.deleteDraftInvoiceDraftId(draftInvoiceId);
            } catch (Exception e) {
                Debug.Print("Exception when calling DraftApi.deleteDraftInvoiceDraftId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DraftApi();
$draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

try {
    $api_instance->deleteDraftInvoiceDraftId($draftInvoiceId);
} catch (Exception $e) {
    echo 'Exception when calling DraftApi->deleteDraftInvoiceDraftId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DraftApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DraftApi->new();
my $draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

eval {
    $api_instance->deleteDraftInvoiceDraftId(draftInvoiceId => $draftInvoiceId);
};
if ($@) {
    warn "Exception when calling DraftApi->deleteDraftInvoiceDraftId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DraftApi()
draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851 # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

try:
    # delete draft
    api_instance.delete_draft_invoice_draft_id(draftInvoiceId)
except ApiException as e:
    print("Exception when calling DraftApi->deleteDraftInvoiceDraftId: %s\n" % e)

extern crate DraftApi;

pub fn main() {
    let draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID

    let mut context = DraftApi::Context::default();
    let result = client.deleteDraftInvoiceDraftId(draftInvoiceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
draftInvoiceId*	UUID (uuid) Techniczny identyfikator (UUID) wersji roboczej faktury. Required

Responses

Schema

Schema

getDraftDraftInvoiceIdAttachment

get attachments

Zwraca listę metadanych wszystkich załączników powiązanych z daną wersją roboczą faktury.

/draft/{draftInvoiceId}/attachment

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/draft/{draftInvoiceId}/attachment"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DraftApi;

import java.io.File;
import java.util.*;

public class DraftApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

        try {
            array[Invoice-Attachment] result = apiInstance.getDraftDraftInvoiceIdAttachment(draftInvoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#getDraftDraftInvoiceIdAttachment");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID draftInvoiceId = new UUID(); // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

try {
    final result = await api_instance.getDraftDraftInvoiceIdAttachment(draftInvoiceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDraftDraftInvoiceIdAttachment: $e\n');
}

import org.openapitools.client.api.DraftApi;

public class DraftApiExample {
    public static void main(String[] args) {
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

        try {
            array[Invoice-Attachment] result = apiInstance.getDraftDraftInvoiceIdAttachment(draftInvoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#getDraftDraftInvoiceIdAttachment");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DraftApi *apiInstance = [[DraftApi alloc] init];
UUID *draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

// get attachments
[apiInstance getDraftDraftInvoiceIdAttachmentWith:draftInvoiceId
              completionHandler: ^(array[Invoice-Attachment] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.DraftApi()
var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // {UUID} Techniczny identyfikator (UUID) wersji roboczej faktury.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDraftDraftInvoiceIdAttachment(draftInvoiceId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDraftDraftInvoiceIdAttachmentExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DraftApi();
            var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851;  // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

            try {
                // get attachments
                array[Invoice-Attachment] result = apiInstance.getDraftDraftInvoiceIdAttachment(draftInvoiceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DraftApi.getDraftDraftInvoiceIdAttachment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DraftApi();
$draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

try {
    $result = $api_instance->getDraftDraftInvoiceIdAttachment($draftInvoiceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DraftApi->getDraftDraftInvoiceIdAttachment: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DraftApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DraftApi->new();
my $draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

eval {
    my $result = $api_instance->getDraftDraftInvoiceIdAttachment(draftInvoiceId => $draftInvoiceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DraftApi->getDraftDraftInvoiceIdAttachment: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DraftApi()
draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851 # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

try:
    # get attachments
    api_response = api_instance.get_draft_draft_invoice_id_attachment(draftInvoiceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DraftApi->getDraftDraftInvoiceIdAttachment: %s\n" % e)

extern crate DraftApi;

pub fn main() {
    let draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID

    let mut context = DraftApi::Context::default();
    let result = client.getDraftDraftInvoiceIdAttachment(draftInvoiceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
draftInvoiceId*	UUID (uuid) Techniczny identyfikator (UUID) wersji roboczej faktury. Required

Responses

Schema

Schema

Schema

getDraftInvoiceDraftId

get draft details

Pobiera pełne dane konkretnej wersji roboczej faktury na podstawie jej identyfikatora.

/draft/{draftInvoiceId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/draft/{draftInvoiceId}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DraftApi;

import java.io.File;
import java.util.*;

public class DraftApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

        try {
            Draft-Invoice result = apiInstance.getDraftInvoiceDraftId(draftInvoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#getDraftInvoiceDraftId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID draftInvoiceId = new UUID(); // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

try {
    final result = await api_instance.getDraftInvoiceDraftId(draftInvoiceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDraftInvoiceDraftId: $e\n');
}

import org.openapitools.client.api.DraftApi;

public class DraftApiExample {
    public static void main(String[] args) {
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

        try {
            Draft-Invoice result = apiInstance.getDraftInvoiceDraftId(draftInvoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#getDraftInvoiceDraftId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DraftApi *apiInstance = [[DraftApi alloc] init];
UUID *draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

// get draft details
[apiInstance getDraftInvoiceDraftIdWith:draftInvoiceId
              completionHandler: ^(Draft-Invoice output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.DraftApi()
var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // {UUID} Techniczny identyfikator (UUID) wersji roboczej faktury.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDraftInvoiceDraftId(draftInvoiceId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDraftInvoiceDraftIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DraftApi();
            var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851;  // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

            try {
                // get draft details
                Draft-Invoice result = apiInstance.getDraftInvoiceDraftId(draftInvoiceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DraftApi.getDraftInvoiceDraftId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DraftApi();
$draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

try {
    $result = $api_instance->getDraftInvoiceDraftId($draftInvoiceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DraftApi->getDraftInvoiceDraftId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DraftApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DraftApi->new();
my $draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

eval {
    my $result = $api_instance->getDraftInvoiceDraftId(draftInvoiceId => $draftInvoiceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DraftApi->getDraftInvoiceDraftId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DraftApi()
draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851 # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

try:
    # get draft details
    api_response = api_instance.get_draft_invoice_draft_id(draftInvoiceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DraftApi->getDraftInvoiceDraftId: %s\n" % e)

extern crate DraftApi;

pub fn main() {
    let draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID

    let mut context = DraftApi::Context::default();
    let result = client.getDraftInvoiceDraftId(draftInvoiceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
draftInvoiceId*	UUID (uuid) Techniczny identyfikator (UUID) wersji roboczej faktury. Required

Responses

Schema

Schema

Schema

getDraftVisualization

get draft invoice visualization

Generuje i zwraca wizualizację wersji roboczej faktury w formacie PDF. Umożliwia podgląd dokumentu przed wysłaniem do KSeF.

/draft/{draftInvoiceId}/visualization

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/pdf,application/json" \
 "https://ksef.devapo.app/api/rest/v1/draft/{draftInvoiceId}/visualization?templateId=templateId_example&includeAttachments=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DraftApi;

import java.io.File;
import java.util.*;

public class DraftApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
        String templateId = templateId_example; // String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
        Boolean includeAttachments = true; // Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki?

        try {
            File result = apiInstance.getDraftVisualization(draftInvoiceId, templateId, includeAttachments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#getDraftVisualization");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID draftInvoiceId = new UUID(); // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
final String templateId = new String(); // String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
final Boolean includeAttachments = new Boolean(); // Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki?

try {
    final result = await api_instance.getDraftVisualization(draftInvoiceId, templateId, includeAttachments);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDraftVisualization: $e\n');
}

import org.openapitools.client.api.DraftApi;

public class DraftApiExample {
    public static void main(String[] args) {
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
        String templateId = templateId_example; // String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
        Boolean includeAttachments = true; // Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki?

        try {
            File result = apiInstance.getDraftVisualization(draftInvoiceId, templateId, includeAttachments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#getDraftVisualization");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DraftApi *apiInstance = [[DraftApi alloc] init];
UUID *draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)
String *templateId = templateId_example; // Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon. (optional) (default to null)
Boolean *includeAttachments = true; // Czy do wizualizacji PDF dołączyć powiązane załączniki? (optional) (default to false)

// get draft invoice visualization
[apiInstance getDraftVisualizationWith:draftInvoiceId
    templateId:templateId
    includeAttachments:includeAttachments
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.DraftApi()
var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // {UUID} Techniczny identyfikator (UUID) wersji roboczej faktury.
var opts = {
  'templateId': templateId_example, // {String} Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
  'includeAttachments': true // {Boolean} Czy do wizualizacji PDF dołączyć powiązane załączniki?
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDraftVisualization(draftInvoiceId, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDraftVisualizationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DraftApi();
            var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851;  // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)
            var templateId = templateId_example;  // String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon. (optional)  (default to null)
            var includeAttachments = true;  // Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki? (optional)  (default to false)

            try {
                // get draft invoice visualization
                File result = apiInstance.getDraftVisualization(draftInvoiceId, templateId, includeAttachments);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DraftApi.getDraftVisualization: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DraftApi();
$draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
$templateId = templateId_example; // String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
$includeAttachments = true; // Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki?

try {
    $result = $api_instance->getDraftVisualization($draftInvoiceId, $templateId, $includeAttachments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DraftApi->getDraftVisualization: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DraftApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DraftApi->new();
my $draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
my $templateId = templateId_example; # String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
my $includeAttachments = true; # Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki?

eval {
    my $result = $api_instance->getDraftVisualization(draftInvoiceId => $draftInvoiceId, templateId => $templateId, includeAttachments => $includeAttachments);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DraftApi->getDraftVisualization: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DraftApi()
draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851 # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)
templateId = templateId_example # String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon. (optional) (default to null)
includeAttachments = true # Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki? (optional) (default to false)

try:
    # get draft invoice visualization
    api_response = api_instance.get_draft_visualization(draftInvoiceId, templateId=templateId, includeAttachments=includeAttachments)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DraftApi->getDraftVisualization: %s\n" % e)

extern crate DraftApi;

pub fn main() {
    let draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID
    let templateId = templateId_example; // String
    let includeAttachments = true; // Boolean

    let mut context = DraftApi::Context::default();
    let result = client.getDraftVisualization(draftInvoiceId, templateId, includeAttachments, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
draftInvoiceId*	UUID (uuid) Techniczny identyfikator (UUID) wersji roboczej faktury. Required

Query parameters

Name	Description
templateId	String Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
includeAttachments	Boolean Czy do wizualizacji PDF dołączyć powiązane załączniki?

Responses

Schema

Schema

Schema

patchDraftInvoiceDraftId

update draft

Aktualizuje dane istniejącej wersji roboczej faktury. Pozwala na modyfikację treści faktury przed wysłaniem jej do KSeF. Można również użyć tej operacji do zainicjowania procesu wysyłki do KSeF poprzez ustawienie flagi `sendAfterValidation`.

/draft/{draftInvoiceId}

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://ksef.devapo.app/api/rest/v1/draft/{draftInvoiceId}" \
 -d ''

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DraftApi;

import java.io.File;
import java.util.*;

public class DraftApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
        DraftInvoiceInput draftInvoiceInput = ; // DraftInvoiceInput | 

        try {
            Draft-Invoice result = apiInstance.patchDraftInvoiceDraftId(draftInvoiceId, draftInvoiceInput);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#patchDraftInvoiceDraftId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID draftInvoiceId = new UUID(); // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
final DraftInvoiceInput draftInvoiceInput = new DraftInvoiceInput(); // DraftInvoiceInput | 

try {
    final result = await api_instance.patchDraftInvoiceDraftId(draftInvoiceId, draftInvoiceInput);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->patchDraftInvoiceDraftId: $e\n');
}

import org.openapitools.client.api.DraftApi;

public class DraftApiExample {
    public static void main(String[] args) {
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
        DraftInvoiceInput draftInvoiceInput = ; // DraftInvoiceInput | 

        try {
            Draft-Invoice result = apiInstance.patchDraftInvoiceDraftId(draftInvoiceId, draftInvoiceInput);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#patchDraftInvoiceDraftId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DraftApi *apiInstance = [[DraftApi alloc] init];
UUID *draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)
DraftInvoiceInput *draftInvoiceInput = ; // 

// update draft
[apiInstance patchDraftInvoiceDraftIdWith:draftInvoiceId
    draftInvoiceInput:draftInvoiceInput
              completionHandler: ^(Draft-Invoice output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.DraftApi()
var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // {UUID} Techniczny identyfikator (UUID) wersji roboczej faktury.
var draftInvoiceInput = ; // {DraftInvoiceInput} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchDraftInvoiceDraftId(draftInvoiceId, draftInvoiceInput, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class patchDraftInvoiceDraftIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DraftApi();
            var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851;  // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)
            var draftInvoiceInput = new DraftInvoiceInput(); // DraftInvoiceInput | 

            try {
                // update draft
                Draft-Invoice result = apiInstance.patchDraftInvoiceDraftId(draftInvoiceId, draftInvoiceInput);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DraftApi.patchDraftInvoiceDraftId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DraftApi();
$draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
$draftInvoiceInput = ; // DraftInvoiceInput | 

try {
    $result = $api_instance->patchDraftInvoiceDraftId($draftInvoiceId, $draftInvoiceInput);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DraftApi->patchDraftInvoiceDraftId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DraftApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DraftApi->new();
my $draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
my $draftInvoiceInput = WWW::OPenAPIClient::Object::DraftInvoiceInput->new(); # DraftInvoiceInput | 

eval {
    my $result = $api_instance->patchDraftInvoiceDraftId(draftInvoiceId => $draftInvoiceId, draftInvoiceInput => $draftInvoiceInput);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DraftApi->patchDraftInvoiceDraftId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DraftApi()
draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851 # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)
draftInvoiceInput =  # DraftInvoiceInput | 

try:
    # update draft
    api_response = api_instance.patch_draft_invoice_draft_id(draftInvoiceId, draftInvoiceInput)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DraftApi->patchDraftInvoiceDraftId: %s\n" % e)

extern crate DraftApi;

pub fn main() {
    let draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID
    let draftInvoiceInput = ; // DraftInvoiceInput

    let mut context = DraftApi::Context::default();
    let result = client.patchDraftInvoiceDraftId(draftInvoiceId, draftInvoiceInput, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
draftInvoiceId*	UUID (uuid) Techniczny identyfikator (UUID) wersji roboczej faktury. Required

Body parameters

Name	Description
draftInvoiceInput *	Obiekt JSON z polami do zaktualizowania.

Responses

Schema

Schema

Schema

Schema

Schema

postDraft

create new invoice draft

Tworzy nową wersję roboczą (draft) faktury. Jest to pierwszy krok w bezpiecznym procesie wysyłania faktury do KSeF. Operacja może działać w kilku trybach: - **Tylko utwórz**: Zapisuje draft w systemie. - **Utwórz i zwaliduj**: Zapisuje draft i od razu uruchamia walidację pod kątem zgodności ze schemą KSeF. - **Utwórz, zwaliduj i wyślij**: Pełen automat - tworzy draft, waliduje go, a jeśli walidacja jest poprawna, od razu zleca wysyłkę do KSeF.

/draft

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://ksef.devapo.app/api/rest/v1/draft" \
 -d ''

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DraftApi;

import java.io.File;
import java.util.*;

public class DraftApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DraftApi apiInstance = new DraftApi();
        DraftInvoiceInput draftInvoiceInput = {sendAfterValidation=false, invoice={$ref=#/components/examples/SampleInvoice}}; // DraftInvoiceInput | 

        try {
            Draft-Invoice result = apiInstance.postDraft(draftInvoiceInput);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#postDraft");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final DraftInvoiceInput draftInvoiceInput = new DraftInvoiceInput(); // DraftInvoiceInput | 

try {
    final result = await api_instance.postDraft(draftInvoiceInput);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postDraft: $e\n');
}

import org.openapitools.client.api.DraftApi;

public class DraftApiExample {
    public static void main(String[] args) {
        DraftApi apiInstance = new DraftApi();
        DraftInvoiceInput draftInvoiceInput = {sendAfterValidation=false, invoice={$ref=#/components/examples/SampleInvoice}}; // DraftInvoiceInput | 

        try {
            Draft-Invoice result = apiInstance.postDraft(draftInvoiceInput);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#postDraft");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DraftApi *apiInstance = [[DraftApi alloc] init];
DraftInvoiceInput *draftInvoiceInput = {sendAfterValidation=false, invoice={$ref=#/components/examples/SampleInvoice}}; // 

// create new invoice draft
[apiInstance postDraftWith:draftInvoiceInput
              completionHandler: ^(Draft-Invoice output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.DraftApi()
var draftInvoiceInput = {sendAfterValidation=false, invoice={$ref=#/components/examples/SampleInvoice}}; // {DraftInvoiceInput} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postDraft(draftInvoiceInput, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postDraftExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DraftApi();
            var draftInvoiceInput = new DraftInvoiceInput(); // DraftInvoiceInput | 

            try {
                // create new invoice draft
                Draft-Invoice result = apiInstance.postDraft(draftInvoiceInput);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DraftApi.postDraft: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DraftApi();
$draftInvoiceInput = {sendAfterValidation=false, invoice={$ref=#/components/examples/SampleInvoice}}; // DraftInvoiceInput | 

try {
    $result = $api_instance->postDraft($draftInvoiceInput);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DraftApi->postDraft: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DraftApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DraftApi->new();
my $draftInvoiceInput = WWW::OPenAPIClient::Object::DraftInvoiceInput->new(); # DraftInvoiceInput | 

eval {
    my $result = $api_instance->postDraft(draftInvoiceInput => $draftInvoiceInput);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DraftApi->postDraft: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DraftApi()
draftInvoiceInput = {sendAfterValidation=false, invoice={$ref=#/components/examples/SampleInvoice}} # DraftInvoiceInput | 

try:
    # create new invoice draft
    api_response = api_instance.post_draft(draftInvoiceInput)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DraftApi->postDraft: %s\n" % e)

extern crate DraftApi;

pub fn main() {
    let draftInvoiceInput = {sendAfterValidation=false, invoice={$ref=#/components/examples/SampleInvoice}}; // DraftInvoiceInput

    let mut context = DraftApi::Context::default();
    let result = client.postDraft(draftInvoiceInput, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters

Name	Description
draftInvoiceInput *	Obiekt JSON zawierający dane faktury oraz flagi sterujące procesem.

Responses

Schema

Schema

Schema

Schema

postDraftDraftInvoiceIdAttachment

add attachment

Dodaje plik (np. umowę, protokół) jako załącznik do wersji roboczej faktury. Plik jest przesyłany w formacie `multipart/form-data`.

/draft/{draftInvoiceId}/attachment

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://ksef.devapo.app/api/rest/v1/draft/{draftInvoiceId}/attachment"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DraftApi;

import java.io.File;
import java.util.*;

public class DraftApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
        File file = BINARY_DATA_HERE; // File | Plik do załączenia.
        String description = description_example; // String | Opcjonalny opis załącznika.

        try {
            Invoice-Attachment result = apiInstance.postDraftDraftInvoiceIdAttachment(draftInvoiceId, file, description);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#postDraftDraftInvoiceIdAttachment");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID draftInvoiceId = new UUID(); // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
final File file = new File(); // File | Plik do załączenia.
final String description = new String(); // String | Opcjonalny opis załącznika.

try {
    final result = await api_instance.postDraftDraftInvoiceIdAttachment(draftInvoiceId, file, description);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postDraftDraftInvoiceIdAttachment: $e\n');
}

import org.openapitools.client.api.DraftApi;

public class DraftApiExample {
    public static void main(String[] args) {
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
        File file = BINARY_DATA_HERE; // File | Plik do załączenia.
        String description = description_example; // String | Opcjonalny opis załącznika.

        try {
            Invoice-Attachment result = apiInstance.postDraftDraftInvoiceIdAttachment(draftInvoiceId, file, description);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#postDraftDraftInvoiceIdAttachment");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DraftApi *apiInstance = [[DraftApi alloc] init];
UUID *draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)
File *file = BINARY_DATA_HERE; // Plik do załączenia. (optional) (default to null)
String *description = description_example; // Opcjonalny opis załącznika. (optional) (default to null)

// add attachment
[apiInstance postDraftDraftInvoiceIdAttachmentWith:draftInvoiceId
    file:file
    description:description
              completionHandler: ^(Invoice-Attachment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.DraftApi()
var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // {UUID} Techniczny identyfikator (UUID) wersji roboczej faktury.
var opts = {
  'file': BINARY_DATA_HERE, // {File} Plik do załączenia.
  'description': description_example // {String} Opcjonalny opis załącznika.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postDraftDraftInvoiceIdAttachment(draftInvoiceId, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postDraftDraftInvoiceIdAttachmentExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DraftApi();
            var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851;  // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)
            var file = BINARY_DATA_HERE;  // File | Plik do załączenia. (optional)  (default to null)
            var description = description_example;  // String | Opcjonalny opis załącznika. (optional)  (default to null)

            try {
                // add attachment
                Invoice-Attachment result = apiInstance.postDraftDraftInvoiceIdAttachment(draftInvoiceId, file, description);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DraftApi.postDraftDraftInvoiceIdAttachment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DraftApi();
$draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
$file = BINARY_DATA_HERE; // File | Plik do załączenia.
$description = description_example; // String | Opcjonalny opis załącznika.

try {
    $result = $api_instance->postDraftDraftInvoiceIdAttachment($draftInvoiceId, $file, $description);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DraftApi->postDraftDraftInvoiceIdAttachment: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DraftApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DraftApi->new();
my $draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.
my $file = BINARY_DATA_HERE; # File | Plik do załączenia.
my $description = description_example; # String | Opcjonalny opis załącznika.

eval {
    my $result = $api_instance->postDraftDraftInvoiceIdAttachment(draftInvoiceId => $draftInvoiceId, file => $file, description => $description);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DraftApi->postDraftDraftInvoiceIdAttachment: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DraftApi()
draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851 # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)
file = BINARY_DATA_HERE # File | Plik do załączenia. (optional) (default to null)
description = description_example # String | Opcjonalny opis załącznika. (optional) (default to null)

try:
    # add attachment
    api_response = api_instance.post_draft_draft_invoice_id_attachment(draftInvoiceId, file=file, description=description)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DraftApi->postDraftDraftInvoiceIdAttachment: %s\n" % e)

extern crate DraftApi;

pub fn main() {
    let draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID
    let file = BINARY_DATA_HERE; // File
    let description = description_example; // String

    let mut context = DraftApi::Context::default();
    let result = client.postDraftDraftInvoiceIdAttachment(draftInvoiceId, file, description, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
draftInvoiceId*	UUID (uuid) Techniczny identyfikator (UUID) wersji roboczej faktury. Required

Form parameters

Name	Description
file	File (binary) Plik do załączenia.
description	String Opcjonalny opis załącznika.

Responses

Schema

Schema

Schema

Schema

postDraftInvoiceDraftId

validate draft

Uruchamia proces walidacji wersji roboczej faktury pod kątem zgodności ze schematem KSeF. Jest to operacja asynchroniczna.

/draft/{draftInvoiceId}

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/draft/{draftInvoiceId}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DraftApi;

import java.io.File;
import java.util.*;

public class DraftApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

        try {
            apiInstance.postDraftInvoiceDraftId(draftInvoiceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#postDraftInvoiceDraftId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID draftInvoiceId = new UUID(); // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

try {
    final result = await api_instance.postDraftInvoiceDraftId(draftInvoiceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postDraftInvoiceDraftId: $e\n');
}

import org.openapitools.client.api.DraftApi;

public class DraftApiExample {
    public static void main(String[] args) {
        DraftApi apiInstance = new DraftApi();
        UUID draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

        try {
            apiInstance.postDraftInvoiceDraftId(draftInvoiceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DraftApi#postDraftInvoiceDraftId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
DraftApi *apiInstance = [[DraftApi alloc] init];
UUID *draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

// validate draft
[apiInstance postDraftInvoiceDraftIdWith:draftInvoiceId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.DraftApi()
var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // {UUID} Techniczny identyfikator (UUID) wersji roboczej faktury.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postDraftInvoiceDraftId(draftInvoiceId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postDraftInvoiceDraftIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DraftApi();
            var draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851;  // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

            try {
                // validate draft
                apiInstance.postDraftInvoiceDraftId(draftInvoiceId);
            } catch (Exception e) {
                Debug.Print("Exception when calling DraftApi.postDraftInvoiceDraftId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DraftApi();
$draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

try {
    $api_instance->postDraftInvoiceDraftId($draftInvoiceId);
} catch (Exception $e) {
    echo 'Exception when calling DraftApi->postDraftInvoiceDraftId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DraftApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DraftApi->new();
my $draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury.

eval {
    $api_instance->postDraftInvoiceDraftId(draftInvoiceId => $draftInvoiceId);
};
if ($@) {
    warn "Exception when calling DraftApi->postDraftInvoiceDraftId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DraftApi()
draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851 # UUID | Techniczny identyfikator (UUID) wersji roboczej faktury. (default to null)

try:
    # validate draft
    api_instance.post_draft_invoice_draft_id(draftInvoiceId)
except ApiException as e:
    print("Exception when calling DraftApi->postDraftInvoiceDraftId: %s\n" % e)

extern crate DraftApi;

pub fn main() {
    let draftInvoiceId = d290f1ee-6c54-4b01-90e6-d701748f0851; // UUID

    let mut context = DraftApi::Context::default();
    let result = client.postDraftInvoiceDraftId(draftInvoiceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
draftInvoiceId*	UUID (uuid) Techniczny identyfikator (UUID) wersji roboczej faktury. Required

Responses

Schema

Schema

Schema

Invoice

getInvoiceBatchBatchProcessId

get batch process status

Pobiera aktualny status i postęp przetwarzania paczki faktur.

/invoice/batch/{batchProcessId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/invoice/batch/{batchProcessId}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvoiceApi;

import java.io.File;
import java.util.*;

public class InvoiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        InvoiceApi apiInstance = new InvoiceApi();
        UUID batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) procesu wsadowego.

        try {
            Batch-Process result = apiInstance.getInvoiceBatchBatchProcessId(batchProcessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#getInvoiceBatchBatchProcessId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID batchProcessId = new UUID(); // UUID | Identyfikator (UUID) procesu wsadowego.

try {
    final result = await api_instance.getInvoiceBatchBatchProcessId(batchProcessId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getInvoiceBatchBatchProcessId: $e\n');
}

import org.openapitools.client.api.InvoiceApi;

public class InvoiceApiExample {
    public static void main(String[] args) {
        InvoiceApi apiInstance = new InvoiceApi();
        UUID batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) procesu wsadowego.

        try {
            Batch-Process result = apiInstance.getInvoiceBatchBatchProcessId(batchProcessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#getInvoiceBatchBatchProcessId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
InvoiceApi *apiInstance = [[InvoiceApi alloc] init];
UUID *batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identyfikator (UUID) procesu wsadowego. (default to null)

// get batch process status
[apiInstance getInvoiceBatchBatchProcessIdWith:batchProcessId
              completionHandler: ^(Batch-Process output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.InvoiceApi()
var batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identyfikator (UUID) procesu wsadowego.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInvoiceBatchBatchProcessId(batchProcessId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getInvoiceBatchBatchProcessIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new InvoiceApi();
            var batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identyfikator (UUID) procesu wsadowego. (default to null)

            try {
                // get batch process status
                Batch-Process result = apiInstance.getInvoiceBatchBatchProcessId(batchProcessId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvoiceApi.getInvoiceBatchBatchProcessId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvoiceApi();
$batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) procesu wsadowego.

try {
    $result = $api_instance->getInvoiceBatchBatchProcessId($batchProcessId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->getInvoiceBatchBatchProcessId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvoiceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvoiceApi->new();
my $batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identyfikator (UUID) procesu wsadowego.

eval {
    my $result = $api_instance->getInvoiceBatchBatchProcessId(batchProcessId => $batchProcessId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvoiceApi->getInvoiceBatchBatchProcessId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.InvoiceApi()
batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identyfikator (UUID) procesu wsadowego. (default to null)

try:
    # get batch process status
    api_response = api_instance.get_invoice_batch_batch_process_id(batchProcessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvoiceApi->getInvoiceBatchBatchProcessId: %s\n" % e)

extern crate InvoiceApi;

pub fn main() {
    let batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = InvoiceApi::Context::default();
    let result = client.getInvoiceBatchBatchProcessId(batchProcessId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
batchProcessId*	UUID (uuid) Identyfikator (UUID) procesu wsadowego. Required

Responses

Schema

Schema

Schema

getInvoiceInvoiceId

get invoice details

Pobiera pełne dane faktury (zarówno sprzedażowej, jak i kosztowej) na podstawie jej numeru KSeF.

/invoice/{invoiceId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/invoice/{invoiceId}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvoiceApi;

import java.io.File;
import java.util.*;

public class InvoiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        InvoiceApi apiInstance = new InvoiceApi();
        String invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.

        try {
            Invoice result = apiInstance.getInvoiceInvoiceId(invoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#getInvoiceInvoiceId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String invoiceId = new String(); // String | Oficjalny numer KSeF faktury.

try {
    final result = await api_instance.getInvoiceInvoiceId(invoiceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getInvoiceInvoiceId: $e\n');
}

import org.openapitools.client.api.InvoiceApi;

public class InvoiceApiExample {
    public static void main(String[] args) {
        InvoiceApi apiInstance = new InvoiceApi();
        String invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.

        try {
            Invoice result = apiInstance.getInvoiceInvoiceId(invoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#getInvoiceInvoiceId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
InvoiceApi *apiInstance = [[InvoiceApi alloc] init];
String *invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // Oficjalny numer KSeF faktury. (default to null)

// get invoice details
[apiInstance getInvoiceInvoiceIdWith:invoiceId
              completionHandler: ^(Invoice output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.InvoiceApi()
var invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // {String} Oficjalny numer KSeF faktury.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInvoiceInvoiceId(invoiceId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getInvoiceInvoiceIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new InvoiceApi();
            var invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01;  // String | Oficjalny numer KSeF faktury. (default to null)

            try {
                // get invoice details
                Invoice result = apiInstance.getInvoiceInvoiceId(invoiceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvoiceApi.getInvoiceInvoiceId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvoiceApi();
$invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.

try {
    $result = $api_instance->getInvoiceInvoiceId($invoiceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->getInvoiceInvoiceId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvoiceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvoiceApi->new();
my $invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; # String | Oficjalny numer KSeF faktury.

eval {
    my $result = $api_instance->getInvoiceInvoiceId(invoiceId => $invoiceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvoiceApi->getInvoiceInvoiceId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.InvoiceApi()
invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01 # String | Oficjalny numer KSeF faktury. (default to null)

try:
    # get invoice details
    api_response = api_instance.get_invoice_invoice_id(invoiceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvoiceApi->getInvoiceInvoiceId: %s\n" % e)

extern crate InvoiceApi;

pub fn main() {
    let invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String

    let mut context = InvoiceApi::Context::default();
    let result = client.getInvoiceInvoiceId(invoiceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
invoiceId*	String Oficjalny numer KSeF faktury. Required

Responses

Schema

Schema

Schema

getInvoiceInvoiceIdAttachments

get invoice attachments

Pobiera listę metadanych wszystkich załączników powiązanych z daną fakturą.

/invoice/{invoiceId}/attachments

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/invoice/{invoiceId}/attachments"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvoiceApi;

import java.io.File;
import java.util.*;

public class InvoiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        InvoiceApi apiInstance = new InvoiceApi();
        String invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.

        try {
            array[Invoice-Attachment] result = apiInstance.getInvoiceInvoiceIdAttachments(invoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#getInvoiceInvoiceIdAttachments");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String invoiceId = new String(); // String | Oficjalny numer KSeF faktury.

try {
    final result = await api_instance.getInvoiceInvoiceIdAttachments(invoiceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getInvoiceInvoiceIdAttachments: $e\n');
}

import org.openapitools.client.api.InvoiceApi;

public class InvoiceApiExample {
    public static void main(String[] args) {
        InvoiceApi apiInstance = new InvoiceApi();
        String invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.

        try {
            array[Invoice-Attachment] result = apiInstance.getInvoiceInvoiceIdAttachments(invoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#getInvoiceInvoiceIdAttachments");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
InvoiceApi *apiInstance = [[InvoiceApi alloc] init];
String *invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // Oficjalny numer KSeF faktury. (default to null)

// get invoice attachments
[apiInstance getInvoiceInvoiceIdAttachmentsWith:invoiceId
              completionHandler: ^(array[Invoice-Attachment] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.InvoiceApi()
var invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // {String} Oficjalny numer KSeF faktury.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInvoiceInvoiceIdAttachments(invoiceId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getInvoiceInvoiceIdAttachmentsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new InvoiceApi();
            var invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01;  // String | Oficjalny numer KSeF faktury. (default to null)

            try {
                // get invoice attachments
                array[Invoice-Attachment] result = apiInstance.getInvoiceInvoiceIdAttachments(invoiceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvoiceApi.getInvoiceInvoiceIdAttachments: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvoiceApi();
$invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.

try {
    $result = $api_instance->getInvoiceInvoiceIdAttachments($invoiceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->getInvoiceInvoiceIdAttachments: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvoiceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvoiceApi->new();
my $invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; # String | Oficjalny numer KSeF faktury.

eval {
    my $result = $api_instance->getInvoiceInvoiceIdAttachments(invoiceId => $invoiceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvoiceApi->getInvoiceInvoiceIdAttachments: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.InvoiceApi()
invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01 # String | Oficjalny numer KSeF faktury. (default to null)

try:
    # get invoice attachments
    api_response = api_instance.get_invoice_invoice_id_attachments(invoiceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvoiceApi->getInvoiceInvoiceIdAttachments: %s\n" % e)

extern crate InvoiceApi;

pub fn main() {
    let invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String

    let mut context = InvoiceApi::Context::default();
    let result = client.getInvoiceInvoiceIdAttachments(invoiceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
invoiceId*	String Oficjalny numer KSeF faktury. Required

Responses

Schema

Schema

Schema

getInvoiceInvoiceIdUpo

get UPO for invoice

Pobiera Urzędowe Poświadczenie Odbioru (UPO) dla wysłanej faktury sprzedażowej. UPO jest dowodem na poprawne złożenie faktury w KSeF.

/invoice/{invoiceId}/upo

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/xml,application/json" \
 "https://ksef.devapo.app/api/rest/v1/invoice/{invoiceId}/upo"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvoiceApi;

import java.io.File;
import java.util.*;

public class InvoiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        InvoiceApi apiInstance = new InvoiceApi();
        String invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.

        try {
            UPO result = apiInstance.getInvoiceInvoiceIdUpo(invoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#getInvoiceInvoiceIdUpo");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String invoiceId = new String(); // String | Oficjalny numer KSeF faktury.

try {
    final result = await api_instance.getInvoiceInvoiceIdUpo(invoiceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getInvoiceInvoiceIdUpo: $e\n');
}

import org.openapitools.client.api.InvoiceApi;

public class InvoiceApiExample {
    public static void main(String[] args) {
        InvoiceApi apiInstance = new InvoiceApi();
        String invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.

        try {
            UPO result = apiInstance.getInvoiceInvoiceIdUpo(invoiceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#getInvoiceInvoiceIdUpo");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
InvoiceApi *apiInstance = [[InvoiceApi alloc] init];
String *invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // Oficjalny numer KSeF faktury. (default to null)

// get UPO for invoice
[apiInstance getInvoiceInvoiceIdUpoWith:invoiceId
              completionHandler: ^(UPO output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.InvoiceApi()
var invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // {String} Oficjalny numer KSeF faktury.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInvoiceInvoiceIdUpo(invoiceId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getInvoiceInvoiceIdUpoExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new InvoiceApi();
            var invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01;  // String | Oficjalny numer KSeF faktury. (default to null)

            try {
                // get UPO for invoice
                UPO result = apiInstance.getInvoiceInvoiceIdUpo(invoiceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvoiceApi.getInvoiceInvoiceIdUpo: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvoiceApi();
$invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.

try {
    $result = $api_instance->getInvoiceInvoiceIdUpo($invoiceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->getInvoiceInvoiceIdUpo: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvoiceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvoiceApi->new();
my $invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; # String | Oficjalny numer KSeF faktury.

eval {
    my $result = $api_instance->getInvoiceInvoiceIdUpo(invoiceId => $invoiceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvoiceApi->getInvoiceInvoiceIdUpo: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.InvoiceApi()
invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01 # String | Oficjalny numer KSeF faktury. (default to null)

try:
    # get UPO for invoice
    api_response = api_instance.get_invoice_invoice_id_upo(invoiceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvoiceApi->getInvoiceInvoiceIdUpo: %s\n" % e)

extern crate InvoiceApi;

pub fn main() {
    let invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String

    let mut context = InvoiceApi::Context::default();
    let result = client.getInvoiceInvoiceIdUpo(invoiceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
invoiceId*	String Oficjalny numer KSeF faktury. Required

Responses

Schema

Schema

Schema

getInvoiceInvoiceIdVisualization

get invoice visualization

Generuje i zwraca wizualizację faktury w formacie PDF.

/invoice/{invoiceId}/visualization

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/pdf,application/json" \
 "https://ksef.devapo.app/api/rest/v1/invoice/{invoiceId}/visualization?templateId=templateId_example&includeAttachments=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvoiceApi;

import java.io.File;
import java.util.*;

public class InvoiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        InvoiceApi apiInstance = new InvoiceApi();
        String invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.
        String templateId = templateId_example; // String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
        Boolean includeAttachments = true; // Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki?

        try {
            File result = apiInstance.getInvoiceInvoiceIdVisualization(invoiceId, templateId, includeAttachments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#getInvoiceInvoiceIdVisualization");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String invoiceId = new String(); // String | Oficjalny numer KSeF faktury.
final String templateId = new String(); // String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
final Boolean includeAttachments = new Boolean(); // Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki?

try {
    final result = await api_instance.getInvoiceInvoiceIdVisualization(invoiceId, templateId, includeAttachments);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getInvoiceInvoiceIdVisualization: $e\n');
}

import org.openapitools.client.api.InvoiceApi;

public class InvoiceApiExample {
    public static void main(String[] args) {
        InvoiceApi apiInstance = new InvoiceApi();
        String invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.
        String templateId = templateId_example; // String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
        Boolean includeAttachments = true; // Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki?

        try {
            File result = apiInstance.getInvoiceInvoiceIdVisualization(invoiceId, templateId, includeAttachments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#getInvoiceInvoiceIdVisualization");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
InvoiceApi *apiInstance = [[InvoiceApi alloc] init];
String *invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // Oficjalny numer KSeF faktury. (default to null)
String *templateId = templateId_example; // Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon. (optional) (default to null)
Boolean *includeAttachments = true; // Czy do wizualizacji PDF dołączyć powiązane załączniki? (optional) (default to false)

// get invoice visualization
[apiInstance getInvoiceInvoiceIdVisualizationWith:invoiceId
    templateId:templateId
    includeAttachments:includeAttachments
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.InvoiceApi()
var invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // {String} Oficjalny numer KSeF faktury.
var opts = {
  'templateId': templateId_example, // {String} Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
  'includeAttachments': true // {Boolean} Czy do wizualizacji PDF dołączyć powiązane załączniki?
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInvoiceInvoiceIdVisualization(invoiceId, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getInvoiceInvoiceIdVisualizationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new InvoiceApi();
            var invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01;  // String | Oficjalny numer KSeF faktury. (default to null)
            var templateId = templateId_example;  // String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon. (optional)  (default to null)
            var includeAttachments = true;  // Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki? (optional)  (default to false)

            try {
                // get invoice visualization
                File result = apiInstance.getInvoiceInvoiceIdVisualization(invoiceId, templateId, includeAttachments);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvoiceApi.getInvoiceInvoiceIdVisualization: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvoiceApi();
$invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.
$templateId = templateId_example; // String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
$includeAttachments = true; // Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki?

try {
    $result = $api_instance->getInvoiceInvoiceIdVisualization($invoiceId, $templateId, $includeAttachments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->getInvoiceInvoiceIdVisualization: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvoiceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvoiceApi->new();
my $invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; # String | Oficjalny numer KSeF faktury.
my $templateId = templateId_example; # String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
my $includeAttachments = true; # Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki?

eval {
    my $result = $api_instance->getInvoiceInvoiceIdVisualization(invoiceId => $invoiceId, templateId => $templateId, includeAttachments => $includeAttachments);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvoiceApi->getInvoiceInvoiceIdVisualization: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.InvoiceApi()
invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01 # String | Oficjalny numer KSeF faktury. (default to null)
templateId = templateId_example # String | Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon. (optional) (default to null)
includeAttachments = true # Boolean | Czy do wizualizacji PDF dołączyć powiązane załączniki? (optional) (default to false)

try:
    # get invoice visualization
    api_response = api_instance.get_invoice_invoice_id_visualization(invoiceId, templateId=templateId, includeAttachments=includeAttachments)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvoiceApi->getInvoiceInvoiceIdVisualization: %s\n" % e)

extern crate InvoiceApi;

pub fn main() {
    let invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String
    let templateId = templateId_example; // String
    let includeAttachments = true; // Boolean

    let mut context = InvoiceApi::Context::default();
    let result = client.getInvoiceInvoiceIdVisualization(invoiceId, templateId, includeAttachments, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
invoiceId*	String Oficjalny numer KSeF faktury. Required

Query parameters

Name	Description
templateId	String Identyfikator szablonu wizualizacji, który ma zostać użyty. Jeśli pominięty, użyty zostanie domyślny szablon.
includeAttachments	Boolean Czy do wizualizacji PDF dołączyć powiązane załączniki?

Responses

Schema

Schema

Schema

postInvoice

create invoice

Tworzy i od razu wysyła fakturę do KSeF. Jest to uproszczona metoda, która nie korzysta z mechanizmu wersji roboczych. Zalecane jest korzystanie z endpointu `/draft` dla pełnej kontroli nad procesem.

/invoice

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://ksef.devapo.app/api/rest/v1/invoice" \
 -d '{
  "seller" : {
    "address" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "taxId" : {
      "countryCodeUE" : "countryCodeUE",
      "nip" : "nip",
      "otherId" : "otherId",
      "vatUE" : "vatUE",
      "noId" : false
    },
    "contact" : {
      "phone" : "phone",
      "email" : "email"
    },
    "name" : "name",
    "isVatGroupMember" : false,
    "correspondenceAddress" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "isLocalGovernmentUnitSubEntity" : false
  },
  "summary" : {
    "totalNetAmount" : 7.0614014,
    "taxSummary" : [ {
      "taxRate" : "taxRate",
      "netValue" : 2.027123023002322,
      "taxAmount" : 4.145608029883936
    }, {
      "taxRate" : "taxRate",
      "netValue" : 2.027123023002322,
      "taxAmount" : 4.145608029883936
    } ],
    "totalGrossAmount" : 3.6160767,
    "totalTaxAmount" : 9.301444
  },
  "footer" : "footer",
  "annotations" : {
    "exemptionReason" : "exemptionReason",
    "isSplitPayment" : false,
    "isCashMethod" : false,
    "isSelfBilling" : false,
    "isReverseCharge" : false,
    "isMarginProcedure" : false
  },
  "correctionDetails" : {
    "reason" : "reason",
    "correctedInvoiceKsefNumber" : "correctedInvoiceKsefNumber",
    "correctedInvoiceNumber" : "correctedInvoiceNumber"
  },
  "saleDate" : "2000-01-23",
  "otherParties" : [ {
    "address" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "role" : "PAYER",
    "taxId" : {
      "countryCodeUE" : "countryCodeUE",
      "nip" : "nip",
      "otherId" : "otherId",
      "vatUE" : "vatUE",
      "noId" : false
    },
    "contact" : {
      "phone" : "phone",
      "email" : "email"
    },
    "name" : "name",
    "isVatGroupMember" : false,
    "roleDescription" : "roleDescription",
    "correspondenceAddress" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "isLocalGovernmentUnitSubEntity" : false,
    "sharePercentage" : 0.8008282
  }, {
    "address" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "role" : "PAYER",
    "taxId" : {
      "countryCodeUE" : "countryCodeUE",
      "nip" : "nip",
      "otherId" : "otherId",
      "vatUE" : "vatUE",
      "noId" : false
    },
    "contact" : {
      "phone" : "phone",
      "email" : "email"
    },
    "name" : "name",
    "isVatGroupMember" : false,
    "roleDescription" : "roleDescription",
    "correspondenceAddress" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "isLocalGovernmentUnitSubEntity" : false,
    "sharePercentage" : 0.8008282
  } ],
  "buyer" : {
    "address" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "taxId" : {
      "countryCodeUE" : "countryCodeUE",
      "nip" : "nip",
      "otherId" : "otherId",
      "vatUE" : "vatUE",
      "noId" : false
    },
    "contact" : {
      "phone" : "phone",
      "email" : "email"
    },
    "name" : "name",
    "isVatGroupMember" : false,
    "correspondenceAddress" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "isLocalGovernmentUnitSubEntity" : false
  },
  "ksefNumber" : "ksefNumber",
  "invoiceNumber" : "invoiceNumber",
  "additionalInfo" : [ {
    "value" : "value",
    "key" : "key"
  }, {
    "value" : "value",
    "key" : "key"
  } ],
  "invoiceType" : "VAT",
  "payment" : {
    "methodDescription" : "methodDescription",
    "method" : "CASH",
    "dueDate" : "2000-01-23",
    "skonto" : {
      "conditions" : "conditions",
      "discountValue" : "discountValue"
    },
    "bankName" : "bankName",
    "accountNumber" : "accountNumber",
    "currencyCode" : "currencyCode"
  },
  "issueDate" : "2000-01-23",
  "items" : [ {
    "taxRate" : "23",
    "unit" : "unit",
    "unitPriceNet" : 1.4658129,
    "quantity" : 6.0274563,
    "netValue" : 5.962134,
    "grossValue" : 2.302136,
    "name" : "name",
    "gtu" : "GTU_01",
    "procedure" : "WSTO_EE",
    "taxAmount" : 5.637377
  }, {
    "taxRate" : "23",
    "unit" : "unit",
    "unitPriceNet" : 1.4658129,
    "quantity" : 6.0274563,
    "netValue" : 5.962134,
    "grossValue" : 2.302136,
    "name" : "name",
    "gtu" : "GTU_01",
    "procedure" : "WSTO_EE",
    "taxAmount" : 5.637377
  } ],
  "issuePlace" : "issuePlace"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvoiceApi;

import java.io.File;
import java.util.*;

public class InvoiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        InvoiceApi apiInstance = new InvoiceApi();
        Invoice invoice = ; // Invoice | 

        try {
            Invoice result = apiInstance.postInvoice(invoice);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#postInvoice");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Invoice invoice = new Invoice(); // Invoice | 

try {
    final result = await api_instance.postInvoice(invoice);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postInvoice: $e\n');
}

import org.openapitools.client.api.InvoiceApi;

public class InvoiceApiExample {
    public static void main(String[] args) {
        InvoiceApi apiInstance = new InvoiceApi();
        Invoice invoice = ; // Invoice | 

        try {
            Invoice result = apiInstance.postInvoice(invoice);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#postInvoice");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
InvoiceApi *apiInstance = [[InvoiceApi alloc] init];
Invoice *invoice = ; // 

// create invoice
[apiInstance postInvoiceWith:invoice
              completionHandler: ^(Invoice output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.InvoiceApi()
var invoice = ; // {Invoice} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postInvoice(invoice, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postInvoiceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new InvoiceApi();
            var invoice = new Invoice(); // Invoice | 

            try {
                // create invoice
                Invoice result = apiInstance.postInvoice(invoice);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvoiceApi.postInvoice: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvoiceApi();
$invoice = ; // Invoice | 

try {
    $result = $api_instance->postInvoice($invoice);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->postInvoice: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvoiceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvoiceApi->new();
my $invoice = WWW::OPenAPIClient::Object::Invoice->new(); # Invoice | 

eval {
    my $result = $api_instance->postInvoice(invoice => $invoice);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvoiceApi->postInvoice: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.InvoiceApi()
invoice =  # Invoice | 

try:
    # create invoice
    api_response = api_instance.post_invoice(invoice)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvoiceApi->postInvoice: %s\n" % e)

extern crate InvoiceApi;

pub fn main() {
    let invoice = ; // Invoice

    let mut context = InvoiceApi::Context::default();
    let result = client.postInvoice(invoice, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters

Name	Description
invoice *

Responses

Schema

Schema

Schema

postInvoiceBatch

init invoice load process

Tworzy nowy proces wsadowy (paczkę) do masowej wysyłki faktur. Zwraca identyfikator procesu, który jest używany w kolejnych krokach.

/invoice/batch

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://ksef.devapo.app/api/rest/v1/invoice/batch" \
 -d ''

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvoiceApi;

import java.io.File;
import java.util.*;

public class InvoiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        InvoiceApi apiInstance = new InvoiceApi();
        PostInvoiceBatchRequest postInvoiceBatchRequest = ; // PostInvoiceBatchRequest | 

        try {
            Batch-Process result = apiInstance.postInvoiceBatch(postInvoiceBatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#postInvoiceBatch");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PostInvoiceBatchRequest postInvoiceBatchRequest = new PostInvoiceBatchRequest(); // PostInvoiceBatchRequest | 

try {
    final result = await api_instance.postInvoiceBatch(postInvoiceBatchRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postInvoiceBatch: $e\n');
}

import org.openapitools.client.api.InvoiceApi;

public class InvoiceApiExample {
    public static void main(String[] args) {
        InvoiceApi apiInstance = new InvoiceApi();
        PostInvoiceBatchRequest postInvoiceBatchRequest = ; // PostInvoiceBatchRequest | 

        try {
            Batch-Process result = apiInstance.postInvoiceBatch(postInvoiceBatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#postInvoiceBatch");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
InvoiceApi *apiInstance = [[InvoiceApi alloc] init];
PostInvoiceBatchRequest *postInvoiceBatchRequest = ; // 

// init invoice load process
[apiInstance postInvoiceBatchWith:postInvoiceBatchRequest
              completionHandler: ^(Batch-Process output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.InvoiceApi()
var postInvoiceBatchRequest = ; // {PostInvoiceBatchRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postInvoiceBatch(postInvoiceBatchRequest, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postInvoiceBatchExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new InvoiceApi();
            var postInvoiceBatchRequest = new PostInvoiceBatchRequest(); // PostInvoiceBatchRequest | 

            try {
                // init invoice load process
                Batch-Process result = apiInstance.postInvoiceBatch(postInvoiceBatchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvoiceApi.postInvoiceBatch: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvoiceApi();
$postInvoiceBatchRequest = ; // PostInvoiceBatchRequest | 

try {
    $result = $api_instance->postInvoiceBatch($postInvoiceBatchRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->postInvoiceBatch: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvoiceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvoiceApi->new();
my $postInvoiceBatchRequest = WWW::OPenAPIClient::Object::PostInvoiceBatchRequest->new(); # PostInvoiceBatchRequest | 

eval {
    my $result = $api_instance->postInvoiceBatch(postInvoiceBatchRequest => $postInvoiceBatchRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvoiceApi->postInvoiceBatch: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.InvoiceApi()
postInvoiceBatchRequest =  # PostInvoiceBatchRequest | 

try:
    # init invoice load process
    api_response = api_instance.post_invoice_batch(postInvoiceBatchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvoiceApi->postInvoiceBatch: %s\n" % e)

extern crate InvoiceApi;

pub fn main() {
    let postInvoiceBatchRequest = ; // PostInvoiceBatchRequest

    let mut context = InvoiceApi::Context::default();
    let result = client.postInvoiceBatch(postInvoiceBatchRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters

Name	Description
postInvoiceBatchRequest *	Obiekt konfiguracyjny dla nowej paczki.

Responses

Schema

Schema

Schema

postInvoiceBatchBatchProcessId

add invoice(s)

Dodaje jedną lub więcej faktur do wcześniej zainicjowanej paczki. Można przesyłać faktury w formacie JSON (jako lista obiektów Invoice) lub jako plik (CSV/XLSX) w `multipart/form-data`. Operację można wywoływać wielokrotnie dla tej samej paczki, aż do momentu jej uruchomienia.

/invoice/batch/{batchProcessId}

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,text/csv" \
 "https://ksef.devapo.app/api/rest/v1/invoice/batch/{batchProcessId}" \
 -d '{
  "seller" : {
    "address" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "taxId" : {
      "countryCodeUE" : "countryCodeUE",
      "nip" : "nip",
      "otherId" : "otherId",
      "vatUE" : "vatUE",
      "noId" : false
    },
    "contact" : {
      "phone" : "phone",
      "email" : "email"
    },
    "name" : "name",
    "isVatGroupMember" : false,
    "correspondenceAddress" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "isLocalGovernmentUnitSubEntity" : false
  },
  "summary" : {
    "totalNetAmount" : 7.0614014,
    "taxSummary" : [ {
      "taxRate" : "taxRate",
      "netValue" : 2.027123023002322,
      "taxAmount" : 4.145608029883936
    }, {
      "taxRate" : "taxRate",
      "netValue" : 2.027123023002322,
      "taxAmount" : 4.145608029883936
    } ],
    "totalGrossAmount" : 3.6160767,
    "totalTaxAmount" : 9.301444
  },
  "footer" : "footer",
  "annotations" : {
    "exemptionReason" : "exemptionReason",
    "isSplitPayment" : false,
    "isCashMethod" : false,
    "isSelfBilling" : false,
    "isReverseCharge" : false,
    "isMarginProcedure" : false
  },
  "correctionDetails" : {
    "reason" : "reason",
    "correctedInvoiceKsefNumber" : "correctedInvoiceKsefNumber",
    "correctedInvoiceNumber" : "correctedInvoiceNumber"
  },
  "saleDate" : "2000-01-23",
  "otherParties" : [ {
    "address" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "role" : "PAYER",
    "taxId" : {
      "countryCodeUE" : "countryCodeUE",
      "nip" : "nip",
      "otherId" : "otherId",
      "vatUE" : "vatUE",
      "noId" : false
    },
    "contact" : {
      "phone" : "phone",
      "email" : "email"
    },
    "name" : "name",
    "isVatGroupMember" : false,
    "roleDescription" : "roleDescription",
    "correspondenceAddress" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "isLocalGovernmentUnitSubEntity" : false,
    "sharePercentage" : 0.8008282
  }, {
    "address" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "role" : "PAYER",
    "taxId" : {
      "countryCodeUE" : "countryCodeUE",
      "nip" : "nip",
      "otherId" : "otherId",
      "vatUE" : "vatUE",
      "noId" : false
    },
    "contact" : {
      "phone" : "phone",
      "email" : "email"
    },
    "name" : "name",
    "isVatGroupMember" : false,
    "roleDescription" : "roleDescription",
    "correspondenceAddress" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "isLocalGovernmentUnitSubEntity" : false,
    "sharePercentage" : 0.8008282
  } ],
  "buyer" : {
    "address" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "taxId" : {
      "countryCodeUE" : "countryCodeUE",
      "nip" : "nip",
      "otherId" : "otherId",
      "vatUE" : "vatUE",
      "noId" : false
    },
    "contact" : {
      "phone" : "phone",
      "email" : "email"
    },
    "name" : "name",
    "isVatGroupMember" : false,
    "correspondenceAddress" : {
      "countryCode" : "countryCode",
      "gln" : "gln",
      "addressLine1" : "addressLine1",
      "addressLine2" : "addressLine2"
    },
    "isLocalGovernmentUnitSubEntity" : false
  },
  "ksefNumber" : "ksefNumber",
  "invoiceNumber" : "invoiceNumber",
  "additionalInfo" : [ {
    "value" : "value",
    "key" : "key"
  }, {
    "value" : "value",
    "key" : "key"
  } ],
  "invoiceType" : "VAT",
  "payment" : {
    "methodDescription" : "methodDescription",
    "method" : "CASH",
    "dueDate" : "2000-01-23",
    "skonto" : {
      "conditions" : "conditions",
      "discountValue" : "discountValue"
    },
    "bankName" : "bankName",
    "accountNumber" : "accountNumber",
    "currencyCode" : "currencyCode"
  },
  "issueDate" : "2000-01-23",
  "items" : [ {
    "taxRate" : "23",
    "unit" : "unit",
    "unitPriceNet" : 1.4658129,
    "quantity" : 6.0274563,
    "netValue" : 5.962134,
    "grossValue" : 2.302136,
    "name" : "name",
    "gtu" : "GTU_01",
    "procedure" : "WSTO_EE",
    "taxAmount" : 5.637377
  }, {
    "taxRate" : "23",
    "unit" : "unit",
    "unitPriceNet" : 1.4658129,
    "quantity" : 6.0274563,
    "netValue" : 5.962134,
    "grossValue" : 2.302136,
    "name" : "name",
    "gtu" : "GTU_01",
    "procedure" : "WSTO_EE",
    "taxAmount" : 5.637377
  } ],
  "issuePlace" : "issuePlace"
}' \
 -d 'Custom MIME type example not yet supported: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' \
 -d 'Custom MIME type example not yet supported: text/csv'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvoiceApi;

import java.io.File;
import java.util.*;

public class InvoiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        InvoiceApi apiInstance = new InvoiceApi();
        UUID batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) procesu wsadowego.
        array[Invoice] invoice = ; // array[Invoice] | 

        try {
            apiInstance.postInvoiceBatchBatchProcessId(batchProcessId, invoice);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#postInvoiceBatchBatchProcessId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID batchProcessId = new UUID(); // UUID | Identyfikator (UUID) procesu wsadowego.
final array[Invoice] invoice = new array[Invoice](); // array[Invoice] | 

try {
    final result = await api_instance.postInvoiceBatchBatchProcessId(batchProcessId, invoice);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postInvoiceBatchBatchProcessId: $e\n');
}

import org.openapitools.client.api.InvoiceApi;

public class InvoiceApiExample {
    public static void main(String[] args) {
        InvoiceApi apiInstance = new InvoiceApi();
        UUID batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) procesu wsadowego.
        array[Invoice] invoice = ; // array[Invoice] | 

        try {
            apiInstance.postInvoiceBatchBatchProcessId(batchProcessId, invoice);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#postInvoiceBatchBatchProcessId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
InvoiceApi *apiInstance = [[InvoiceApi alloc] init];
UUID *batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identyfikator (UUID) procesu wsadowego. (default to null)
array[Invoice] *invoice = ; // 

// add invoice(s)
[apiInstance postInvoiceBatchBatchProcessIdWith:batchProcessId
    invoice:invoice
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.InvoiceApi()
var batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identyfikator (UUID) procesu wsadowego.
var invoice = ; // {array[Invoice]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.postInvoiceBatchBatchProcessId(batchProcessId, invoice, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postInvoiceBatchBatchProcessIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new InvoiceApi();
            var batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identyfikator (UUID) procesu wsadowego. (default to null)
            var invoice = new array[Invoice](); // array[Invoice] | 

            try {
                // add invoice(s)
                apiInstance.postInvoiceBatchBatchProcessId(batchProcessId, invoice);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvoiceApi.postInvoiceBatchBatchProcessId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvoiceApi();
$batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) procesu wsadowego.
$invoice = ; // array[Invoice] | 

try {
    $api_instance->postInvoiceBatchBatchProcessId($batchProcessId, $invoice);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->postInvoiceBatchBatchProcessId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvoiceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvoiceApi->new();
my $batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identyfikator (UUID) procesu wsadowego.
my $invoice = [WWW::OPenAPIClient::Object::array[Invoice]->new()]; # array[Invoice] | 

eval {
    $api_instance->postInvoiceBatchBatchProcessId(batchProcessId => $batchProcessId, invoice => $invoice);
};
if ($@) {
    warn "Exception when calling InvoiceApi->postInvoiceBatchBatchProcessId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.InvoiceApi()
batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identyfikator (UUID) procesu wsadowego. (default to null)
invoice =  # array[Invoice] | 

try:
    # add invoice(s)
    api_instance.post_invoice_batch_batch_process_id(batchProcessId, invoice)
except ApiException as e:
    print("Exception when calling InvoiceApi->postInvoiceBatchBatchProcessId: %s\n" % e)

extern crate InvoiceApi;

pub fn main() {
    let batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let invoice = ; // array[Invoice]

    let mut context = InvoiceApi::Context::default();
    let result = client.postInvoiceBatchBatchProcessId(batchProcessId, invoice, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
batchProcessId*	UUID (uuid) Identyfikator (UUID) procesu wsadowego. Required

Body parameters

Name	Description
invoice *	Lista faktur lub plik z fakturami.

Responses

Schema

Schema

Schema

Schema

postInvoiceBatchBatchProcessIdStart

start process

Rozpoczyna proces wysyłki wszystkich faktur dodanych do paczki. Po wywołaniu tej operacji nie można już dodawać nowych faktur do paczki. Proces jest asynchroniczny. Jego postęp można śledzić za pomocą operacji GET.

/invoice/batch/{batchProcessId}/start

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/invoice/batch/{batchProcessId}/start"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvoiceApi;

import java.io.File;
import java.util.*;

public class InvoiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        InvoiceApi apiInstance = new InvoiceApi();
        UUID batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) procesu wsadowego.

        try {
            Batch-Process result = apiInstance.postInvoiceBatchBatchProcessIdStart(batchProcessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#postInvoiceBatchBatchProcessIdStart");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID batchProcessId = new UUID(); // UUID | Identyfikator (UUID) procesu wsadowego.

try {
    final result = await api_instance.postInvoiceBatchBatchProcessIdStart(batchProcessId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postInvoiceBatchBatchProcessIdStart: $e\n');
}

import org.openapitools.client.api.InvoiceApi;

public class InvoiceApiExample {
    public static void main(String[] args) {
        InvoiceApi apiInstance = new InvoiceApi();
        UUID batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) procesu wsadowego.

        try {
            Batch-Process result = apiInstance.postInvoiceBatchBatchProcessIdStart(batchProcessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#postInvoiceBatchBatchProcessIdStart");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
InvoiceApi *apiInstance = [[InvoiceApi alloc] init];
UUID *batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identyfikator (UUID) procesu wsadowego. (default to null)

// start process
[apiInstance postInvoiceBatchBatchProcessIdStartWith:batchProcessId
              completionHandler: ^(Batch-Process output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.InvoiceApi()
var batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identyfikator (UUID) procesu wsadowego.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postInvoiceBatchBatchProcessIdStart(batchProcessId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postInvoiceBatchBatchProcessIdStartExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new InvoiceApi();
            var batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identyfikator (UUID) procesu wsadowego. (default to null)

            try {
                // start process
                Batch-Process result = apiInstance.postInvoiceBatchBatchProcessIdStart(batchProcessId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvoiceApi.postInvoiceBatchBatchProcessIdStart: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvoiceApi();
$batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) procesu wsadowego.

try {
    $result = $api_instance->postInvoiceBatchBatchProcessIdStart($batchProcessId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->postInvoiceBatchBatchProcessIdStart: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvoiceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvoiceApi->new();
my $batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identyfikator (UUID) procesu wsadowego.

eval {
    my $result = $api_instance->postInvoiceBatchBatchProcessIdStart(batchProcessId => $batchProcessId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvoiceApi->postInvoiceBatchBatchProcessIdStart: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.InvoiceApi()
batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identyfikator (UUID) procesu wsadowego. (default to null)

try:
    # start process
    api_response = api_instance.post_invoice_batch_batch_process_id_start(batchProcessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvoiceApi->postInvoiceBatchBatchProcessIdStart: %s\n" % e)

extern crate InvoiceApi;

pub fn main() {
    let batchProcessId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = InvoiceApi::Context::default();
    let result = client.postInvoiceBatchBatchProcessIdStart(batchProcessId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
batchProcessId*	UUID (uuid) Identyfikator (UUID) procesu wsadowego. Required

Responses

Schema

Schema

Schema

Schema

postInvoiceInvoiceIdAttachments

add invoice attachment

Dodaje załącznik do faktury, która już została wysłana do KSeF i posiada numer KSeF.

/invoice/{invoiceId}/attachments

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://ksef.devapo.app/api/rest/v1/invoice/{invoiceId}/attachments"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InvoiceApi;

import java.io.File;
import java.util.*;

public class InvoiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        InvoiceApi apiInstance = new InvoiceApi();
        String invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.
        File file = BINARY_DATA_HERE; // File | Plik do załączenia.
        String description = description_example; // String | Opcjonalny opis załącznika.

        try {
            Invoice-Attachment result = apiInstance.postInvoiceInvoiceIdAttachments(invoiceId, file, description);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#postInvoiceInvoiceIdAttachments");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String invoiceId = new String(); // String | Oficjalny numer KSeF faktury.
final File file = new File(); // File | Plik do załączenia.
final String description = new String(); // String | Opcjonalny opis załącznika.

try {
    final result = await api_instance.postInvoiceInvoiceIdAttachments(invoiceId, file, description);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postInvoiceInvoiceIdAttachments: $e\n');
}

import org.openapitools.client.api.InvoiceApi;

public class InvoiceApiExample {
    public static void main(String[] args) {
        InvoiceApi apiInstance = new InvoiceApi();
        String invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.
        File file = BINARY_DATA_HERE; // File | Plik do załączenia.
        String description = description_example; // String | Opcjonalny opis załącznika.

        try {
            Invoice-Attachment result = apiInstance.postInvoiceInvoiceIdAttachments(invoiceId, file, description);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvoiceApi#postInvoiceInvoiceIdAttachments");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
InvoiceApi *apiInstance = [[InvoiceApi alloc] init];
String *invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // Oficjalny numer KSeF faktury. (default to null)
File *file = BINARY_DATA_HERE; // Plik do załączenia. (optional) (default to null)
String *description = description_example; // Opcjonalny opis załącznika. (optional) (default to null)

// add invoice attachment
[apiInstance postInvoiceInvoiceIdAttachmentsWith:invoiceId
    file:file
    description:description
              completionHandler: ^(Invoice-Attachment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.InvoiceApi()
var invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // {String} Oficjalny numer KSeF faktury.
var opts = {
  'file': BINARY_DATA_HERE, // {File} Plik do załączenia.
  'description': description_example // {String} Opcjonalny opis załącznika.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postInvoiceInvoiceIdAttachments(invoiceId, opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postInvoiceInvoiceIdAttachmentsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new InvoiceApi();
            var invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01;  // String | Oficjalny numer KSeF faktury. (default to null)
            var file = BINARY_DATA_HERE;  // File | Plik do załączenia. (optional)  (default to null)
            var description = description_example;  // String | Opcjonalny opis załącznika. (optional)  (default to null)

            try {
                // add invoice attachment
                Invoice-Attachment result = apiInstance.postInvoiceInvoiceIdAttachments(invoiceId, file, description);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InvoiceApi.postInvoiceInvoiceIdAttachments: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InvoiceApi();
$invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String | Oficjalny numer KSeF faktury.
$file = BINARY_DATA_HERE; // File | Plik do załączenia.
$description = description_example; // String | Opcjonalny opis załącznika.

try {
    $result = $api_instance->postInvoiceInvoiceIdAttachments($invoiceId, $file, $description);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoiceApi->postInvoiceInvoiceIdAttachments: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InvoiceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InvoiceApi->new();
my $invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; # String | Oficjalny numer KSeF faktury.
my $file = BINARY_DATA_HERE; # File | Plik do załączenia.
my $description = description_example; # String | Opcjonalny opis załącznika.

eval {
    my $result = $api_instance->postInvoiceInvoiceIdAttachments(invoiceId => $invoiceId, file => $file, description => $description);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvoiceApi->postInvoiceInvoiceIdAttachments: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.InvoiceApi()
invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01 # String | Oficjalny numer KSeF faktury. (default to null)
file = BINARY_DATA_HERE # File | Plik do załączenia. (optional) (default to null)
description = description_example # String | Opcjonalny opis załącznika. (optional) (default to null)

try:
    # add invoice attachment
    api_response = api_instance.post_invoice_invoice_id_attachments(invoiceId, file=file, description=description)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InvoiceApi->postInvoiceInvoiceIdAttachments: %s\n" % e)

extern crate InvoiceApi;

pub fn main() {
    let invoiceId = 1234567890-20250630-A1B2C3D4E5F6-01; // String
    let file = BINARY_DATA_HERE; // File
    let description = description_example; // String

    let mut context = InvoiceApi::Context::default();
    let result = client.postInvoiceInvoiceIdAttachments(invoiceId, file, description, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
invoiceId*	String Oficjalny numer KSeF faktury. Required

Form parameters

Name	Description
file	File (binary) Plik do załączenia.
description	String Opcjonalny opis załącznika.

Responses

Schema

Schema

Schema

Schema

Notification

getNotification

get notification list

Pobiera listę wszystkich zdefiniowanych powiadomień o fakturach kosztowych.

/notification

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/notification"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationApi;

import java.io.File;
import java.util.*;

public class NotificationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        NotificationApi apiInstance = new NotificationApi();

        try {
            array[Notification] result = apiInstance.getNotification();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#getNotification");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getNotification();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getNotification: $e\n');
}

import org.openapitools.client.api.NotificationApi;

public class NotificationApiExample {
    public static void main(String[] args) {
        NotificationApi apiInstance = new NotificationApi();

        try {
            array[Notification] result = apiInstance.getNotification();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#getNotification");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
NotificationApi *apiInstance = [[NotificationApi alloc] init];

// get notification list
[apiInstance getNotificationWithCompletionHandler: 
              ^(array[Notification] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.NotificationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNotification(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getNotificationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new NotificationApi();

            try {
                // get notification list
                array[Notification] result = apiInstance.getNotification();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationApi.getNotification: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationApi();

try {
    $result = $api_instance->getNotification();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->getNotification: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationApi->new();

eval {
    my $result = $api_instance->getNotification();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotificationApi->getNotification: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.NotificationApi()

try:
    # get notification list
    api_response = api_instance.get_notification()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationApi->getNotification: %s\n" % e)

extern crate NotificationApi;

pub fn main() {

    let mut context = NotificationApi::Context::default();
    let result = client.getNotification(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Schema

Schema

getNotificationNotificationId

get notification definition

Pobiera pełną definicję konkretnego powiadomienia.

/notification/{notificationId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/notification/{notificationId}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationApi;

import java.io.File;
import java.util.*;

public class NotificationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        NotificationApi apiInstance = new NotificationApi();
        UUID notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) powiadomienia.

        try {
            Notification result = apiInstance.getNotificationNotificationId(notificationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#getNotificationNotificationId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID notificationId = new UUID(); // UUID | Identyfikator (UUID) powiadomienia.

try {
    final result = await api_instance.getNotificationNotificationId(notificationId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getNotificationNotificationId: $e\n');
}

import org.openapitools.client.api.NotificationApi;

public class NotificationApiExample {
    public static void main(String[] args) {
        NotificationApi apiInstance = new NotificationApi();
        UUID notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) powiadomienia.

        try {
            Notification result = apiInstance.getNotificationNotificationId(notificationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#getNotificationNotificationId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
NotificationApi *apiInstance = [[NotificationApi alloc] init];
UUID *notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identyfikator (UUID) powiadomienia. (default to null)

// get notification definition
[apiInstance getNotificationNotificationIdWith:notificationId
              completionHandler: ^(Notification output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.NotificationApi()
var notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identyfikator (UUID) powiadomienia.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNotificationNotificationId(notificationId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getNotificationNotificationIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new NotificationApi();
            var notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identyfikator (UUID) powiadomienia. (default to null)

            try {
                // get notification definition
                Notification result = apiInstance.getNotificationNotificationId(notificationId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationApi.getNotificationNotificationId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationApi();
$notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) powiadomienia.

try {
    $result = $api_instance->getNotificationNotificationId($notificationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->getNotificationNotificationId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationApi->new();
my $notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identyfikator (UUID) powiadomienia.

eval {
    my $result = $api_instance->getNotificationNotificationId(notificationId => $notificationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotificationApi->getNotificationNotificationId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.NotificationApi()
notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identyfikator (UUID) powiadomienia. (default to null)

try:
    # get notification definition
    api_response = api_instance.get_notification_notification_id(notificationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationApi->getNotificationNotificationId: %s\n" % e)

extern crate NotificationApi;

pub fn main() {
    let notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = NotificationApi::Context::default();
    let result = client.getNotificationNotificationId(notificationId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
notificationId*	UUID (uuid) Identyfikator (UUID) powiadomienia. Required

Responses

Schema

Schema

Schema

postNotification

add notification

Tworzy nową definicję powiadomienia, określając harmonogram, filtr faktur oraz kanał dostawy.

/notification

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://ksef.devapo.app/api/rest/v1/notification" \
 -d '{
  "filter" : {
    "query" : "query",
    "limit" : 0,
    "id" : "id"
  },
  "schedule" : "0 8 * * 1-5",
  "channel" : {
    "description" : "description",
    "definition" : "definition",
    "id" : "id",
    "type" : "EMAIL_INFO"
  },
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationApi;

import java.io.File;
import java.util.*;

public class NotificationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        NotificationApi apiInstance = new NotificationApi();
        Notification notification = ; // Notification | 

        try {
            Notification result = apiInstance.postNotification(notification);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#postNotification");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Notification notification = new Notification(); // Notification | 

try {
    final result = await api_instance.postNotification(notification);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postNotification: $e\n');
}

import org.openapitools.client.api.NotificationApi;

public class NotificationApiExample {
    public static void main(String[] args) {
        NotificationApi apiInstance = new NotificationApi();
        Notification notification = ; // Notification | 

        try {
            Notification result = apiInstance.postNotification(notification);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#postNotification");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
NotificationApi *apiInstance = [[NotificationApi alloc] init];
Notification *notification = ; // 

// add notification
[apiInstance postNotificationWith:notification
              completionHandler: ^(Notification output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.NotificationApi()
var notification = ; // {Notification} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postNotification(notification, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postNotificationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new NotificationApi();
            var notification = new Notification(); // Notification | 

            try {
                // add notification
                Notification result = apiInstance.postNotification(notification);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationApi.postNotification: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationApi();
$notification = ; // Notification | 

try {
    $result = $api_instance->postNotification($notification);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->postNotification: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationApi->new();
my $notification = WWW::OPenAPIClient::Object::Notification->new(); # Notification | 

eval {
    my $result = $api_instance->postNotification(notification => $notification);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotificationApi->postNotification: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.NotificationApi()
notification =  # Notification | 

try:
    # add notification
    api_response = api_instance.post_notification(notification)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotificationApi->postNotification: %s\n" % e)

extern crate NotificationApi;

pub fn main() {
    let notification = ; // Notification

    let mut context = NotificationApi::Context::default();
    let result = client.postNotification(notification, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters

Name	Description
notification *

Responses

Schema

Schema

Schema

putNotificationNotificationId

update notification

Aktualizuje istniejącą definicję powiadomienia.

/notification/{notificationId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://ksef.devapo.app/api/rest/v1/notification/{notificationId}" \
 -d '{
  "filter" : {
    "query" : "query",
    "limit" : 0,
    "id" : "id"
  },
  "schedule" : "0 8 * * 1-5",
  "channel" : {
    "description" : "description",
    "definition" : "definition",
    "id" : "id",
    "type" : "EMAIL_INFO"
  },
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationApi;

import java.io.File;
import java.util.*;

public class NotificationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        NotificationApi apiInstance = new NotificationApi();
        UUID notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) powiadomienia.
        Notification notification = ; // Notification | 

        try {
            apiInstance.putNotificationNotificationId(notificationId, notification);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#putNotificationNotificationId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UUID notificationId = new UUID(); // UUID | Identyfikator (UUID) powiadomienia.
final Notification notification = new Notification(); // Notification | 

try {
    final result = await api_instance.putNotificationNotificationId(notificationId, notification);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putNotificationNotificationId: $e\n');
}

import org.openapitools.client.api.NotificationApi;

public class NotificationApiExample {
    public static void main(String[] args) {
        NotificationApi apiInstance = new NotificationApi();
        UUID notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) powiadomienia.
        Notification notification = ; // Notification | 

        try {
            apiInstance.putNotificationNotificationId(notificationId, notification);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationApi#putNotificationNotificationId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
NotificationApi *apiInstance = [[NotificationApi alloc] init];
UUID *notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identyfikator (UUID) powiadomienia. (default to null)
Notification *notification = ; // 

// update notification
[apiInstance putNotificationNotificationIdWith:notificationId
    notification:notification
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.NotificationApi()
var notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identyfikator (UUID) powiadomienia.
var notification = ; // {Notification} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putNotificationNotificationId(notificationId, notification, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putNotificationNotificationIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new NotificationApi();
            var notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identyfikator (UUID) powiadomienia. (default to null)
            var notification = new Notification(); // Notification | 

            try {
                // update notification
                apiInstance.putNotificationNotificationId(notificationId, notification);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationApi.putNotificationNotificationId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationApi();
$notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identyfikator (UUID) powiadomienia.
$notification = ; // Notification | 

try {
    $api_instance->putNotificationNotificationId($notificationId, $notification);
} catch (Exception $e) {
    echo 'Exception when calling NotificationApi->putNotificationNotificationId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationApi->new();
my $notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identyfikator (UUID) powiadomienia.
my $notification = WWW::OPenAPIClient::Object::Notification->new(); # Notification | 

eval {
    $api_instance->putNotificationNotificationId(notificationId => $notificationId, notification => $notification);
};
if ($@) {
    warn "Exception when calling NotificationApi->putNotificationNotificationId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.NotificationApi()
notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identyfikator (UUID) powiadomienia. (default to null)
notification =  # Notification | 

try:
    # update notification
    api_instance.put_notification_notification_id(notificationId, notification)
except ApiException as e:
    print("Exception when calling NotificationApi->putNotificationNotificationId: %s\n" % e)

extern crate NotificationApi;

pub fn main() {
    let notificationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let notification = ; // Notification

    let mut context = NotificationApi::Context::default();
    let result = client.putNotificationNotificationId(notificationId, notification, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
notificationId*	UUID (uuid) Identyfikator (UUID) powiadomienia. Required

Body parameters

Name	Description
notification *

Responses

Schema

Schema

Payment

getPaymentPaymentId

get payment

Pobiera dane płatności: których faktur dotyczy, jaki jest jej status, kwota etc.

/payment/{paymentId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/payment/{paymentId}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentApi;

import java.io.File;
import java.util.*;

public class PaymentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentApi apiInstance = new PaymentApi();
        String paymentId = paymentId_example; // String | Identyfikator płatności.

        try {
            Payment result = apiInstance.getPaymentPaymentId(paymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentApi#getPaymentPaymentId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String paymentId = new String(); // String | Identyfikator płatności.

try {
    final result = await api_instance.getPaymentPaymentId(paymentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPaymentPaymentId: $e\n');
}

import org.openapitools.client.api.PaymentApi;

public class PaymentApiExample {
    public static void main(String[] args) {
        PaymentApi apiInstance = new PaymentApi();
        String paymentId = paymentId_example; // String | Identyfikator płatności.

        try {
            Payment result = apiInstance.getPaymentPaymentId(paymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentApi#getPaymentPaymentId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
PaymentApi *apiInstance = [[PaymentApi alloc] init];
String *paymentId = paymentId_example; // Identyfikator płatności. (default to null)

// get payment
[apiInstance getPaymentPaymentIdWith:paymentId
              completionHandler: ^(Payment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.PaymentApi()
var paymentId = paymentId_example; // {String} Identyfikator płatności.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPaymentPaymentId(paymentId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPaymentPaymentIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PaymentApi();
            var paymentId = paymentId_example;  // String | Identyfikator płatności. (default to null)

            try {
                // get payment
                Payment result = apiInstance.getPaymentPaymentId(paymentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentApi.getPaymentPaymentId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentApi();
$paymentId = paymentId_example; // String | Identyfikator płatności.

try {
    $result = $api_instance->getPaymentPaymentId($paymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->getPaymentPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentApi->new();
my $paymentId = paymentId_example; # String | Identyfikator płatności.

eval {
    my $result = $api_instance->getPaymentPaymentId(paymentId => $paymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentApi->getPaymentPaymentId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentApi()
paymentId = paymentId_example # String | Identyfikator płatności. (default to null)

try:
    # get payment
    api_response = api_instance.get_payment_payment_id(paymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentApi->getPaymentPaymentId: %s\n" % e)

extern crate PaymentApi;

pub fn main() {
    let paymentId = paymentId_example; // String

    let mut context = PaymentApi::Context::default();
    let result = client.getPaymentPaymentId(paymentId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
paymentId*	String Identyfikator płatności. Required

Responses

Schema

Schema

Schema

postPayment

create payment

Tworzy nową płatność, potencjalnie grupując kilka faktur kosztowych od tego samego kontrahenta w jeden przelew.

/payment

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://ksef.devapo.app/api/rest/v1/payment" \
 -d '{
  "totalAmount" : 0.8008282,
  "paymentId" : "paymentId",
  "description" : "Płatność za faktury 123/2025, 124/2025",
  "creationDate" : "2000-01-23T04:56:07.000+00:00",
  "paymentDate" : "2000-01-23",
  "currencyCode" : "PLN",
  "invoiceIds" : [ "invoiceIds", "invoiceIds" ],
  "status" : "NEW"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentApi;

import java.io.File;
import java.util.*;

public class PaymentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentApi apiInstance = new PaymentApi();
        Payment payment = ; // Payment | 

        try {
            Payment result = apiInstance.postPayment(payment);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentApi#postPayment");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Payment payment = new Payment(); // Payment | 

try {
    final result = await api_instance.postPayment(payment);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postPayment: $e\n');
}

import org.openapitools.client.api.PaymentApi;

public class PaymentApiExample {
    public static void main(String[] args) {
        PaymentApi apiInstance = new PaymentApi();
        Payment payment = ; // Payment | 

        try {
            Payment result = apiInstance.postPayment(payment);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentApi#postPayment");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
PaymentApi *apiInstance = [[PaymentApi alloc] init];
Payment *payment = ; // 

// create payment
[apiInstance postPaymentWith:payment
              completionHandler: ^(Payment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.PaymentApi()
var payment = ; // {Payment} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postPayment(payment, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postPaymentExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PaymentApi();
            var payment = new Payment(); // Payment | 

            try {
                // create payment
                Payment result = apiInstance.postPayment(payment);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentApi.postPayment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentApi();
$payment = ; // Payment | 

try {
    $result = $api_instance->postPayment($payment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->postPayment: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentApi->new();
my $payment = WWW::OPenAPIClient::Object::Payment->new(); # Payment | 

eval {
    my $result = $api_instance->postPayment(payment => $payment);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentApi->postPayment: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentApi()
payment =  # Payment | 

try:
    # create payment
    api_response = api_instance.post_payment(payment)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentApi->postPayment: %s\n" % e)

extern crate PaymentApi;

pub fn main() {
    let payment = ; // Payment

    let mut context = PaymentApi::Context::default();
    let result = client.postPayment(payment, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters

Name	Description
payment *

Responses

Schema

Schema

Schema

Rules

getRules

get categorization rules

Pobiera aktualnie obowiązujący zestaw reguł kategoryzacji faktur kosztowych w formacie DMN (XML).

/rules

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/xml,application/json" \
 "https://ksef.devapo.app/api/rest/v1/rules"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RulesApi;

import java.io.File;
import java.util.*;

public class RulesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        RulesApi apiInstance = new RulesApi();

        try {
            Categorization-Rules result = apiInstance.getRules();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#getRules");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getRules();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getRules: $e\n');
}

import org.openapitools.client.api.RulesApi;

public class RulesApiExample {
    public static void main(String[] args) {
        RulesApi apiInstance = new RulesApi();

        try {
            Categorization-Rules result = apiInstance.getRules();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#getRules");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
RulesApi *apiInstance = [[RulesApi alloc] init];

// get categorization rules
[apiInstance getRulesWithCompletionHandler: 
              ^(Categorization-Rules output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.RulesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRules(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRulesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new RulesApi();

            try {
                // get categorization rules
                Categorization-Rules result = apiInstance.getRules();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RulesApi.getRules: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RulesApi();

try {
    $result = $api_instance->getRules();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RulesApi->getRules: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RulesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RulesApi->new();

eval {
    my $result = $api_instance->getRules();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RulesApi->getRules: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.RulesApi()

try:
    # get categorization rules
    api_response = api_instance.get_rules()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RulesApi->getRules: %s\n" % e)

extern crate RulesApi;

pub fn main() {

    let mut context = RulesApi::Context::default();
    let result = client.getRules(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Schema

Schema

putRules

update categorization rules

Zastępuje istniejący zestaw reguł kategoryzacji nową wersją. Treść żądania musi zawierać poprawny plik DMN w formacie XML. System waliduje poprawność składniową i semantyczną reguł.

/rules

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/xml" \
 "https://ksef.devapo.app/api/rest/v1/rules" \
 -d ''

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RulesApi;

import java.io.File;
import java.util.*;

public class RulesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        RulesApi apiInstance = new RulesApi();
        CategorizationRules categorizationRules = ; // CategorizationRules | 

        try {
            apiInstance.putRules(categorizationRules);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#putRules");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CategorizationRules categorizationRules = new CategorizationRules(); // CategorizationRules | 

try {
    final result = await api_instance.putRules(categorizationRules);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putRules: $e\n');
}

import org.openapitools.client.api.RulesApi;

public class RulesApiExample {
    public static void main(String[] args) {
        RulesApi apiInstance = new RulesApi();
        CategorizationRules categorizationRules = ; // CategorizationRules | 

        try {
            apiInstance.putRules(categorizationRules);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#putRules");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
RulesApi *apiInstance = [[RulesApi alloc] init];
CategorizationRules *categorizationRules = ; // 

// update categorization rules
[apiInstance putRulesWith:categorizationRules
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.RulesApi()
var categorizationRules = ; // {CategorizationRules} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putRules(categorizationRules, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putRulesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new RulesApi();
            var categorizationRules = new CategorizationRules(); // CategorizationRules | 

            try {
                // update categorization rules
                apiInstance.putRules(categorizationRules);
            } catch (Exception e) {
                Debug.Print("Exception when calling RulesApi.putRules: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RulesApi();
$categorizationRules = ; // CategorizationRules | 

try {
    $api_instance->putRules($categorizationRules);
} catch (Exception $e) {
    echo 'Exception when calling RulesApi->putRules: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RulesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RulesApi->new();
my $categorizationRules = WWW::OPenAPIClient::Object::CategorizationRules->new(); # CategorizationRules | 

eval {
    $api_instance->putRules(categorizationRules => $categorizationRules);
};
if ($@) {
    warn "Exception when calling RulesApi->putRules: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.RulesApi()
categorizationRules =  # CategorizationRules | 

try:
    # update categorization rules
    api_instance.put_rules(categorizationRules)
except ApiException as e:
    print("Exception when calling RulesApi->putRules: %s\n" % e)

extern crate RulesApi;

pub fn main() {
    let categorizationRules = ; // CategorizationRules

    let mut context = RulesApi::Context::default();
    let result = client.putRules(categorizationRules, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters

Name	Description
categorizationRules *	Plik DMN (XML) z nowym zestawem reguł.

Responses

Schema

Schema

Schema

Template

getTemplate

get templates

Pobiera listę dostępnych szablonów klienta do wizualizacji faktur.

/template

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/template"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TemplateApi;

import java.io.File;
import java.util.*;

public class TemplateApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TemplateApi apiInstance = new TemplateApi();

        try {
            array[Visualization-Template] result = apiInstance.getTemplate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getTemplate");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getTemplate();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTemplate: $e\n');
}

import org.openapitools.client.api.TemplateApi;

public class TemplateApiExample {
    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();

        try {
            array[Visualization-Template] result = apiInstance.getTemplate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getTemplate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
TemplateApi *apiInstance = [[TemplateApi alloc] init];

// get templates
[apiInstance getTemplateWithCompletionHandler: 
              ^(array[Visualization-Template] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.TemplateApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTemplate(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TemplateApi();

            try {
                // get templates
                array[Visualization-Template] result = apiInstance.getTemplate();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TemplateApi.getTemplate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TemplateApi();

try {
    $result = $api_instance->getTemplate();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->getTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TemplateApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TemplateApi->new();

eval {
    my $result = $api_instance->getTemplate();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->getTemplate: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TemplateApi()

try:
    # get templates
    api_response = api_instance.get_template()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->getTemplate: %s\n" % e)

extern crate TemplateApi;

pub fn main() {

    let mut context = TemplateApi::Context::default();
    let result = client.getTemplate(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Schema

Schema

getTemplateTemplateId

get template

Pobiera szczegóły konkretnego szablonu wizualizacji faktury.

/template/{templateId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://ksef.devapo.app/api/rest/v1/template/{templateId}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TemplateApi;

import java.io.File;
import java.util.*;

public class TemplateApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | Identyfikator szablonu wizualizacji.

        try {
            Visualization-Template result = apiInstance.getTemplateTemplateId(templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getTemplateTemplateId");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String templateId = new String(); // String | Identyfikator szablonu wizualizacji.

try {
    final result = await api_instance.getTemplateTemplateId(templateId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTemplateTemplateId: $e\n');
}

import org.openapitools.client.api.TemplateApi;

public class TemplateApiExample {
    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | Identyfikator szablonu wizualizacji.

        try {
            Visualization-Template result = apiInstance.getTemplateTemplateId(templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getTemplateTemplateId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
TemplateApi *apiInstance = [[TemplateApi alloc] init];
String *templateId = templateId_example; // Identyfikator szablonu wizualizacji. (default to null)

// get template
[apiInstance getTemplateTemplateIdWith:templateId
              completionHandler: ^(Visualization-Template output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.TemplateApi()
var templateId = templateId_example; // {String} Identyfikator szablonu wizualizacji.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTemplateTemplateId(templateId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getTemplateTemplateIdExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TemplateApi();
            var templateId = templateId_example;  // String | Identyfikator szablonu wizualizacji. (default to null)

            try {
                // get template
                Visualization-Template result = apiInstance.getTemplateTemplateId(templateId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TemplateApi.getTemplateTemplateId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TemplateApi();
$templateId = templateId_example; // String | Identyfikator szablonu wizualizacji.

try {
    $result = $api_instance->getTemplateTemplateId($templateId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->getTemplateTemplateId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TemplateApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TemplateApi->new();
my $templateId = templateId_example; # String | Identyfikator szablonu wizualizacji.

eval {
    my $result = $api_instance->getTemplateTemplateId(templateId => $templateId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->getTemplateTemplateId: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TemplateApi()
templateId = templateId_example # String | Identyfikator szablonu wizualizacji. (default to null)

try:
    # get template
    api_response = api_instance.get_template_template_id(templateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->getTemplateTemplateId: %s\n" % e)

extern crate TemplateApi;

pub fn main() {
    let templateId = templateId_example; // String

    let mut context = TemplateApi::Context::default();
    let result = client.getTemplateTemplateId(templateId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
templateId*	String Identyfikator szablonu wizualizacji. Required

Responses

Schema

Schema

Schema

postTemplate

create template

Przesyła i zapisuje nowy, własny szablon wizualizacji faktury. Szablon (np. w formacie HTML lub XSL-FO) musi być zakodowany w Base64. System waliduje poprawność szablonu.

/template

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://ksef.devapo.app/api/rest/v1/template" \
 -d ''

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TemplateApi;

import java.io.File;
import java.util.*;

public class TemplateApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        TemplateApi apiInstance = new TemplateApi();
        VisualizationTemplate visualizationTemplate = ; // VisualizationTemplate | 

        try {
            Visualization-Template result = apiInstance.postTemplate(visualizationTemplate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#postTemplate");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final VisualizationTemplate visualizationTemplate = new VisualizationTemplate(); // VisualizationTemplate | 

try {
    final result = await api_instance.postTemplate(visualizationTemplate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->postTemplate: $e\n');
}

import org.openapitools.client.api.TemplateApi;

public class TemplateApiExample {
    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        VisualizationTemplate visualizationTemplate = ; // VisualizationTemplate | 

        try {
            Visualization-Template result = apiInstance.postTemplate(visualizationTemplate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#postTemplate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];


// Create an instance of the API class
TemplateApi *apiInstance = [[TemplateApi alloc] init];
VisualizationTemplate *visualizationTemplate = ; // 

// create template
[apiInstance postTemplateWith:visualizationTemplate
              completionHandler: ^(Visualization-Template output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var DevapoKseFIntegratorRestApi = require('devapo_kse_f_integrator_rest_api');
var defaultClient = DevapoKseFIntegratorRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Create an instance of the API class
var api = new DevapoKseFIntegratorRestApi.TemplateApi()
var visualizationTemplate = ; // {VisualizationTemplate} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postTemplate(visualizationTemplate, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new TemplateApi();
            var visualizationTemplate = new VisualizationTemplate(); // VisualizationTemplate | 

            try {
                // create template
                Visualization-Template result = apiInstance.postTemplate(visualizationTemplate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TemplateApi.postTemplate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TemplateApi();
$visualizationTemplate = ; // VisualizationTemplate | 

try {
    $result = $api_instance->postTemplate($visualizationTemplate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->postTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TemplateApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TemplateApi->new();
my $visualizationTemplate = WWW::OPenAPIClient::Object::VisualizationTemplate->new(); # VisualizationTemplate | 

eval {
    my $result = $api_instance->postTemplate(visualizationTemplate => $visualizationTemplate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->postTemplate: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.TemplateApi()
visualizationTemplate =  # VisualizationTemplate | 

try:
    # create template
    api_response = api_instance.post_template(visualizationTemplate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->postTemplate: %s\n" % e)

extern crate TemplateApi;

pub fn main() {
    let visualizationTemplate = ; // VisualizationTemplate

    let mut context = TemplateApi::Context::default();
    let result = client.postTemplate(visualizationTemplate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters

Name	Description
visualizationTemplate *

Responses

Schema

Schema

Schema