Factuarea APIDevelopers
Contracte

Capacitats PDF al compte

El recurs Account i l’endpoint de plantilles exposen un bloc de capacitats només de lectura: què permet el pla en la marca dels documents, quines plantilles es poden fixar i quin pla desbloqueja l’editor. Les actualitzacions de personalització fora del pla retornen ja 403.

GET /v1/account i GET /v1/account/personalization/templates inclouen ja pdf_capabilities, un bloc només de lectura calculat a partir del pla del compte. Permet a una integració activar o desactivar els controls de marca abans de cridar PATCH /v1/account/personalization.

Actualització. pdf_capabilities conserva els mateixos camps. Les opcions avançades de les plantilles de la biblioteca depenen del mòdul pdf_templates_editor, i la biblioteca té els seus propis scopes, pdf_templates:read i pdf_templates:write. Consulta Biblioteca de plantilles PDF i factures estructurades i Accés.

CampSignificat
can_upload_logoEl compte pot pujar un logotip. can_upload_brand_image el replica.
can_customizeL’editor PDF avançat està disponible: color d’accent, plantilles avançades i opcions de maquetació.
requires_attributionEls documents generats conserven l’atribució de Factuarea. true sempre que can_customize sigui false.
available_templatesSlugs que el compte pot fixar: les cinc amb l’editor; si no, classic, modern i minimal.
upgrade_planPla que desbloqueja l’editor per a un compte emprendedor (empresario), o null.

PATCH /v1/account/personalization aplica la mateixa regla: un accent_color o una plantilla fora de available_templates en un compte sense l’editor retorna 403 amb code: feature_not_available_in_plan i no aplica cap camp. Els valors fora del catàleg continuen retornant 422 amb els valors acceptats.

Llegeix Personalització del compte.

Endpoints actualitzats3

EndpointDescripció
GET/v1/meObtenir la credencial que crida
GET/v1/companies/{company}/personalization/templatesLlista les plantilles de personalització disponibles
PATCH/v1/companies/{company}/personalizationActualitza la personalització del compte