> ## Documentation Index
> Fetch the complete documentation index at: https://docs.go.aiinsurance.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Rebuild Financials Read-State

> Rebuilds the company's derived financial read state from its source of
truth (the journal and ledger) — the remediation counterpart of
`GET …/financials/validation/check`. Cache maintenance, NOT a financial
action: no journal records are written, no amounts change; the rebuild
runs under an exclusive company-level lock, serialized against every
in-flight financials write.

`scope` picks which derived read models to rebuild — `invoices` (invoices
and their payments), `balances` (entity account balances), or `earning`
(policy earning layers); omit it to
rebuild everything. Returns per-table rebuilt row counts (`0` for
out-of-scope tables).

**Idempotent and safe at any time.** The read state is a pure derivation
of the journal, so re-running converges on the same result. Verify with
the [check endpoint](/api-reference/financials/check-financials-read-state-consistency).

**Required permission:** `company.payment:update`




## OpenAPI

````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/financials/validation/sync
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/financials/validation/sync:
    post:
      tags:
        - Financials
      summary: Rebuild Financials Read-State
      description: >
        Rebuilds the company's derived financial read state from its source of

        truth (the journal and ledger) — the remediation counterpart of

        `GET …/financials/validation/check`. Cache maintenance, NOT a financial

        action: no journal records are written, no amounts change; the rebuild

        runs under an exclusive company-level lock, serialized against every

        in-flight financials write.


        `scope` picks which derived read models to rebuild — `invoices`
        (invoices

        and their payments), `balances` (entity account balances), or `earning`

        (policy earning layers); omit it to

        rebuild everything. Returns per-table rebuilt row counts (`0` for

        out-of-scope tables).


        **Idempotent and safe at any time.** The read state is a pure derivation

        of the journal, so re-running converges on the same result. Verify with

        the [check
        endpoint](/api-reference/financials/check-financials-read-state-consistency).


        **Required permission:** `company.payment:update`
      operationId: syncFinancialsValidation
      parameters:
        - $ref: '#/components/parameters/companyId'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                scope:
                  type: string
                  enum:
                    - invoices
                    - balances
                    - earning
                  description: >-
                    Which derived read models to rebuild; omit to rebuild
                    everything
            examples:
              everything:
                summary: Rebuild everything (scope omitted)
                value: {}
              invoicesOnly:
                summary: Rebuild the invoice read models only
                value:
                  scope: invoices
      responses:
        '200':
          description: Per-table rebuilt row counts (`0` for out-of-scope tables)
          content:
            application/json:
              schema:
                type: object
                required:
                  - rebuilt
                properties:
                  rebuilt:
                    type: object
                    required:
                      - invoices
                      - invoicePayments
                      - entityAccountBalances
                      - earningLayers
                    properties:
                      invoices:
                        type: integer
                        description: Invoice rows rebuilt
                      invoicePayments:
                        type: integer
                        description: Payment rows rebuilt
                      entityAccountBalances:
                        type: integer
                        description: Entity account balance rows rebuilt
                      earningLayers:
                        type: integer
                        description: Policy earning layer rows rebuilt
              examples:
                fullRebuild:
                  summary: Everything rebuilt
                  value:
                    rebuilt:
                      invoices: 214
                      invoicePayments: 388
                      entityAccountBalances: 152
                      earningLayers: 96
                scopedRebuild:
                  summary: Invoices scope only (balances and earning untouched)
                  value:
                    rebuilt:
                      invoices: 214
                      invoicePayments: 388
                      entityAccountBalances: 0
                      earningLayers: 0
        '400':
          description: Bad Request — an unknown `scope` or unknown fields
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unknownScope:
                  summary: Unknown scope
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: >-
                        scope: Invalid option: expected one of
                        "invoices"|"balances"|"earning"
                      userMessages:
                        - >-
                          scope: Invalid option: expected one of
                          "invoices"|"balances"|"earning"
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            Not Found — the company does not have this financials surface
            enabled (the endpoint behaves as if it does not exist)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                notFound:
                  summary: Not found
                  value:
                    error:
                      code: NotFoundError
                      message: Not found
                      userMessages:
                        - Not found
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: UncaughtActionError
                  message: Uncaught error occurred in <actionName>
                  userMessages:
                    - An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Send your raw API key as the `Authorization`
        header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
        NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
        header; those are not accepted.

````