Skip to main content

Templates guide

Templates define the structure of financial acts. Each template contains tabs, sections, and fields that describe what data must be captured for an evaluation. Fetch templates to render data-entry forms, validate inputs, or map act data points into your internal schema.

What a template includes​

A template is a hierarchical structure:

  • Template metadata - id, name, country, language, and timestamps for auditing.
  • Tabs - Ordered groupings of sections that match the UI layout used by Krebit Finance.
  • Sections - Ordered clusters of fields inside each tab.
  • Fields - Individual data points with id, name, type, required, options, and order.

Use field metadata to enforce validation rules and guide operators through the expected data entry flow.

Template workflows​

Use list workflows to discover templates by name or country, then fetch a specific template when you need field-level metadata such as tabs, sections, and fields. The Templates section of the generated API reference includes the authoritative request parameters and response shapes.

Mapping templates to act data​

Act data points return template_field_id, name, type, required, section_id, and tab_id. Use these relationships to:

  • Match act values back to template fields.
  • Render forms that mirror the same tab and section order.
  • Validate or transform values based on each field's type and options.

If you persist act data in your own database, store the template ID alongside each record so you can reconcile changes when templates evolve.

Best practices​

  • Cache templates - Templates do not change frequently. Cache responses and refresh on a schedule to minimize API calls.
  • Validate before update - When updating act data, use the template to enforce required fields and acceptable value formats.
  • Support localization - Templates include language and country. Respect these when rendering forms or labels.

Working with the API reference​

The generated API reference in the sidebar documents every request and response schema for templates. Combine the conceptual guidance here with the reference details for exact field definitions.