{
 "openapi": "3.1.0",
 "info": {
  "title": "Retention Policies (Platform)",
  "version": "20261030b",
  "description": "Archive or purge one kind of data once it is older than the years you set AND has not been added to or changed for the years you set — then again on the period you choose. There are no defaults and none is shipped. A policy starts switched off: preview it, then switch it on. Records something else still refers to are kept and counted. Purging needs the delete permission on this screen."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "retention-policies": {
    "type": "object",
    "required": [
     "code",
     "name",
     "target",
     "action",
     "older_than_years",
     "untouched_years",
     "frequency"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "code": {
      "type": "string",
      "description": "Policy code"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "target": {
      "type": "string",
      "description": "Data"
     },
     "action": {
      "type": "string",
      "description": "Archive or purge",
      "enum": [
       "archive",
       "purge"
      ]
     },
     "older_than_years": {
      "type": "integer",
      "description": "Older than (years)"
     },
     "untouched_years": {
      "type": "integer",
      "description": "Not added or changed for (years)"
     },
     "frequency": {
      "type": "string",
      "description": "Runs",
      "enum": [
       "daily",
       "weekly",
       "monthly",
       "quarterly",
       "yearly"
      ]
     },
     "first_run_at": {
      "type": "string",
      "format": "date-time",
      "description": "First run"
     },
     "max_rows_per_run": {
      "type": "integer",
      "description": "At most (rows per run)"
     },
     "is_active": {
      "type": "boolean",
      "description": "Switched on"
     },
     "notes": {
      "type": "string",
      "description": "Notes"
     },
     "next_run_at": {
      "type": "string",
      "format": "date-time",
      "description": "Next run at",
      "readOnly": true
     },
     "claimed_at": {
      "type": "string",
      "format": "date-time",
      "description": "Claimed at",
      "readOnly": true
     },
     "last_run_at": {
      "type": "string",
      "format": "date-time",
      "description": "Last run at",
      "readOnly": true
     },
     "last_run_status": {
      "type": "string",
      "description": "Last run status",
      "readOnly": true
     },
     "last_run_id": {
      "type": "string",
      "format": "uuid",
      "description": "Last run id",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     },
     "purge_archived_after_years": {
      "type": "integer",
      "description": "Then purge the archive after (years)"
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/platform/retention-policies": {
   "get": {
    "summary": "list retention-policies",
    "operationId": "list_retention_policies_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create retention-policies",
    "operationId": "create_retention_policies_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/retention-policies/{id}": {
   "get": {
    "summary": "get retention-policies",
    "operationId": "get_retention_policies_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change retention-policies",
    "operationId": "change_retention_policies_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete retention-policies",
    "operationId": "delete_retention_policies_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/retention-policies/{id}/preview": {
   "post": {
    "summary": "Preview",
    "operationId": "action_retention_policies_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/retention-policies/{id}/run": {
   "post": {
    "summary": "Run",
    "operationId": "action_retention_policies_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/retention-policies/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_retention_policies_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}