{
 "openapi": "3.1.0",
 "info": {
  "title": "Recognition Schedule (Accounting)",
  "version": "20261030b",
  "description": "Written forward for the whole term at the moment of allocation, so a deferred revenue waterfall is a query and not a projection."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "rev-schedule": {
    "type": "object",
    "required": [],
    "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
     },
     "contract_id": {
      "type": "string",
      "format": "uuid",
      "description": "Contract id",
      "readOnly": true
     },
     "obligation_id": {
      "type": "string",
      "format": "uuid",
      "description": "Obligation id",
      "readOnly": true
     },
     "ledger_id": {
      "type": "string",
      "format": "uuid",
      "description": "Ledger id",
      "readOnly": true
     },
     "period_code": {
      "type": "string",
      "description": "Period code",
      "readOnly": true
     },
     "period_date": {
      "type": "string",
      "format": "date",
      "description": "Period date",
      "readOnly": true
     },
     "period_no": {
      "type": "integer",
      "description": "Period no",
      "readOnly": true
     },
     "planned_revenue": {
      "type": "string",
      "format": "decimal",
      "description": "Planned revenue",
      "readOnly": true
     },
     "recognised_revenue": {
      "type": "string",
      "format": "decimal",
      "description": "Recognised revenue",
      "readOnly": true
     },
     "planned_cost": {
      "type": "string",
      "format": "decimal",
      "description": "Planned cost",
      "readOnly": true
     },
     "recognised_cost": {
      "type": "string",
      "format": "decimal",
      "description": "Recognised cost",
      "readOnly": true
     },
     "cumulative_recognised": {
      "type": "string",
      "format": "decimal",
      "description": "Cumulative recognised",
      "readOnly": true
     },
     "percent_complete": {
      "type": "string",
      "format": "decimal",
      "description": "Percent complete",
      "readOnly": true
     },
     "is_recognised": {
      "type": "boolean",
      "description": "Is recognised",
      "readOnly": true
     },
     "run_id": {
      "type": "string",
      "format": "uuid",
      "description": "Run id",
      "readOnly": true
     },
     "journal_id": {
      "type": "string",
      "format": "uuid",
      "description": "Journal id",
      "readOnly": true
     },
     "recognised_at": {
      "type": "string",
      "format": "date-time",
      "description": "Recognised 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_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/rev-schedule": {
   "get": {
    "summary": "list rev-schedule",
    "operationId": "list_rev_schedule_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create rev-schedule",
    "operationId": "create_rev_schedule_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/rev-schedule/{id}": {
   "get": {
    "summary": "get rev-schedule",
    "operationId": "get_rev_schedule_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change rev-schedule",
    "operationId": "change_rev_schedule_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete rev-schedule",
    "operationId": "delete_rev_schedule_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/rev-schedule/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_rev_schedule_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"
     }
    }
   }
  }
 }
}