API reference

Complete Fakturnia REST API reference, generated from OpenAPI: endpoints, parameters, request bodies, responses and schemas.

Base URL: https://prod.api.fakturnia.pl/external/v1

documents

• GET /documents/ Get list of documents
• POST /documents/ Create a new document
• GET /documents/{id} Get document details
• PUT /documents/{id} Full update of an existing document
• PATCH /documents/{id} Partial update of a document field(s)
• DELETE /documents/{id} Delete a document
• GET /documents/{id}/download Download document
• POST /documents/validate Dry-run validation of a document payload (no DB writes)
• PATCH /documents/{id}/payment-status Update document payment status
• PATCH /documents/{id}/external-reference Link document with external order reference
• DELETE /documents/{id}/external-reference Remove external order reference from a document
• PATCH /documents/{id}/margin-purchases Set purchase amounts of margin-scheme lines
• POST /documents/{id}/send-to-ksef Send document to KSeF
• GET /documents/{id}/ksef-status Get document KSeF send status
• GET /documents/{id}/history Get the history of a document

clients

• GET /clients/ Get list of clients
• POST /clients/ Create a new client
• GET /clients/{id} Get client details
• PUT /clients/{id} Update an existing client
• DELETE /clients/{id} Delete a client

products

• GET /products/ Get list of products
• POST /products/ Create a new product
• GET /products/{id} Get product details
• PUT /products/{id} Update an existing product
• DELETE /products/{id} Delete a product

dictionaries

• GET /dictionaries/ Get static dictionaries (document types, payment methods, etc.)

ksef

• GET /ksef/connection Get KSeF connection status
• POST /ksef/connection Create or update KSeF connection (token or certificate)
• DELETE /ksef/connection Deactivate KSeF connection
• POST /ksef/connection/test Test KSeF connection authorization and permissions

webhooks

• GET /webhooks/ List webhooks
• POST /webhooks/ Create a webhook
• POST /webhooks/initial Create the initial webhook of a plugin (all events)
• GET /webhooks/{id} Get a webhook
• PATCH /webhooks/{id} Update a webhook
• DELETE /webhooks/{id} Delete a webhook
• POST /webhooks/{id}/rotate-secret Rotate the signing secret of a webhook
• GET /webhooks/{id}/deliveries List recent deliveries of a webhook
• POST /webhooks/{id}/test Send a test delivery to a webhook

settings

• GET /settings/ Get general and numbering settings
• PATCH /settings/general Update general settings (date format, newsletter)
• PATCH /settings/numbering Update numbering settings (type, format, symbols)

company

• GET /company/nip-lookup Lookup company data in GUS by NIP

warehouse

• GET /warehouse/ Get list of warehouses
• POST /warehouse/ Create a warehouse (requires the MAX plan)
• GET /warehouse/stock Get stock levels report (sum of movements per product/warehouse)
• GET /warehouse/movements List stock movements
• POST /warehouse/adjustments Create a manual stock adjustment (INW movement)
• POST /warehouse/wz-from-invoice/{id} Create a WZ document from a sales invoice (goods lines only)
• POST /warehouse/documents/validate Validate a warehouse document without saving it
• POST /warehouse/documents Issue a warehouse document (WZ, PZ, PW, RW, MM)
• GET /warehouse/{id} Get a warehouse
• PUT /warehouse/{id} Update a warehouse
• DELETE /warehouse/{id} Delete a warehouse (blocked when it has stock movements)

employees

• GET /employees/permissions Get the registry of available employee permissions
• GET /employees/ Get list of employee accounts
• POST /employees/ Create an employee account
• GET /employees/{id} Get an employee account
• PUT /employees/{id} Update an employee account (data, permissions, activation, password)
• DELETE /employees/{id} Delete an employee account (soft delete; its email becomes available again)
• GET /employees/{id}/activity Get the activity feed of an employee

recurring-rules

• GET /recurring-rules/ Get list of recurring document rules
• GET /recurring-rules/{id}/history Get generation history of a recurring rule
• GET /recurring-rules/{id} Get recurring rule details
• PATCH /recurring-rules/{id}/toggle Pause or resume a recurring rule

email-accounts

• GET /email-accounts/ List connected email accounts
• GET /email-accounts/{id} Get a connected email account

activity

• GET /activity/ Get the account activity feed

auth

• GET /auth/me Get information about the current account