---
title: "PATCH /policy/{tenantLocator}/transactions/{locator}/initialize"
method: PATCH
path: "/policy/{tenantLocator}/transactions/{locator}/initialize"
---

# PATCH /policy/{tenantLocator}/transactions/{locator}/initialize

`PATCH /policy/{tenantLocator}/transactions/{locator}/initialize`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/policy/{tenantLocator}/transactions/{locator}/initialize`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/policy/:tenantLocator/transactions/:locator/initialize/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required
- `locator` string, ulid, required

## Response `200`

OK

- PolicyTransactionResponse
  - `locator` string, ulid, required
  - `transactionCategory` 'issuance' | 'change' | 'renewal' | 'cancellation' | 'continuation' | 'flatCancellation' | 'reinstatement' | 'reversal' | 'aggregate', required
  - `transactionState` 'draft' | 'initialized' | 'validated' | 'earlyUnderwritten' | 'priced' | 'underwritten' | 'accepted' | 'issued' | 'underwrittenBlocked' | 'declined' | 'rejected' | 'refused' | 'discarded' | 'invalidated' | 'reversed', required
  - `underwritingStatus` string
  - `policyLocator` string, ulid, required
  - `baseTransactionLocator` string, ulid
  - `aggregateTransactionLocator` string, ulid
  - `createdAt` string, date-time, required
  - `createdBy` string, uuid, required
  - `validationResult` ValidationResult
    - `validationItems` ValidationItemResponse[]
      - `elementType` string, required
      - `locator` string, ulid, required
      - `errors` string[], required
    - `success` boolean, required
  - `changeInstructions` union[]
    - union
      - AddChangeInstructionResponse
        - `action` 'add', required
        - `elements` ElementCreateRequest[], required
          - `type` string, required
          - `parentLocator` string, ulid
          - `elements` ElementCreateRequest[], required
          - `coverageTerms` object
          - `data` object
          - `staticLocator` string, ulid
        - `transactionConflictResolution` 'elidedInstruction', required
        - `locator` string, ulid, required
      - DeleteChangeInstructionResponse
        - `action` 'delete', required
        - `staticElementLocators` string[], required
        - `locator` string, ulid, required
      - ModifyChangeInstructionResponse
        - `action` 'modify', required
        - `staticLocator` string, ulid, required
        - `setData` object, required
        - `removeData` object, required
        - `setCoverageTerms` object, required
        - `removeCoverageTerms` object, required
        - `transactionConflictResolution` 'elidedInstruction', required
        - `locator` string, ulid, required
      - ParamsChangeInstructionResponse
        - `action` 'params', required
        - `effectiveTime` string, date-time, required
        - `newPolicyEndTime` string, date-time
        - `preferences` Preferences
          - `installmentPreferences` InstallmentPreferences
            - `cadence` 'none' | 'fullPay' | 'weekly' | 'everyOtherWeek' | 'monthly' | 'quarterly' | 'semiannually' | 'annually' | 'thirtyDays' | 'everyNDays'
            - `anchorMode` 'generateDay' | 'termStartDay' | 'dueDay'
            - `generateLeadDays` integer
            - `dueLeadDays` integer
            - `installmentWeights` number[], required
            - `maxInstallmentsPerTerm` integer
            - `installmentPlanName` string
            - `anchorType` 'none' | 'dayOfMonth' | 'anchorTime' | 'dayOfWeek' | 'weekOfMonth'
            - `dayOfMonth` integer
            - `dayOfWeek` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
            - `weekOfMonth` 'none' | 'first' | 'second' | 'third' | 'fourth' | 'fifth'
            - `anchorTime` string, date-time
            - `autopayLeadDays` number
        - `billingModeChange` boolean: Use triggerBillingChange instead.
        - `triggerBillingChange` boolean
        - `inheritSettings` boolean
        - `expirationTime` string, date-time
        - `locator` string, ulid, required
      - ProducersChangeInstructionResponse
        - `action` 'producers', required
        - `setProducerCode` string
        - `clearProducerCode` boolean
        - `setProducerCodeOfRecord` string
        - `revertProducerCodeOfRecord` boolean
        - `locator` string, ulid, required
      - MigrateChangeInstructionResponse
        - `action` 'migrate', required
        - `configVersionLocator` string, ulid
        - `locator` string, ulid, required
      - TransactionDataChangeInstructionResponse
        - `action` 'transactionData', required
        - `data` object, required: Policy transaction extension data can only be associated with a named policy transaction
        - `locator` string, ulid, required
  - `effectiveTime` string, date-time, required
  - `aggregatedTransactions` PolicyTransactionResponse[]
  - `termLocator` string, ulid, required
  - `preferences` Preferences
    - `installmentPreferences` InstallmentPreferences
      - `cadence` 'none' | 'fullPay' | 'weekly' | 'everyOtherWeek' | 'monthly' | 'quarterly' | 'semiannually' | 'annually' | 'thirtyDays' | 'everyNDays'
      - `anchorMode` 'generateDay' | 'termStartDay' | 'dueDay'
      - `generateLeadDays` integer
      - `dueLeadDays` integer
      - `installmentWeights` number[], required
      - `maxInstallmentsPerTerm` integer
      - `installmentPlanName` string
      - `anchorType` 'none' | 'dayOfMonth' | 'anchorTime' | 'dayOfWeek' | 'weekOfMonth'
      - `dayOfMonth` integer
      - `dayOfWeek` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
      - `weekOfMonth` 'none' | 'first' | 'second' | 'third' | 'fourth' | 'fifth'
      - `anchorTime` string, date-time
      - `autopayLeadDays` number
  - `transactionType` string, required
  - `issuedTime` string, date-time
  - `acceptedTime` string, date-time
  - `reapplicationOfLocator` string, ulid
  - `maskingLevel` 'none' | 'level1' | 'level2'
  - `anonymizedAt` string, date-time
  - `staticLocator` string, ulid, required: Equals the locator of the first transaction this is based on.
  - `expirationTime` string, date-time
  - `data` object, required

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/77ee7d8172b9?raw)