PRO REST API

REST API en el espacio de nombres polski-pro/v1 para gestionar facturas, ajustes y documentos legales. Requiere autenticación y la capacidad manage_woocommerce.

Requisitos

Polski PRO requiere: Polski (gratis) v1.3.0+, WordPress 6.4+, WooCommerce 8.0+, PHP 8.1+

Autenticación

La API requiere dos elementos de autorización:

1. Nonce de WordPress - la cabecera X-WP-Nonce con un valor generado por wp_create_nonce('wp_rest')
2. Capacidad - el usuario que ha iniciado sesión debe tener la capacidad manage_woocommerce

Ejemplo de autenticación (JavaScript)

const response = await fetch('/wp-json/polski-pro/v1/invoices', {
    headers: {
        'X-WP-Nonce': wpApiSettings.nonce,
        'Content-Type': 'application/json',
    },
});

Ejemplo de autenticación (PHP / cURL)

$nonce = wp_create_nonce('wp_rest');

$response = wp_remote_get(
    rest_url('polski-pro/v1/invoices'),
    [
        'headers' => [
            'X-WP-Nonce' => $nonce,
        ],
    ]
);

Las solicitudes sin autenticar o las de usuarios sin la capacidad requerida reciben una respuesta 401 Unauthorized o 403 Forbidden.

Endpoints de facturas

Obtener la lista de facturas

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

Parámetros de consulta:

Parámetro	Tipo	Predeterminado	Descripción
page	int	1	Número de página
per_page	int	20	Resultados por página (máx. 100)
status	string	any	Filtro de estado: draft, issued, sent, paid, cancelled
date_from	string	null	Fecha desde (Y-m-d)
date_to	string	null	Fecha hasta (Y-m-d)
order_id	int	null	Filtrar por ID de pedido de WooCommerce
search	string	null	Buscar por número de factura o nombre del contratante

Respuesta (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
}

Crear factura a partir de un pedido

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

Parámetros del cuerpo (JSON):

Parámetro	Tipo	Obligatorio	Descripción
order_id	int	Sí	ID de pedido de WooCommerce
type	string	No	Tipo: vat (predeterminado), proforma, receipt
issue_date	string	No	Fecha de emisión (Y-m-d), por defecto hoy
due_date	string	No	Fecha de vencimiento del pago (Y-m-d)
notes	string	No	Notas en la factura
send_to_provider	bool	No	Enviar al sistema contable (predeterminado true)

Solicitud:

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

Respuesta (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"
}

Obtener los detalles de una factura

GET /wp-json/polski-pro/v1/invoices/{id}

Devuelve los datos completos de la factura, incluidas las líneas.

Respuesta (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
}

Respuesta (404 Not Found):

{
    "code": "invoice_not_found",
    "message": "Faktura o podanym ID nie istnieje.",
    "data": { "status": 404 }
}

Regenerar el PDF de la factura

POST /wp-json/polski-pro/v1/invoices/{id}/pdf

Regenera el archivo PDF de la factura y devuelve la URL de descarga.

Parámetros del cuerpo (opcionales):

Parámetro	Tipo	Descripción
template	string	Plantilla PDF: default, minimal, detailed
language	string	Idioma: pl, en, de

Respuesta (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
}

Enviar la factura a KSeF

POST /wp-json/polski-pro/v1/invoices/{id}/ksef

Envía la factura al Sistema Nacional de e-Facturas (KSeF).

Parámetros del cuerpo (opcionales):

Parámetro	Tipo	Descripción
test_mode	bool	Enviar al entorno de pruebas de KSeF (predeterminado false)

Respuesta (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"
}

Respuesta (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"
        ]
    }
}

Crear una factura rectificativa

POST /wp-json/polski-pro/v1/invoices/{id}/correction

Crea una factura rectificativa vinculada a la factura de origen.

Parámetros del cuerpo (JSON):

Parámetro	Tipo	Obligatorio	Descripción
reason	string	Sí	Motivo de la rectificación
items	array	Sí	Líneas rectificadas
items[].original_index	int	Sí	Índice de la línea en la factura de origen (desde 0)
items[].quantity	int	No	Nueva cantidad
items[].net_price	string	No	Nuevo precio neto

Solicitud:

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

Respuesta (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"
}

Endpoint de estadísticas

Obtener las estadísticas de facturas

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

Parámetros de consulta:

Parámetro	Tipo	Predeterminado	Descripción
days	int	30	Número de días hacia atrás
group_by	string	day	Agrupación: day, week, month

Respuesta (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" }
    ]
}

Endpoint de ajustes

Actualizar los ajustes PRO

POST /wp-json/polski-pro/v1/settings

Parámetros del cuerpo (JSON):

Parámetro	Tipo	Descripción
section	string	Sección de ajustes: invoices, catalog, quote, inpost, accounting
settings	object	Objeto con pares clave-valor de ajustes

Solicitud:

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

Respuesta (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"
}

Endpoint de generación de documentos legales

Generar un documento legal

POST /wp-json/polski-pro/v1/legal/generate

Genera documentos legales (términos y condiciones, política de privacidad) a partir de los datos de la tienda.

Parámetros del cuerpo (JSON):

Parámetro	Tipo	Obligatorio	Descripción
type	string	Sí	Tipo de documento: terms, privacy, withdrawal, cookies
company_data	object	Sí	Datos de la empresa
company_data.name	string	Sí	Nombre de la empresa
company_data.nip	string	Sí	NIF (NIP)
company_data.address	string	Sí	Dirección
company_data.email	string	Sí	Correo electrónico de contacto
company_data.phone	string	No	Número de teléfono
format	string	No	Formato: html (predeterminado), markdown, pdf
language	string	No	Idioma: pl (predeterminado)

Solicitud:

{
    "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"
}

Respuesta (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"
    ]
}

Códigos de error

Todos los endpoints devuelven códigos de error estandarizados:

Código HTTP	Código de error	Descripción
400	invalid_params	Parámetros de solicitud no válidos
401	rest_not_logged_in	Usuario no ha iniciado sesión
403	rest_forbidden	Falta la capacidad manage_woocommerce
404	invoice_not_found	La factura no existe
409	invoice_already_exists	Ya existe una factura para este pedido
422	validation_error	Error de validación de datos
429	rate_limit_exceeded	Límite de solicitudes superado (60/min)
500	internal_error	Error interno del servidor

Límites y limitación de velocidad

La API aplica una limitación de velocidad: un máximo de 60 solicitudes por minuto y usuario. Al superar el límite, se devuelve una respuesta 429 con la cabecera Retry-After.

HTTP/1.1 429 Too Many Requests
Retry-After: 30

Próximos pasos

• Informar de problemas: GitHub Issues
• Relacionado: Integraciones contables

Esta página tiene únicamente carácter informativo y no constituye asesoramiento legal. Consulte a un abogado antes de la implementación. Polski for WooCommerce es software de código abierto (GPLv2) proporcionado sin garantía.