Preskočiť na obsah

PRO REST API

REST API v namespace polski-pro/v1 na správu faktúr, nastavení a právnych dokumentov. Vyžaduje autentifikáciu a oprávnenie manage_woocommerce.

API vyžaduje dva prvky autorizácie:

  1. Nonce WordPress - hlavička X-WP-Nonce s hodnotou vygenerovanou cez wp_create_nonce('wp_rest')
  2. Oprávnenie - prihlásený používateľ musí mať capability manage_woocommerce
const response = await fetch('/wp-json/polski-pro/v1/invoices', {
headers: {
'X-WP-Nonce': wpApiSettings.nonce,
'Content-Type': 'application/json',
},
});
$nonce = wp_create_nonce('wp_rest');
$response = wp_remote_get(
rest_url('polski-pro/v1/invoices'),
[
'headers' => [
'X-WP-Nonce' => $nonce,
],
]
);

Neautentifikované požiadavky alebo požiadavky od používateľov bez požadovaného oprávnenia dostanú odpoveď 401 Unauthorized alebo 403 Forbidden.

GET /wp-json/polski-pro/v1/invoices

Parametre požiadavky:

ParameterTypPredvolenáPopis
pageint1Číslo stránky
per_pageint20Počet výsledkov na stránku (max 100)
statusstringanyFilter stavu: draft, issued, sent, paid, cancelled
date_fromstringnullDátum od (Y-m-d)
date_tostringnullDátum do (Y-m-d)
order_idintnullFilter podľa ID objednávky WooCommerce
searchstringnullVyhľadávanie podľa čísla faktúry alebo názvu odberateľa

Odpoveď (200 OK):

{
"invoices": [
{
"id": 1,
"number": "FV/2026/04/001",
"order_id": 567,
"status": "issued",
"type": "vat",
"buyer": {
"name": "Firma Testowa Sp. z o.o.",
"nip": "1234567890",
"address": "ul. Testowa 1, 00-001 Warszawa"
},
"net_total": "1000.00",
"tax_total": "230.00",
"gross_total": "1230.00",
"currency": "PLN",
"issued_at": "2026-04-01T10:30:00+02:00",
"due_date": "2026-04-15",
"external_id": "FV-12345",
"provider": "fakturownia"
}
],
"total": 42,
"pages": 3
}
POST /wp-json/polski-pro/v1/invoices

Parametre body (JSON):

ParameterTypPovinnýPopis
order_idintÁnoID objednávky WooCommerce
typestringNieTyp: vat (predvolene), proforma, receipt
issue_datestringNieDátum vystavenia (Y-m-d), predvolene dnes
due_datestringNieLehota platby (Y-m-d)
notesstringNiePoznámky na faktúre
send_to_providerboolNieOdoslať do účtovného systému (predvolene true)

Požiadavka:

{
"order_id": 567,
"type": "vat",
"due_date": "2026-04-15",
"notes": "Termin płatności 14 dni",
"send_to_provider": true
}

Odpoveď (201 Created):

{
"id": 43,
"number": "FV/2026/04/002",
"order_id": 567,
"status": "issued",
"type": "vat",
"buyer": {
"name": "Firma Testowa Sp. z o.o.",
"nip": "1234567890",
"address": "ul. Testowa 1, 00-001 Warszawa"
},
"net_total": "500.00",
"tax_total": "115.00",
"gross_total": "615.00",
"currency": "PLN",
"issued_at": "2026-04-05T14:00:00+02:00",
"due_date": "2026-04-15",
"external_id": null,
"provider_status": "pending"
}
GET /wp-json/polski-pro/v1/invoices/{id}

Vracia kompletné dáta faktúry vrátane položiek (items).

Odpoveď (200 OK):

{
"id": 43,
"number": "FV/2026/04/002",
"order_id": 567,
"status": "issued",
"type": "vat",
"buyer": {
"name": "Firma Testowa Sp. z o.o.",
"nip": "1234567890",
"address": "ul. Testowa 1, 00-001 Warszawa"
},
"seller": {
"name": "Mój Sklep Sp. z o.o.",
"nip": "9876543210",
"address": "ul. Sklepowa 5, 02-222 Warszawa"
},
"items": [
{
"name": "Produkt testowy",
"sku": "TEST-001",
"quantity": 2,
"unit": "szt.",
"net_price": "100.00",
"tax_rate": 23,
"tax_amount": "46.00",
"gross_price": "246.00"
},
{
"name": "Dostawa - InPost Paczkomat",
"sku": null,
"quantity": 1,
"unit": "szt.",
"net_price": "12.20",
"tax_rate": 23,
"tax_amount": "2.80",
"gross_price": "15.00"
}
],
"net_total": "212.20",
"tax_total": "48.80",
"gross_total": "261.00",
"currency": "PLN",
"payment_method": "transfer",
"issued_at": "2026-04-05T14:00:00+02:00",
"due_date": "2026-04-15",
"notes": "Termin płatności 14 dni",
"external_id": "FV-12346",
"provider": "fakturownia",
"provider_status": "issued",
"ksef_number": null
}

Odpoveď (404 Not Found):

{
"code": "invoice_not_found",
"message": "Faktura o podanym ID nie istnieje.",
"data": { "status": 404 }
}
POST /wp-json/polski-pro/v1/invoices/{id}/pdf

Regeneruje súbor PDF faktúry a vráti URL na stiahnutie.

Parametre body (voliteľné):

ParameterTypPopis
templatestringŠablóna PDF: default, minimal, detailed
languagestringJazyk: pl, en, de

Odpoveď (200 OK):

{
"id": 43,
"pdf_url": "https://example.com/wp-content/uploads/polski-pro/invoices/FV-2026-04-002.pdf",
"generated_at": "2026-04-05T14:05:00+02:00",
"file_size": 45678
}
POST /wp-json/polski-pro/v1/invoices/{id}/ksef

Odošle faktúru do Krajového systému e-faktúr (KSeF).

Parametre body (voliteľné):

ParameterTypPopis
test_modeboolOdoslať do testovacieho prostredia KSeF (predvolene false)

Odpoveď (200 OK):

{
"id": 43,
"ksef_number": "1234567890-20260405-ABC123DEF456",
"ksef_status": "accepted",
"submitted_at": "2026-04-05T14:10:00+02:00",
"upo_url": "https://example.com/wp-content/uploads/polski-pro/ksef/UPO-43.xml"
}

Odpoveď (422 Unprocessable Entity):

{
"code": "ksef_validation_error",
"message": "Faktura nie spełnia wymagań schematu KSeF.",
"data": {
"status": 422,
"errors": [
"Brak numeru NIP nabywcy",
"Nieprawidłowa stawka VAT dla pozycji 2"
]
}
}
POST /wp-json/polski-pro/v1/invoices/{id}/correction

Vytvorí opravnú faktúru prepojenú so zdrojovou faktúrou.

Parametre body (JSON):

ParameterTypPovinnýPopis
reasonstringÁnoDôvod opravy
itemsarrayÁnoOpravené položky
items[].original_indexintÁnoIndex položky na zdrojovej faktúre (od 0)
items[].quantityintNieNové množstvo
items[].net_pricestringNieNová cena bez DPH

Požiadavka:

{
"reason": "Zwrot 1 sztuki produktu",
"items": [
{
"original_index": 0,
"quantity": 1,
"net_price": "100.00"
}
]
}

Odpoveď (201 Created):

{
"id": 44,
"number": "FK/2026/04/001",
"type": "correction",
"original_invoice_id": 43,
"original_invoice_number": "FV/2026/04/002",
"reason": "Zwrot 1 sztuki produktu",
"items": [
{
"name": "Produkt testowy",
"quantity_before": 2,
"quantity_after": 1,
"net_difference": "-100.00",
"tax_difference": "-23.00",
"gross_difference": "-123.00"
}
],
"net_total": "-100.00",
"tax_total": "-23.00",
"gross_total": "-123.00",
"status": "issued",
"issued_at": "2026-04-05T15:00:00+02:00"
}
GET /wp-json/polski-pro/v1/invoices/stats

Parametre požiadavky:

ParameterTypPredvolenáPopis
daysint30Počet dní dozadu
group_bystringdayZoskupovanie: day, week, month

Odpoveď (200 OK):

{
"period": {
"from": "2026-03-06",
"to": "2026-04-05"
},
"summary": {
"total_invoices": 156,
"total_net": "125430.00",
"total_tax": "28848.90",
"total_gross": "154278.90",
"total_corrections": 3,
"average_invoice_value": "989.22"
},
"by_status": {
"issued": 120,
"sent": 25,
"paid": 8,
"cancelled": 3
},
"by_tax_rate": {
"23": { "count": 140, "net": "110000.00", "tax": "25300.00" },
"8": { "count": 12, "net": "12000.00", "tax": "960.00" },
"5": { "count": 4, "net": "3430.00", "tax": "171.50" }
},
"timeline": [
{ "date": "2026-04-05", "count": 5, "gross": "4890.00" },
{ "date": "2026-04-04", "count": 7, "gross": "6230.00" }
]
}
POST /wp-json/polski-pro/v1/settings

Parametre body (JSON):

ParameterTypPopis
sectionstringSekcia nastavení: invoices, catalog, quote, inpost, accounting
settingsobjectObjekt s pármi kľúč-hodnota nastavení

Požiadavka:

{
"section": "invoices",
"settings": {
"auto_issue": true,
"trigger_status": "processing",
"default_type": "vat",
"due_days": 14,
"number_format": "FV/{year}/{month}/{number}"
}
}

Odpoveď (200 OK):

{
"section": "invoices",
"settings": {
"auto_issue": true,
"trigger_status": "processing",
"default_type": "vat",
"due_days": 14,
"number_format": "FV/{year}/{month}/{number}"
},
"updated_at": "2026-04-05T14:20:00+02:00"
}
POST /wp-json/polski-pro/v1/legal/generate

Generuje právne dokumenty (obchodné podmienky, zásady ochrany osobných údajov) na základe dát obchodu.

Parametre body (JSON):

ParameterTypPovinnýPopis
typestringÁnoTyp dokumentu: terms, privacy, withdrawal, cookies
company_dataobjectÁnoDáta firmy
company_data.namestringÁnoNázov firmy
company_data.nipstringÁnoIČ DPH
company_data.addressstringÁnoAdresa
company_data.emailstringÁnoKontaktný e-mail
company_data.phonestringNieTelefón
formatstringNieFormát: html (predvolene), markdown, pdf
languagestringNieJazyk: pl (predvolene)

Požiadavka:

{
"type": "terms",
"company_data": {
"name": "Mój Sklep Sp. z o.o.",
"nip": "9876543210",
"address": "ul. Sklepowa 5, 02-222 Warszawa",
"email": "[email protected]",
"phone": "+48 123 456 789"
},
"format": "html"
}

Odpoveď (200 OK):

{
"type": "terms",
"content": "<h1>Regulamin sklepu internetowego...</h1>...",
"format": "html",
"generated_at": "2026-04-05T14:25:00+02:00",
"word_count": 3200,
"sections": [
"Postanowienia ogólne",
"Składanie zamówień",
"Płatności",
"Dostawa",
"Prawo odstąpienia od umowy",
"Reklamacje",
"Dane osobowe",
"Postanowienia końcowe"
]
}

Všetky endpointy vracajú štandardizované chybové kódy:

HTTP kódKód chybyPopis
400invalid_paramsNeplatné parametre požiadavky
401rest_not_logged_inPoužívateľ neprihlásený
403rest_forbiddenChýba oprávnenie manage_woocommerce
404invoice_not_foundFaktúra neexistuje
409invoice_already_existsFaktúra pre túto objednávku už existuje
422validation_errorChyba validácie dát
429rate_limit_exceededPrekročený limit požiadaviek (60/min)
500internal_errorInterná chyba servera

API uplatňuje rate limiting: maximálne 60 požiadaviek za minútu na používateľa. Po prekročení limitu sa vracia odpoveď 429 s hlavičkou Retry-After.

HTTP/1.1 429 Too Many Requests
Retry-After: 30
Táto stránka slúži len na informačné účely a nepredstavuje právne poradenstvo. Pred implementáciou sa poraďte s právnikom. Polski for WooCommerce je open source softvér (GPLv2) poskytovaný bez záruky.