Skip to main content

Acts guide

Acts represent financial evaluations tied to a client. Each act records the template used, the requested amount and currency, and a set of structured data points captured during the assessment. Use acts to track the latest evaluation status, display input values, or sync completed assessments into your own systems.

What an act includes​

Every act includes core metadata:

  • Identity - A uuid that uniquely identifies the act across the platform.
  • Client linkage - client_id connects the act back to the originating client.
  • Template context - template_id and template_name tell you which template defines the act structure.
  • Financial values - amount and currency capture the requested or approved amount.
  • Locale - language indicates which language the template uses.
  • Timestamps - created_at and updated_at help with auditing and synchronization.

List, detail, and latest act workflows​

Use list workflows to page through recent acts, detail workflows to fetch a single act by UUID, and latest-act workflows to surface the most recent evaluation when you only need current context. If you want the full act history for a client, list acts and filter by client_id in your application or query results. For the exact parameters and responses, use the Acts section in the generated API reference.

Working with act data points​

Act data points represent the values entered for each template field. Fetch all data points when rendering a full act, update a single data point when a user edits one field, and use bulk updates when you need to persist multiple changes at once. The generated API reference documents the request bodies and validation rules for each data workflow.

Each data point includes:

  • id and template_field_id for mapping values back to the template.
  • name, type, and required to describe the field semantics.
  • section_id, tab_id, and order to preserve the template structure.

Always validate values against the template field type and required rules before sending updates.

Best practices​

  • Use templates for validation - Load template details to confirm field types, required flags, and any options constraints before writing data.
  • Cache act detail - Act payloads are stable after completion; cache responses for short periods to reduce API calls.
  • Prefer latest endpoints - Use the latest act endpoints when you only need the most recent evaluation instead of scanning full histories.
  • Track timestamps - Use updated_at to trigger downstream sync jobs or refresh stale views.

Working with the API reference​

The generated API reference in the sidebar documents every request and response schema for acts and act data. Combine the conceptual guidance here with the reference details to build reliable act workflows.