{
 "openapi": "3.1.0",
 "info": {
  "title": "Allocation Runs (Accounting)",
  "version": "20261030b",
  "description": "A residue above the threshold means the iteration gave up before converging, and the cost left over is stranded on the sender — so the run says so rather than letting it disappear."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "allocation-runs": {
    "type": "object",
    "required": [
     "period_code"
    ],
    "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
     },
     "run_no": {
      "type": "string",
      "description": "Run no",
      "readOnly": true
     },
     "cycle_id": {
      "type": "string",
      "format": "uuid",
      "description": "Cycle id"
     },
     "period_code": {
      "type": "string",
      "description": "Period code"
     },
     "posting_date": {
      "type": "string",
      "format": "date",
      "description": "Posting date"
     },
     "version": {
      "type": "string",
      "description": "Version"
     },
     "is_test_run": {
      "type": "boolean",
      "description": "Is test run"
     },
     "status": {
      "type": "string",
      "description": "Status",
      "readOnly": true
     },
     "iterations": {
      "type": "integer",
      "description": "Iterations",
      "readOnly": true
     },
     "residual_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Residual amount",
      "readOnly": true
     },
     "sender_count": {
      "type": "integer",
      "description": "Sender count",
      "readOnly": true
     },
     "receiver_count": {
      "type": "integer",
      "description": "Receiver count",
      "readOnly": true
     },
     "allocated_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Allocated amount",
      "readOnly": true
     },
     "unallocated_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Unallocated amount",
      "readOnly": true
     },
     "journal_id": {
      "type": "string",
      "format": "uuid",
      "description": "Journal id",
      "readOnly": true
     },
     "close_run_id": {
      "type": "string",
      "format": "uuid",
      "description": "Close run id"
     },
     "exceptions": {
      "type": "object",
      "description": "Exceptions",
      "readOnly": true
     },
     "started_at": {
      "type": "string",
      "format": "date-time",
      "description": "Started at",
      "readOnly": true
     },
     "finished_at": {
      "type": "string",
      "format": "date-time",
      "description": "Finished at",
      "readOnly": true
     },
     "run_by": {
      "type": "string",
      "format": "uuid",
      "description": "Run by",
      "readOnly": true
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "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
     },
     "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/allocation-runs": {
   "get": {
    "summary": "list allocation-runs",
    "operationId": "list_allocation_runs_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create allocation-runs",
    "operationId": "create_allocation_runs_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/allocation-runs/{id}": {
   "get": {
    "summary": "get allocation-runs",
    "operationId": "get_allocation_runs_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change allocation-runs",
    "operationId": "change_allocation_runs_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete allocation-runs",
    "operationId": "delete_allocation_runs_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/allocation-runs/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_allocation_runs_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"
     }
    }
   }
  }
 }
}