{
 "openapi": "3.1.0",
 "info": {
  "title": "Placements (Talent & Contingent Workforce)",
  "version": "20261030b",
  "description": "The assignment. Everything downstream hangs off it — the timesheet, the invoice, the pay record, the margin and the compliance clock."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "placements": {
    "type": "object",
    "required": [
     "candidate_id",
     "client_id",
     "start_date"
    ],
    "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
     },
     "location_id": {
      "type": "string",
      "format": "uuid",
      "description": "Office"
     },
     "placement_no": {
      "type": "string",
      "description": "Placement no",
      "readOnly": true
     },
     "job_order_id": {
      "type": "string",
      "format": "uuid",
      "description": "Job order"
     },
     "submission_id": {
      "type": "string",
      "format": "uuid",
      "description": "Submission id"
     },
     "offer_id": {
      "type": "string",
      "format": "uuid",
      "description": "Offer id"
     },
     "candidate_id": {
      "type": "string",
      "format": "uuid",
      "description": "Worker"
     },
     "client_id": {
      "type": "string",
      "format": "uuid",
      "description": "Client"
     },
     "msp_program_id": {
      "type": "string",
      "format": "uuid",
      "description": "Programme"
     },
     "placement_type": {
      "type": "string",
      "description": "Engagement type"
     },
     "employment_classification": {
      "type": "string",
      "description": "Worker classification"
     },
     "supplier_id": {
      "type": "string",
      "format": "uuid",
      "description": "Supplied by"
     },
     "job_title": {
      "type": "string",
      "description": "Role title"
     },
     "start_date": {
      "type": "string",
      "format": "date",
      "description": "Starts"
     },
     "end_date": {
      "type": "string",
      "format": "date",
      "description": "Ends"
     },
     "actual_end_date": {
      "type": "string",
      "format": "date",
      "description": "Actually ended"
     },
     "status": {
      "type": "string",
      "description": "Status"
     },
     "currency": {
      "type": "string",
      "description": "Currency"
     },
     "rate_unit": {
      "type": "string",
      "description": "Rate unit",
      "enum": [
       "hour",
       "day",
       "week",
       "month",
       "year",
       "fixed"
      ]
     },
     "bill_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Bill rate"
     },
     "pay_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Pay rate"
     },
     "ot_bill_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Overtime bill rate"
     },
     "ot_pay_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Overtime pay rate"
     },
     "burden_pct": {
      "type": "string",
      "format": "decimal",
      "description": "Employer burden %"
     },
     "msp_fee_pct": {
      "type": "string",
      "format": "decimal",
      "description": "Programme fee %"
     },
     "gross_margin_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Gross margin amount",
      "readOnly": true
     },
     "gross_margin_pct": {
      "type": "string",
      "format": "decimal",
      "description": "Gross margin pct",
      "readOnly": true
     },
     "net_margin_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Net margin amount",
      "readOnly": true
     },
     "hours_per_week": {
      "type": "string",
      "format": "decimal",
      "description": "Hours a week"
     },
     "annual_salary": {
      "type": "string",
      "format": "decimal",
      "description": "Annual salary"
     },
     "placement_fee": {
      "type": "string",
      "format": "decimal",
      "description": "Placement fee"
     },
     "fee_pct": {
      "type": "string",
      "format": "decimal",
      "description": "Fee %"
     },
     "guarantee_days": {
      "type": "integer",
      "description": "Guarantee (days)"
     },
     "conversion_date": {
      "type": "string",
      "format": "date",
      "description": "Conversion date",
      "readOnly": true
     },
     "conversion_fee": {
      "type": "string",
      "format": "decimal",
      "description": "Conversion fee",
      "readOnly": true
     },
     "work_order_id": {
      "type": "string",
      "format": "uuid",
      "description": "Work order"
     },
     "client_po_no": {
      "type": "string",
      "description": "Client PO number"
     },
     "employee_id": {
      "type": "string",
      "format": "uuid",
      "description": "Employee record"
     },
     "recruiter_id": {
      "type": "string",
      "format": "uuid",
      "description": "Recruiter"
     },
     "account_manager_id": {
      "type": "string",
      "format": "uuid",
      "description": "Account manager"
     },
     "cost_center_id": {
      "type": "string",
      "format": "uuid",
      "description": "Cost center"
     },
     "termination_reason": {
      "type": "string",
      "description": "Termination reason"
     },
     "termination_notice_date": {
      "type": "string",
      "format": "date",
      "description": "Termination notice date"
     },
     "external_ref": {
      "type": "string",
      "description": "Reference over there"
     },
     "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/ats/placements": {
   "get": {
    "summary": "list placements",
    "operationId": "list_placements_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create placements",
    "operationId": "create_placements_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/placements/{id}": {
   "get": {
    "summary": "get placements",
    "operationId": "get_placements_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change placements",
    "operationId": "change_placements_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete placements",
    "operationId": "delete_placements_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/placements/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_placements_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"
     }
    }
   }
  },
  "/api/ats/placements/{parentId}/rates": {
   "get": {
    "summary": "Rates",
    "operationId": "action_placements_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Rates",
    "operationId": "action_placements_1_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/placements/{parentId}/rates/{lineId}": {
   "put": {
    "summary": "Rates",
    "operationId": "action_placements_0_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Rates",
    "operationId": "action_placements_1_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/placements/{id}/extend": {
   "post": {
    "summary": "Extend",
    "operationId": "action_placements_0_6",
    "description": "Body keys: endDate*, billRate, payRate, reason",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/placements/{id}/terminate": {
   "post": {
    "summary": "Terminate",
    "operationId": "action_placements_0_6",
    "description": "Body keys: force, completed, endDate, reason*",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/placements/{id}/convert": {
   "post": {
    "summary": "Convert",
    "operationId": "action_placements_0_6",
    "description": "Body keys: conversionDate, annualSalary, conversionFee, employeeNo",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ats/placements/{id}/compliance-checklist": {
   "post": {
    "summary": "Compliance checklist",
    "operationId": "action_placements_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}