{
 "openapi": "3.1.0",
 "info": {
  "title": "Grants (Accounting)",
  "version": "20261030b",
  "description": "Every award: who gave it, its Assistance Listing number, its period of performance and the fund it belongs to. A cost outside the period, or in another fund, is refused at posting."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "grant-awards": {
    "type": "object",
    "required": [
     "code",
     "name",
     "grantor",
     "period_from",
     "period_to",
     "fund_id"
    ],
    "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": "Code"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "grantor": {
      "type": "string",
      "description": "Grantor"
     },
     "grantor_type": {
      "type": "string",
      "description": "Grantor type",
      "enum": [
       "federal",
       "state",
       "local",
       "private",
       "other"
      ]
     },
     "pass_through_entity": {
      "type": "string",
      "description": "Pass-through entity"
     },
     "aln": {
      "type": "string",
      "description": "Assistance Listing number (CFDA)"
     },
     "award_no": {
      "type": "string",
      "description": "Award number"
     },
     "award_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Award amount"
     },
     "currency": {
      "type": "string",
      "description": "Currency"
     },
     "period_from": {
      "type": "string",
      "format": "date",
      "description": "Period of performance from"
     },
     "period_to": {
      "type": "string",
      "format": "date",
      "description": "Period of performance to"
     },
     "fund_id": {
      "type": "string",
      "format": "uuid",
      "description": "Fund"
     },
     "funding_source_id": {
      "type": "string",
      "format": "uuid",
      "description": "Funding source (budget)"
     },
     "match_required_pct": {
      "type": "string",
      "format": "decimal",
      "description": "Local match required (%)"
     },
     "indirect_rate_pct": {
      "type": "string",
      "format": "decimal",
      "description": "Indirect cost rate (%)"
     },
     "status": {
      "type": "string",
      "description": "Status",
      "enum": [
       "pending",
       "active",
       "suspended",
       "closed"
      ]
     },
     "notes": {
      "type": "string",
      "description": "Notes"
     },
     "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/accounting/grant-awards": {
   "get": {
    "summary": "list grant-awards",
    "operationId": "list_grant_awards_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create grant-awards",
    "operationId": "create_grant_awards_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/grant-awards/{id}": {
   "get": {
    "summary": "get grant-awards",
    "operationId": "get_grant_awards_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change grant-awards",
    "operationId": "change_grant_awards_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete grant-awards",
    "operationId": "delete_grant_awards_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/grant-awards/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_grant_awards_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"
     }
    }
   }
  }
 }
}