{
 "openapi": "3.1.0",
 "info": {
  "title": "GL Interfaces (HRMS)",
  "version": "20261030b",
  "description": "Where payroll goes in the general ledger that receives it: the target system profile (Yardi Voyager journal ETL, or a generic CSV / JSON journal), its codes, the schedule and the transport. A new interface sends TEST files until Go live."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "gl-interfaces": {
    "type": "object",
    "required": [
     "code",
     "name"
    ],
    "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"
     },
     "profile": {
      "type": "string",
      "description": "Target system profile",
      "enum": [
       "Yardi Voyager -- journal ETL (CSV)",
       "Generic journal (CSV)",
       "Generic journal (JSON)"
      ]
     },
     "mode": {
      "type": "string",
      "description": "Mode"
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "detail_level": {
      "type": "string",
      "description": "Detail",
      "enum": [
       "By account and dimension",
       "By employee as well"
      ]
     },
     "liability_split": {
      "type": "string",
      "description": "Liabilities",
      "enum": [
       "Split like the cost (each property balances)",
       "At company level (default property)"
      ]
     },
     "dimensions": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Dimensions carried"
     },
     "default_property_code": {
      "type": "string",
      "description": "Default property / entity code"
     },
     "entity_code": {
      "type": "string",
      "description": "Entity code"
     },
     "journal_prefix": {
      "type": "string",
      "description": "Journal prefix"
     },
     "book_code": {
      "type": "string",
      "description": "Book"
     },
     "person_code": {
      "type": "string",
      "description": "Person code"
     },
     "column_overrides": {
      "type": "object",
      "description": "Column headings"
     },
     "account_pattern": {
      "type": "string",
      "description": "Account code pattern"
     },
     "property_pattern": {
      "type": "string",
      "description": "Property code pattern"
     },
     "require_valid_list": {
      "type": "boolean",
      "description": "Codes must be on the valid-code list"
     },
     "schedule": {
      "type": "string",
      "description": "Schedule",
      "enum": [
       "After each payroll is posted (and caught up daily)",
       "Manual"
      ]
     },
     "transport": {
      "type": "string",
      "description": "Transport",
      "enum": [
       "Download",
       "SFTP",
       "HTTPS API"
      ]
     },
     "sftp_host": {
      "type": "string",
      "description": "SFTP host"
     },
     "sftp_port": {
      "type": "integer",
      "description": "SFTP port"
     },
     "sftp_username": {
      "type": "string",
      "description": "SFTP user"
     },
     "sftp_auth": {
      "type": "string",
      "description": "SFTP sign-in",
      "enum": [
       "Private key",
       "Password"
      ]
     },
     "sftp_host_key_sha256": {
      "type": "string",
      "description": "Pinned host key (SHA256)"
     },
     "sftp_directory": {
      "type": "string",
      "description": "Folder (live)"
     },
     "sftp_test_directory": {
      "type": "string",
      "description": "Folder (test)"
     },
     "https_url": {
      "type": "string",
      "description": "HTTPS URL (live)"
     },
     "https_test_url": {
      "type": "string",
      "description": "HTTPS URL (test)"
     },
     "https_header_name": {
      "type": "string",
      "description": "Token header"
     },
     "file_name_pattern": {
      "type": "string",
      "description": "File name"
     },
     "notify_emails": {
      "type": "string",
      "description": "Notify emails"
     },
     "go_live_at": {
      "type": "string",
      "format": "date-time",
      "description": "Go live at",
      "readOnly": true
     },
     "go_live_by": {
      "type": "string",
      "format": "uuid",
      "description": "Go live by",
      "readOnly": true
     },
     "last_test_run_id": {
      "type": "string",
      "format": "uuid",
      "description": "Last test run id",
      "readOnly": true
     },
     "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
     },
     "scope_pay_group_ids": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Only these pay groups"
     },
     "scope_org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Only this business unit"
     },
     "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/hrms/gl-interfaces": {
   "get": {
    "summary": "list gl-interfaces",
    "operationId": "list_gl_interfaces_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create gl-interfaces",
    "operationId": "create_gl_interfaces_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/gl-interfaces/{id}": {
   "get": {
    "summary": "get gl-interfaces",
    "operationId": "get_gl_interfaces_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change gl-interfaces",
    "operationId": "change_gl_interfaces_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete gl-interfaces",
    "operationId": "delete_gl_interfaces_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/gl-interfaces/options": {
   "get": {
    "summary": "Options",
    "operationId": "action_gl_interfaces_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/gl-interfaces/{id}/credentials": {
   "put": {
    "summary": "Credentials",
    "operationId": "action_gl_interfaces_0_6",
    "description": "Body keys: privateKey",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/gl-interfaces/{id}/host-key": {
   "post": {
    "summary": "Host key",
    "operationId": "action_gl_interfaces_0_6",
    "description": "Body keys: pin, expect",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/gl-interfaces/{id}/preview": {
   "post": {
    "summary": "Preview",
    "operationId": "action_gl_interfaces_0_6",
    "description": "Body keys: payrollRunId, mode",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/gl-interfaces/{id}/go-live": {
   "post": {
    "summary": "Go live",
    "operationId": "action_gl_interfaces_0_6",
    "description": "Body keys: confirmation",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/gl-interfaces/{id}/specification": {
   "get": {
    "summary": "Specification",
    "operationId": "action_gl_interfaces_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/gl-interfaces/{id}/workbook": {
   "get": {
    "summary": "Workbook",
    "operationId": "action_gl_interfaces_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/hrms/gl-interfaces/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_gl_interfaces_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"
     }
    }
   }
  }
 }
}