{
 "openapi": "3.1.0",
 "info": {
  "title": "Approval Document Types (Platform)",
  "version": "20261030b",
  "description": "What can be sent for approval. The built-in types are run by their own modules' rules (listed under Approval Rule Catalogue) or by self-service; add a type of your own by naming the table it lives in. No code needed."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "approval-doc-types": {
    "type": "object",
    "required": [
     "doc_type",
     "label"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "doc_type": {
      "type": "string",
      "description": "Type key"
     },
     "label": {
      "type": "string",
      "description": "Name"
     },
     "engine": {
      "type": "string",
      "description": "Engine",
      "readOnly": true
     },
     "table_name": {
      "type": "string",
      "description": "Table"
     },
     "id_column": {
      "type": "string",
      "description": "Id column"
     },
     "number_column": {
      "type": "string",
      "description": "Number column"
     },
     "amount_column": {
      "type": "string",
      "description": "Amount column"
     },
     "currency_column": {
      "type": "string",
      "description": "Currency column"
     },
     "party_column": {
      "type": "string",
      "description": "Description column"
     },
     "org_unit_column": {
      "type": "string",
      "description": "Org unit column"
     },
     "grant_module": {
      "type": "string",
      "description": "Screen module"
     },
     "grant_resource": {
      "type": "string",
      "description": "Screen resource"
     },
     "status_column": {
      "type": "string",
      "description": "Status column"
     },
     "on_approved_status": {
      "type": "string",
      "description": "Status when approved"
     },
     "on_rejected_status": {
      "type": "string",
      "description": "Status when rejected"
     },
     "when_no_rule": {
      "type": "string",
      "description": "When no route applies",
      "enum": [
       "Refuse to send it (safe)",
       "Approve it automatically"
      ]
     },
     "allow_self_approval": {
      "type": "boolean",
      "description": "Requester may approve their own"
     },
     "is_builtin": {
      "type": "boolean",
      "description": "Is builtin",
      "readOnly": true
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "description": {
      "type": "string",
      "description": "Description"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "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
     },
     "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/approval-doc-types": {
   "get": {
    "summary": "list approval-doc-types",
    "operationId": "list_approval_doc_types_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create approval-doc-types",
    "operationId": "create_approval_doc_types_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/approval-doc-types/{id}": {
   "get": {
    "summary": "get approval-doc-types",
    "operationId": "get_approval_doc_types_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change approval-doc-types",
    "operationId": "change_approval_doc_types_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete approval-doc-types",
    "operationId": "delete_approval_doc_types_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/approval-doc-types/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_approval_doc_types_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"
     }
    }
   }
  }
 }
}