{
 "openapi": "3.1.0",
 "info": {
  "title": "Settlement Rules (Accounting)",
  "version": "20261030b",
  "description": "Where cost on a collector goes, and in what proportion. A period closed over unsettled orders leaves cost stranded forever."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "settlement-rules": {
    "type": "object",
    "required": [
     "source_type",
     "source_id",
     "receiver_type"
    ],
    "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
     },
     "source_type": {
      "type": "string",
      "description": "Collector type",
      "enum": [
       "production_order",
       "internal_order",
       "project",
       "wbs_element",
       "work_order",
       "maintenance_order",
       "cost_center",
       "asset_under_construction"
      ]
     },
     "source_id": {
      "type": "string",
      "format": "uuid",
      "description": "Collector"
     },
     "line_no": {
      "type": "integer",
      "description": "Line"
     },
     "receiver_type": {
      "type": "string",
      "description": "Receiver type",
      "enum": [
       "cost_center",
       "profit_center",
       "gl_account",
       "asset",
       "project",
       "wbs_element",
       "profitability_segment",
       "order",
       "inventory",
       "customer"
      ]
     },
     "receiver_id": {
      "type": "string",
      "format": "uuid",
      "description": "Receiver"
     },
     "receiver_code": {
      "type": "string",
      "description": "Receiver code"
     },
     "basis": {
      "type": "string",
      "description": "Basis",
      "enum": [
       "percentage",
       "equivalence",
       "fixed_amount",
       "by_cost_element",
       "full"
      ]
     },
     "percentage": {
      "type": "string",
      "format": "decimal",
      "description": "Percentage"
     },
     "equivalence": {
      "type": "string",
      "format": "decimal",
      "description": "Equivalence number"
     },
     "fixed_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Fixed amount"
     },
     "cost_element_group": {
      "type": "string",
      "description": "Cost element group"
     },
     "settlement_type": {
      "type": "string",
      "description": "Settlement type",
      "enum": [
       "periodic",
       "full",
       "partial",
       "final"
      ]
     },
     "valid_from": {
      "type": "string",
      "format": "date",
      "description": "From"
     },
     "valid_to": {
      "type": "string",
      "format": "date",
      "description": "To"
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "notes": {
      "type": "string",
      "description": "Notes"
     },
     "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
     },
     "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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/accounting/settlement-rules": {
   "get": {
    "summary": "list settlement-rules",
    "operationId": "list_settlement_rules_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create settlement-rules",
    "operationId": "create_settlement_rules_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/settlement-rules/{id}": {
   "get": {
    "summary": "get settlement-rules",
    "operationId": "get_settlement_rules_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change settlement-rules",
    "operationId": "change_settlement_rules_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete settlement-rules",
    "operationId": "delete_settlement_rules_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/settlement-rules/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_settlement_rules_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"
     }
    }
   }
  }
 }
}