{
 "openapi": "3.1.0",
 "info": {
  "title": "Job Schedules (Platform)",
  "version": "20261030b",
  "description": "When each job runs without anybody starting it. Every one of these fires in the background as the person who created it, so it may take as long as it takes — which is the point for a large file read off a drive, or a folder somebody drops one into every morning. \"State\" says whether it is waiting, running, overdue or paused; overdue for long means the API is not running the scheduler."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "batch-schedules": {
    "type": "object",
    "required": [
     "job_id"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "job_id": {
      "type": "string",
      "format": "uuid",
      "description": "Job"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "cadence": {
      "type": "string",
      "description": "Cadence",
      "enum": [
       "once",
       "every_15_min",
       "hourly",
       "daily",
       "weekly",
       "monthly",
       "quarterly",
       "annually",
       "on_demand"
      ]
     },
     "run_at": {
      "type": "string",
      "description": "At"
     },
     "day_of_week": {
      "type": "integer",
      "description": "Day of week"
     },
     "day_of_month": {
      "type": "integer",
      "description": "Day of month"
     },
     "parameters": {
      "type": "object",
      "description": "Parameters",
      "readOnly": true
     },
     "dry_run": {
      "type": "boolean",
      "description": "Rehearse only"
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "last_run_at": {
      "type": "string",
      "format": "date-time",
      "description": "Last run at",
      "readOnly": true
     },
     "next_due": {
      "type": "string",
      "format": "date-time",
      "description": "Next due",
      "readOnly": true
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "description": {
      "type": "string",
      "description": "What it is for"
     },
     "starts_at": {
      "type": "string",
      "format": "date-time",
      "description": "When (a one-off)"
     },
     "run_once": {
      "type": "boolean",
      "description": "Run once",
      "readOnly": true
     },
     "run_as": {
      "type": "string",
      "format": "uuid",
      "description": "Run as",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "origin": {
      "type": "string",
      "description": "Origin",
      "readOnly": true
     },
     "origin_ref": {
      "type": "object",
      "description": "Origin ref",
      "readOnly": true
     },
     "claimed_at": {
      "type": "string",
      "format": "date-time",
      "description": "Claimed at",
      "readOnly": true
     },
     "claimed_by": {
      "type": "string",
      "description": "Claimed by",
      "readOnly": true
     },
     "last_run_id": {
      "type": "string",
      "format": "uuid",
      "description": "Last run id",
      "readOnly": true
     },
     "last_status": {
      "type": "string",
      "description": "Last status",
      "readOnly": true
     },
     "last_error": {
      "type": "string",
      "description": "Last error",
      "readOnly": true
     },
     "run_count": {
      "type": "integer",
      "description": "Run count",
      "readOnly": true
     },
     "time_zone": {
      "type": "string",
      "description": "Time zone",
      "enum": [
       "UTC",
       "Africa/Abidjan",
       "Africa/Accra",
       "Africa/Addis_Ababa",
       "Africa/Algiers",
       "Africa/Asmera",
       "Africa/Bamako",
       "Africa/Bangui",
       "Africa/Banjul",
       "Africa/Bissau",
       "Africa/Blantyre",
       "Africa/Brazzaville",
       "Africa/Bujumbura",
       "Africa/Cairo",
       "Africa/Casablanca",
       "Africa/Ceuta",
       "Africa/Conakry",
       "Africa/Dakar",
       "Africa/Dar_es_Salaam",
       "Africa/Djibouti",
       "Africa/Douala",
       "Africa/El_Aaiun",
       "Africa/Freetown",
       "Africa/Gaborone",
       "Africa/Harare",
       "Africa/Johannesburg",
       "Africa/Juba",
       "Africa/Kampala",
       "Africa/Khartoum",
       "Africa/Kigali",
       "Africa/Kinshasa",
       "Africa/Lagos",
       "Africa/Libreville",
       "Africa/Lome",
       "Africa/Luanda",
       "Africa/Lubumbashi",
       "Africa/Lusaka",
       "Africa/Malabo",
       "Africa/Maputo",
       "Africa/Maseru",
       "Africa/Mbabane",
       "Africa/Mogadishu",
       "Africa/Monrovia",
       "Africa/Nairobi",
       "Africa/Ndjamena",
       "Africa/Niamey",
       "Africa/Nouakchott",
       "Africa/Ouagadougou",
       "Africa/Porto-Novo",
       "Africa/Sao_Tome",
       "Africa/Tripoli",
       "Africa/Tunis",
       "Africa/Windhoek",
       "America/Adak",
       "America/Anchorage",
       "America/Anguilla",
       "America/Antigua",
       "America/Araguaina",
       "America/Argentina/La_Rioja",
       "America/Argentina/Rio_Gallegos",
       "America/Argentina/Salta",
       "America/Argentina/San_Juan",
       "America/Argentina/San_Luis",
       "America/Argentina/Tucuman",
       "America/Argentina/Ushuaia",
       "America/Aruba",
       "America/Asuncion",
       "America/Bahia",
       "America/Bahia_Banderas",
       "America/Barbados",
       "America/Belem",
       "America/Belize",
       "America/Blanc-Sablon",
       "America/Boa_Vista",
       "America/Bogota",
       "America/Boise",
       "America/Buenos_Aires",
       "America/Cambridge_Bay",
       "America/Campo_Grande",
       "America/Cancun",
       "America/Caracas",
       "America/Catamarca",
       "America/Cayenne",
       "America/Cayman",
       "America/Chicago",
       "America/Chihuahua",
       "America/Ciudad_Juarez",
       "America/Coral_Harbour",
       "America/Cordoba",
       "America/Costa_Rica",
       "America/Coyhaique",
       "America/Creston",
       "America/Cuiaba",
       "America/Curacao",
       "America/Danmarkshavn",
       "America/Dawson",
       "America/Dawson_Creek",
       "America/Denver",
       "America/Detroit",
       "America/Dominica",
       "America/Edmonton",
       "America/Eirunepe",
       "America/El_Salvador",
       "America/Fort_Nelson",
       "America/Fortaleza",
       "America/Glace_Bay",
       "America/Godthab",
       "America/Goose_Bay",
       "America/Grand_Turk",
       "America/Grenada",
       "America/Guadeloupe",
       "America/Guatemala",
       "America/Guayaquil",
       "America/Guyana",
       "America/Halifax",
       "America/Havana",
       "America/Hermosillo",
       "America/Indiana/Knox",
       "America/Indiana/Marengo",
       "America/Indiana/Petersburg",
       "America/Indiana/Tell_City",
       "America/Indiana/Vevay",
       "America/Indiana/Vincennes",
       "America/Indiana/Winamac",
       "America/Indianapolis",
       "America/Inuvik",
       "America/Iqaluit",
       "America/Jamaica",
       "America/Jujuy",
       "America/Juneau",
       "America/Kentucky/Monticello",
       "America/Kralendijk",
       "America/La_Paz",
       "America/Lima",
       "America/Los_Angeles",
       "America/Louisville",
       "America/Lower_Princes",
       "America/Maceio",
       "America/Managua",
       "America/Manaus",
       "America/Marigot",
       "America/Martinique",
       "America/Matamoros",
       "America/Mazatlan",
       "America/Mendoza",
       "America/Menominee",
       "America/Merida",
       "America/Metlakatla",
       "America/Mexico_City",
       "America/Miquelon",
       "America/Moncton",
       "America/Monterrey",
       "America/Montevideo",
       "America/Montserrat",
       "America/Nassau",
       "America/New_York",
       "America/Nome",
       "America/Noronha",
       "America/North_Dakota/Beulah",
       "America/North_Dakota/Center",
       "America/North_Dakota/New_Salem",
       "America/Ojinaga",
       "America/Panama",
       "America/Paramaribo",
       "America/Phoenix",
       "America/Port-au-Prince",
       "America/Port_of_Spain",
       "America/Porto_Velho",
       "America/Puerto_Rico",
       "America/Punta_Arenas",
       "America/Rankin_Inlet",
       "America/Recife",
       "America/Regina",
       "America/Resolute",
       "America/Rio_Branco",
       "America/Santarem",
       "America/Santiago",
       "America/Santo_Domingo",
       "America/Sao_Paulo",
       "America/Scoresbysund",
       "America/Sitka",
       "America/St_Barthelemy",
       "America/St_Johns",
       "America/St_Kitts",
       "America/St_Lucia",
       "America/St_Thomas",
       "America/St_Vincent",
       "America/Swift_Current",
       "America/Tegucigalpa",
       "America/Thule",
       "America/Tijuana",
       "America/Toronto",
       "America/Tortola",
       "America/Vancouver",
       "America/Whitehorse",
       "America/Winnipeg",
       "America/Yakutat",
       "Antarctica/Casey",
       "Antarctica/Davis",
       "Antarctica/DumontDUrville",
       "Antarctica/Macquarie",
       "Antarctica/Mawson",
       "Antarctica/McMurdo",
       "Antarctica/Palmer",
       "Antarctica/Rothera",
       "Antarctica/Syowa",
       "Antarctica/Troll",
       "Antarctica/Vostok",
       "Arctic/Longyearbyen",
       "Asia/Aden",
       "Asia/Almaty",
       "Asia/Amman",
       "Asia/Anadyr",
       "Asia/Aqtau",
       "Asia/Aqtobe",
       "Asia/Ashgabat",
       "Asia/Atyrau",
       "Asia/Baghdad",
       "Asia/Bahrain",
       "Asia/Baku",
       "Asia/Bangkok",
       "Asia/Barnaul",
       "Asia/Beirut",
       "Asia/Bishkek",
       "Asia/Brunei",
       "Asia/Calcutta",
       "Asia/Chita",
       "Asia/Colombo",
       "Asia/Damascus",
       "Asia/Dhaka",
       "Asia/Dili",
       "Asia/Dubai",
       "Asia/Dushanbe",
       "Asia/Famagusta",
       "Asia/Gaza",
       "Asia/Hebron",
       "Asia/Hong_Kong",
       "Asia/Hovd",
       "Asia/Irkutsk",
       "Asia/Jakarta",
       "Asia/Jayapura",
       "Asia/Jerusalem",
       "Asia/Kabul",
       "Asia/Kamchatka",
       "Asia/Karachi",
       "Asia/Katmandu",
       "Asia/Khandyga",
       "Asia/Krasnoyarsk",
       "Asia/Kuala_Lumpur",
       "Asia/Kuching",
       "Asia/Kuwait",
       "Asia/Macau",
       "Asia/Magadan",
       "Asia/Makassar",
       "Asia/Manila",
       "Asia/Muscat",
       "Asia/Nicosia",
       "Asia/Novokuznetsk",
       "Asia/Novosibirsk",
       "Asia/Omsk",
       "Asia/Oral",
       "Asia/Phnom_Penh",
       "Asia/Pontianak",
       "Asia/Pyongyang",
       "Asia/Qatar",
       "Asia/Qostanay",
       "Asia/Qyzylorda",
       "Asia/Rangoon",
       "Asia/Riyadh",
       "Asia/Saigon",
       "Asia/Sakhalin",
       "Asia/Samarkand",
       "Asia/Seoul",
       "Asia/Shanghai",
       "Asia/Singapore",
       "Asia/Srednekolymsk",
       "Asia/Taipei",
       "Asia/Tashkent",
       "Asia/Tbilisi",
       "Asia/Tehran",
       "Asia/Thimphu",
       "Asia/Tokyo",
       "Asia/Tomsk",
       "Asia/Ulaanbaatar",
       "Asia/Urumqi",
       "Asia/Ust-Nera",
       "Asia/Vientiane",
       "Asia/Vladivostok",
       "Asia/Yakutsk",
       "Asia/Yekaterinburg",
       "Asia/Yerevan",
       "Atlantic/Azores",
       "Atlantic/Bermuda",
       "Atlantic/Canary",
       "Atlantic/Cape_Verde",
       "Atlantic/Faeroe",
       "Atlantic/Madeira",
       "Atlantic/Reykjavik",
       "Atlantic/South_Georgia",
       "Atlantic/St_Helena",
       "Atlantic/Stanley",
       "Australia/Adelaide",
       "Australia/Brisbane",
       "Australia/Broken_Hill",
       "Australia/Darwin",
       "Australia/Eucla",
       "Australia/Hobart",
       "Australia/Lindeman",
       "Australia/Lord_Howe",
       "Australia/Melbourne",
       "Australia/Perth",
       "Australia/Sydney",
       "Europe/Amsterdam",
       "Europe/Andorra",
       "Europe/Astrakhan",
       "Europe/Athens",
       "Europe/Belgrade",
       "Europe/Berlin",
       "Europe/Bratislava",
       "Europe/Brussels",
       "Europe/Bucharest",
       "Europe/Budapest",
       "Europe/Busingen",
       "Europe/Chisinau",
       "Europe/Copenhagen",
       "Europe/Dublin",
       "Europe/Gibraltar",
       "Europe/Guernsey",
       "Europe/Helsinki",
       "Europe/Isle_of_Man",
       "Europe/Istanbul",
       "Europe/Jersey",
       "Europe/Kaliningrad",
       "Europe/Kiev",
       "Europe/Kirov",
       "Europe/Lisbon",
       "Europe/Ljubljana",
       "Europe/London",
       "Europe/Luxembourg",
       "Europe/Madrid",
       "Europe/Malta",
       "Europe/Mariehamn",
       "Europe/Minsk",
       "Europe/Monaco",
       "Europe/Moscow",
       "Europe/Oslo",
       "Europe/Paris",
       "Europe/Podgorica",
       "Europe/Prague",
       "Europe/Riga",
       "Europe/Rome",
       "Europe/Samara",
       "Europe/San_Marino",
       "Europe/Sarajevo",
       "Europe/Saratov",
       "Europe/Simferopol",
       "Europe/Skopje",
       "Europe/Sofia",
       "Europe/Stockholm",
       "Europe/Tallinn",
       "Europe/Tirane",
       "Europe/Ulyanovsk",
       "Europe/Vaduz",
       "Europe/Vatican",
       "Europe/Vienna",
       "Europe/Vilnius",
       "Europe/Volgograd",
       "Europe/Warsaw",
       "Europe/Zagreb",
       "Europe/Zurich",
       "Indian/Antananarivo",
       "Indian/Chagos",
       "Indian/Christmas",
       "Indian/Cocos",
       "Indian/Comoro",
       "Indian/Kerguelen",
       "Indian/Mahe",
       "Indian/Maldives",
       "Indian/Mauritius",
       "Indian/Mayotte",
       "Indian/Reunion",
       "Pacific/Apia",
       "Pacific/Auckland",
       "Pacific/Bougainville",
       "Pacific/Chatham",
       "Pacific/Easter",
       "Pacific/Efate",
       "Pacific/Enderbury",
       "Pacific/Fakaofo",
       "Pacific/Fiji",
       "Pacific/Funafuti",
       "Pacific/Galapagos",
       "Pacific/Gambier",
       "Pacific/Guadalcanal",
       "Pacific/Guam",
       "Pacific/Honolulu",
       "Pacific/Kiritimati",
       "Pacific/Kosrae",
       "Pacific/Kwajalein",
       "Pacific/Majuro",
       "Pacific/Marquesas",
       "Pacific/Midway",
       "Pacific/Nauru",
       "Pacific/Niue",
       "Pacific/Norfolk",
       "Pacific/Noumea",
       "Pacific/Pago_Pago",
       "Pacific/Palau",
       "Pacific/Pitcairn",
       "Pacific/Ponape",
       "Pacific/Port_Moresby",
       "Pacific/Rarotonga",
       "Pacific/Saipan",
       "Pacific/Tahiti",
       "Pacific/Tarawa",
       "Pacific/Tongatapu",
       "Pacific/Truk",
       "Pacific/Wake",
       "Pacific/Wallis"
      ]
     },
     "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/platform/batch-schedules": {
   "get": {
    "summary": "list batch-schedules",
    "operationId": "list_batch_schedules_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create batch-schedules",
    "operationId": "create_batch_schedules_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/batch-schedules/{id}": {
   "get": {
    "summary": "get batch-schedules",
    "operationId": "get_batch_schedules_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change batch-schedules",
    "operationId": "change_batch_schedules_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete batch-schedules",
    "operationId": "delete_batch_schedules_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/batch-schedules/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_batch_schedules_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"
     }
    }
   }
  }
 }
}